Add initial documentation for StatefulSetSlice feature #37224

pwschuurman · 2022-10-08T21:21:00Z

Add documentation for StatefulSetSlice feature targeting Kubernetes alpha in 1.26

KEP-3335 Enhancement: KEP-3335: StatefulSet Start Ordinal enhancements#3336
KEP-3335 Implementation: Add implementation of KEP-3335, StatefulSetSlice kubernetes#112744

netlify · 2022-10-08T21:21:06Z

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

Name	Link
🔨 Latest commit	`6474d77`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/6384a29235494100099bb35e

k8s-ci-robot · 2022-10-08T21:21:08Z

Welcome @pwschuurman!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

sftim · 2022-10-08T23:19:34Z

/retitle Add initial documentation for StatefulSetSlice feature

soltysh

/lgtm
from tech pov

k8s-ci-robot · 2022-11-25T14:58:02Z

LGTM label has been added.

Git tree hash: 91dfb7bc888d93632cfa36c50e88eff615b5efaa

tengqm · 2022-11-26T01:26:24Z

content/en/docs/reference/command-line-tools-reference/feature-gates.md

 - `StatefulSetMinReadySeconds`: Allows `minReadySeconds` to be respected by
  the StatefulSet controller.
+- `StatefulSetStartOrdinal`: Allow StatefulSet to control start replica ordinal
+   numbering.


Suggested change

numbering.

numbering. Check [StatefulSet ordinals](/[docs/concepts/workloads/controllers/statefulset/#ordinals) for details.

Added suggestion to link to #ordinal-index

tengqm · 2022-11-26T01:29:10Z

content/en/docs/tutorials/stateful-application/basic-stateful-set.md

+#### Custom replica numbering
+
+Note: To customize the replica numbering of pods in a StatefulSet, see
+[Ordinals](docs/tutorials/stateful-application/basic-stateful-set/#ordinals).


We usually avoid H4 in the document. Maybe render this as a note shortcode would be better?

Suggested change

#### Custom replica numbering

Note: To customize the replica numbering of pods in a StatefulSet, see

[Ordinals](docs/tutorials/stateful-application/basic-stateful-set/#ordinals).

{{< note >}}

To customize the replica numbering of pods in a StatefulSet, see

[Ordinals](/docs/concepts/workloads/controllers/statefulset/#ordinals).

{{< /note >}}

Thanks, updated to render as a note.

krol3 · 2022-11-28T01:09:51Z

Hi @pwschuurman! This PR needs a doc review by Mon Nov 28th to get this into the release. Please reach out to required SIGs to get their review. Thank you!

pwschuurman · 2022-11-28T02:12:55Z

@soltysh @sftim @tengqm Thanks for the reviews so far. Can you take another quick look before the docs freeze? Thanks!

sftim

/lgtm

but I'd rather see Markdown and a hyperlink for the new heading, rather than HTML with no fragment identifier.

sftim · 2022-11-28T11:07:46Z

content/en/docs/concepts/workloads/controllers/statefulset.md

+will be assigned an integer ordinal, that is unique over the Set. By default,
+pods will be assigned ordinals from 0 up through N-1.
+
+<b>Start Ordinal</b>


Suggested change

<b>Start Ordinal</b>

### Start ordinal

Updated this to a h3 heading, and updated the other files to link to the new fragment.

k8s-ci-robot · 2022-11-28T11:08:51Z

LGTM label has been added.

Git tree hash: ff1e683551ee085d4c4f4df45a0b3fbb6828a883

pwschuurman · 2022-11-28T12:00:42Z

@sftim Thanks. Updated the formatting of the new section

pwschuurman · 2022-11-29T02:00:29Z

@sftim @soltysh Can you take another quick look before the docs freeze? Thanks!

soltysh

/lgtm
from tech pov

k8s-ci-robot · 2022-11-29T12:51:21Z

LGTM label has been added.

Git tree hash: f0530b84c66143b3232f485c34bfd47e513ab1ac

tengqm · 2022-11-29T14:08:06Z

/lgtm
/approve

k8s-ci-robot · 2022-11-29T14:08:15Z

[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:

~~content/en/OWNERS~~ [tengqm]

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 added this to the 1.26 milestone Oct 8, 2022

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 8, 2022

k8s-ci-robot requested review from ahg-g and ahmetb October 8, 2022 21:21

k8s-ci-robot added language/vi Issues or PRs related to Vietnamese language language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/release Categorizes an issue or PR as relevant to SIG Release. labels Oct 8, 2022

pwschuurman force-pushed the kep-3335-documentation branch from 9b5fd5a to 138007e Compare October 8, 2022 21:24

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 8, 2022

pwschuurman mentioned this pull request Oct 8, 2022

Allow StatefulSet to control start replica ordinal numbering kubernetes/enhancements#3335

Closed

18 tasks

k8s-ci-robot changed the title ~~KEP-3335 Documentation~~ Add initial documentation for StatefulSetSlice feature Oct 8, 2022

k8s-ci-robot requested review from enisoc and kow3ns November 9, 2022 18:19

soltysh approved these changes Nov 25, 2022

View reviewed changes

k8s-ci-robot assigned soltysh Nov 25, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 25, 2022

tengqm reviewed Nov 26, 2022

View reviewed changes

Update StatefulSet Ordinal Index documentation

23134e5

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2022

k8s-ci-robot requested a review from soltysh November 28, 2022 02:08

sftim reviewed Nov 28, 2022

View reviewed changes

k8s-ci-robot assigned sftim Nov 28, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2022

Rename docs section for StatefulSetStartOrdinal to 'Start ordinal'

6474d77

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 28, 2022

k8s-ci-robot requested a review from sftim November 28, 2022 11:59

soltysh approved these changes Nov 29, 2022

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2022

k8s-ci-robot assigned tengqm Nov 29, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 29, 2022

k8s-ci-robot merged commit 6143904 into kubernetes:dev-1.26 Nov 29, 2022

	numbering.
	numbering. Check [StatefulSet ordinals](/[docs/concepts/workloads/controllers/statefulset/#ordinals) for details.

Add initial documentation for StatefulSetSlice feature #37224

Add initial documentation for StatefulSetSlice feature #37224

Uh oh!

Conversation

pwschuurman commented Oct 8, 2022

Uh oh!

netlify bot commented Oct 8, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

k8s-ci-robot commented Oct 8, 2022

Uh oh!

sftim commented Oct 8, 2022

Uh oh!

soltysh left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 25, 2022

Uh oh!

tengqm Nov 26, 2022

Choose a reason for hiding this comment

Uh oh!

pwschuurman Nov 28, 2022

Choose a reason for hiding this comment

Uh oh!

tengqm Nov 26, 2022

Choose a reason for hiding this comment

Uh oh!

pwschuurman Nov 28, 2022

Choose a reason for hiding this comment

Uh oh!

krol3 commented Nov 28, 2022

Uh oh!

pwschuurman commented Nov 28, 2022

Uh oh!

sftim left a comment

Choose a reason for hiding this comment

Uh oh!

sftim Nov 28, 2022

Choose a reason for hiding this comment

Uh oh!

pwschuurman Nov 28, 2022

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 28, 2022

Uh oh!

pwschuurman commented Nov 28, 2022

Uh oh!

pwschuurman commented Nov 29, 2022

Uh oh!

soltysh left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Nov 29, 2022

Uh oh!

tengqm commented Nov 29, 2022

Uh oh!

k8s-ci-robot commented Nov 29, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

netlify bot commented Oct 8, 2022 •

edited

Loading