Backoff Limit Per Index For Indexed Jobs

[jensentanlo]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add New Indexed Job backoff limit mode that is counted per index rather than per job

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-apps/3850-backoff-limits-per-index-for-indexed-jobs

• Discussion Link: An Indexed Job mode that allows every index to execute kubernetes#109712

• Primary contact (assignee): mimowo

• Responsible SIGs: apps

• Enhancement target (which target equals to which milestone):

  • Alpha release target (x.y): 1.28
  • Beta release target (x.y): 1.29
  • Stable release target (x.y): 1.33

• Alpha

  • KEP (k/enhancements) update PR(s): Backoff limit per Job Index #3967
  • Code (k/k) update PR(s):
    • Support BackoffLimitPerIndex in Jobs kubernetes#118009
    • Extend the Job API for BackoffLimitPerIndex kubernetes#119294
  • Docs (k/website) update PR(s): Docs update for Job's backoff limit per index (alpha in 1.28) website#41921

• Beta

  • KEP (k/enhancements) update PR(s):
    • Update KEP-3850 "Backoff Limit Per Index" for Beta #4228
    • Update KEP3850 "BackoffLimitPerIndex for Indexed Jobs" #4321
  • Code (k/k) update PR(s):
    • Graduate BackoffLimitPerIndex to Beta kubernetes#121356
    • Introduce the job_finished_indexes_total metric kubernetes#121292
    • Indicate Job Backoff Limit Per Index reason consts are beta kubernetes#121471
    • Backoff limit per index e2e test kubernetes#121368
    • Add remaining e2e tests for Job BackoffLimitPerIndex based on KEP kubernetes#121633
    • Benchmark job with backoff limit per index kubernetes#121393
  • Docs (k/website) update(s): Docs update for Job Backoff Limit Per Index in Beta website#43388

• Stable

  • KEP (k/enhancements) update PR(s): KEP3850: graduate Backoff Limit Per Index for Job to stable #5154
  • Code (k/k) update PR(s):
    • Graduate Backoff Limit Per Index as stable kubernetes#130061
    • Add Job e2e for tracking failure count per index kubernetes#130390
  • Docs (k/website) update(s): Docs update as we promote JobBackoffLimitPerIndex to stable website#49811

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

[jensentanlo]

/sig apps
/wg batch

[alculquicondor]

/assign @mimowo

[alculquicondor]

In addition to configuring the backoff per index, we should probably have FailIndex as one of the actions for pod failure policies.

[soltysh]

/milestone v1.28
/stage alpha
/label lead-opted-in

[aramase]

Hello @mimowo 👋, 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 alpha 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.

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!

[mimowo]

@aramase I think the first point is addressed as the KEP has been merged: #3967.

[mimowo]

@aramase is there anything missing to make it tracked?

[Atharva-Shinde]

Hey @mimowo
With all the KEP requirements in place and merged into k/enhancements, this enhancement is all good for the upcoming enhancements freeze. 🚀

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

[Rishit-dagli]

Hello @mimowo 👋, 1.28 Docs Lead 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!

[aramase]

Hey again @mimowo 👋

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.

I see kubernetes/kubernetes#118009 PR in the issue description. If there are any other k/k related PR(s) that we should be tracking for this KEP please link them in the issue description above.

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

[Atharva-Shinde]

Hey @mimowo 👋 Enhancements Lead here,
With kubernetes/kubernetes#118009 and
kubernetes/kubernetes#119294 merged as per the issue description, this enhancement is now tracked for v1.28 Code Freeze!

[jenshu]

Hello @mimowo @soltysh 👋, v1.33 Enhancements team here.

Just checking in as we approach enhancements freeze on 02:00 UTC Friday 14th February 2025 / 19:00 PDT Thursday 13th February 2025.

This enhancement is targeting stage stable for v1.33 (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.33.
• 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 6th February 2025 so that the PRR team has enough time to review your KEP.

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

• in the kep.yaml, the latest-milestone should be set to v1.33
• in the PRR file there should be an approver listed for stable

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

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

[mimowo]

I will not have the capacity to work on this in the release cycle. I'm happy to help with reviews if there are other contributors. Otherwise I will try to book time for it in the next cycle.

[jenshu]

@kannon92 @mimowo thanks, I've moved this to Deferred but let me know if someone else will end up picking it up in this cycle

[mimowo]

Actually, let me give it a shot in this iteration. I think it should be relatively little work to do: #5154

[mimowo]

cc @jenshu
cc @wojtek-t @soltysh @kannon92 could you PTAL at #5154

[mimowo]

@jenshu with the #5154 merged I think we can mark the enhancement status as "Tracked for enhancement freeze".

[jenshu]

@mimowo thank you - it's now tracked!

[ArvindParekh]

Hello, @mimowo @soltysh 👋, v1.33 Docs Shadow here.

Does this enhancement work planned for v1.33 require any new docs or modifications to existing docs?

If so, please follow the steps here to open a PR against the dev-1.33 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday 27th February 2025 18:00 PDT.

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

Thank you!

[mimowo]

I have opened the website PR: kubernetes/website#49811

[ArvindParekh]

Great! Please also update the issue description with the PR link :) Thank you, @mimowo!

[mimowo]

Great! Please also update the issue description with the PR link :) Thank you, @mimowo!

cc @jensentanlo please update the Issue description with the code and docs PRs

[rytswd]

Hi @mimowo 👋 -- this is Ryota (@rytswd) from the 1.33 Communications Team!

For the 1.33 release, we are currently in the process of collecting and curating a list of potential feature blogs, and we'd love for you to consider writing one for your enhancement!

As you may be aware, feature blogs are a great way to communicate to users about features which fall into (but not limited to) the following categories:

• This introduces some breaking change(s)
• This has significant impacts and/or implications to users
• ...Or this is a long-awaited feature, which would go a long way to cover the journey more in detail 🎉

To opt in to write a feature blog, could you please let us know and open a "Feature Blog placeholder PR" (which can be only a skeleton at first) against the website repository by Wednesday, 5th March, 2025? For more information about writing a blog, please find the blog contribution guidelines 📚

Tip

Some timeline to keep in mind:

• 02:00 UTC Wednesday, 5th March, 2025: Feature blog PR freeze
• Monday, 7th April, 2025: Feature blogs ready for review
• You can find more in the release document

Note

In your placeholder PR, use XX characters for the blog date in the front matter and file name. We will work with you on updating the PR with the publication date once we have a final number of feature blogs for this release.

[mimowo]

Hi @rytswd, yes, I would like to opt-in, opened the placeholder PR: kubernetes/website#49982

[jenshu]

Hey again @mimowo @soltysh 👋, v1.33 Enhancements team here.

Just checking in as we approach code freeze at 02:00 UTC Friday 21st March 2025 / 19:00 PDT Thursday 20th March 2025.

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 PRs are ready to be merged (they have approved and lgtm labels applied) by the code freeze deadline. This includes tests.

Per the issue description, these are all of the implementation (code-related) PRs for 1.33:

• Graduate Backoff Limit Per Index as stable kubernetes#130061
• Add Job e2e for tracking failure count per index kubernetes#130390

Please let me know (and keep the issue description updated) if there are any other PRs in k/k that we should track for this KEP, so that we can maintain accurate status.

This enhancement is now marked as Tracked for code freeze for the v1.33 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.

[mimowo]

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.

Sure, I opened a PR to update it: #5186.