KUBERNETES(1)(kubernetes)

✨ NAME ✨

kubectl exec β€” bestie, this is the one that lets you execute a command in a container πŸ’…

This page lives in the KUBERNETES(1)(kubernetes) manual, and honestly? It's giving main character energy.


🌸 SYNOPSIS 🌸

kubectl exec [OPTIONS]

πŸ¦‹ DESCRIPTION πŸ¦‹

Execute a command in a container. That's it, that's the whole vibe β€” you point at a pod, you say what to run, it runs. Iconic behavior, no cap πŸ’–


πŸ’… OPTIONS πŸ’…

  • -c, --container="" β€” Container name. If you omit it, kubectl peeks at the kubectl.kubernetes.io/default-container annotation to pick which container to attach to β€” and if that's not there either, it just grabs the first container in the pod. Defaults gonna default, bestie πŸŽ€
  • -f, --filename=[] β€” to use to exec into the resource
  • --pod-running-timeout=1m0s β€” The length of time (like 5s, 2m, or 3h, higher than zero) to wait until at least one pod is running. So patient of you 🫢
  • -q, --quiet=false β€” Only print output from the remote session. No extra chatter, just the goods.
  • -i, --stdin=false β€” Pass stdin to the container. Feed it, it's hungry 😭
  • -t, --tty=false β€” Stdin is a TTY. That's the "make it look like a real terminal" switch, and yes, you want it for interactive stuff.

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

These bad boys come down from kubectl itself, so they work here too:

  • --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
🚨 Bestie. Read that one again. Skipping TLS verification means nobody's checking who you're actually talking to. Secure vibes: off.
  • --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.
  • -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

🌈 EXAMPLE 🌈

Okay this is the part where it all clicks, watch this:

# Get output from running the 'date' command from pod mypod, using the first container by default
kubectl exec mypod -- date

# Get output from running the 'date' command in ruby-container from pod mypod
kubectl exec mypod -c ruby-container -- date

# Switch to raw terminal mode; sends stdin to 'bash' in ruby-container from pod mypod
# and sends stdout/stderr from 'bash' back to the client
kubectl exec mypod -c ruby-container -i -t -- bash -il

# List contents of /usr from the first container of pod mypod and sort by modification time
# If the command you want to execute in the pod has any flags in common (e.g. -i),
# you must use two dashes (--) to separate your command's flags/arguments
# Also note, do not surround your command and its flags/arguments with quotes
# unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr")
kubectl exec mypod -i -t -- ls -t /usr

# Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default
kubectl exec deploy/mydeployment -- date

# Get output from running 'date' command from the first pod of the service myservice, using the first container by default
kubectl exec svc/myservice -- date
πŸ’– The -- thing is SO important bestie. If your command has a flag that clashes with a kubectl exec flag (like -i), the two dashes tell kubectl "everything after this is NOT yours." And don't quote your whole command β€” ls -t /usr, not "ls -t /usr" β€” unless that's genuinely how you'd run it normally. Periodt.

🧚 SEE ALSO 🧚

kubectl(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!


okay that's the whole page, you ate that πŸ“ This was KUBERNETES(1)(kubernetes), from the Manuals / User corner of the world, and the vibe is signed off with love β€” mwah πŸ’…βœ¨

πŸ“¦ where this page comes from