Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs for field validation GA #39195

Closed

Conversation

kevindelgado
Copy link
Contributor

@kevindelgado kevindelgado commented Jan 31, 2023

Update docs for Server Side Field Validation graduation to GA
KEP: kubernetes/enhancements#2885

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language labels Jan 31, 2023
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jan 31, 2023
@kevindelgado
Copy link
Contributor Author

I don't think there's anything new to add for GA graduation so I just updated the meta stuff.

PTAL @sftim @liggitt

@kevindelgado
Copy link
Contributor Author

/assign @sftim

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

I think this is a bigger update than the version bump.

@@ -690,7 +690,7 @@ These situations are:

### Setting the field validation level

{{< feature-state for_k8s_version="v1.25" state="beta" >}}
{{< feature-state for_k8s_version="v1.27" state="stable" >}}

Provided that the `ServerSideFieldValidation` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/) is enabled (disabled
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to revise this section, and review the whole document, to frame things differently: validation is server-side, and client-side validation is now deprecated (right?).

Optionally, a client can request either strict validation, or no validation.

Elsewhere in the docs, we should document the warnings that you get from kubectl when the input manifest (or partial configuration) either duplicates a field, or refers to a field that the API server doesn't recognise. The key point to bear in mind when revising is the new origin of the warnings. However, the final docs should be timeless and describe the current approach, rather than the change to the new thing.

Aside: we ought to have done that wider review when this moved to beta; for graduation to GA, it's essential - there's no later point in the KEP lifecycle to pick up those changes.

If there are big changes needed to docs that another SIG would lead on maintaining, it's OK to instead file and freeze an issue that tracks the changes we need.

Finally, please fix the typo in

server-side field validation when sending requests to a serer with this feature

Copy link
Contributor Author

@kevindelgado kevindelgado Feb 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reworded the introduction and removed references to the "enableability" of the feature-gate throughout (given that server-side validation is now locked to enabled in GA).

Hopefully this reads more timeless, let me know if anything is off.

I've also opened and froze an issue to track the need to update the docs once client side validation is fully removed from kubectl.

content/en/docs/reference/using-api/api-concepts.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 1, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim by writing /assign @sftim in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kevindelgado kevindelgado requested review from sftim and removed request for lavalamp and shannonxtreme February 1, 2023 17:42
@kevindelgado
Copy link
Contributor Author

Thanks. Feedback addressed. PTAL @sftim

@sftim
Copy link
Contributor

sftim commented Feb 1, 2023

I've also opened and froze an issue to track the need to update the docs once client side validation is fully removed from kubectl.

That's useful. We also need to document that validation is server-side by default if that's the case (which I think it will be in v1.27). For example, https://kubernetes.io/docs/reference/kubectl/ doesn't mention validation at all yet - but it should, so we can document the behavior and tell folks where to learn more about customising the outcome.

https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/ should also briefly outline unknown field handling and link to the API concepts page for further reading.

I know this feels late, but graduation to GA is the last gateway we have before the need to document gets forgotten. That's why I'm calling out where we need to add these details.

I recommend filing an issue to track those gaps. Please Cc: me so I can let the release docs people know it needs manual tracking.

@kevindelgado
Copy link
Contributor Author

Created issues for both the tasks you've mentioned and cc'd you on them:

#39211
#39212

@kevindelgado
Copy link
Contributor Author

/assign @apelisse

I am handing this off to Antoine, as I am leaving the kubernetes project.

@kbhawkey
Copy link
Contributor

/milestone 1.27

@k8s-ci-robot
Copy link
Contributor

@kbhawkey: You must be a member of the kubernetes/website-milestone-maintainers GitHub team to set the milestone. If you believe you should be able to issue the /milestone command, please contact your Website milestone maintainers and have them propose you as an additional delegate for this responsibility.

In response to this:

/milestone 1.27

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.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 25, 2023
@k8s-ci-robot
Copy link
Contributor

PR needs rebase.

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.

@liggitt
Copy link
Member

liggitt commented Mar 16, 2023

/close
in favor of #39716

@k8s-ci-robot
Copy link
Contributor

@liggitt: Closed this PR.

In response to this:

/close
in favor of #39716

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants