github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/user-guide/kubectl/kubectl_label.md

128 lines
6.1 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
Better scary message
2015-07-16 17:02:26 +00:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
<strong>
The latest 1.0.x release of this document can be found
[here](http://releases.k8s.io/release-1.0/docs/user-guide/kubectl/kubectl_label.md).
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
Run gendocs
2015-07-13 22:15:35 +00:00
Run gendocs and munges
2015-07-12 04:04:52 +00:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Run gendocs
2015-07-17 22:35:41 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
## kubectl label
Update the labels on a resource
### Synopsis
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Update the labels on a resource.
label: Invalidate empty or invalid value labels
2015-05-20 09:02:30 +00:00
A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Kubectl label command accepts a filename param
2015-08-05 03:43:48 +00:00
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-11 17:22:08 +00:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
### Examples
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
```
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Update pod 'foo' with the label 'unhealthy' and the value 'true'.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
$ kubectl label pods foo unhealthy=true
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
$ kubectl label --overwrite pods foo status=unhealthy
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Update all pods in the namespace
`kubectl label` should support resource builder Allow applying labels to all resources, by existing selector, and soon allow multiple selection.
2015-03-26 01:52:12 +00:00
$ kubectl label pods --all status=unhealthy
Kubectl label command accepts a filename param
2015-08-05 03:43:48 +00:00
# Update a pod identified by the type and name in "pod.json"
$ kubectl label -f pod.json status=unhealthy
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Update pod 'foo' only if the resource is unchanged from version 1.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
$ kubectl label pods foo status=unhealthy --resource-version=1
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-12 16:50:09 +00:00
# Update pod 'foo' by removing a label named 'bar' if it exists.
# Does not require the --overwrite flag.
Generate new docs with the new changes
2015-02-20 21:29:23 +00:00
$ kubectl label pods foo bar-
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
### Options
```
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--all[=false]: select all resources in the namespace of the specified resource types
Add --dry-run option for label command With --dry-run option, label command will print the object locally without update it on server side.
2015-08-31 12:52:04 +00:00
--dry-run[=false]: If true, only print the object that would be sent, without sending it.
Kubectl label command accepts a filename param
2015-08-05 03:43:48 +00:00
-f, --filename=[]: Filename, directory, or URL to a file identifying the resource to update the labels
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--no-headers[=false]: When using the default output, don't print headers.
change -o template to -o go-template=...
2015-08-21 13:09:41 +00:00
-o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md].
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--output-version="": Output the formatted object with the given version (default api-version).
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--overwrite[=false]: If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
`kubectl label` should support resource builder Allow applying labels to all resources, by existing selector, and soon allow multiple selection.
2015-03-26 01:52:12 +00:00
--resource-version="": If non-empty, the labels update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.
-l, --selector="": Selector (label query) to filter on
Hide failed/succeeded pods in 'kubectl get pods' by default
2015-07-31 23:42:34 +00:00
-a, --show-all[=false]: When printing, show all resources (default hide terminated pods.)
Add field based sorting to the kubectl command line.
2015-08-08 06:04:25 +00:00
--sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
change -o template to -o go-template=...
2015-08-21 13:09:41 +00:00
--template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
```
Update docs after cobra update (spellling mistake)
2015-04-29 15:26:55 +00:00
### Options inherited from parent commands
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
```
Update docs
2015-08-17 18:06:16 +00:00
--alsologtostderr[=false]: log to standard error as well as files
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--api-version="": The API version to use when talking to the server
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
Update docs
2015-08-17 18:06:16 +00:00
--log-dir="": If non-empty, write log files in this directory
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-16 16:44:42 +00:00
--log-flush-frequency=5s: Maximum number of seconds between log flushes
Update docs
2015-08-17 18:06:16 +00:00
--logtostderr[=true]: log to standard error instead of files
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 14:23:28 +00:00
--match-server-version[=false]: Require server version to match client version
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--namespace="": If present, the namespace scope for this CLI request.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--password="": Password for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-19 19:51:38 +00:00
--username="": Username for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
Run gendocs
2015-07-17 22:35:41 +00:00
update docs using spf13/cobra generator
2015-04-12 19:04:39 +00:00
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-01-31 19:08:59 +00:00
Integrate convertion tool to kubectl Added 'convert' subcommand to kubectl to convert config files between different API versions.
2015-07-16 09:20:53 +00:00
###### Auto generated by spf13/cobra at 2015-09-22 12:53:42.29251561 +0000 UTC
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
move kubectl docs to docs/user-guide/kubectl
2015-07-13 17:19:25 +00:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_label.md?pixel)]()
Apply mungedocs changes
2015-07-14 00:13:09 +00:00
<!-- END MUNGE: GENERATED_ANALYTICS -->