kubectl-label man page

kubectl label — Update the labels on a resource

Synopsis

kubectl label [Options]

Description

Update the labels on a resource.

0[step]

item A label must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to  63 characters.
item If --overwrite is true, then existing labels can be overwritten, otherwise attempting to overwrite a label will result in an error.
item If --resource-version is specified, then updates will use this resource version, otherwise the existing resource-version will be used.

Options

--all=false

select all resources in the namespace of the specified resource types

--allow-missing-template-keys=true

If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

--dry-run=false

If true, only print the object that would be sent, without sending it.

-f, --filename=[]

Filename, directory, or URL to files identifying the resource to update the labels

--include-extended-apis=true

If true, include definitions of new APIs via calls to the API server. [default true]

--local=false

If true, label will NOT contact api-server but run locally.

--no-headers=false

When using the default or custom-column output format, don't print headers.

-o, --output=""

Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [ ⟨http://kubernetes.io/docs/user-guide/kubectl-overview/#custom-columns⟩], golang template [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩] and jsonpath template [ ⟨http://kubernetes.io/docs/user-guide/jsonpath⟩].

--output-version=""

Output the formatted object with the given group version (for ex: 'extensions/v1beta1').

--overwrite=false

If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.

--record=false

Record current kubectl command in the resource annotation. If set to false, do not record the command. If set to true, record the command. If not set, default to updating the existing annotation value only if one already exists.

-R, --recursive=false

Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.

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

-a, --show-all=false

When printing, show all resources (default hide terminated pods.)

--show-labels=false

When printing, show all labels as the last column (default hide labels column)

--sort-by=""

If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.

--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⟩].

Options Inherited from Parent Commands

--allow-verification-with-non-compliant-keys=false

Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.

--alsologtostderr=false

log to standard error as well as files

--api-version=""

DEPRECATED: The API version to use when talking to the server

--application-metrics-count-limit=100

Max number of application metrics to store (per container)

--as=""

Username to impersonate for the operation

--azure-container-registry-config=""

Path to the file container Azure container registry configuration information.

--boot-id-file="/proc/sys/kernel/random/boot_id"

Comma-separated list of files to check for boot-id. Use the first one that exists.

--certificate-authority=""

Path to a cert. file for the certificate authority

--client-certificate=""

Path to a client certificate file for TLS

--client-key=""

Path to a client key file for TLS

--cluster=""

The name of the kubeconfig cluster to use

--container-hints="/etc/cadvisor/container_hints.json"

location of the container hints file

--context=""

The name of the kubeconfig context to use

--docker="unix:///var/run/docker.sock"

docker endpoint

--docker-env-metadata-whitelist=""

a comma-separated list of environment variable keys that needs to be collected for docker containers

--docker-only=false

Only report docker containers in addition to root stats

--docker-root="/var/lib/docker"

DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)

--enable-load-reader=false

Whether to enable cpu load reader

--event-storage-age-limit="default=0"

Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types

--event-storage-event-limit="default=0"

Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types

--global-housekeeping-interval=1m0s

Interval between global housekeepings

--google-json-key=""

The Google Cloud Platform Service Account JSON Key to use for authentication.

--housekeeping-interval=10s

Interval between container housekeepings

--insecure-skip-tls-verify=false

If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--ir-data-source="influxdb"

Data source used by InitialResources. Supported options: influxdb, gcm.

--ir-dbname="k8s"

InfluxDB database name which contains metrics required by InitialResources

--ir-hawkular=""

Hawkular configuration URL

--ir-influxdb-host="localhost:8080/api/v1/proxy/namespaces/kube-system/services/monitoring-influxdb:api"

Address of InfluxDB which contains metrics required by InitialResources

--ir-namespace-only=false

Whether the estimation should be made only based on data from the same namespace.

--ir-password="root"

Password used for connecting to InfluxDB

--ir-percentile=90

Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.

--ir-user="root"

User used for connecting to InfluxDB

--kubeconfig=""

Path to the kubeconfig file to use for CLI requests.

--log-backtrace-at=:0

when logging hits line file:N, emit a stack trace

--log-cadvisor-usage=false

Whether to log the usage of the cAdvisor container

--log-dir=""

If non-empty, write log files in this directory

--loglevel=1

Log level (0 = DEBUG, 5 = FATAL)

--logtostderr=false

log to standard error instead of files

--machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"

Comma-separated list of files to check for machine-id. Use the first one that exists.

--match-server-version=false

Require server version to match client version

-n, --namespace=""

If present, the namespace scope for this CLI request

--password=""

Password for basic authentication to the API server

--request-timeout="0"

The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server=""

The address and port of the Kubernetes API server

--stderrthreshold=2

logs at or above this threshold go to stderr

--storage-driver-buffer-duration=1m0s

Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction

--storage-driver-db="cadvisor"

database name

--storage-driver-host="localhost:8086"

database host:port

--storage-driver-password="root"

database password

--storage-driver-secure=false

use secure connection with database

--storage-driver-table="stats"

table name

--storage-driver-user="root"

database username

--token=""

Bearer token for authentication to the API server

--user=""

The name of the kubeconfig user to use

--username=""

Username for basic authentication to the API server

-v, --v=0

log level for V logs

--vmodule=

comma-separated list of pattern=N settings for file-filtered logging

Example

  # Update pod 'foo' with the label 'unhealthy' and the value 'true'.
  kubectl label pods foo unhealthy=true
  
  # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value.
  kubectl label --overwrite pods foo status=unhealthy
  
  # Update all pods in the namespace
  kubectl label pods --all status=unhealthy
  
  # Update a pod identified by the type and name in "pod.json"
  kubectl label -f pod.json status=unhealthy
  
  # Update pod 'foo' only if the resource is unchanged from version 1.
  kubectl label pods foo status=unhealthy --resource-version=1
  
  # Update pod 'foo' by removing a label named 'bar' if it exists.
  # Does not require the --overwrite flag.
  kubectl label pods foo bar-

See Also

kubectl(1),

History

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since!

Referenced By

kubectl(1).

kubernetes User Manuals Eric Paris Jan 2015