Add subresource support to kubectl

[nikhita]

Enhancement Description

• One-line enhancement description (can be used as a release note): Add a new flag --subresource to kubectl commands like get, patch, edit and replace commands to allow fetching and updating subresources like status, scale, etc.
• Kubernetes Enhancement Proposal: https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/2590-kubectl-subresource
• Discussion Link:
  • Discussion in the POC PR - kubectl: support --subresource flag kubernetes#99556
  • mailing list/meeting link: https://youtu.be/zUa7dudYCQM?t=299
• Primary contact (assignee): @nikhita @MadhavJivrajani
• Responsible SIGs: SIG CLI
• Enhancement target (which target equals to which milestone):
  • Alpha release target (x.y): v1.24
  • Beta release target (x.y): v1.27
  • Stable release target (x.y): v1.31
• Alpha
  • KEP (k/enhancements) update PR(s):
    • kubectl subresource KEP #2600
  • Code (k/k) update PR(s):
    • apiserver changes - kubectl: apiserver changes to add --subresource support kubernetes#103516
    • kubectl changes - kubectl: support --subresource flag kubernetes#99556
  • Docs (k/website) update PR(s):
    • Document kubectl subresource support website#32604
• Beta
  • KEP (k/enhancements) update PR(s):
    • KEP-2590: graduate kubectl subresource support to beta #3729
  • Code (k/k) update PR(s):
    • kubectl: Change subresource flag to beta kubernetes#116595
    • test/e2e: Add e2e tests for kubectl --subresource kubernetes#116590
    • test/e2e: Fix flaking subresource test kubernetes#116619
  • Docs (k/website) update(s):
    • reference/kubectl: Update docs for moving kubectl subresource to beta website#39828
• Stable
  • KEP (k/enhancements) update PR(s):
    • KEP-2590: graduate kubectl subresource support to stable #4468
  • Code (k/k) update PR(s):
    • TODO
  • Docs (k/website) update(s):
    • TODO

/sig cli
/assign @nikhita @ykakarap
cc @eddiezane @soltysh @seans3 @pwittrock

[JamesLaverack]

/stage alpha
/milestone v1.22

[salaxander]

Hi @nikhita , 1.22 enhancements team here!

For the enhancement to be included in the milestone, it must meet the following criteria:

• The KEP must be merged in an implementable state
• [DONE] The KEP must have test plans
• [DONE] The KEP must have graduation criteria
• The KEP must have a production readiness review

In order to move forward in 1.22 we'd need to get the KEP merged as well as a production readiness review before enhancements freeze on 5/13. Let us know if there's anything we can do to help before then.

Thanks!!

[ykakarap]

Hi @salaxander, @nikhita and I are working in this together.
Thanks for the heads-up on the pending items for the KEP :).

Regarding the production readiness review, the KEP doc has a section by the same name. Does this section satisfy the required criteria? If not, can you let us know what is missing from it.
Thanks!

[salaxander]

Hi @ykakarap! - Here's the full documentation on the production readiness review process -> https://github.com/kubernetes/community/blob/master/sig-architecture/production-readiness.md

[soltysh]

#2600 merged so we should be all good now.

[chrisnegus]

Hi @nikhita 👋 1.22 Docs Shadow here.
This enhancement is marked as Needs Docs for the 1.22 release.

Please follow the steps detailed in the documentation to open a PR against dev-1.22 in the kubernetes/website repo. This PR can be just a placeholder at this time and must be created before Fri July 9, 11:59 PM PDT.

Also, take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thank you!

[ykakarap]

@chrisnegus Thanks for the heads-up! :)

Will follow the steps to do it.

[salaxander]

Hi @nikhita and @ykakarap - Just checking in as we're about 2 weeks away from 1.22 code freeze. Are there any open or merged k/k PRs we should be tracking for this? Thanks!!

[ykakarap]

Hey @salaxander the final PR will be read in a day or 2.

[ykakarap]

Hey @salaxander, this is the corresponding PR: kubernetes/kubernetes#99556.

[salaxander]

Hi @ykakarap - One more check-in as we're a week away from code freeze. Any updates on if you expect kubernetes/kubernetes#99556 to merge before the deadline?

Thanks!

[ykakarap]

Hi @salaxander, I expect the PR to be merged before the deadline. SIG CLI has already reviewed the code.

cc @nikhita

[salaxander]

Hey @ykakarap - I see the PR is approved, but there are merge conflicts at the moment. It'll need to merge before code freeze tomorrow evening to be included in 1.22. Let us know if there's anything we can do to help :)

[ykakarap]

@salaxander thanks for offering to help :)

There is still some work that needs to be done before the PR can be merged.
I will drop a message here tomorrow to update the status of the PR.

[ritpanjw]

Hi @nikhita 👋 1.22 Docs Shadow here.
This enhancement is marked as Needs Docs for the 1.22 release.

Please follow the steps detailed in the documentation to open a PR against dev-1.22 in the kubernetes/website repo. This PR can be just a placeholder at this time and must be created before Fri July 9, 11:59 PM PDT.

Also, take a look at Documenting for a release to familiarize yourself with the docs requirement for the release.

Thank you!

@nikhita @salaxander Friendly reminder about the upcoming docs placeholder PR deadline tomorrow
on Fri July 9, 11:59 PM PDT.

[ykakarap]

@salaxander @ritpanjw We are planning to move this enhancement to the next release. Please let me know if there is anything I need to do to note that.

[salaxander]

Hi @ykakarap - I'll update it in our tracking, thanks for letting me know!

[soltysh]

/milestone v1.23

[soltysh]

/label lead-opted-in
/stage stable
/milestone v1.30

[mickeyboxell]

Hello @nikhita 👋, Enhancements team here.

Just checking in as we approach enhancements freeze on [02:00 UTC Friday 9th February 2024 / 18:00 PDT Thursday 8th February 2024](https://everytimezone.com/s/1ade3dca):.

This enhancement is targeting for stage stable for v1.30 (correct me, if otherwise)

Here's where this enhancement currently stands:

• KEP readme using the [latest template](https://github.com/kubernetes/enhancements/tree/master/keps/NNNN-kep-template) has been merged into the k/enhancements repo.
• KEP status is marked as implementable for latest-milestone: 1.30. KEPs targeting stable will need to be marked as implemented after code PRs are merged and the feature gates are removed.
• KEP readme has up-to-date graduation criteria
• KEP has a production readiness review that has been completed and merged into k/enhancements. (For more information on the PRR process, check [here](https://github.com/kubernetes/community/blob/master/sig-architecture/production-readiness.md#submitting-a-kep-for-production-readiness-approval)).

The only thing left to do is to merge: #4468. Please let me know when you've done so.

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

[soltysh]

@mickeyboxell based on slack discussion with @MadhavJivrajani we'll taking this out from 1.30 cycle, we'll push this over to 1.31

/remove-label lead-opted-in
/milestone clear

[salehsedghpour]

/milestone clear

[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 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

[thockin]

I saw today that edit --subresource scale still is notr implemented. Do we know if it is on purpose or just an accident of impl?

[thockin]

Maybe we should close this KEP out and open a bug against k/k ?

[soltysh]

I saw today that edit --subresource scale still is notr implemented. Do we know if it is on purpose or just an accident of impl?

Tim this enhancement is still in beta, I haven't heard from the original authors, so very likely the sig-cli will have to find new folks to push this through, but I doubt this is something we can pick up in 1.32.

[thockin]

Thanks, Maciej. Totally understand.

[nikhita]

I don't have bandwidth to push this through. Removing myself as an assignee. @MadhavJivrajani PTAL if you can contribute here.