Skip to content

kx label

Sets or removes labels on one indexed resource — key=value to set, --remove to drop a key.

A flag kx doesn’t know is refused; put it after -- to pass it through to kubectl.

Usage

kx label [OPTIONS] <index> [key=value...] [kubectl flags]

Arguments

ArgumentDescription
<index>Row number from the current listing, or @name for a mark; kx state or kx mark shows them
[key=value]...Key and value to set; repeatable

Options

OptionDescription
--dry-run[=string]client or server to preview the change without making it, as kubectl takes it; kx’s line says nothing was changed
-o, --output stringOutput format, as kubectl takes it; kubectl’s output is printed, and kx’s own lines go to stderr
--overwriteAllow replacing an existing key
--remove stringsKey to remove (repeatable)

Passthrough options

OptionDescription
--allSelect all resources, in the namespace of the specified resource types
-A, --all-namespacesIf true, check the specified action in all namespaces.
--allow-missing-template-keysIf 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.
--field-manager stringName of the manager used to track field ownership.
--field-selector stringSelector (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.
-f, --filename stringsFilename, directory, or URL to files identifying the resource to update the labels
-k, --kustomize stringProcess the kustomization directory. This flag can’t be used together with -f or -R.
--listIf true, display the labels for a given resource.
--localIf true, label will NOT contact api-server but run locally.
-R, --recursiveProcess the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
--resource-version stringIf 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 stringSelector (label query) to filter on, supports ‘=’, ‘==’, ‘!=’, ‘in’, ’notin’.(e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints.
--show-managed-fieldsIf true, keep the managedFields when printing objects in JSON or YAML format.
--template stringTemplate 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].
…kubectl’s global flags too: --context, --kubeconfig, --as and the rest; kubectl options lists them

Global options

OptionDescription
--no-colorDisable styled output
-h, --helpShow this message and exit

Examples

kx label 1 env=prod
kx label 1 --remove env
kx label 1 env=prod --dry-run=server