KUBERNETES(1)(kubernetes)

πŸ’… kubectl set image β€” the manual, but make it iconic

okay bestie, welcome to the KUBERNETES(1)(kubernetes) manual page, which is technically from Eric Paris, Jan 2015 β€” yes, this page is literally older than some of us, and it still eats. πŸ’–


✨ NAME ✨

kubectl set image β€” update the image of a pod template. that's it. that's the whole job. glow-up your containers, no cap. πŸŽ€


🌸 SYNOPSIS 🌸

kubectl set image [OPTIONS]

πŸ¦‹ DESCRIPTION πŸ¦‹

so the vibe here is: you have resources that already exist, and you want to swap out the container image(s) inside them. that's what this does. it's giving ✨makeover montage✨.

Possible resources include (case insensitive, so don't stress about your caps lock):

pod (po), replicationcontroller (rc), deployment (deploy), daemonset (ds), statefulset (sts), cronjob (cj), replicaset (rs)

πŸ’… OPTIONS πŸ’…

  • --all=false β€” Select all resources, in the namespace of the specified resource types. yes queen, all of them. 🫢
  • --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. basically: let it slide when something's not there.
  • --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. it's a rehearsal, not the real performance. 🎭
  • --field-manager="kubectl-set" β€” Name of the manager used to track field ownership. somebody has to keep the receipts. 🧾
  • -f, --filename=[] β€” Filename, directory, or URL to files identifying the resource to get from a server.
  • -k, --kustomize="" β€” Process the kustomization directory. This flag can't be used together with -f or -R. pick a lane bestie, they don't play nice. πŸ’€
  • --local=false β€” If true, set image will NOT contact api-server but run locally. it's a homebody, it stays in. 🏠
  • -o, --output="" β€” Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
  • --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. it remembers only if it already had memory. iconic behaviour honestly. 🧠
  • -R, --recursive=false β€” Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. dig through everything, no crumbs left. πŸ•΅οΈβ€β™€οΈ
  • -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. all of them. no partial credit.
  • --show-managed-fields=false β€” If true, keep the managedFields when printing objects in JSON or YAML format.
  • --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 🌈

these ones come from the parent command, so they're like the family traits you didn't ask for but got anyway. πŸ’œ

  • --as="" β€” Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
  • --as-group=[] β€” Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  • --as-uid="" β€” UID to impersonate for the operation.
  • --as-user-extra=[] β€” User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
  • --cache-dir="/home/username/.kube/cache" β€” Default cache directory.
  • --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.
  • --context="" β€” The name of the kubeconfig context to use.
  • --disable-compression=false β€” If true, opt-out of response compression for all requests to the server.
  • --insecure-skip-tls-verify=false β€” If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. 🚨 bestie. this is the red flag. do not.
  • --kubeconfig="" β€” Path to the kubeconfig file to use for CLI requests.
  • --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.
  • --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.
  • --profile="none" β€” Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace).
  • --profile-output="profile.pprof" β€” Name of the file to write the profile to.
  • --proxy-url="" β€” Proxy URL to use for requests 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. zero = zero patience limits, live your truth. ⏳
  • -s, --server="" β€” The address and port of the Kubernetes API server.
  • --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.
  • --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.
  • --version=false β€” --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version.
  • --warnings-as-errors=false β€” Treat warnings received from the server as errors and exit with a non-zero exit code. no more gentle parenting. 😀

πŸ“ EXAMPLE πŸ“

okay these examples are lowkey the best part, they're so satisfying:

# Set a deployment's nginx container image to 'nginx:1.9.1', and its busybox container image to 'busybox'
kubectl set image deployment/nginx busybox=busybox nginx=nginx:1.9.1

# Update all deployments' and rc's nginx container's image to 'nginx:1.9.1'
kubectl set image deployments,rc nginx=nginx:1.9.1 --all

# Update image of all containers of daemonset abc to 'nginx:1.9.1'
kubectl set image daemonset abc *=nginx:1.9.1

# Print result (in yaml format) of updating nginx container image from local file, without hitting the server
kubectl set image -f path/to/file.yaml nginx=nginx:1.9.1 --local -o yaml

the *= in that third one?? chef's kiss. 🌟


πŸ”₯ SEE ALSO πŸ”₯

go read it, it's the sibling. iykyk. πŸ’œ


πŸ‘‘ 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!


and that's the whole page, bestie!! πŸŽ€ it's from Manuals β€” User, KUBERNETES(1)(kubernetes), dated Jan 2015 by Eric Paris. literally a legend, we stan an OG contributor. slay, periodt, go update some container images. πŸ’–βœ¨

πŸ“¦ where this page comes from