Enhancements: Publish CRD OpenAPI Schema

Created on 16 Jan 2019 · 35Comments · Source: kubernetes/enhancements

Enhancement Description

One-line enhancement description (can be used as a release note): Serve validation schema for Custom Resources from kube-apiserver
Primary contact (assignee): @roycaihw
Responsible SIGs: SIG API Machinery
Design proposal link (community repo):
Link to e2e and/or unit tests:
Reviewer(s) - (for LGTM) recommend having 2+ reviewers (at least one from code-area OWNERS file) agreed to review. Reviewers from multiple companies preferred:
- @liggitt
- @mbohlool
- @sttts
Approver (likely from SIG/area to which enhancement belongs):
- @smarterclayton
Enhancement target (which target equals to which milestone):
- Alpha release target (1.14)
- Beta release target (1.15)
- Stable release target (1.16)

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

/sig api-machinery

1.14
KEP: https://github.com/kubernetes/enhancements/blob/master/keps/sig-api-machinery/00xx-publish-crd-openapi.md
Documentation: https://github.com/kubernetes/website/pull/12910
Implementation: https://github.com/kubernetes/kubernetes/pull/71192
Testing-related: https://github.com/kubernetes/test-infra/pull/11618, https://github.com/kubernetes/kubernetes/pull/74832

1.15
Promotion to beta: kubernetes/kubernetes#77825
Documentation: kubernetes/website#14583

1.16
Promotion to GA: https://github.com/kubernetes/kubernetes/pull/81965
Documentation: kubernetes/website#15982
Bug fixes:

Metrics: https://github.com/kubernetes/kubernetes/pull/81786

kinapi-change siapi-machinery stagstable

Source

roycaihw

All 35 comments

@liggitt @roycaihw - I see y'all are hoping to target 1.14 for this milestone - I don't see a KEP associated with this issue - was one merged already?

claurence on 7 Feb 2019

/milestone clear
If this is proven to have a merged KEP prior to Feb 4 we can add this back

spiffxp on 7 Feb 2019

this is ongoing work described in https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/customresources-validation.md#client-side-validation

what is the desired granularity for copying that document into a KEP to unblock work on one aspect of it in this release?

liggitt on 7 Feb 2019

I need enough to understand what the implications are from a testing and upgrade/downgrade perspective

spiffxp on 7 Feb 2019

My desire is not to expect copy-pasta from that doc into a KEP, I am OK with linking out where it makes sense.

spiffxp on 7 Feb 2019

👍1

KEP sent out at https://github.com/kubernetes/enhancements/pull/821. It's still a draft but comments are welcome

roycaihw on 8 Feb 2019

@roycaihw @liggitt thanks - since we have passed enhancement freeze and want all issues targeting 1.14 to have a KEP merged by enhancements freeze this issue will require an exception for the 1.14 milestone - please submit one https://github.com/kubernetes/sig-release/blob/master/releases/EXCEPTIONS.md

claurence on 8 Feb 2019

KEP is now implementable, exception requested at https://groups.google.com/forum/#!msg/kubernetes-milestone-burndown/QKSQVXBPeAQ/dv9Y3qsyAQAJ and acked by sig lead

liggitt on 15 Feb 2019

exception request was approved adding back to 1.14 milestone

claurence on 28 Feb 2019

@roycaihw @liggitt, 1.14 enhancement shadow here.
What should be merged before code freeze? is #71192 the only k/k PR you need to merge ?
Moreover i think you dont have test plan inside the KEP, could you add it quickly please? Thanks a lot

lledru on 5 Mar 2019

@lledru we aim to merge https://github.com/kubernetes/kubernetes/pull/71192 (the feature) and kubernetes/kubernetes#74832 (kubectl regression test, doesn't depend on the new feature) before code freeze

the two PRs cover the test plan that we put in the KEP graduation criteria

roycaihw on 6 Mar 2019

👍1

/stage alpha
ref: https://github.com/kubernetes/kubernetes/pull/71192/files#diff-84e72664a7cc9add01954d3a7b8cbb45R500

spiffxp on 19 Mar 2019

Hello @roycaihw , I'm the Enhancement Lead for 1.15. Is this feature going to be graduating alpha/beta/stable stages in 1.15? Please let me know so it can be tracked properly and added to the spreadsheet.

