enhancements icon indicating copy to clipboard operation
enhancements copied to clipboard

Add subresource support to kubectl

Open nikhita opened this issue 4 years ago • 58 comments

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 - https://github.com/kubernetes/kubernetes/pull/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
  • [x] Alpha
    • [x] KEP (k/enhancements) update PR(s):
      • https://github.com/kubernetes/enhancements/pull/2600
    • [x] Code (k/k) update PR(s):
      • apiserver changes - https://github.com/kubernetes/kubernetes/pull/103516
      • kubectl changes - https://github.com/kubernetes/kubernetes/pull/99556
    • [x] Docs (k/website) update PR(s):
      • https://github.com/kubernetes/website/pull/32604
  • [x] Beta
    • [x] KEP (k/enhancements) update PR(s):
      • https://github.com/kubernetes/enhancements/pull/3729
    • [x] Code (k/k) update PR(s):
      • https://github.com/kubernetes/kubernetes/pull/116595
      • https://github.com/kubernetes/kubernetes/pull/116590
      • https://github.com/kubernetes/kubernetes/pull/116619
    • [x] Docs (k/website) update(s):
      • https://github.com/kubernetes/website/pull/39828
  • [ ] Stable
    • [x] KEP (k/enhancements) update PR(s):
      • https://github.com/kubernetes/enhancements/pull/4468
    • [ ] Code (k/k) update PR(s):
      • TODO
    • [ ] Docs (k/website) update(s):
      • TODO

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

nikhita avatar Mar 31 '21 09:03 nikhita

/stage alpha /milestone v1.22

JamesLaverack avatar May 11 '21 00:05 JamesLaverack

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

salaxander avatar May 11 '21 02:05 salaxander

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!

ykakarap avatar May 11 '21 02:05 ykakarap

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

salaxander avatar May 11 '21 03:05 salaxander

https://github.com/kubernetes/enhancements/pull/2600 merged so we should be all good now.

soltysh avatar May 13 '21 08:05 soltysh

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!

chrisnegus avatar May 19 '21 20:05 chrisnegus

@chrisnegus Thanks for the heads-up! :)

Will follow the steps to do it.

ykakarap avatar May 20 '21 01:05 ykakarap

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

salaxander avatar Jun 23 '21 02:06 salaxander

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

ykakarap avatar Jun 23 '21 02:06 ykakarap

Hey @salaxander, this is the corresponding PR: https://github.com/kubernetes/kubernetes/pull/99556.

ykakarap avatar Jun 23 '21 16:06 ykakarap

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

Thanks!

salaxander avatar Jul 02 '21 01:07 salaxander

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

cc @nikhita

ykakarap avatar Jul 02 '21 03:07 ykakarap

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 :)

salaxander avatar Jul 08 '21 03:07 salaxander

@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.

ykakarap avatar Jul 08 '21 03:07 ykakarap

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.

ritpanjw avatar Jul 08 '21 15:07 ritpanjw

@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.

ykakarap avatar Jul 08 '21 15:07 ykakarap

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

salaxander avatar Jul 08 '21 22:07 salaxander

/milestone v1.23

soltysh avatar Sep 02 '21 13:09 soltysh

Hi @ykakarap and @nikhita! 1.23 Enhancements team here. Just checking in as we approach enhancements freeze on Thursday 09/09. Here's where this enhancement currently stands:

  • [ ] Updated KEP file using the latest template has been merged into the k/enhancements repo.
  • [X] ~~KEP status is marked as implementable~~
  • [X] ~~KEP has a test plan section filled out.~~
  • [X] ~~KEP has up to date graduation criteria.~~
  • [X] ~~KEP has a production readiness review that has been completed and merged into k/enhancements.~~

For this KEP, it looks like we just need the kep.yaml file updated with the latest milestone info :)

Thanks!

salaxander avatar Sep 02 '21 16:09 salaxander

Hi @ykakarap and @nikhita, 1.23 Enhancements Shadow here 👋🏽 Just following up as we are approaching the enhancements freeze deadline at 23:59:59 PDT on Thursday, September 9th.

With the latest merged PR( latest-milestone update), we are all set for the enhancements freeze 🎉 I will update the tracking sheet accordingly. Thank you!

supriya-premkumar avatar Sep 09 '21 02:09 supriya-premkumar

Hi @ykakarap and @nikhita. :wave: 1.23 Docs release lead here.

This enhancement issue is listed as 'None required' for docs in the tracking sheet. I have moved it over to 'Needs Docs', please correct me if I'm mistaken.

Otherwise, please follow the steps detailed in the documentation to open a PR against the dev-1.23 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu November 18, 11:59 PM PDT.

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

Thanks!

jlbutler avatar Sep 22 '21 20:09 jlbutler

I think we should review and potentially update existing docs in light of this new feature:

  • the cheat sheet
  • https://kubernetes.io/docs/reference/kubectl/overview/
  • https://kubectl.docs.kubernetes.io/guides/

sftim avatar Oct 15 '21 16:10 sftim

Hi @ykakarap and @nikhita, 1.23 Enhancements Shadow here 👋🏽 I wanted to check in on the PR status for this issue since we are approaching code freeze deadline on Tuesday, November 16 at 6:00 pm PST

I see that there is one open PR. For this issue to be included in the release please make sure to merge the PRs(k/k) before code freeze deadline

Marking this issue as atRisk on the tracking sheet for now. Please let me know once you have updated it.

supriya-premkumar avatar Nov 09 '21 09:11 supriya-premkumar

Hi @ykakarap and @nikhita, 1.23 Docs shadow here. If this enhancement makes the release and you need any help documenting this feature, please let me know.

chrisnegus avatar Nov 10 '21 15:11 chrisnegus

Hi, 1.23 Enhancements Lead here 👋. With code freeze now in effect, this enhancement has not met the criteria for the freeze and has been removed from the milestone.

As a reminder, the criteria for code freeze is:

  • All PRs to the kubernetes/kubernetes repo have merged by the code freeze deadline

Feel free to file an exception to add this back to the release. If you plan to do so, please file this as early as possible.

Thanks! /milestone clear

salaxander avatar Nov 17 '21 02:11 salaxander

/milestone v1.24

soltysh avatar Jan 19 '22 17:01 soltysh

/unassign @ykakarap @ykakarap won't have the bandwidth to work on this right now, but will help on the sidelines!

/assign @MadhavJivrajani

nikhita avatar Jan 20 '22 05:01 nikhita

Hi @MadhavJivrajani and @nikhita 1.24 Docs shadow here. This enhancement is marked as 'Needs Docs' for the 1.24 release.

Please follow the steps detailed in the documentation to open a PR against the dev-1.24 branch in the k/website repo. This PR can be just a placeholder at this time and must be created before Thu March 31, 11:59 PM PDT.

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

Note also that the date for having the docs ready for review is coming up soon as well: April 5, 2022.

chrisnegus avatar Mar 28 '22 15:03 chrisnegus

This PR can be just a placeholder at this time and must be created before Thu March 31, 11:59 PM PDT.

@chrisnegus placeholder PR created - https://github.com/kubernetes/website/pull/32604

nikhita avatar Mar 29 '22 06:03 nikhita

Thanks @nikhita !

chrisnegus avatar Mar 31 '22 15:03 chrisnegus