CRD Validation Ratcheting

[alexzielenski]

Enhancement Description

• One-line enhancement description (can be used as a release note): Allows CRs to with failing validations to pass if the a patch did not alter any of the invalid fields.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/4008-crd-ratcheting/
• Discussion Link: SIG-API Machinery 05/18/23
• Primary contact (assignee): @alexzielenski
• Responsible SIGs: api-machinery
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.28
  • Beta release target (x.y):
  • Stable release target (x.y):
• Alpha
  • KEP (k/enhancements) update PR(s): KEP-4008: CRD Validation Ratcheting #4013
  • Code (k/k) update PR(s): KEP-4008: CRD Validation Ratcheting alpha implementation kubernetes#118990
  • Docs (k/website) update PR(s): Add Documentation for CRD Validation Ratcheting website#41737
• Alpha 2
  • KEP (k/enhancements) update PR(s): KEP-4008: CRD Ratcheting target beta to 1.29 #4246
  • Code (k/k) update PR(s):
    • add rest of accessors to common.Schema kubernetes#121096
    • CRDValidationRatcheting: Factor object correlation and comparison into reusable component kubernetes#121118
    • KEP-4008: CRDValidationRatcheting: Ratchet errors from CEL expressions if old DeepEqual new kubernetes#121016
    • KEP-4008: CRDValidationRatcheting: Add support for optional oldSelf kubernetes#121034
    • KEP-4008: CRDValidationRatcheting Metrics kubernetes#121462
    • KEP-4008: CRDValidationRatcheting: Add Benchmarks kubernetes#121405
  • Docs (k/website) update(s):
    • KEP-4008: CRD Validation Ratcheting - Alpha 2 Docs website#43560
• Beta
  • KEP (k/enhancements) update PR(s): KEP-4008: CRD Ratcheting target beta to 1.29 #4246
  • Code (k/k) update PR(s): KEP-4008: CRDValidationRatcheting Bump Feature Gate To Beta kubernetes#121461
  • Docs (k/website) update(s):

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

[alexzielenski]

/sig api-machinery

[deads2k]

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

[Atharva-Shinde]

/stage alpha

[Kasambx]

Hello @alexzielenski 👋, 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 v1.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: v1.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.

For this KEP, we would just need to update the following:
-Fill out questions on e2e test,Rollout, Upgrade and Rollback Planning, monitoring requirements.
-Ensure the Pr is merged

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!

[Atharva-Shinde]

Thanks @alexzielenski :)
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.

[katcosgrove]

Hello @alexzielenski! 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!

[alexzielenski]

Thanks @katcosgrove I've created the placeholder PR and edited the description.

This PR can be just a placeholder at this time and must be created before Thursday 20th July 2023.

Hopefully I am in time. I'm assuming that since you posted on Wed Jul 21, you meant Thu Jul 22, instead of 20.

[Atharva-Shinde]

Hey @alexzielenski Enhancements team here 👋

Just checking in as we approach Code freeze at 01:00 UTC Wednesday, 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 don't see any code (k/k) update PR(s) in the issue description so if there are any 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!

[jpbetz]

Just confirming that code for this feature has merged: kubernetes/kubernetes#118990 (and it included in the description for tracking purposes)

[Atharva-Shinde]

Hey @alexzielenski 👋 Enhancements Lead here,
With kubernetes/kubernetes#118990 merged as per the issue description, this enhancement is now tracked for v1.28 Code Freeze! Thanks :)

[Rishit-dagli]

Hello @alexzielenski wave: please take a look at Documenting for a release - PR Ready for Review to get your docs PR ready for review before Tuesday 25th July 2023. Thank you!

Ref: kubernetes/website#41737

[npolshakova]

/remove-label lead-opted-in

[npolshakova]

Hi @alexzielenski, is this KEP targeting 1.29? If it is, can you make sure the lead-opted-in label is set on the issue so it is correctly tracked by the enhancements project board? Thanks!

[sftim]

BTW, the issue description (still) reads: “Draft KEP for upcoming SIG API Machinery proposal”

[jpbetz]

/label lead-opted-in

[kcmartin]

Hi @alexzielenski,

👋 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

[Vyom-Yadav]

Hello @alexzielenski 👋, 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?

At a minimum, we'll need a docs PR upgrading the stability version of CRDValidationRatcheting feature gate. Marking as Need Docs. Thanks!

[alexzielenski]

Opened placeholder PR here: kubernetes/website#45264

[alexzielenski]

Also opened placeholder for feature blog post: kubernetes/website#45265

[kcmartin]

Also opened placeholder for feature blog post: kubernetes/website#45265

@alexzielenski I may be missing something, but the placeholder should only be one file (the actual blog post template), whereas I am seeing 11 changed files in your PR. Let me know if there's anything we can assist with.

[meganwolf0]

Hello @alexzielenski 👋, Enhancements team here.

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

• KEP-4008: CRDValidationRatcheting Bump Feature Gate To Beta kubernetes#121461

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

[sreeram-venkitesh]

Hi @alexzielenski 👋, 1.31 Enhancements Lead here.

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

/remove-label lead-opted-in

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[liangyuanpeng]

/remove-lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten