enhancements icon indicating copy to clipboard operation
enhancements copied to clipboard

Published 20 hours ago • verified publisher icon kubernetes

Retry Generate Name

Open jpbetz opened this issue 1 year ago • 22 comments
trafficstars

Enhancement Description

  • One-line enhancement description (can be used as a release note): Create requests using generateName are retried automatically by the apiserver when the generated name conflicts with an existing resource name, up to a max limit of 7 retries.
  • Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/4420-retry-generate-name/README.md
  • Discussion Link:
  • Primary contact (assignee):
  • Responsible SIGs:
  • Enhancement target (which target equals to which milestone):
    • Alpha release target (x.y): 1.30
    • Beta release target (x.y): 1.31
    • Stable release target (x.y):
  • [x] Alpha
    • [x] KEP (k/enhancements) update PR(s): https://github.com/kubernetes/enhancements/pull/4421
    • [x] Code (k/k) update PR(s): https://github.com/kubernetes/kubernetes/pull/122887
    • [x] Docs (k/website) update PR(s): https://github.com/kubernetes/website/pull/45154
  • [x] Beta
    • [x] KEP (k/enhancements) update PR(s): https://github.com/kubernetes/enhancements/pull/4592
    • [x] Code (k/k) update PR(s): https://github.com/kubernetes/kubernetes/pull/124673
    • [ ] Docs (k/website) update(s): https://github.com/kubernetes/website/pull/46983

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

jpbetz avatar Jan 20 '24 00:01 jpbetz

/sig api-machinery

jpbetz avatar Jan 20 '24 01:01 jpbetz

/label lead-opted-in /milestone v1.30

jpbetz avatar Feb 02 '24 21:02 jpbetz

Hello @jpbetz 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on Friday, February 9th, 2024 at 02:00 UTC.

This enhancement is targeting for stage alpha for 1.30 (correct me, if otherwise)

Here’s where this enhancement currently stands:

  • [X] KEP readme using the latest template has been merged into the k/enhancements repo.
  • [X] KEP status is marked as implementable for latest-milestone: { CURRENT_RELEASE }. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
  • [X] KEP readme has up-to-date graduation criteria.
  • [X] KEP has submitted a production readiness review request for approval and has a reviewer assigned.
  • [X] KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

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 for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

tjons avatar Feb 06 '24 20:02 tjons

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

tjons avatar Feb 09 '24 02:02 tjons

Hi @jpbetz,

👋 from the v1.30 Communications Team! We'd love for you to opt in to write a feature blog about your enhancement!

We encourage blogs for features including, but not limited to: breaking changes, features and changes important to our users, and features that have been in progress for a long time and are graduating.

To opt in, you need to open a Feature Blog placeholder PR against the website repository. The placeholder PR deadline is 27th February, 2024. Here's the 1.30 Release Calendar

kcmartin avatar Feb 14 '24 21:02 kcmartin

Hello @jpbetz 👋, v1.30 Docs Shadow here.

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

If so, please follows the steps here to open a PR against dev-1.30 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday, February 22nd, 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!

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

I see the new NameGenerationRetries feature gate, so we'll need docs for that. Marking this as Need Docs. Thanks!

Vyom-Yadav avatar Feb 15 '24 17:02 Vyom-Yadav

Draft Documentation PR: https://github.com/kubernetes/website/pull/45154

jpbetz avatar Feb 15 '24 17:02 jpbetz

Hey again @jpbetz 👋 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 6th March 2024 .

Here's where this enhancement currently stands:

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

Everything looks good. Please let me know if there are any other PRs in k/k we should be tracking for this issue, other than https://github.com/kubernetes/kubernetes/pull/122887.

tjons avatar Feb 25 '24 18:02 tjons

/milestone v1.31

jpbetz avatar May 02 '24 14:05 jpbetz

With https://github.com/kubernetes/enhancements/pull/4592 merged, we should update the issue description.

sftim avatar May 07 '24 16:05 sftim

