OC-ROLLOUT-CANCEL(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

👑 oc rollout cancel — the "nvm bestie, abort" command

okay so quick vibe check: this page is oc rollout cancel from section 1 of the Openshift CLI User Manuals, and yes she's a whole moment. no cap. let's get into it 💅

✨ NAME ✨

oc rollout cancel — literally just cancels the in-progress deployment. that's the whole gig. she's an icon, she's a legend, she is the moment 🎀

🦋 SYNOPSIS 🦋

oc rollout cancel [OPTIONS]

🌸 DESCRIPTION 🌸

bestie, this command cancels the in-progress deployment. periodt.

now listen — running this command will cause the current in-progress deployment to be cancelled, but keep in mind this is a best-effort operation and it may take some time to complete. it's genuinely possible the deployment will partially or totally complete before the cancellation is effective 😭 like you asked her to stop and she already sent the text, yk?

in such a case, an appropriate event will be emitted. so at least you'll know. 🙈

lowkey important: "best-effort" is doing a lot of heavy lifting in that sentence. don't come for this command if the deployment sneaks through anyway. 💀

💖 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. (so forgiving, so slay ✨)
  • -f, --filename=[] — filename, directory, or URL to files. filename, directory, or URL to a file identifying the resource to get from a server. yes she says it twice, she's thorough 💅
  • -k, --kustomize="" — process the kustomization directory. this flag can't be used together with -f or -R. it's giving exclusive 🫶
  • -o, --output="" — output format. one of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). pick 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. go off, organizational queen 👑
  • --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]. ngl that link is your friend 🧚

🎀 OPTIONS INHERITED FROM PARENT COMMANDS 🎀

these ones she got from her parent commands, and honestly they ate. every single one, no skips:

  • --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="/homeless-shelter/.kube/cache" — default cache directory. yes that's literally the path. don't ask, bestie, just accept it 💀
  • --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. ⚠️ like actually, be careful, this one is not a cute risk
  • --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
  • --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex)
  • --profile-output="profile.pprof" — name of the file to write the profile to
  • --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.
  • -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
  • --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code

🔥 EXAMPLE 🔥

okay so this is the whole thing, look how simple:

# Cancel the in-progress deployment based on 'nginx'
oc rollout cancel dc/nginx

like. that's it. one line and the deployment is getting cancelled. main character energy fr fr ⭐

🫶 SEE ALSO 🫶

oc-rollout(1)

(that's her parent, go say hi 👋)

💜 HISTORY 💜

June 2016, Ported from the Kubernetes man-doc generator. vintage. iconic. the way she's been serving since 2016 🎀

and that's the page bestie!! 💖 this all came straight from the Openshift CLI User Manuals (Openshift, duh), last touched in June 2016 — so yeah, she's old money but she still slays. mwah 😘✨🌸

📦 where this page comes from