OC-ROLLOUT-PAUSE(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

✨ OC ROLLOUT(1) — the "pause" era ✨

okay so bestie, welcome to the oc rollout pause page 💅 this is from the OpenShift CLI User Manuals, June 2016, and it's literally the glow-up your deployment needs when you want it to just chill for a sec. no cap.

🌸 NAME 🌸

oc rollout pause — mark the provided resource as paused 🫶

🎀 SYNOPSIS 🎀

oc rollout pause [OPTIONS]

🦋 DESCRIPTION 🦋

Mark the provided resource as paused. periodt. 💅

Paused resources will not be reconciled by a controller. use oc rollout resume to resume a paused resource. currently, only deployments support being paused — that's the vibe check, don't come for me. 👑

💖 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. lowkey a lifesaver when your template is being dramatic 😭
  • --field-manager="kubectl-rollout" — name of the manager used to track field ownership. iykyk.
  • -f, --filename=[] — filename, directory, or URL to files identifying the resource to get from a server. like, tell me where the manifest lives bestie 🗂️
  • -k, --kustomize="" — process the kustomization directory. this flag can't be used together with -f or -R. no cap, they're not compatible, pick a lane 💀
  • -o, --output="" — output format. one of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). choose your fighter ✨
  • -R, --recursive=false — process the directory used in -f, --filename recursively. useful when you want to manage related manifests organized within the same directory. it's giving organized queen energy 🧚
  • -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. every single one. no exceptions bestie 💅
  • --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format. main character metadata vibes 👑
  • --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⟩ ]. ngl, go read the docs, they ate. 🔥

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these are the hand-me-downs from the parent command, and honestly? they're iconic. 💜

  • --as="" — username to impersonate for the operation. user could be a regular user or a service account in a namespace. be someone else, slay 🎭
  • --as-group=[] — group to impersonate for the operation, this flag can be repeated to specify multiple groups. stack 'em up 🫶
  • --as-uid="" — UID to impersonate for the operation. yes, the UID specifically. we love specificity.
  • --as-user-extra=[] — user extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key. extra. literally extra. 💅
  • --cache-dir="/homeless-shelter/.kube/cache" — default cache directory. that path is giving chaotic neutral but ok 😭
  • --certificate-authority="" — path to a cert file for the certificate authority. trust issues? fix 'em here.
  • --client-certificate="" — path to a client certificate file for TLS. secure the bag 🔐
  • --client-key="" — path to a client key file for TLS. the key to the kingdom, periodt.
  • --cluster="" — the name of the kubeconfig cluster to use. pick your cluster bestie 🌐
  • --context="" — the name of the kubeconfig context to use. context is everything, literally.
  • --disable-compression=false — if true, opt-out of response compression for all requests to the server. uncompressed and unbothered ✨
  • --insecure-skip-tls-verify=false — if true, the server's certificate will not be checked for validity. this will make your HTTPS connections insecure — like, actually insecure, not cute insecure. be careful bestie ⚠️
  • --kubeconfig="" — path to the kubeconfig file to use for CLI requests. where's your config at? 🗂️
  • --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. toggle vibes 🎚️
  • --match-server-version=false — require server version to match client version. matching outfits only 👯
  • -n, --namespace="" — if present, the namespace scope for this CLI request. stay in your lane (affectionate) 💖
  • --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex). profiling era 🔍
  • --profile-output="profile.pprof" — name of the file to write the profile to. save the receipts 📝
  • --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 chill, zero timeout 😌
  • -s, --server="" — the address and port of the Kubernetes API server. slide into the server's DMs 📡
  • --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 behavior is lowkey fine.
  • --token="" — bearer token for authentication to the API server. your all-access pass 🎟️
  • --user="" — the name of the kubeconfig user to use. who dis? 👀
  • --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
oc rollout pause deployment/nginx

see how clean that is? the nginx deployment stays doing its current thing, but new updates are on do-not-disturb until you resume. obsessed. 🦋

👑 SEE ALSO 👑

that's the whole family tree, bestie. go check it out.

🍓 HISTORY 🍓

June 2016, ported from the Kubernetes man-doc generator. vintage. iconic. historic. 💜

sign-off szn 🎀 this page came from Openshift — Openshift CLI User Manuals — and it's dated June 2016. go pause something responsibly, bestie. mwah. 💋✨

📦 where this page comes from