OpenAPI v3 for kubectl explain

[alexzielenski]

Enhancement Description

• One-line enhancement description (can be used as a release note): Changes kubectl explain to use OpenAPI v3 data instead of OpenAPI v2.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/3515-kubectl-explain-openapiv3
• Discussion Link: https://youtu.be/3Xnb0R_ios4?t=1512
• Primary contact (assignee): @alexzielenski
• Responsible SIGs: sig-cli
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): 1.26
  • Beta release target (x.y): 1.27
  • Stable release target (x.y):
• Alpha
  • KEP (k/enhancements) update PR(s): KEP-3515: add new kep kubectl explain openapi v3 upgrade #3516
  • Code (k/k) update PR(s):
    1. kubectl explain openapiv3 template foundations kubernetes#113024
    2. kubectl explain --output plaintext kubernetes#113146
  • Docs (k/website) update PR(s): document kubectl explain openapi v3 website#37788
• Beta
  • KEP (k/enhancements) update PR(s):
    • KEP-3515: kubectl explain openapiv3 - beta graduation criteria #3748
  • Code (k/k) update PR(s):
    • kubectl-explain: add --output plaintext-openapiv2 fallback kubernetes#115480
    • kubectl explain: use openapiv3 by default kubernetes#116390
  • Docs (k/website) update(s):
    • Update kubectl docs/Explain beta docs website#40068

[kikisdeliveryservice]

@alexzielenski please provide a Discussion Link. It is required that you "link to SIG mailing list thread, meeting, or recording where the Enhancement was discussed before KEP creation"

[rhockenbury]

/milestone v1.26
/label tracked/yes

[rhockenbury]

Hello @alexzielenski 👋, 1.26 Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00 PDT on Thursday 6th October 2022.

This enhancement is targeting for stage alpha for 1.26 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.26
• KEP readme has a updated detailed test plan section filled out
• KEP readme has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

For this KEP, we would just need to get #3516 merged up to meet the requirements.

The status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well. Thank you!

[alexzielenski]

@rhockenbury The PR has been merged with PRR and I think satisfies the checklist. Please let me know if there is anything left to do!

[rhockenbury]

Thanks. With #3516 merged, this enhancement is all set for enhancements freeze.

[cathchu]

Hello @alexzielenski 👋 1.26 Release Docs shadow here!

This enhancement is marked as ‘Needs Docs’ for 1.26 release. Please follow the steps detailed in the documentation to open a PR against dev-1.26 branch in the k/website repo. This PR can be just a placeholder at this time, and must be created by November 9. Also, take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thank you!

[ruheenaansari34]

Hi @alexzielenski 👋,

Checking in once more as we approach the 1.26 code freeze at 17:00 PDT on Tuesday 8th November 2022.

Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.

For this enhancement, it looks like the following PRs are open and need to be merged before code freeze:

• kubectl explain --output plaintext kubernetes#113146

As always, we are here to help should questions come up. Thanks!

[ruheenaansari34]

For this enhancement, it looks like the k/k PR kubernetes/kubernetes#113146 is closed.

• If you do have any other k/k PRs open, please link them to this issue.
• Please ensure that PRs are linked in the above issue description as well.

[marosset]

/remove-label lead-opted-in
/remove-label tracked/yes
/label tracked/no
/milestone clear

[alexzielenski]

/milestone v1.27
/label tracked/yes

[k8s-ci-robot]

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

In response to this:

/milestone v1.26
/label tracked/yes

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]

@alexzielenski: Can not set label tracked/yes: Must be member in one of these teams: [release-team-enhancements release-team-leads]

In response to this:

/milestone v1.26
/label tracked/yes

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.

[marosset]

/remove-label tracked/yes

[marosset]

Hello @alexzielenski 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on 18:00 PDT Thursday 9th February 2023.

This enhancement is targeting for stage beta for v1.27 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the latest template has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: v1.27
• KEP readme has a updated detailed test plan section filled out
• KEP readme has up to date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements.

For this enhancement, it looks like #3748 will address all of the above requirements

The status of this enhancement is marked as at risk. Please keep the issue description up-to-date with appropriate stages as well.
Thank you!

[marosset]

With #3748 merged this enhancement is ready to be tracked for v1.27.
Thanks!

[mickeyboxell]

Hi @alexzielenski 👋, I’m reaching out from the 1.27 Release Docs team. This enhancement is marked as ‘Needs Docs’ for the 1.27 release.

Please follow the steps detailed in the documentation to open a PR against dev-1.27 branch in the k/website repo. This PR can be just a placeholder at this time, and must be created by March 16. For more information, please take a look at Documenting for a release to familiarize yourself with the documentation requirements for the release.

Please feel free to reach out with any questions. Thanks!

[shatoboar]

Hi @alexzielenski 👋,
Checking in as we approach 1.27 code freeze at 17:00 PDT on Tuesday 14th March 2023.
Please ensure the following items are completed:

• All PRs to the Kubernetes repo that are related to your enhancement are linked in the above issue description (for tracking purposes).
• All PRs are fully merged by the code freeze deadline.
  • kubectl-explain: add --output plaintext-openapiv2 fallback kubernetes#115480

Please let me know what other PRs in k/k I should be tracking for this KEP.
As always, we are here to help should questions come up. Thanks!

[mickeyboxell]

Hi @alexzielenski, please follow the steps detailed in the documentation to open a PR against dev-1.27 branch in the k/website repo. This placeholder PR must be created by today, March 16, and should be ready for review on Tuesday, March 21.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle stale
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue as fresh with /remove-lifecycle rotten
• Close this issue with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

[k8s-ci-robot]

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Reopen this issue with /reopen
• Mark this issue as fresh with /remove-lifecycle rotten
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

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.