Update kubectl subresource documentation #49824

soltysh · 2025-02-18T13:13:19Z

Description

Updates kubectl subresource documentation

Issue

netlify · 2025-02-18T13:13:38Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name	Link
🔨 Latest commit	`ab6b9ae`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/67b5b05cc1e1be0008539f0c

ardaguclu · 2025-02-18T13:16:04Z

That looks nice. Thanks.
/lgtm
from sig-cli POV

k8s-ci-robot · 2025-02-18T13:16:10Z

LGTM label has been added.

Git tree hash: 8f8d6c99068f25e488e6c48d67b5da1246ce9388

netlify · 2025-02-18T13:23:15Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`ab6b9ae`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67b5b05c9c6c360008d5abf6
😎 Deploy Preview	https://deploy-preview-49824--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

sftim · 2025-02-18T13:44:20Z

/sig cli

sftim

BTW, try to avoid unrelated whitespace changes as they can provoke merge conflicts.

We could merge this but I would tweak it; the CRD page mentions some details relevant to old (v1.23) Kubernetes that I don't think we need to keep.

So:
/hold
OK to unhold if we want to ship this and iterate.

/approve
I support the intent of this PR.

sftim · 2025-02-18T13:44:58Z

content/en/docs/reference/kubectl/conventions.md


-* You can use the `--subresource` beta flag for kubectl commands like `get`, `patch`,
-`edit` and `replace` to fetch and update subresources for all resources that
+* You can use the `--subresource` flag for kubectl commands like `get`, `patch`,


(nit)

Suggested change

* You can use the `--subresource` flag for kubectl commands like `get`, `patch`,

* You can use the `--subresource` argument for kubectl subcommands such as `get`, `patch`,

sftim · 2025-02-18T13:46:36Z

content/en/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md

-edit and replace to fetch and update `status` and `scale` subresources of the resources
-(applicable for kubectl version v1.24 or more). This flag is used with all the API resources
+edit, apply and replace to fetch and update `status` and `scale` subresources of the resources
+(applicable for kubectl version v1.24 or newer). This flag is used with all the API resources


Suggested change

(applicable for kubectl version v1.24 or newer). This flag is used with all the API resources

you specify. You can specify a subresource for any of the Kubernetes API resources

sftim · 2025-02-18T13:47:59Z

content/en/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch.md

 (built-in and CRs) that have `status` or `scale` subresource. Deployment is one of the
 examples which supports these subresources.


Suggested change

(built-in and CRs) that have `status` or `scale` subresource. Deployment is one of the

examples which supports these subresources.

(built-in and CRs) that have either a `status` or `scale` subresource, if they have both.

For example, a Deployment has a `status` subresource and a `scale` subresource, so you can use

`kubectl` to get or modify just the `status` subresource of a Deployment.

...nt/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning.md

sftim · 2025-02-18T13:55:54Z

...nt/en/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definition-versioning.md

   storage version, which is `v1`.
 3. Remove `v1beta1` from the CustomResourceDefinition `status.storedVersions` field.

 {{< note >}}


I think we could simplify the contents of this note to:

Here is an example of how to patch the `status` subresource for a CRD object using `kubectl`: ```bash kubectl patch customresourcedefinitions <CRD_Name> --subresource='status' --type='merge' -p '{"status":{"storedVersions":["v1"]}}' ```

WDYT?

Yeah, I think it's reasonable. Previously --subresource was new, so we needed explicit info when it's available. But since it's beta for all supported releases, we can just mention the example only.

sftim · 2025-02-18T13:57:16Z

content/en/docs/reference/kubectl/conventions.md

-`edit` and `replace` to fetch and update subresources for all resources that
+* You can use the `--subresource` flag for kubectl commands like `get`, `patch`,
+`edit`, `apply` and `replace` to fetch and update subresources for all resources that
 support them. Currently, only the `status` and `scale` subresources are supported.


Suggested change

support them. Currently, only the `status` and `scale` subresources are supported.

support them. In Kubernetes version {{< skew currentVersion >}}, only the `status` and `scale` subresources are supported.

