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

Document APIResponseCompression feature gate #41318

Merged
merged 4 commits into from
May 26, 2023

Conversation

mrgiles
Copy link
Contributor

@mrgiles mrgiles commented May 25, 2023

API reference: Document APIResponseCompression feature gate. Fixes #30639

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 25, 2023
@k8s-ci-robot k8s-ci-robot requested a review from lavalamp May 25, 2023 07:53
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label May 25, 2023
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label May 25, 2023
@netlify
Copy link

netlify bot commented May 25, 2023

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit faa979c
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/647033eda4e0d60008ace5a7
😎 Deploy Preview https://deploy-preview-41318--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@mrgiles
Copy link
Contributor Author

mrgiles commented May 25, 2023

FYI @sftim

@k8s-triage-robot
Copy link

Unknown CLA label state. Rechecking for CLA labels.

Send feedback to sig-contributor-experience at kubernetes/community.

/check-cla
/easycla

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 25, 2023
@mrgiles mrgiles requested a review from tengqm May 26, 2023 01:21
Comment on lines 293 to 294
It is enabled by default since Kubernetes 1.16, but can be disabled by setting the `--feature-gates`
flag on the API server to `APIResponseCompression=false`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It is enabled by default since Kubernetes 1.16, but can be disabled by setting the `--feature-gates`
flag on the API server to `APIResponseCompression=false`.
It is enabled by default since Kubernetes 1.16 and it can be disabled by including
`APIResponseCompression=false` in the `--feature-gates` flag on the API server.

mrgiles added 2 commits May 25, 2023 20:55
Modify APIResponseCompression definition

Minor edits to streamline paragraphs
@mrgiles mrgiles requested a review from tengqm May 26, 2023 04:40
@tengqm
Copy link
Contributor

tengqm commented May 26, 2023

/label tide/merge-method-squash
/approve

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 26, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

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 May 26, 2023
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

This PR improves the docs

depending on the number of pods and their attributes. By compressing the response, the network bandwidth
can be saved and the latency can be reduced.

To verify if `APIResponseCompression` is working, you can send a **get** or **list** request to the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: if it has a request header, it's a GET (list is a logical verb in API and is not part of HTTP)

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

LGTM label has been added.

Git tree hash: 510334c9912c22938db4654dc6555165fe4b61b6

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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document API response compression
5 participants