Publish CRD OpenAPI Schema
roycaihw opened this issue · 35 comments
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:
- Approver (likely from SIG/area to which enhancement belongs):
- 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: kubernetes/website#12910
Implementation: kubernetes/kubernetes#71192
Testing-related: kubernetes/test-infra#11618, kubernetes/kubernetes#74832
1.15
Promotion to beta: kubernetes/kubernetes#77825
Documentation: kubernetes/website#14583
1.16
Promotion to GA: kubernetes/kubernetes#81965
Documentation: kubernetes/website#15982
Bug fixes:
Metrics: kubernetes/kubernetes#81786
/milestone clear
If this is proven to have a merged KEP prior to Feb 4 we can add this back
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?
I need enough to understand what the implications are from a testing and upgrade/downgrade perspective
My desire is not to expect copy-pasta from that doc into a KEP, I am OK with linking out where it makes sense.
@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
KEP is now implementable, exception requested at https://groups.google.com/forum/#!msg/kubernetes-milestone-burndown/QKSQVXBPeAQ/dv9Y3qsyAQAJ and acked by sig lead
exception request was approved adding back to 1.14 milestone
@lledru we aim to merge kubernetes/kubernetes#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
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.
/milestone v1.15
/stage beta
/assign @roycaihw
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! 😄
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! 😄
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?
kubernetes/kubernetes#71192
kubernetes/kubernetes#77825
If you know this will slip, please reply back and let us know. Thanks!
@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
Docs PR kubernetes/website#14583
@roycaihw can you update the issue description?
PRs being tracked for this feature:
kubernetes/kubernetes#78521
kubernetes/kubernetes#78453
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 The plan is to go stable in 1.16. I will keep the issue updated when the coding begins
/stage stable
/milestone v1.16
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!
/sub
kubernetes/kubernetes#81965 is the only outstanding PR
docs ready for review in kubernetes/website#15982
Released as stable in v1.16.0
Post-GA work tracked in https://github.com/orgs/kubernetes/projects/28
/close
@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.