kubernetes-sigs / apiserver-network-proxy

Apache License 2.0
381 stars 182 forks source link

Use protobuf encoding for core K8s APIs in apiserver-network-proxy #655

Closed tosi3k closed 1 month ago

tosi3k commented 2 months ago

For core K8s API objects like Pods, Nodes, etc., we can use protobuf encoding which, compared to the default JSON encoding, reduces CPU consumption related to (de)serialization, reduces overall latency of the API calls, reduces memory footprint and the work performed by the GC and results in quicker propagation of objects to event handlers of shared informers.

Core system components of K8s default their serialization method to protobuf for 8 years already: https://github.com/kubernetes/kubernetes/pull/25738.

Some benchmarks comparing JSON vs. protobuf showcasing how the latter data format (de)serializes faster and uses less memory:

k8s-ci-robot commented 2 months ago

Welcome @tosi3k!

It looks like this is your first PR to kubernetes-sigs/apiserver-network-proxy 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/apiserver-network-proxy has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot commented 2 months ago

Hi @tosi3k. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
tosi3k commented 2 months ago

/assign @cheftako

jkh52 commented 1 month ago

/ok-to-test

jkh52 commented 1 month ago

The only failure is with lint, and this PR is not likely the culprit:

level=info msg="[runner] linters took 15.706254297s with stages: goanalysis_metalinter: 15.075948509s"
cmd/agent/app/server.go:104:2: undefined: klog (typecheck)
    klog.V(1).Infoln("Shutting down agent.")
    ^
cmd/agent/app/server.go:126:2: undefined: klog (typecheck)
    klog.V(2).InfoS("Received first signal", "signal", s)
    ^
cmd/agent/app/server.go:129:2: undefined: klog (typecheck)
    klog.V(2).InfoS("Received second signal", "signal", s)
    ^
pkg/server/backend_manager.go:64:1: missing return (typecheck)
}
^
cheftako commented 1 month ago

I like the change. I have concern that there might be edge cases where this might cause problems. I do not know of any but wonder for instance if we have adequately tested this with the system running in HTTP-CONNECT mode rather than GRPC. I think it would be good to at least have a flag to allow someone to revert to the legacy behavior if they do suspect a problem.

jkh52 commented 1 month ago

I like the change. I have concern that there might be edge cases where this might cause problems. I do not know of any but wonder for instance if we have adequately tested this with the system running in HTTP-CONNECT mode rather than GRPC. I think it would be good to at least have a flag to allow someone to revert to the legacy behavior if they do suspect a problem.

+1 to a flag, but the default should be protobuf (I don't see much risk here).

tosi3k commented 1 month ago

Thanks - added appropriate flag to both the agent and the server with defaulting to protobuf.

PTAL :)

k8s-ci-robot commented 1 month ago

@tosi3k: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-apiserver-network-proxy-make-lint-master e68f77bad89ca47e79366f6c651fef28905aa2cb link true /test pull-apiserver-network-proxy-make-lint-master

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository. I understand the commands that are listed [here](https://go.k8s.io/bot-commands).
jkh52 commented 1 month ago

/lgtm /approve

(The lint error should hopefully be resolved soon, and this PR will become merge-able.)

k8s-ci-robot commented 1 month ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jkh52, tosi3k

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/apiserver-network-proxy/blob/master/OWNERS)~~ [jkh52] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tosi3k commented 1 month ago

@jkh52 given it's an unrelated linter failure, maybe we can force submit the PR? :)

Although I suppose it could wait for Monday given Friday is the worst day for releasing / submitting anything, especially in controversial ways like force submitting.

tosi3k commented 1 month ago

@cheftako @jkh52 friendly ping :)