label

Update pod ‘foo’ with the label ‘unhealthy’ and the value ‘true’

  1. kubectl label pods foo unhealthy=true

Update pod ‘foo’ with the label ‘status’ and the value ‘unhealthy’, overwriting any existing value

  1. kubectl label --overwrite pods foo status=unhealthy

Update all pods in the namespace

  1. kubectl label pods --all status=unhealthy

Update a pod identified by the type and name in “pod.json”

  1. kubectl label -f pod.json status=unhealthy

Update pod ‘foo’ only if the resource is unchanged from version 1

  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

  1. kubectl label pods foo bar-

Update the labels on a resource.

  • A label key and value must begin with a letter or number, and may contain letters, numbers, hyphens, dots, and underscores, up to 63 characters each.
  • Optionally, the key can begin with a DNS subdomain prefix and a single ‘/‘, like example.com/my-app.
  • 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.

Usage

$ kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

Flags

NameShorthandDefaultUsage
allfalseSelect all resources, including uninitialized ones, in the namespace of the specified resource types
all-namespacesAfalseIf true, check the specified action in all namespaces.
allow-missing-template-keystrueIf 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-runnoneMust be “none”, “server”, or “client”. If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.
field-managerkubectl-labelName of the manager used to track field ownership.
field-selectorSelector (field query) to filter on, supports ‘=’, ‘==’, and ‘!=’.(e.g. —field-selector key1=value1,key2=value2). The server only supports a limited number of field queries per type.
filenamef[]Filename, directory, or URL to files identifying the resource to update the labels
kustomizekProcess the kustomization directory. This flag can’t be used together with -f or -R.
listfalseIf true, display the labels for a given resource.
localfalseIf true, label will NOT contact api-server but run locally.
outputoOutput format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file.
overwritefalseIf true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels.
recordfalseRecord 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.
recursiveRfalseProcess the directory used in -f, —filename recursively. Useful when you want to manage related manifests organized within the same directory.
resource-versionIf 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.
selectorlSelector (label query) to filter on, not including uninitialized ones, supports ‘=’, ‘==’, and ‘!=’.(e.g. -l key1=value1,key2=value2).
show-managed-fieldsfalseIf true, keep the managedFields when printing objects in JSON or YAML format.
templateTemplate 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].