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

Jump to bottom

Blog post for KEP-2896 and KEP-2885 #39844

Merged
merged 2 commits into from
Apr 24, 2023
Merged

Blog post for KEP-2896 and KEP-2885 #39844

merged 2 commits into from
Apr 24, 2023

Conversation

Jefftree
Copy link
Member

@Jefftree Jefftree commented Mar 7, 2023 •
edited
Loading

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. 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. labels Mar 7, 2023
@Jefftree Jefftree changed the title [WIP] Blog post for OpenAPI V3 and ServerSideValidation [WIP] Blog post for KEP-2896 and KEP-2885 Mar 7, 2023
@netlify
Copy link

netlify bot commented Mar 7, 2023 •
edited
Loading

✅ Pull request preview available for checking

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6445e763bf985c53862abeda
😎 Deploy Preview https://deploy-preview-39844--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@Jefftree Jefftree mentioned this pull request Mar 15, 2023
Closed
13 tasks
@harshitasao
Copy link
Contributor

harshitasao commented Mar 24, 2023 •
edited
Loading

Hello, Comms Lead for the 1.27 release here. This feature blog is tracked for release, the deadline for submitting the draft is on 4th of April- the sooner the better since there's still editing to be done afterwards. Any doubt, the Comms team is here to help.
Thank you!

@harshitasao
Copy link
Contributor

Hello @Jefftree, we're doing a global reminder about submitting a draft for review for all opted-in feature blogs. If it's at all possible, it is very helpful for the release team to have drafts submitted for review before the hard deadline date, to better plan the release dates and avoid missing out. Thank you!

@harshitasao
Copy link
Contributor

@Jefftree
Reminder: The feature blog ready to review deadline is tomorrow (April 4th)

@k8s-ci-robot k8s-ci-robot added area/blog Issues or PRs related to the Kubernetes Blog subproject language/en Issues or PRs related to English language 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. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 4, 2023
@Jefftree Jefftree changed the title [WIP] Blog post for KEP-2896 and KEP-2885 Blog post for KEP-2896 and KEP-2885 Apr 7, 2023
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 7, 2023
@Jefftree
Copy link
Member Author

Jefftree commented Apr 7, 2023

@harshitasao Is there a guideline on how to set the date for the blog publishing date?

@Jefftree
Copy link
Member Author

Jefftree commented Apr 7, 2023

/assign @apelisse

@harshitasao
Copy link
Contributor

Hello, Comms Lead for v1.27 here. The publication order and date for the Feature Blog series has been finalized and the tracking board is updated.

The publication date for this article is 24-04-2023 (April 24).

Thank you!

tengqm
tengqm reviewed Apr 8, 2023
View reviewed changes
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated

kubectl will skip client side validation and will automatically use server side field validation in strict mode. Controllers by default use server side field validation in warn mode.

With client side validation, we had to be extra lenient because some fields were missing from OpenAPI V2 and we didn’t want to reject possibly valid objects. This is all fixed in server side validation. Additional documentation may be found [here](https://kubernetes.io/docs/reference/using-api/api-concepts/#field-validation)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
With client side validation, we had to be extra lenient because some fields were missing from OpenAPI V2 and we didn’t want to reject possibly valid objects. This is all fixed in server side validation. Additional documentation may be found [here](https://kubernetes.io/docs/reference/using-api/api-concepts/#field-validation)
With client side validation, we had to be extra lenient because some fields were missing
from OpenAPI V2 and we didn’t want to reject possibly valid objects.
This is all fixed in server side validation. Additional documentation may be found
[here](/reference/using-api/api-concepts/#field-validation)

Copy link
Member Author

Choose a reason for hiding this comment

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

Just want to confirm, this URL should be /docs/reference/using-api/api-concepts/#field-validation instead of /reference/using-api/api-concepts/#field-validation?

content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2023-xx-xx-openapi-v3-field-validation-ga.md Outdated Show resolved Hide resolved
@lavalamp
Copy link
Member

LGTM (after fixing comments), thanks for writing this!

@apelisse
Copy link
Member

Thanks, @Jefftree is out right now but will be back in a few days and will make the updates. Thanks.

@harshitasao
Copy link
Contributor

/lgtm
Comms View

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 21, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 7058d43f0ea13ae3715023536b76cf53f07ab4bc

@Jefftree
Copy link
Member Author

/retest

sftim
sftim reviewed Apr 24, 2023
View reviewed changes
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.

/lgtm

Some nits

content/en/blog/_posts/2023-04-24-openapi-v3-field-validation-ga.md

#### Custom Resource Definitions

In Kubernetes, Custom Resource Definitions use a structural OpenAPI V3
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit)

Suggested change
In Kubernetes, Custom Resource Definitions use a structural OpenAPI V3
In Kubernetes, CustomResourceDefinitions use a structural OpenAPI V3

content/en/blog/_posts/2023-04-24-openapi-v3-field-validation-ga.md
Comment on lines +95 to +96
Additional documentation may be found
[here](/docs/reference/using-api/api-concepts/#field-validation)
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit)

Suggested change
Additional documentation may be found
[here](/docs/reference/using-api/api-concepts/#field-validation)
You can find [additional details](/docs/reference/using-api/api-concepts/#field-validation)
in the API Concepts reference page.

Actually the final . is the more important thing to add here, as missing it out cuts gravitas from the article.

content/en/blog/_posts/2023-04-24-openapi-v3-field-validation-ga.md

## What's next?

With Server Side Field Validation and OpenAPI V3 released as GA, we
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit) Clarify who “we” are in this paragraph.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 24, 2023
sftim
sftim reviewed Apr 24, 2023
View reviewed changes
content/en/blog/_posts/2023-04-24-openapi-v3-field-validation-ga.md

## OpenAPI V3

### What does OpenAPI V3 offer over V2
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit)

Suggested change
### What does OpenAPI V3 offer over V2
### What does OpenAPI v3 offer over v2?

sftim
sftim reviewed Apr 24, 2023
View reviewed changes
content/en/blog/_posts/2023-04-24-openapi-v3-field-validation-ga.md
OpenAPI V3 Golang client is available in
[client-go](https://github.com/kubernetes/client-go/blob/release-1.27/openapi3/root.go).

## Server Side Field Validation
Copy link
Contributor

Choose a reason for hiding this comment

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

(nit)

Suggested change
## Server Side Field Validation
## Server side field validation

sftim
sftim reviewed Apr 24, 2023
View reviewed changes
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

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 24, 2023
@sftim
Copy link
Contributor

sftim commented Apr 24, 2023

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 24, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: e1511a1ddff0a887a96c95828d67a44372102219

@k8s-ci-robot k8s-ci-robot merged commit 579c5cf into kubernetes:main Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tengqm tengqm tengqm left review comments

@sftim sftim sftim left review comments

@apelisse apelisse Awaiting requested review from apelisse

@harshitasao harshitasao Awaiting requested review from harshitasao

Assignees

@apelisse apelisse

@sftim sftim

@harshitasao harshitasao

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Jefftree @harshitasao @lavalamp @apelisse @k8s-ci-robot @sftim @tengqm