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

Add docs for minReadySeconds in StatefulSet #27683

Merged
merged 1 commit into from
Jul 23, 2021

Conversation

ravisantoshgudimetla
Copy link
Contributor

Add docs from minReadySeconds.

xref: kubernetes/enhancements#2607

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 23, 2021
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Apr 23, 2021
@netlify
Copy link

netlify bot commented Apr 23, 2021

Deploy preview for kubernetes-io-master-staging ready!

Built with commit ee7bd56

https://deploy-preview-27683--kubernetes-io-master-staging.netlify.app

@kbhawkey
Copy link
Contributor

Hi @ravisantoshgudimetla .
Is this change for the 1.22 release? Docs for v1.22 features should use the dev-1.22 branch.
/cc @PI-Victor

@ravisantoshgudimetla ravisantoshgudimetla changed the base branch from master to dev-1.22 May 23, 2021 21:43
@ravisantoshgudimetla
Copy link
Contributor Author

Hi @ravisantoshgudimetla .
Is this change for the 1.22 release? Docs for v1.22 features should use the dev-1.22 branch.
/cc @PI-Victor

Yes @PI-Victor, updated the branch. Thank you.

@PI-Victor
Copy link
Member

/assign @chrisnegus
/sig apps

@k8s-ci-robot k8s-ci-robot added the sig/apps Categorizes an issue or PR as relevant to SIG Apps. label May 26, 2021
Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Jun 15, 2021

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

🔨 Explore the source changes: 2dff666

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/60f9757d7dcd870007d59f9c

@ravisantoshgudimetla ravisantoshgudimetla changed the title [wip] Add docs for minReadySeconds in StatefulSet Add docs for minReadySeconds in StatefulSet Jun 15, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 15, 2021
@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 Jun 15, 2021
Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

/lgtm

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

LGTM label has been added.

Git tree hash: 4e07138c98b4e1a2cdd45e6c645bd90f01a8d91a

@@ -228,6 +228,13 @@ and Ready or completely terminated prior to launching or terminating another
Pod. This option only affects the behavior for scaling operations. Updates are not
affected.

#### Min Ready Seconds
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest we spell this as "Minimum ready seconds".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. PTAL

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 21, 2021
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 14, 2021
@ravisantoshgudimetla
Copy link
Contributor Author

I don't need to update the featuregates as it was already covered by @tengqm in 372d34d

Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

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

/lgtm

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

LGTM label has been added.

Git tree hash: 50e90d95813a363b9c3fae38e1df69889601c7a4

@sftim
Copy link
Contributor

sftim commented Jul 16, 2021

/milestone 1.22

@k8s-ci-robot k8s-ci-robot added this to the 1.22 milestone Jul 16, 2021
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.

Do we also need to update https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/ to mention StatefulSetMinReadySeconds?

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.

Is this behind the StatefulSetMinReadySeconds feature gate? If so, let's also mention that in the StatefulSet concept page, and update https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/

@chrisnegus
Copy link
Contributor

Is this behind the StatefulSetMinReadySeconds feature gate? If so, let's also mention that in the StatefulSet concept page, and update https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/

I'm 1.22 release docs shadow for this PR. It looks like the changes for this feature to the dev-1.22 feature-gates page have already been merged. This PR seems to cover the StatefulSet concept page you asked about. @sftim is there more that you think needs to be done or is this ready to be merged?

@PI-Victor
Copy link
Member

based on Chris' comment i'd like to merge this, anything to else needs to be added?

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.

I think this feedback is right - not sure. If I'm wrong please comment and then dismiss this review.

#### Minimum Ready Seconds

{{< feature-state for_k8s_version="v1.22" state="alpha" >}}

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's explain that this field only works if you enable the StatefulSetMinReadySeconds feature gate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure, I added it here. PTAL.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 21, 2021
This defaults to 0 (the Pod will be considered available as soon as it is ready). To learn more about when
a Pod is considered ready, see [Container Probes](/docs/concepts/workloads/pods/pod-lifecycle/#container-probes).

Please note that this field only works if you enable the `StatefulSetMinReadySeconds` featuregate
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
Please note that this field only works if you enable the `StatefulSetMinReadySeconds` featuregate
Please note that this field only works if you enable the `StatefulSetMinReadySeconds` feature gate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. PTAL

@tengqm
Copy link
Contributor

tengqm commented Jul 23, 2021

All feedbacks addressed. Good to go.
/lgtm
/approve

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

LGTM label has been added.

Git tree hash: e54afbee4344820f21013487217732c57aaf0bbe

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: soltysh, 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 Jul 23, 2021
@k8s-ci-robot k8s-ci-robot merged commit 794a8ff into kubernetes:dev-1.22 Jul 23, 2021
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/apps Categorizes an issue or PR as relevant to SIG Apps. sig/docs Categorizes an issue or PR as relevant to SIG Docs. 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.

9 participants