add WatchListCompression feature gate documentation - #56515
Conversation
👷 Deploy Preview for kubernetes-io-vnext-staging processing.
|
kubernetes-prow
Bot
added
the
cncf-cla: yes
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
kubernetes-prow
Bot
added
the
language/en
kubernetes-prow
Bot
added
the
size/S
|
/assign @wojtek-t |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
lmktfy
left a comment
lmktfy
left a comment
There was a problem hiding this comment.
https://k8s.io/docs/reference/using-api/api-concepts/#streaming-lists also wants a brief update, to mention that clients can request that the watch response is gzip encoded (and what happens if they do).
| fromVersion: "1.37" | ||
| --- | ||
| Enables compression for | ||
| [WatchList](/docs/reference/command-line-tools-reference/feature-gates/WatchList/) |
There was a problem hiding this comment.
| [WatchList](/docs/reference/command-line-tools-reference/feature-gates/WatchList/) | |
| [_watch list_](/docs/reference/using-api/api-concepts/#streaming-lists) |
| --- | ||
| Enables compression for | ||
| [WatchList](/docs/reference/command-line-tools-reference/feature-gates/WatchList/) | ||
| responses from the API server. |
There was a problem hiding this comment.
Maybe something like this?
responses from the API server.
+
+If you disable the
+[`WatchList`](/docs/reference/command-line-tools-+reference/feature-gates/#WatchList)
+feature gate, the API server starts without any error,
+but Kubernetes doesn't provide support for watch lists
+(compressed or uncompressed).There was a problem hiding this comment.
I'd prefer to keep this doc focused on WatchListCompression rather than explaining WatchList behavior here.
How about: This feature gate has no effect if WatchList is disabled. ?
|
/sig api-machinery |
kubernetes-prow
Bot
added
the
sig/api-machinery
|
@p0lyn0mial could you please address the suggestions so we can get this merged for docs freeze? Thank you! |
|
Does this PR now need a docs exception? |
|
pushed. ptal. |
5 participants
Description
Add feature gate description file for
WatchListCompression(beta, default true, v1.37).The gate enables gzip compression for WatchList responses from the API server.
xref: kubernetes/kubernetes#140140
Issue
Closes: #