OC-ROLLOUT-RETRY(1)

πŸ“¦
version 4.22.0 Β· 2 versions
, in nixpkgs unstable

OC ROLLOUT(1) β€” aka the oc rollout retry page πŸ’…

okay so real quick before we dive in: this is the manual page for oc rollout retry, straight out of the Openshift CLI User Manuals, dated June 2016. Yes bestie, 2016 β€” she's vintage, she's iconic, she still slays. Let's get into it ✨


πŸŽ€ NAME πŸŽ€

oc rollout retry β€” literally just: retry the latest failed rollout. That's the whole gig. 🫢


πŸ¦‹ SYNOPSIS πŸ¦‹

oc rollout retry [OPTIONS]

no cap, that's it. flags go where flags go.


🌸 DESCRIPTION 🌸

so picture this: a rollout fails 😭. if the error was transient (like, a flaky little moment, not a whole personality flaw), you may opt to retry it. slay.

but lowkey some rollouts may never successfully complete β€” in which case you can use rollout latest to force a redeployment. main character energy, forcing the issue. πŸ’…

here's the cute part though: if a deployment config has completed rolling out successfully at least once in the past, it would be automatically rolled back in the event of a new failed rollout. the system's got your back 🫢.

⚠️ but not me reminding you: you would still need to update the erroneous deployment config in order to have its template persisted across your application. the rollback doesn't fix your bad config, bestie. it just buys you time. πŸ’€

✨ OPTIONS ✨

  • --allow-missing-template-keys=true β€” if true, ignore any errors in templates when a field or map key is missing in the template. heads up: it only applies to golang and jsonpath output formats. πŸ™ˆ
  • -f, --filename=[] β€” filename, directory, or URL to files. (the page says it twice, so I'm saying it twice: filename, directory, or URL to a file 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.
  • -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 options, so little time ⭐
  • -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, folder structure 🌈
  • --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, read the docs on that one 🧚

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these are the flags she got from her parents, and honestly? good genes.

  • --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
  • --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. fr fr, be careful with this one.
  • --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 πŸ’œ

# Retry the latest failed deployment based on 'frontend'
# The deployer pod and any hook pods are deleted for the latest failed deployment
oc rollout retry dc/frontend

that's the whole vibe. drop the # comments if you want, but honestly they're giving tutorial-girlie and I respect it. πŸ“


πŸ”₯ SEE ALSO πŸ”₯

oc-rollout(1),

go read the parent page, she's the blueprint. πŸ‘‘


⭐ HISTORY ⭐

June 2016, ported from the Kubernetes man-doc generator. a classic, honestly.


πŸ’– okay that's the page!! every flag accounted for, nothing skipped, no facts invented β€” just vibes and accurate documentation living in harmony.

sign-off time 🫢 β€” this little love letter lives under Openshift, in the Openshift CLI User Manuals, and yes, the header still says OC ROLLOUT(1) because we don't rename perfection. mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from