k8s-ci-robot · 2025-02-18T13:58:29Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/docs/OWNERS~~ [sftim]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Signed-off-by: Maciej Szulik <[email protected]>

soltysh · 2025-02-19T10:20:38Z

BTW, try to avoid unrelated whitespace changes as they can provoke merge conflicts.

Will drop them, my editor by default removes all whitespaces from line endings.

We could merge this but I would tweak it; the CRD page mentions some details relevant to old (v1.23) Kubernetes that I don't think we need to keep.

So: /hold OK to unhold if we want to ship this and iterate.

Updated, so droping the hold

/hold cancel

sftim · 2025-02-20T10:12:19Z

Changes since LGTM in #49824 (comment) are trivial
/lgtm

k8s-ci-robot · 2025-02-20T10:12:28Z

LGTM label has been added.

Git tree hash: d49a4500ff4846d81294168b6e0684b56f4f1a92

k8s-ci-robot assigned ardaguclu Feb 18, 2025

k8s-ci-robot added the language/en Issues or PRs related to English language label Feb 18, 2025

k8s-ci-robot requested review from liggitt and nate-double-u February 18, 2025 13:13

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Feb 18, 2025

soltysh mentioned this pull request Feb 18, 2025

Add subresource support to kubectl kubernetes/enhancements#2590

Closed

12 tasks

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 18, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 18, 2025

k8s-ci-robot added the sig/cli Categorizes an issue or PR as relevant to SIG CLI. label Feb 18, 2025

sftim reviewed Feb 18, 2025

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 18, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 18, 2025

Update kubetl subresource documentation

ab6b9ae

Signed-off-by: Maciej Szulik <[email protected]>

soltysh force-pushed the subresource_docs branch from 123bc59 to ab6b9ae Compare February 19, 2025 10:20

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 19, 2025

k8s-ci-robot requested a review from ardaguclu February 19, 2025 10:20

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 19, 2025

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Feb 19, 2025

k8s-ci-robot assigned sftim Feb 20, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 20, 2025

k8s-ci-robot merged commit af7cde7 into kubernetes:dev-1.33 Feb 20, 2025
6 checks passed

soltysh deleted the subresource_docs branch February 20, 2025 14:24

	* You can use the `--subresource` flag for kubectl commands like `get`, `patch`,
	* You can use the `--subresource` argument for kubectl subcommands such as `get`, `patch`,

	(applicable for kubectl version v1.24 or newer). This flag is used with all the API resources
	you specify. You can specify a subresource for any of the Kubernetes API resources

		(built-in and CRs) that have `status` or `scale` subresource. Deployment is one of the
		examples which supports these subresources.

-(built-in and CRs) that have `status` or `scale` subresource. Deployment is one of the
-examples which supports these subresources.
+(built-in and CRs) that have either a `status` or `scale` subresource, if they have both.
+For example, a Deployment has a `status` subresource and a `scale` subresource, so you can use
+`kubectl` to get or modify just the `status` subresource of a Deployment.

	support them. Currently, only the `status` and `scale` subresources are supported.
	support them. In Kubernetes version {{< skew currentVersion >}}, only the `status` and `scale` subresources are supported.

Update kubectl subresource documentation #49824

Update kubectl subresource documentation #49824

Uh oh!

Conversation

soltysh commented Feb 18, 2025

Description

Issue

Uh oh!

netlify bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Uh oh!

ardaguclu commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

k8s-ci-robot commented Feb 18, 2025

Uh oh!

netlify bot commented Feb 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

sftim commented Feb 18, 2025

Uh oh!

sftim left a comment

Choose a reason for hiding this comment

Uh oh!

sftim Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

sftim Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

sftim Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sftim Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

soltysh Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

sftim Feb 18, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Feb 18, 2025

Uh oh!

soltysh commented Feb 19, 2025

Uh oh!

sftim commented Feb 20, 2025

Uh oh!

k8s-ci-robot commented Feb 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Feb 18, 2025 •

edited

Loading

ardaguclu commented Feb 18, 2025 •

edited

Loading

netlify bot commented Feb 18, 2025 •

edited

Loading