Once coding begins, please list all relevant k/k PRs in this issue so they can be tracked properly.

kacole2 on 12 Apr 2019

@kacole2 yes, this is still planned to get promoted to beta in 1.15.

sttts on 12 Apr 2019

@roycaihw can you prepare a PR to switch it over?

sttts on 12 Apr 2019

👍1

/milestone v1.15
/stage beta

kacole2 on 12 Apr 2019

/assign @roycaihw

justaugustus on 28 Apr 2019

Hey, @roycaihw I'm the v1.15 docs release shadow.

I see that you are targeting the beta version of this enhancement for the 1.15 release. Does this require any new docs (or modifications)?

Just a friendly reminder we're looking for a PR against k/website (branch dev-1.15) due by Thursday, May 30th. It would be great if it's the start of the full documentation, but even a placeholder PR is acceptable. Let me know if you have any questions! 😄

daminisatya on 18 May 2019

@roycaihw

daminisatya on 27 May 2019

Hi @roycaihw . Code Freeze is Thursday, May 30th 2019 @ EOD PST. All enhancements going into the release must be code-complete, including tests, and have docs PRs open.

Please list all current k/k PRs so they can be tracked going into freeze. If the PRs aren't merged by freeze, this feature will slip for the 1.15 release cycle. Only release-blocking issues and PRs will be allowed in the milestone.

I'm seeing these PRs merged. Is there anything else we should be tracking?
https://github.com/kubernetes/kubernetes/pull/71192
https://github.com/kubernetes/kubernetes/pull/77825

If you know this will slip, please reply back and let us know. Thanks!

kacole2 on 28 May 2019

@daminisatya @kacole2 Thanks for the reminder. The PR tracking looks good. In 1.15 we did kubernetes/kubernetes#77825 and it's merged. I will open a documentation placeholder and link it here

roycaihw on 28 May 2019

Docs PR https://github.com/kubernetes/website/pull/14583

@roycaihw can you update the issue description?

sttts on 28 May 2019

@sttts done. Thanks

roycaihw on 29 May 2019

Thank you @sttts @roycaihw ✨

daminisatya on 29 May 2019

PRs being tracked for this feature:
https://github.com/kubernetes/kubernetes/pull/78521
https://github.com/kubernetes/kubernetes/pull/78453

liggitt on 30 May 2019

👍1

Hi @roycaihw , I'm the 1.16 Enhancement Lead. Is this feature going to be graduating alpha/beta/stable stages in 1.16? Please let me know so it can be added to the 1.6 Tracking Spreadsheet. If not's graduating, I will remove it from the milestone and change the tracked label.

Once coding begins or if it already has, please list all relevant k/k PRs in this issue so they can be tracked properly.

Milestone dates are Enhancement Freeze 7/30 and Code Freeze 8/29.

Thank you.

kacole2 on 8 Jul 2019

@kacole2 The plan is to go stable in 1.16. I will keep the issue updated when the coding begins

roycaihw on 9 Jul 2019

/stage stable
/milestone v1.16

kacole2 on 9 Jul 2019

Hi @roycaihw, I'm the v1.16 docs release shadow.

Does this enhancement require any new docs (or modifications)?

Just a friendly reminder we're looking for a PR against k/website (branch dev-1.16) due by Friday,August 23rd. It would be great if it's the start of the full documentation, but even a placeholder PR is acceptable. Let me know if you have any questions!

Thanks!

VineethReddy02 on 1 Aug 2019

/sub

yue9944882 on 2 Aug 2019

@liggitt @roycaihw code freeze for 1.16 is on Thursday 8/29. Are there any outstanding k/k PRs that still need to be merged for this to go Stable?

kacole2 on 26 Aug 2019

https://github.com/kubernetes/kubernetes/pull/81965 is the only outstanding PR

liggitt on 27 Aug 2019

docs ready for review in https://github.com/kubernetes/website/pull/15982

liggitt on 3 Sep 2019

Released as stable in v1.16.0

Post-GA work tracked in https://github.com/orgs/kubernetes/projects/28

/close

liggitt on 19 Sep 2019

@liggitt: Closing this issue.

In response to this:

Released as stable in v1.16.0

Post-GA work tracked in https://github.com/orgs/kubernetes/projects/28

/close

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.