KUBERNETES(1)(kubernetes)

πŸ’– KUBERNETES(1)(kubernetes) πŸ’–

okay bestie, welcome to kubectl rollout β€” it's giving main character energy for your deployments, and I'm about to explain it to you like we're texting at 2am. this page lives in the kubernetes manual (section 1, user commands), so you already know it's iconic. πŸŽ€


✨ NAME ✨

kubectl rollout β€” Manage the rollout of a resource πŸ¦‹


🌸 SYNOPSIS 🌸

kubectl rollout [OPTIONS]

that's it. that's the whole vibe. options and vibes, no positional args up top, periodt. πŸ’…


πŸ‘‘ DESCRIPTION πŸ‘‘

Manage the rollout of one or many resources. like, you're the director and the resources are your cast, and you're calling the shots on how the show rolls out. no cap.

Valid resource types include:

  • deployments
  • daemonsets
  • statefulsets
lowkey important: those three are the whole guest list. if your resource type isn't on this list, this command is not the one, bestie. 😭

🧚 OPTIONS INHERITED FROM PARENT COMMANDS 🧚

these aren't even rollout's own flags β€” they're heirlooms. inherited from the parent command, which is kubectl itself. so every single one of these is available to you here. obsessed. πŸ’œ

  • --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. stack 'em up. 🌈
  • --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. that's literally the default right there. πŸ“
  • --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 one is not the move unless you know exactly why you're doing it.
  • --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. the lowercase -n is your bestie fr fr. πŸŽ€
  • --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). pick your fighter. πŸ”₯
  • --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. so 0 = the waiting game never ends. 😭
  • -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. the vX.Y.Z... is a literal placeholder, don't come for me. ⭐
  • --warnings-as-errors=false β€” Treat warnings received from the server as errors and exit with a non-zero exit code.

🌈 EXAMPLE 🌈

the moment you've been waiting for. the fit check. πŸ‘‘

  # Rollback to the previous deployment
  kubectl rollout undo deployment/abc

  # Check the rollout status of a daemonset
  kubectl rollout status daemonset/foo

  # Restart a deployment
  kubectl rollout restart deployment/abc

  # Restart deployments with the 'app=nginx' label
  kubectl rollout restart deployment --selector=app=nginx

ate. no crumbs. πŸ’…


πŸŽ€ SEE ALSO πŸŽ€

go read these next, bestie, they're the friend group:


πŸ’œ 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! shoutout to Eric, an absolute legend for starting this. 🫢


okay and for the lil sign-off moment: this whole page comes from the Manuals collection, User section, dated back to Jan 2015, and it's filed under KUBERNETES(1)(kubernetes). iykyk. mwah. πŸ’–βœ¨πŸŽ€

πŸ“¦ where this page comes from