Declarative Validation Of Kubernetes Native Types With validation-gen

[aaron-prindle]

Enhancement Description

• One-line enhancement description (can be used as a release note): Implement declarative validation of Kubernetes native types using validation-gen to generate validation code.
• Kubernetes Enhancement Proposal: KEP 5073
• Discussion Link: KEP-5073: Declarative Validation of Kubernetes Native Types With validation-gen #5074
• Primary contact (assignee): @aprindle
• Responsible SIGs: sig-api-machinery
• Enhancement target (which target equals to which milestone):
  • Beta release target (x.y): 1.33
  • Stable release target (x.y):

Beta

• KEP ( k/enhancements ) update PR(s):
  • KEP-5073: Declarative Validation of Kubernetes Native Types With validation-gen #5074
• Code ( k/k ) update PR(s):
  • add feature gates: feat: add DeclarativeValidation and DeclarativeValidationMismatchMetric feature gates kubernetes#130478
  • add validation-gen framework: KEP-5073: Declarative Validation: Add validation generator kubernetes#130349
• Docs ( k/website ) update PR(s):
  • Declarative Validation Docs website: TODO

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

[aaron-prindle]

/sig api-machinery
/wg api-machinery

[k8s-ci-robot]

@aaron-prindle: The label(s) wg/api-machinery cannot be applied, because the repository doesn't have them.

In response to this:

/sig api-machinery
/wg api-machinery

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-sigs/prow repository.

[jpbetz]

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

[lzung]

Hello @aaron-prindle 👋, 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 beta for v1.33 (correct me, if otherwise)
/stage beta

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:

• Create the KEP readme using the latest template and merge it in the k/enhancements repo.
• Ensure that the KEP has undergone a production readiness review and has been merged into k/enhancements.

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!

[dipesh-rawat]

Hi @aaron-prindle 👋, 1.33 Enhancements team here,

Just a quick friendly reminder as we approach the enhancements freeze later this week, at 02:00 UTC Friday 14th February 2025 / 19:00 PDT Thursday 13th February 2025.

The current status of this enhancement is marked as At risk for enhancement freeze. There are a few requirements mentioned in the comment #5073 (comment) that still need to be completed.

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

[aaron-prindle]

Thanks @lzung and @dipesh-rawat. The goal for the KEP currently is to get it merged before the enhancements freeze for 1.33. From the comments above I believe for this KEP, we would just need to update/complete the following:

• [WIP - not merged] Create the KEP readme using the latest template and merge it in the k/enhancements repo.
  • KEP is submitted (not merged yet), see PR under review here - KEP-5073: Declarative Validation of Kubernetes Native Types With validation-gen #5074
• [WIP - not merged] Ensure that the KEP has undergone a production readiness review and has been merged into k/enhancements.
  • We have a lead opted in and PRR review approval on the KEP but it isn't currently merged (see comment here - KEP-5073: Declarative Validation of Kubernetes Native Types With validation-gen #5074 (comment))

We are currently in the process (see KEP PR here - #5074) and are working with the necessary reviewers to get this in before the enhancements freeze (assuming no major blockers from reviewers). Currently I believe we will be able to get the KEP merged prior the enhancements freeze date.

[hacktivist123]

Hello @aaron-prindle 👋, v1.33 Docs Shadow here.

Does this enhancement work planned for v1.33 require any new docs or modification to existing docs?
If so, please follow the steps here to open a PR against 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 familiarize with the docs requirement for the release.
Thank you!

[aaron-prindle]

@hacktivist123 thanks for the information here! The KEP adds 2 feature gates which should be documented in the k/website repo. I have followed the steps posted (link) and submitted a draft PR to k/website, PR here:
kubernetes/website#49732

[dipesh-rawat]

Hello @aaron-prindle 👋, v1.33 Enhancements team here.

Unfortunately, this enhancement did not meet requirements for enhancements freeze.

If you still wish to progress this enhancement in v1.33, please file an exception request as soon as possible, within three days. If you have any questions, you can reach out in the #release-enhancements channel on Slack and we'll be happy to help. Thanks!

Looks like PR #5074 to update the KEP files misses to add the Release Signoff Checklist in the README file from the latest template (here).

/milestone clear

[aaron-prindle]

@dipesh-rawat - thanks for the information here. I have submitted a PR to fix the issue with the Release Signoff Checklist:
#5171

The KEP itself was reviewed and approved by a Sig Lead - @deads2k
and had PRR review and approval from - @jpbetz

I have submitted an exception request following the guide here to:
[email protected],
[email protected],
[email protected]
If possible, can you confirm that with that PR the KEP would be compliant and be allowed into 1.33? I am not sure how that section was missed (sorry!) so just want to maybe get some confirmation that we would meet the necessary criteria if that PR is merged. Thanks

[dipesh-rawat]

@aaron-prindle Since the release team has APPROVED the exception request here. This will be considered to be added to the milestone for v1.33 release.

[dipesh-rawat]

@aaron-prindle Now that PRs #5074 #5171 has been merged, all the KEP requirements are 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!
(cc: @lzung)

/milestone v1.33
/label tracked/yes

[aakankshabhende]

Hi @aprindle @aaron-prindle 👋 -- this is Aakanksha (@aakankshabhende ) 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.

[lzung]

Hey again @aaron-prindle 👋, 1.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.

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

• validation: Add Origin field to field.Error for more precise error tracking kubernetes#130355
• feat: add DeclarativeValidation and DeclarativeValidationMismatchMetric feature gates kubernetes#130478

Additionally, please let me know if there are any other PRs in k/k not listed above that we should track for this KEP, so that we can maintain accurate status.

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

The status of this enhancement is marked as at risk for code freeze.

[aakankshabhende]

Hi @aaron-prindle 👋 -- this is Aakanksha (@aakankshabhende ) from 1.33 Communications Team here again!

This is a gentle reminder for the feature blog deadline mentioned above, which is 02:00 UTC Wednesday, 5th March, 2025. To opt in, please let us know and open a Feature Blog placeholder PR against k/website by the deadline. If you have any questions, please feel free to reach out to us!

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.

[lzung]

Hey again @aaron-prindle 👋 I see that kubernetes/kubernetes#130355 and kubernetes/kubernetes#130478 were recently approved and merged. I'm updating this KEP to Tracked for code freeze 🎉