-
Notifications
You must be signed in to change notification settings - Fork 14k
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
Update API Priority and Fairness doc for graduation to beta #24975
Conversation
Deploy preview for kubernetes-io-vnext-staging processing. Building with commit 78869f6 https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5faecc43c710b6000845b6df |
/milestone 1.20 |
@reylejano-rxm : This is not dependent on k/k PRs 90541 and 91389 |
@MikeSpreitzer I updated the related k/k PR dependency |
--feature-gates=APIPriorityAndFairness=true \ | ||
--runtime-config=flowcontrol.apiserver.k8s.io/v1alpha1=true \ | ||
--feature-gates=APIPriorityAndFairness=false \ | ||
--runtime-config=flowcontrol.apiserver.k8s.io/v1alpha1=false \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This alpha API group is enabled by default? Is that right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch, no, that should read --runtime-config=flowcontrol.apiserver.k8s.io/v1beta1=false
if I'm not mistaken (alpha runtime config flag is false by default)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
except for one minor nit
@@ -7,6 +7,7 @@ min-kubernetes-server-version: v1.18 | |||
<!-- overview --> | |||
|
|||
{{< feature-state state="alpha" for_k8s_version="v1.18" >}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is it common practice to leave the alpha section in? I couldn't find anything similar from a brief search
I'd imagine the older versions of the docs will have the alpha tag
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, remove this line.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
/lgtm cancel |
@MikeSpreitzer , since this feature is graduating to beta, does it need to be updated in the Feature Gates list |
Ah, yes, the FeatureGates list needs to be updated too. |
038398d
to
354695a
Compare
@@ -52,6 +52,7 @@ different Kubernetes components. | |||
| `APIListChunking` | `false` | Alpha | 1.8 | 1.8 | | |||
| `APIListChunking` | `true` | Beta | 1.9 | | | |||
| `APIPriorityAndFairness` | `false` | Alpha | 1.17 | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the convention seems to be to have the last alpha version in the Until column - do we do this only if the alpha API is entirely removed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added the "until" for alpha.
354695a
to
cf4829a
Compare
looks like correct k/k pr for this is kubernetes/kubernetes#96527 |
Oh yes, we had to switch to a different k/k PR because the original author is sleeping now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Markdown makes sense, technical changes here are minor.
content/en/docs/concepts/cluster-administration/flow-control.md
Outdated
Show resolved
Hide resolved
Note: /hold |
@sftim : I took your suggestion, and naturally lost your LGTM for my trouble. |
/lgtm Only minor changes since #24975 (review) BTW - this repo does preserve LGTM through squashes |
LGTM label has been added. Git tree hash: 5b36f976ac2f1720cff959599e5f1bd9ba744c9e
|
2820957
to
285bc5c
Compare
The force-push to 285bc5c is a squash. |
285bc5c
to
78869f6
Compare
aand the force-push to 78869f6 added the overlooked close quote. |
/lgtm |
LGTM label has been added. Git tree hash: 20d4b15e2a56e2a735bf5ef53fd28e192a222783
|
disable them. The name of the feature gate for APF is | ||
"APIPriorityAndFairness". This feature also involves an {{< | ||
glossary_tooltip term_id="api-group" text="API Group" >}} with: (a) a | ||
`v1alpha1` version, disabled by default, and (b) a `v1beta1` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The changes seem straightforward.
You could use a list here instead of using:
(a) some text
(b) some more text
This feature includes an {{< glossary_tooltip term_id="api-group" text="API Group" >}} with:
- a
v1alpha1
version, disabled, and - a
v1beta1
version, enabled by default
You can disable the feature gate ...
@@ -189,12 +194,14 @@ that originate from outside your cluster. | |||
|
|||
## Resources | |||
The flow control API involves two kinds of resources. | |||
[PriorityLevelConfigurations](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#prioritylevelconfiguration-v1alpha1-flowcontrol-apiserver-k8s-io) | |||
[PriorityLevelConfigurations](/docs/reference/generated/kubernetes-api/{{< param "version" >}}/#prioritylevelconfiguration-v1beta1-flowcontrol-apiserver-k8s-io) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: This could be a list?
The flow control API involves two types of resources:
- PriorityLevelConfigurations .... define the available isolation classes and the share of the available concurrency
budget that each can handle, and allow for fine-tuning queuing behavior. - FlowSchemas ...
/label tide/method-merge-squash |
@irvifa: The label(s) In response to this:
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/test-infra repository. |
/label tide/merge-method-squash |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kbhawkey 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 |
/hold cancel |
Update the doc page to mention the v1beta1 API group in addition to, and in preference to, the v1alpha. Update the example to use the v1beta1 API group.