KUBERNETES(1)(kubernetes)

💖 KUBERNETES(1) — the kubernetes manual, but make it cute 💖

okay bestie, welcome to the kubernetes manual page, section 1 (that's the "User" section, iykyk) ✨ this one is all about kubectl rollout pause, and it's short, it's sweet, it's giving "one job and it does it flawlessly." no cap.

---

✨ NAME ✨

kubectl rollout pause — mark the provided resource as paused 🫶

---

🌸 SYNOPSIS 🌸

kubectl rollout pause [OPTIONS]

---

🦋 DESCRIPTION 🦋

So the whole vibe here: mark the provided resource as paused. that's it. that's the job. 💅

Now listen, because this part is important. Paused resources will not be reconciled by a controller. like, the controller is not coming to fix it, it's on pause-pause, do not disturb, main character is resting 😌. When you're ready to let it live again, use kubectl rollout resume to resume a paused resource. no hard feelings.

Also, fr fr, currently only deployments support being paused. so if you're out here trying to pause something else, that's not a thing yet, bestie. 💀

---

💖 OPTIONS 💖

• --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 is true, so it's already chillin'.
• --field-manager="kubectl-rollout" — name of the manager used to track field ownership. that's the little name tag it wears at the function.
• -f, --filename=[] — filename, directory, or URL to files identifying the resource to get from a server. give it a path, it goes and gets it 🧚
• -k, --kustomize="" — process the kustomization directory. ⚠️ this flag can't be used together with -f or -R. pick a lane, babe.
• -o, --output="" — output format. one of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). so many fits, pick your fave 👑
• -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, so you gotta opt in.
• -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. yes, all of them, it's an overachiever 🍓
• --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format. default is 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].

---

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the ones that got passed down like family recipes 💜

• --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. say it with me: insecure. it's literally in the name, bestie.
• --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. it's giving patient queen energy 🧘
• -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. strict queen behavior 💅

---

🎀 EXAMPLE 🎀

  # Mark the nginx deployment as paused
  # Any current state of the deployment will continue its function; new updates
  # to the deployment will not have an effect as long as the deployment is paused
  kubectl rollout pause deployment/nginx

look at her go. iconic. ✨

---

👑 SEE ALSO 👑

• kubectl-rollout(1)

---

📜 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 honestly, same, let the robots cook.)

---

and that's the whole page, bestie 🫶 shoutout to Eric Paris for the original Jan 2015 writeup, and this lil doc lives in the Manuals collection, User section, as KUBERNETES(1)(kubernetes) — you found it, you read it, you ate. mwah 💋💖