@jpbetz Could I please get clarification on something. I see that in the upstream code for Alpha (PR https://github.com/kubernetes/kubernetes/pull/122887/files), the feature gate that was added was named as RetryGenerateName but in our documentation (here) and in the kep (here), we mentioned the feature gate name as NameGenerationRetries. What is the expected feature gate name, and should we make changes accordingly? Apologies for any confusion on my part.

dipesh-rawat avatar Jun 03 '24 23:06 dipesh-rawat

the feature gate that was added was named as RetryGenerateName but in our documentation (here) and in the kep (here), we mentioned the feature gate name as NameGenerationRetries. What is the expected feature gate name, and should we make changes accordingly? Apologies for any confusion on my part.

This was an oversight. Since RetryGenerateName is used in releases already, we have to stick with that name. The documentation should be corrected. I've opened a PR: https://github.com/kubernetes/website/pull/46666

jpbetz avatar Jun 04 '24 16:06 jpbetz

Thanks. We do sometimes change the name of feature gates, but I wouldn't do that here.

@thockin had an idea a while ago for machine readable things like feature gates so we could spot mismatches like this before they make it into a release.

Should we update the KEP text as well?

sftim avatar Jun 04 '24 16:06 sftim

I was aiming to add structure to the API docs (e.g. +featureGate=... tag on fields). I don't think that would have caught this.

thockin avatar Jun 04 '24 16:06 thockin

Hello @jpbetz 👋, 1.31 Enhancements team here.

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

This enhancement is targeting for stage beta for 1.31 (correct me, if otherwise) /stage beta

Here's where this enhancement currently stands:

  • [x] KEP readme using the latest template has been merged into the k/enhancements repo.
  • [x] KEP status is marked as implementable for latest-milestone: v1.31. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
  • [x] KEP readme has up-to-date graduation criteria
  • [x] 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 so that the PRR team has enough time to review your KEP.

Before the enhancement freeze, it would be appreciated if following nits could be addressed:

  • Update issue description to highlight Beta release target (x.y): 1.31
  • Ensure that this issue has an assignee.
  • Update the KEP to accurately reflect the feature gate name RetryGenerateName (kep.yaml, README.md).
  • Update the Implementation History section in the KEP README.md.

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 for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

dipesh-rawat avatar Jun 05 '24 00:06 dipesh-rawat

@dipesh-rawat Feedback addressed.

Opened https://github.com/kubernetes/enhancements/pull/4697 to make requested KEP updates.

/assign

jpbetz avatar Jun 05 '24 19:06 jpbetz

Hi @jpbetz 👋, 1.31 Docs Shadow here.

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

If so, please follows the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 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!

Daniel

chanieljdan avatar Jun 11 '24 12:06 chanieljdan

Hi @jpbetz

:wave: from the v1.31 Communications Team! We'd love for you to opt in to write 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 3rd July, 2024. For more information about writing a blog see the blog contribution guidelines.

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.

hailkomputer avatar Jun 19 '24 11:06 hailkomputer

Hi @jpbetz 👋, 1.31 Docs Shadow here.

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

If so, please follows the steps here to open a PR against dev-1.31 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thursday June 27, 2024 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!

Daniel

Hi @jpbetz 👋,

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

Thanks,

Daniel

chanieljdan avatar Jun 20 '24 19:06 chanieljdan

@jpbetz , friendly reminder about the upcoming blog opt-in and placeholder deadline on July 3rd. Please open a blog placeholder PR if you are interested in contributing a blog.

hailkomputer avatar Jun 28 '24 09:06 hailkomputer

friendly reminder about the upcoming blog opt-in and placeholder deadline on July 3rd. Please open a blog placeholder PR if you are interested in contributing a blog.

Thanks, @hailkomputer I've created https://github.com/kubernetes/website/pull/47022

jpbetz avatar Jun 28 '24 13:06 jpbetz

Hey again @jpbetz 👋, 1.31 Enhancements team here,

Just checking in as we approach code freeze at 02:00 UTC Wednesday 24th July 2024 / 19:00 PDT Tuesday 23rd July 2024.

Here's where this enhancement currently stands:

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

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

  • https://github.com/kubernetes/kubernetes/pull/124673

Additionally, please let me know if there are any other PRs in k/k not listed in the description 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 1.31 Code Freeze!

dipesh-rawat avatar Jul 01 '24 18:07 dipesh-rawat

/milestone v1.32

jpbetz avatar Sep 03 '24 19:09 jpbetz

/label lead-opted-in

jpbetz avatar Sep 03 '24 19:09 jpbetz

Hello @jpbetz 👋, 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 v.132 (correct me, if otherwise)

Here’s where this enhancement currently stands:

  • [X] KEP readme using the latest template has been merged into the k/enhancements repo.
  • [X] KEP status is marked as implementable for latest-milestone: 1.32. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
  • [X] KEP readme has up-to-date graduation criteria.
  • [X] KEP has submitted a production readiness review request for approval and has a reviewer assigned.
  • [X] KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check here).

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 for enhancement freeze. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

shecodesmagic avatar Sep 28 '24 18:09 shecodesmagic