KUBERNETES(1)(kubernetes)

💖 KUBERNETES(1) — the kubectl attach page, bestie edition ✨

okay so. hi. you're here because you want to get all up in a container that's already running. not start a new one, not exec a fresh process — literally attach your terminal to a process that is already vibing inside an existing container. iconic behaviour honestly. 🫶

this page lives in the kubernetes manual, section 1. let's go. 💅

---

🌸 NAME 🌸

kubectl attach — attach to a running container

---

✨ SYNOPSIS ✨

---

💖 DESCRIPTION 💖

You attach to a process that is already running inside an existing container. That's the whole bit. no new process, no fresh shell — you're pulling up a chair next to something that's already alive. 🍓

---

🎀 OPTIONS 🎀

• -c, --container="" — the container name. and like, if you don't give one? it uses the kubectl.kubernetes.io/default-container annotation to pick which container to attach to. and if that's not there either, the first container in the pod gets chosen for you. no pressure bestie, it'll figure it out. 🙈
• --detach-keys="ctrl-p,ctrl-q" — overrides the key sequence you press to detach from a container. yes, you can change the escape hatch. 👑
• --pod-running-timeout=1m0s — how long to wait until at least one pod is running. it's a length of time, like 5s, 2m, or 3h, and it has to be higher than zero. ⏳
• -q, --quiet=false — only print output from the remote session. that's it. that's the vibe. quiet mode stays quiet. 💀
• -i, --stdin=false — pass stdin to the container. you type, it hears you. 🫶
• -t, --tty=false — stdin is a TTY. the classic little friend that makes your terminal behave like a terminal. ✨

---

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these come from the parent command, and yeah, there's a LOT of them. no skipping though. we list them all, periodt. 💅

• --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. it literally says insecure. only do this if you know exactly what you're doing. 😭

• --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 🦋

# Get output from running pod mypod; use the 'kubectl.kubernetes.io/default-container' annotation
# for selecting the container to be attached or the first container in the pod will be chosen
kubectl attach mypod

# Get output from ruby-container from pod mypod
kubectl attach mypod -c ruby-container

# 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 attach mypod -c ruby-container -i -t

# Get output from the first pod of a replica set named nginx
kubectl attach rs/nginx

see how it's giving? pod name straight up, or rs/nginx for a replica set — chef's kiss. 😌✨

---

👑 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 it, go attach to something. 🎀

this was KUBERNETES(1)(kubernetes) from the User manuals, dated January 2015, by Eric Paris — love that for us, mwah, bye bestie 💖✨🦋