Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

tosi3k
Copy link
Contributor

@tosi3k tosi3k commented Sep 16, 2024

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: kubernetes/kubernetes#25738.

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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 16, 2024
@k8s-ci-robot
Copy link
Contributor

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. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Sep 16, 2024
@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 16, 2024
@tosi3k
Copy link
Contributor Author

tosi3k commented Sep 16, 2024

/assign @cheftako

@jkh52
Copy link
Contributor

jkh52 commented Sep 23, 2024

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 23, 2024
@jkh52
Copy link
Contributor

jkh52 commented Sep 24, 2024

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
Copy link
Contributor

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
Copy link
Contributor

jkh52 commented Oct 2, 2024

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).

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 2, 2024
@tosi3k
Copy link
Contributor Author

tosi3k commented Oct 2, 2024

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

PTAL :)

@k8s-ci-robot
Copy link
Contributor

@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 e68f77b 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@jkh52
Copy link
Contributor

jkh52 commented Oct 2, 2024

/lgtm
/approve

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

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 2, 2024
@k8s-ci-robot
Copy link
Contributor

[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:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 2, 2024
@tosi3k
Copy link
Contributor Author

tosi3k commented Oct 4, 2024

@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
Copy link
Contributor Author

tosi3k commented Oct 11, 2024

@cheftako @jkh52 friendly ping :)

@k8s-ci-robot k8s-ci-robot merged commit dd110ca into kubernetes-sigs:master Oct 14, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants