Add Pod Index Label for StatefulSets and Indexed Jobs

[danielvegamyhre]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add Pod Index Label for StatefulSets and Indexed Jobs.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-apps/4017-pod-index-label
• Discussion Link: Publish the pod index as a label and annotation for Statefulset and indexed Job kubernetes#117986
• Primary contact (assignee): @danielvegamyhre
• Responsible SIGs: sig-apps
• Enhancement target (which target equals to which milestone):
  • Beta release target (x.y): 1.28
  • Stable release target (x.y): 1.32

Note: We will release the feature directly in Beta state since there is no benefit in having an alpha release, since we are simply adding a new label so there is very little risk (unlike removing an
existing label which other things may depend on, for example).

• Beta
  • KEP (k/enhancements) update PR(s): KEP-4017: Pod Index Label for StatefulSets and Indexed Jobs #4019
  • Code (k/k) update PR(s):
    • Add completion index as pod label for indexed jobs kubernetes#118883
    • Add StatefulSet pod index as pod label kubernetes#119232
  • Docs (k/website) update(s):
    • Add docs for KEP-4017 (pod index label) website#42139
• Stable
  • KEP (k/enhancements) update PR(s): KEP-4017: promote Pod Index Label for StatefulSets and Indexed Jobs to GA #4865
  • Code (k/k) update PR(s):
    [KEP-4017]: update e2e and integration test for PodIndexLabel kubernetes#128107
    Promote PodIndexLabel for Statefulset and IndexedJob stable kubernetes#128387
  • Docs (k/website) update(s): [KEP 4017]: add documentation for PodIndexLabel going GA website#48496

Please keep this description up to date. This will help the Enhancement Team to track the evolution of the enhancement efficiently.

[danielvegamyhre]

/sig apps
/assign

[soltysh]

/label beta
/milestone v1.28
/label lead-opted-in

[k8s-ci-robot]

@soltysh: The label(s) /label beta cannot be applied. These labels are supported: api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda, refactor, lead-opted-in, tracked/no, tracked/out-of-tree, tracked/yes. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label beta
/milestone v1.28
/label lead-opted-in

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.

[soltysh]

/stage beta

[npolshakova]

Hi @danielvegamyhre 👋, Enhancements team here!

Just checking in as we approach enhancements freeze on 01:00 UTC Friday, 16th June 2023.

This enhancement is targeting for stage beta for 1.28 (correct me, if otherwise.)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.28
• KEP readme has a updated detailed test plan section filled out
• KEP readme has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

It looks like #4019 will address some of these requirements.

For this KEP, we would just need to update the following:

• Mark the status as implementable for 1.28
• Address questions inside the Production Readiness Review Questionnaire

The status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[ahg-g]

@Atharva-Shinde this is only pending PRR review

[Atharva-Shinde]

@Atharva-Shinde this is only pending PRR review

Ack. We'll mark this as tracked after it is approved.

[npolshakova]

Looks like the PRR is approved and #4019 has gone in so this is now tracked for 1.28 🚀

[katcosgrove]

Hello @danielvegamyhre! 1.28 Docs Shadow here.

Does this enhancement work planned for 1.28 require any new docs or modification to existing docs?

If so, please follows the steps here to open a PR against dev-1.28 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 20th July 2023.

Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.

Thank you!

[npolshakova]

Hey again @danielvegamyhre 👋

Just checking in as we approach Code freeze at 01:00 UTC Friday, 19th July 2023 .

Here’s the enhancement’s state for the upcoming code freeze:

• All the PRs that are related to your enhancement are linked in the above issue description (for tracking purposes). This includes code, tests, and documentation related PR/s.
• All code related PR/s are merged or are in merge-ready state ( i.e they have approved and lgtm labels applied) by the code freeze deadline. This includes any tests related PR/s too.

For this enhancement, it looks like the following code related PR/s are open and they need to be merged or should be in merge-ready state before the code freeze commences :

• Add completion index as pod label for indexed jobs kubernetes#118883
• Add StatefulSet pod index as pod label kubernetes#119232

Also please let me know if there are other PRs in k/k we should be tracking for this KEP.

As always, we are here to help if any questions come up. Thanks!

[Rishit-dagli]

Hey @danielvegamyhre , could you please create a docs PR even if it is a draft PR with no content yet against dev-1.28 branch in the k/website repo. The deadline to create this draft PR is Thursday 20th July 2023.

[danielvegamyhre]

@Rishit-dagli Docs PR created here: kubernetes/website#42059

[Atharva-Shinde]

Hey @danielvegamyhre 👋 Enhancements Lead here

With all the implementation(code related) PRs merged as per the issue description:
kubernetes/kubernetes#118883
kubernetes/kubernetes#119232

This enhancement is now marked as tracked for the v1.28 Code Freeze!

[danielvegamyhre]

All items for beta in 1.28 release have been completed.

[npolshakova]

Hello 👋, 1.29 Enhancements Lead here.

If you wish to progress this enhancement in v1.29, please have the SIG lead opt-in your enhancement by adding the lead-opt-in and milestone v1.29 labels before the Production Readiness Review Freeze.

/remove-label lead-opted-in

[kannon92]

@soltysh It looks like @alaypatel07 is eager to work on this for 1.32. Can we get a lead-opt-in for this feature? I think we can promote this to stable in this release.

[soltysh]

/label lead-opted-in
/milestone v1.32
/stage stable

[shecodesmagic]

Hello @alaypatel07 👋, v1.32 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 11th October 2024 / 19:00 PDT Thursday 10th October 2024.

This enhancement is targeting for stage stable for v1.32 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP readme has up-to-date graduation criteria
• KEP has submitted a production readiness review request for approval and has a reviewer assigned.
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday 3rd October 2024 so that the PRR team has enough time to review your KEP.

For this KEP, we would need to update the following:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.32.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here). If your production readiness review is not completed yet, please make sure to fill the production readiness questionnaire in your KEP by the PRR Freeze deadline on Thursday 3rd October 2024 so that the PRR team has enough time to review your KEP.

Also, in the KEP readme, please make sure you update Release Signoff Checklist where applicable. Second If there are any questions in the KEP readme file that doesn’t apply to your KEP, please reply to them with NA if haven’t already and dont leave them blank.

The status of this enhancement is marked as at risk for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

If you anticipate missing enhancements freeze, you can file an exception request in advance. Thank you!

[shecodesmagic]

With all the requirements fulfilled this enhancement is now marked as tracked for the upcoming enhancements freeze 🚀

[michellengnx]

Hello @alaypatel07 and @danielvegamyhre 👋, 1.32 Docs Shadow here.
Does this enhancement work planned for 1.32 require any new docs or modification to existing docs?
If so, please follows the steps here to open a PR against dev-1.32 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday October 24th 2024 18:00 PDT.
Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release.
Thank you!

[rashansmith]

Hello @alaypatel07 @danielvegamyhre 👋 from the v1.32 Communications Team!
We'd love for you to consider writing a feature blog about your enhancement! Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog see the blog contribution guidelines.

[michellengnx]

Hello @alaypatel07 and @danielvegamyhre 👋, 1.32 Docs Shadow here. Does this enhancement work planned for 1.32 require any new docs or modification to existing docs? If so, please follows the steps here to open a PR against dev-1.32 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday October 24th 2024 18:00 PDT. Also, take a look at Documenting for a release to get yourself familiarize with the docs requirement for the release. Thank you!

Hello @alaypatel07 and @danielvegamyhre 👋,

Just a reminder to open a placeholder PR against dev-1.32 branch in the k/website repo for this (steps available here). The deadline for this is 4 days away at Thursday October 24, 2024 18:00 PDT.

Thanks,
Michelle

[rashansmith]

Hello @alaypatel07 @danielvegamyhre 👋 from the v1.32 Communications Team! We'd love for you to consider writing a feature blog about your enhancement! Some reasons why you might want to write a blog for this feature include (but are not limited to) if this introduces breaking changes, is important to our users, or has been in progress for a long time and is graduating.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog see the blog contribution guidelines.

Hello @alaypatel07, this is a reminder for the feature blog post for v1.32.

To opt-in, let us know and open a Feature Blog placeholder PR against the website repository by 30th Oct 2024. For more information about writing a blog see the blog contribution guidelines.

Please reach out if you have any questions!

[alaypatel07]

@rashansmith @michellengnx apologies for delayed response, but I dont think a blog post is needed for this feature.

[shecodesmagic]

Hello @danielvegamyhre @alaypatel07 👋, Enhancements team here (again 😁 )

Just checking in as we approach code freeze at 02:00 UTC Friday 8th November 2024 / 19:00 PDT Thursday 7th November 2024.

Here’s where this enhancement currently stands:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PR/s are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

For this enhancement, it looks like the following PRs need to be merged before code freeze (and we need to update the Issue description to include all the related PRs of this KEP if missing):

• Promote PodIndexLabel for Statefulset and IndexedJob stable kubernetes#128387

If you anticipate missing code freeze, you can file an exception request in advance.

Also, please let me know if there are other PRs in k/k we should be tracking for this KEP.
As always, we are here to help if any questions come up. Thanks!

[tjons]

Hello @danielvegamyhre @alaypatel07 👋, Enhancements team here.

With all the implementation(code related) PRs merged as per the issue description:

• [KEP-4017]: update e2e and integration test for PodIndexLabel kubernetes#128107
• Promote PodIndexLabel for Statefulset and IndexedJob stable kubernetes#128387

This enhancement is now marked as tracked for code freeze for the 1.32 Code Freeze!

Please note that KEPs targeting stable need to have the status field marked as implemented in the kep.yaml file after code PRs are merged and the feature gates are removed.

[soltysh]

@alaypatel07 can you make sure the docs PR gets merged kubernetes/website#48496

[kannon92]

/wg batch

[dipesh-rawat]

Hi @danielvegamyhre @alaypatel07 👋 , 1.33 Enhancements lead here,

Now that this KEP has graduated to stable, could we update the KEP status in kep.yaml (here) from implementable to implemented? If yes, once the PR for the status change is merged, we could also close this issue.

[dipesh-rawat]

/remove-label lead-opted-in

[atiratree]

Now that this KEP has graduated to stable, could we update the KEP status in kep.yaml (here) from implementable to implemented? If yes, once the PR for the status change is merged, we could also close this issue.

opened a PR for that: #5086