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
[docs]: Promote STS minReadySeconds to beta #30435
Conversation
👷 Deploy Preview for kubernetes-io-vnext-staging processing. 🔨 Explore the source changes: 9ea79fa 🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/61a4de89b46c9800085062c7 |
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.
One nit, rest lgtm
@@ -286,7 +286,7 @@ StatefulSet will then begin to recreate the Pods using the reverted template. | |||
|
|||
### Minimum ready seconds | |||
|
|||
{{< feature-state for_k8s_version="v1.22" state="alpha" >}} | |||
{{< feature-state for_k8s_version="v1.23" state="beta" >}} | |||
|
|||
`.spec.minReadySeconds` is an optional field that specifies the minimum number of seconds for which a newly |
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.
It's worth mentioning that starting from 1.23 it's on 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.
We should reword line 296. maybe bring it right under this shortcode:
Please note that this field only works if you enable the
StatefulSetMinReadySeconds
feature gate.
/assign @chrisnegus |
/lgtm |
LGTM label has been added. Git tree hash: 24386685c768fb544450e3563843eef44fdd6b1d
|
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.
Looks good from SIG Docs side too, +1 to Maciej's suggestion!
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
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.
Thanks for this. I recommend a more thorough tidying in connection with the promotion past alpha.
Now that this is beta, we should move this to be a level-3 heading under “Components” (see line 51), and include it in the example.
We should also clarify that the default zero value is honored by default and that you have to opt-out if you want the old behavior.
@@ -286,7 +286,7 @@ StatefulSet will then begin to recreate the Pods using the reverted template. | |||
|
|||
### Minimum ready seconds | |||
|
|||
{{< feature-state for_k8s_version="v1.22" state="alpha" >}} | |||
{{< feature-state for_k8s_version="v1.23" state="beta" >}} | |||
|
|||
`.spec.minReadySeconds` is an optional field that specifies the minimum number of seconds for which a newly |
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.
We should reword line 296. maybe bring it right under this shortcode:
Please note that this field only works if you enable the
StatefulSetMinReadySeconds
feature gate.
@ravisantoshgudimetla: if you agree with my suggested changes, but don't have time yet, please /lgtm cancel and mark this PR as WIP to record your intent. |
@sftim he's out this week, he'll respond next when he's back |
/hold to address @sftim's comments. |
Isn't it already level3? |
It's already level 3, but part of the section headed “Rolling Updates” |
So would level 3 under components section makes sense? |
I'm asserting that it would. The |
5c728fe
to
466561c
Compare
And I agree with you. I was asking just to make sure that we're on same page. |
/hold cancel This is ready for further review / further rework. |
/sig apps @kubernetes/sig-apps-pr-reviews is this revised documentation technically accurate? |
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
LGTM label has been added. Git tree hash: 92eede88316b7645bde6d0ca9adf8ef213f53873
|
Yes, it is :) |
LGTM for SIG Docs too |
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jlbutler, soltysh 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 |
The `minReadySeconds` Helm values have a kubernetes version constraint `>=1.25` since MR bitnami#13783. While `minReadySeconds` for `StatefulSet` is stable since 1.25, it has been in beta state since 1.23 (see kubernetes/website#30435), which means that it is available on k8s >=1.23 by default unless specifically disabled. Change the version constraint to `>=1.23` to make the feature available on older k8s clusters. Signed-off-by: Simon Baatz <gmbnomis@gmail.com>
The `minReadySeconds` Helm values have a kubernetes version constraint `>=1.25` since MR bitnami#13783. While `minReadySeconds` for `StatefulSet` is stable since 1.25, it has been in beta state since 1.23 (see kubernetes/website#30435), which means that it is available on k8s >=1.23 by default unless specifically disabled. Change the version constraint to `>=1.23-0` to make the feature available on older k8s clusters. (The `-0` includes pre-releases and follows the general pattern used in the Bitnami Helm charts) Signed-off-by: Simon Baatz <gmbnomis@gmail.com>
) The `minReadySeconds` Helm values have a kubernetes version constraint `>=1.25` since MR #13783. While `minReadySeconds` for `StatefulSet` is stable since 1.25, it has been in beta state since 1.23 (see kubernetes/website#30435), which means that it is available on k8s >=1.23 by default unless specifically disabled. Change the version constraint to `>=1.23-0` to make the feature available on older k8s clusters. (The `-0` includes pre-releases and follows the general pattern used in the Bitnami Helm charts) Signed-off-by: Simon Baatz <gmbnomis@gmail.com>
…nami#15417) The `minReadySeconds` Helm values have a kubernetes version constraint `>=1.25` since MR bitnami#13783. While `minReadySeconds` for `StatefulSet` is stable since 1.25, it has been in beta state since 1.23 (see kubernetes/website#30435), which means that it is available on k8s >=1.23 by default unless specifically disabled. Change the version constraint to `>=1.23-0` to make the feature available on older k8s clusters. (The `-0` includes pre-releases and follows the general pattern used in the Bitnami Helm charts) Signed-off-by: Simon Baatz <gmbnomis@gmail.com> Signed-off-by: Frédéric Marchand <frederic.marchand@kudelskisecurity.com>
) The `minReadySeconds` Helm values have a kubernetes version constraint `>=1.25` since MR #13783. While `minReadySeconds` for `StatefulSet` is stable since 1.25, it has been in beta state since 1.23 (see kubernetes/website#30435), which means that it is available on k8s >=1.23 by default unless specifically disabled. Change the version constraint to `>=1.23-0` to make the feature available on older k8s clusters. (The `-0` includes pre-releases and follows the general pattern used in the Bitnami Helm charts) Signed-off-by: Simon Baatz <gmbnomis@gmail.com>
xref: kubernetes/enhancements#2599
cc @soltysh @sftim @jlbutler