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.

Sign up for GitHub

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
wants to merge 2 commits into from
Closed

docs for field validation GA #39195

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ea9d24
docs for field validation GA
kevindelgado Jan 31, 2023
29e8e40
make more timeless
kevindelgado Feb 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions content/en/docs/reference/command-line-tools-reference/feature-gates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,6 @@ For a reference to old feature gates that are removed, please refer to
| `SELinuxMountReadWriteOncePod` | `false` | Alpha | 1.25 | |
| `SeccompDefault` | `false` | Alpha | 1.22 | 1.24 |
| `SeccompDefault` | `true` | Beta | 1.25 | |
| `ServerSideFieldValidation` | `false` | Alpha | 1.23 | 1.24 |
| `ServerSideFieldValidation` | `true` | Beta | 1.25 | |
| `SizeMemoryBackedVolumes` | `false` | Alpha | 1.20 | 1.21 |
| `SizeMemoryBackedVolumes` | `true` | Beta | 1.22 | |
| `StatefulSetAutoDeletePVC` | `false` | Alpha | 1.22 | |
Expand Down Expand Up @@ -322,6 +320,9 @@ For a reference to old feature gates that are removed, please refer to
| `ServerSideApply` | `false` | Alpha | 1.14 | 1.15 |
| `ServerSideApply` | `true` | Beta | 1.16 | 1.21 |
| `ServerSideApply` | `true` | GA | 1.22 | - |
| `ServerSideFieldValidation` | `false` | Alpha | 1.23 | 1.24 |
| `ServerSideFieldValidation` | `true` | Beta | 1.25 | 1.26 |
| `ServerSideFieldValidation` | `true` | GA | 1.27 | - |
| `ServiceInternalTrafficPolicy` | `false` | Alpha | 1.21 | 1.21 |
| `ServiceInternalTrafficPolicy` | `true` | Beta | 1.22 | 1.25 |
| `ServiceInternalTrafficPolicy` | `true` | GA | 1.26 | - |
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/reference/using-api/api-concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,7 +690,7 @@ These situations are:

### Setting the field validation level
kevindelgado marked this conversation as resolved.
Show resolved Hide resolved

{{< 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 •
edited
Loading

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.

by default in 1.23 and 1.24, enabled by default starting in 1.25), you can take
Expand Down