OC(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc label — OC(1), bestie edition 💅

🏷️ NAME

oc label — update the labels on a resource. That’s the whole assignment, and it ate. ✨

✨ SYNOPSIS

oc label [OPTIONS]

💖 DESCRIPTION

Update the labels on a resource. Okay so here are the rules, and yes, they matter fr fr:

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

🌸 OPTIONS

  • --all=false — Select all resources, in the namespace of the specified resource types. Default: false.
  • -A, --all-namespaces=false — If true, check the specified action in all namespaces. Default: false.
  • --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. Default: true.
  • --dry-run="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. Default: "none".
  • --field-manager="kubectl-label" — Name of the manager used to track field ownership. Default: "kubectl-label".
  • --field-selector="" — 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. Default: "".
  • -f, --filename=[] — Filename, directory, or URL to files identifying the resource to update the labels. Default: [].
  • -k, --kustomize="" — Process the kustomization directory. This flag can’t be used together with -f or -R. Default: "".
  • --list=false — If true, display the labels for a given resource. Default: false.
  • --local=false — If true, label will NOT contact api-server but run locally. Default: false.
  • -o, --output="" — Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). Default: "".
  • --overwrite=false — If true, allow labels to be overwritten, otherwise reject label updates that overwrite existing labels. Default: false.
  • -R, --recursive=false — Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. Default: false.
  • --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. Default: "".
  • -l, --selector="" — Selector (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. Default: "".
  • --show-managed-fields=false — If true, keep the managedFields when printing objects in JSON or YAML format. Default: false.
  • --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). Default: "".

🦋 OPTIONS INHERITED FROM PARENT COMMANDS

These are the extra little besties that come along for the ride:

  • --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace. Default: "".
  • --as-group=[] — Group to impersonate for the operation, this flag can be repeated to specify multiple groups. Default: [].
  • --as-uid="" — UID to impersonate for the operation. Default: "".
  • --as-user-extra=[] — User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. Default: [].
  • --cache-dir="/homeless-shelter/.kube/cache" — Default cache directory. Default: "/homeless-shelter/.kube/cache".
  • --certificate-authority="" — Path to a cert file for the certificate authority. Default: "".
  • --client-certificate="" — Path to a client certificate file for TLS. Default: "".
  • --client-key="" — Path to a client key file for TLS. Default: "".
  • --cluster="" — The name of the kubeconfig cluster to use. Default: "".
  • --context="" — The name of the kubeconfig context to use. Default: "".
  • --disable-compression=false — If true, opt-out of response compression for all requests to the server. Default: false.
  • --insecure-skip-tls-verify=false — If true, the server’s certificate will not be checked for validity. This will make your HTTPS connections insecure. Default: false.
  • --kubeconfig="" — Path to the kubeconfig file to use for CLI requests. Default: "".
  • --kuberc="" — Path to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off. Default: "".
  • --match-server-version=false — Require server version to match client version. Default: false.
  • -n, --namespace="" — If present, the namespace scope for this CLI request. Default: "".
  • --profile="none" — Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex). Default: "none".
  • --profile-output="profile.pprof" — Name of the file to write the profile to. Default: "profile.pprof".
  • --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. Default: "0".
  • -s, --server="" — The address and port of the Kubernetes API server. Default: "".
  • --tls-server-name="" — Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used. Default: "".
  • --token="" — Bearer token for authentication to the API server. Default: "".
  • --user="" — The name of the kubeconfig user to use. Default: "".
  • --warnings-as-errors=false — Treat warnings received from the server as errors and exit with a non-zero exit code. Default: false.

🎀 EXAMPLE

# Update pod 'foo' with the label 'unhealthy' and the value 'true'
oc label pods foo unhealthy=true

# Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value
oc label --overwrite pods foo status=unhealthy

# Update all pods in the namespace
oc label pods --all status=unhealthy

# Update a pod identified by the type and name in "pod.json"
oc label -f pod.json status=unhealthy

# Update pod 'foo' only if the resource is unchanged from version 1
oc 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
oc label pods foo bar-

🌈 SEE ALSO

  • oc(1), — the main character. Go read it, iykyk.

👑 HISTORY

June 2016, Ported from the Kubernetes man-doc generator. Periodt.

💖 signed, sealed, slayed: Openshift — Openshift CLI User Manuals — OC(1) — June 2016. Mwah. 💖

📦 where this page comes from