kubectl annotate

Synopsis

Update the annotations on one or more resources.

All Kubernetes objects support the ability to store additional data with the object as annotations. Annotations are key/value pairs that can be larger than labels and include arbitrary string values such as structured JSON. Tools and system extensions may use annotations to store their own data.

Attempting to set an annotation that already exists will fail unless —overwrite is set. If —resource-version is specified and does not match the current resource version on the server the command will fail.

Use “kubectl api-resources” for a complete list of supported resources.

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

Examples

  1.   # Update pod 'foo' with the annotation 'description' and the value 'my frontend'
  2.   # If the same annotation is set multiple times, only the last value will be applied
  3.   kubectl annotate pods foo description='my frontend'
  5.   # Update a pod identified by type and name in "pod.json"
  6.   kubectl annotate -f pod.json description='my frontend'
  8.   # Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value
  9.   kubectl annotate --overwrite pods foo description='my frontend running nginx'
  11.   # Update all pods in the namespace
  12.   kubectl annotate pods --all description='my frontend running nginx'
  14.   # Update pod 'foo' only if the resource is unchanged from version 1
  15.   kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
  17.   # Update pod 'foo' by removing an annotation named 'description' if it exists
  18.   # Does not require the --overwrite flag
  19.   kubectl annotate pods foo description-

Options

—all

Select all resources, in the namespace of the specified resource types.

-A, —all-namespaces

If true, check the specified action in all namespaces.

—allow-missing-template-keys     Default: 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 string[=”unchanged”]     Default: “none”

Must 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-manager string     Default: “kubectl-annotate”

Name of the manager used to track field ownership.

—field-selector string

Selector (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 strings

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

-h, —help

help for annotate

-k, —kustomize string

Process the kustomization directory. This flag can’t be used together with -f or -R.

—list

If true, display the annotations for a given resource.

—local

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

-o, —output string

Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).

—overwrite

If true, allow annotations to be overwritten, otherwise reject annotation updates that overwrite existing annotations.

-R, —recursive

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

—resource-version string

If non-empty, the annotation update will only succeed if this is the current resource-version for the object. Only valid when specifying a single resource.

-l, —selector string

Selector (label query) to filter on, supports ‘=’, ‘==’, and ‘!=’.(e.g. -l key1=value1,key2=value2). Matching objects must satisfy all of the specified label constraints.

—show-managed-fields

If true, keep the managedFields when printing objects in JSON or YAML format.

—template string

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

—as string

Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

—as-group strings

Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

—as-uid string

UID to impersonate for the operation.

—cache-dir string     Default: “$HOME/.kube/cache”

Default cache directory

—certificate-authority string

Path to a cert file for the certificate authority

—client-certificate string

Path to a client certificate file for TLS

—client-key string

Path to a client key file for TLS

—cloud-provider-gce-l7lb-src-cidrs cidrs     Default: 130.211.0.0/22,35.191.0.0/16

CIDRs opened in GCE firewall for L7 LB traffic proxy & health checks

—cloud-provider-gce-lb-src-cidrs cidrs     Default: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16

CIDRs opened in GCE firewall for L4 LB traffic proxy & health checks

—cluster string

The name of the kubeconfig cluster to use

—context string

The name of the kubeconfig context to use

—default-not-ready-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for notReady:NoExecute that is added by default to every pod that does not already have such a toleration.

—default-unreachable-toleration-seconds int     Default: 300

Indicates the tolerationSeconds of the toleration for unreachable:NoExecute that is added by default to every pod that does not already have such a toleration.

—disable-compression

If true, opt-out of response compression for all requests to the server

—insecure-skip-tls-verify

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

—kubeconfig string

Path to the kubeconfig file to use for CLI requests.

—match-server-version

Require server version to match client version

-n, —namespace string

If present, the namespace scope for this CLI request

—password string

Password for basic authentication to the API server

—profile string     Default: “none”

Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

—profile-output string     Default: “profile.pprof”

Name of the file to write the profile to

—request-timeout string     Default: “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 string

The address and port of the Kubernetes API server

—storage-driver-buffer-duration duration     Default: 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 string     Default: “cadvisor”

database name

—storage-driver-host string     Default: “localhost:8086”

database host:port

—storage-driver-password string     Default: “root”

database password

—storage-driver-secure

use secure connection with database

—storage-driver-table string     Default: “stats”

table name

—storage-driver-user string     Default: “root”

database username

—tls-server-name string

Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

—token string

Bearer token for authentication to the API server

—user string

The name of the kubeconfig user to use

—username string

Username for basic authentication to the API server

—version version[=true]

—version, —version=raw prints version information and quits; —version=vX.Y.Z… sets the reported version

—warnings-as-errors

Treat warnings received from the server as errors and exit with a non-zero exit code

See Also

  • kubectl - kubectl controls the Kubernetes cluster manager