Server Side Unknown Field Validation

[kevindelgado]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add the ability to optionally trigger schema validation on the API server that errors when unknown fields are detected.

• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/2885-server-side-unknown-field-validation

• Discussion Link: sig-meeting, initial public doc

• Primary contact (assignee): @kevindelgado

• Responsible SIGs: api-machinery

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

  • Alpha release target (x.y): 1.23
  • Beta release target (x.y): 1.25
  • Stable release target (x.y): 1.27

• Alpha

  • KEP (k/enhancements) update PR(s): KEP-2885: Add Server-Side Unknown Field Validation KEP #2886
  • Code (k/k) update PR(s): Server Side Strict Field Validation kubernetes#105916
  • Docs (k/website) update PR(s): Document server side field validation website#30532 Relevant docs for new query parameter are autogenerated from source code in k/k. No additional docs needed for alpha.

• Beta

  • KEP (k/enhancements) update PR(s): KEP-2885: Beta Graduation Criteria for Field Validation #3081
  • Code (k/k) update PR(s):
    • Kubectl validation defaults to server-side: Server Side Field Validation Support For Kubectl kubernetes#108350
    • beta enablement: ServerSideFieldValidation Beta Graduation kubernetes#108889
    • Additional 1.24 follow ups from alpha
      • Look into strict handling of nested object decoding: PR
      • Customresource_handler unit tests of field validation: PR
      • Endpoints handler unit testing of field validation: PR
      • Integration tests should check for exact match of strict errors PR
    • Add unknown metadata field validation tests kubernetes#109316
    • store err type and path separately in strict errors kubernetes-sigs/json#16
    • server-side metadata unknown field validation kubernetes#109494
    • Graduate server side validation to beta kubernetes#110178
  • Docs (k/website) update(s):
    • Field Validation API Concepts website#32357

• Stable

  • KEP (k/enhancements) update PR(s):KEP-2885 Field Validation 1.27 GA graduation #3725
  • Code (k/k) update PR(s):
    • Field validation e2e tests and GA graduation kubernetes#115271
  • Docs (k/website) update(s):
    • docs for field validation GA #39715 website#39716

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

[kevindelgado]

/sig api-machinery

[kevindelgado]

/milestone v1.23

[kevindelgado]

/stage alpha

[kevindelgado]

/tracked

[kevindelgado]

Hi @kevindelgado! This is @kevindelgado from the 1.23 Enhancements team here. Just checking in as we approach enhancements freeze on Thursday 09/09. Here's where this enhancement currently stands:

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

Looks like for this one we would just need the KEP & the PRR file to merge by enhancements freeze :)

All good now!

Thanks!

[kevindelgado]

Thanks for checking in @kevindelgado, I'll be sure to get the KEP and PRR merged in by enhancements freeze!

[kevindelgado]

Hi @kevindelgado

Ping! As a reminder your PR (#2886) needs to merge by EOD PST tomorrow September 9th to be included in the 1.23 Release. After that time you will need to request an exception.

Lmk if you need anything,
Kevin

[mehabhalodiya]

Hi @kevindelgado 👋 1.23 Docs shadow here.

This enhancement is marked as 'Needs Docs' for the 1.23 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.23 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu November 18, 11:59 PM PDT.

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

Thanks!

[kwiesmueller]

/wg api-expression

[kevindelgado]

Hi @kevindelgado 👋

Checking in once more as we approach 1.23 code freeze at 6:00 pm PST on Tuesday, November 16.

Please ensure the following items are completed:

• 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 fully merged by the code freeze deadline.
• Have a documentation placeholder PR open by Thursday, November 18.

As always, we are here to help should questions come up.

Thanks!!

[salaxander]

Hi, 1.23 Enhancements Lead here 👋. With code freeze now in effect, this enhancement has not met the criteria for the freeze and has been removed from the milestone.

As a reminder, the criteria for code freeze is:

• All PRs to the kubernetes/kubernetes repo have merged by the code freeze deadline

Feel free to file an exception to add this back to the release. If you plan to do so, please file this as early as possible.

Thanks!
/milestone clear

[sftim]

@kevindelgado I recommend changing the KEP link in this issue description to that it refers to https://github.com/kubernetes/enhancements/tree/master/keps/sig-api-machinery/2885-server-side-unknown-field-validation

[reylejano]

The Release Team approve an exception request for 3 additional days after the 1.23 Code Freeze. Please have kubernetes/kubernetes#105916 approved & merged by Friday (Nov 19). If updated or new documentation is required, please create a placeholder PR to the dev-1.23 branch in k/website by tomorrow (Nov 18).
/milestone v1.23

[marosset]

Hello @kevindelgado 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00 PDT Thursday 9th February 2023.

This enhancement is targeting for stage stable for v1.27 (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.27
• 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.

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!

/label tracked/yes
/remove-label tracked/no

[kevindelgado]

/assign @apelisse

I am leaving the kubernetes project and am handing this off to Antoine to shepard it through GA (should mostly be done except for documentation and graduating the e2e test to conformance

[apelisse]

I can't keep the issue updated because, I don't have permission.

[apelisse]

Only the docs PR is missing now

[LukeMwila]

Hi @apelisse, I’m reaching out from the 1.27 Release Docs team. This enhancement is marked as ‘Needs Docs’ for the 1.27 release.

Please follow the steps detailed in the documentation to open a PR against dev-1.27 branch in the k/website repo. This PR can be just a placeholder at this time, and must be created by March 16. For more information, please take a look at Documenting for a release to familiarize yourself with the documentation requirements for the release.

Please feel free to reach out with any questions. Thanks!

[shatoboar]

Hi @apelisse 👋,
Checking in as we approach 1.27 code freeze at 17:00 PDT on Tuesday 14th March 2023.
Please ensure the following items are completed:

• 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 fully merged by the code freeze deadline.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze:

• Field validation e2e to conformance kubernetes#115340

Please let me know what other PRs in k/k I should be tracking for this KEP.
As always, we are here to help should questions come up. Thanks!

[apelisse]

That should have been closed, everything is done here, thanks!

[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

[k8s-triage-robot]

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

This bot triages 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:

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

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

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

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

This bot triages 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:

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

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

/close not-planned

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.