1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl exec - Execute a command in a container
10
14 kubectl exec [OPTIONS]
15
19 Execute a command in a container.
20
24 -c, --container="" Container name. If omitted, the first container
25 in the pod will be chosen
26 -f, --filename=[] to use to exec into the resource
29 --pod-running-timeout=1m0s The length of time (like 5s, 2m, or 3h,
32 higher than zero) to wait until at least one pod is running
33 -i, --stdin=false Pass stdin to the container
36 -t, --tty=false Stdin is a TTY
39
43 --add-dir-header=false If true, adds the file directory to the
44 header of the log messages
45 --alsologtostderr=false log to standard error as well as files
48 --application-metrics-count-limit=100 Max number of application
51 metrics to store (per container)
52 --as="" Username to impersonate for the operation
55 --as-group=[] Group to impersonate for the operation, this flag
58 can be repeated to specify multiple groups.
59 --azure-container-registry-config="" Path to the file containing
62 Azure container registry configuration information.
63 --boot-id-file="/proc/sys/kernel/random/boot_id" Comma-separated
66 list of files to check for boot-id. Use the first one that exists.
67 --cache-dir="/builddir/.kube/cache" Default cache directory
70 --certificate-authority="" Path to a cert file for the certificate
73 authority
74 --client-certificate="" Path to a client certificate file for TLS
77 --client-key="" Path to a client key file for TLS
80 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
83 CIDRs opened in GCE firewall for L7 LB traffic proxy health
84 checks
85 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
88 CIDRs opened in GCE firewall for L4 LB traffic proxy health
89 checks
90 --cluster="" The name of the kubeconfig cluster to use
93 --container-hints="/etc/cadvisor/container_hints.json" location of
96 the container hints file
97 --containerd="/run/containerd/containerd.sock" containerd endpoint
100 --containerd-namespace="k8s.io" containerd namespace
103 --context="" The name of the kubeconfig context to use
106 --default-not-ready-toleration-seconds=300 Indicates the tolera‐
109 tionSeconds of the toleration for notReady:NoExecute that is added by
110 default to every pod that does not already have such a toleration.
111 --default-unreachable-toleration-seconds=300 Indicates the tolera‐
114 tionSeconds of the toleration for unreachable:NoExecute that is added
115 by default to every pod that does not already have such a toleration.
116 --disable-root-cgroup-stats=false Disable collecting root Cgroup
119 stats
120 --docker="unix:///var/run/docker.sock" docker endpoint
123 --docker-env-metadata-whitelist="" a comma-separated list of envi‐
126 ronment variable keys matched with specified prefix that needs to be
127 collected for docker containers
128 --docker-only=false Only report docker containers in addition to
131 root stats
132 --docker-root="/var/lib/docker" DEPRECATED: docker root is read
135 from docker info (this is a fallback, default: /var/lib/docker)
136 --docker-tls=false use TLS to connect to docker
139 --docker-tls-ca="ca.pem" path to trusted CA
142 --docker-tls-cert="cert.pem" path to client certificate
145 --docker-tls-key="key.pem" path to private key
148 --enable-load-reader=false Whether to enable cpu load reader
151 --event-storage-age-limit="default=0" Max length of time for which
154 to store events (per type). Value is a comma separated list of key val‐
155 ues, where the keys are event types (e.g.: creation, oom) or "default"
156 and the value is a duration. Default is applied to all non-specified
157 event types
158 --event-storage-event-limit="default=0" Max number of events to
161 store (per type). Value is a comma separated list of key values, where
162 the keys are event types (e.g.: creation, oom) or "default" and the
163 value is an integer. Default is applied to all non-specified event
164 types
165 --global-housekeeping-interval=1m0s Interval between global house‐
168 keepings
169 --housekeeping-interval=10s Interval between container housekeep‐
172 ings
173 --insecure-skip-tls-verify=false If true, the server's certificate
176 will not be checked for validity. This will make your HTTPS connections
177 insecure
178 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
181 quests.
182 --log-backtrace-at=:0 when logging hits line file:N, emit a stack
185 trace
186 --log-cadvisor-usage=false Whether to log the usage of the cAdvi‐
189 sor container
190 --log-dir="" If non-empty, write log files in this directory
193 --log-file="" If non-empty, use this log file
196 --log-file-max-size=1800 Defines the maximum size a log file can
199 grow to. Unit is megabytes. If the value is 0, the maximum file size is
200 unlimited.
201 --log-flush-frequency=5s Maximum number of seconds between log
204 flushes
205 --logtostderr=true log to standard error instead of files
208 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
211 Comma-separated list of files to check for machine-id. Use the
212 first one that exists.
213 --match-server-version=false Require server version to match
216 client version
217 -n, --namespace="" If present, the namespace scope for this CLI
220 request
221 --one-output=false If true, only write logs to their native sever‐
224 ity level (vs also writing to each lower severity level
225 --password="" Password for basic authentication to the API server
228 --profile="none" Name of profile to capture. One of
231 (none|cpu|heap|goroutine|threadcreate|block|mutex)
232 --profile-output="profile.pprof" Name of the file to write the
235 profile to
236 --referenced-reset-interval=0 Reset interval for referenced bytes
239 (container_referenced_bytes metric), number of measurement cycles after
240 which referenced bytes are cleared, if set to 0 referenced bytes are
241 never cleared (default: 0)
242 --request-timeout="0" The length of time to wait before giving up
245 on a single server request. Non-zero values should contain a corre‐
246 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
247 out requests.
248 -s, --server="" The address and port of the Kubernetes API server
251 --skip-headers=false If true, avoid header prefixes in the log
254 messages
255 --skip-log-headers=false If true, avoid headers when opening log
258 files
259 --stderrthreshold=2 logs at or above this threshold go to stderr
262 --storage-driver-buffer-duration=1m0s Writes in the storage driver
265 will be buffered for this duration, and committed to the non memory
266 backends as a single transaction
267 --storage-driver-db="cadvisor" database name
270 --storage-driver-host="localhost:8086" database host:port
273 --storage-driver-password="root" database password
276 --storage-driver-secure=false use secure connection with database
279 --storage-driver-table="stats" table name
282 --storage-driver-user="root" database username
285 --tls-server-name="" Server name to use for server certificate
288 validation. If it is not provided, the hostname used to contact the
289 server is used
290 --token="" Bearer token for authentication to the API server
293 --update-machine-info-interval=5m0s Interval between machine info
296 updates.
297 --user="" The name of the kubeconfig user to use
300 --username="" Username for basic authentication to the API server
303 -v, --v=0 number for the log level verbosity
306 --version=false Print version information and quit
309 --vmodule= comma-separated list of pattern=N settings for
312 file-filtered logging
313 --warnings-as-errors=false Treat warnings received from the server
316 as errors and exit with a non-zero exit code
317
321 # Get output from running 'date' command from pod mypod, using the first container by default
322 kubectl exec mypod -- date
323 # Get output from running 'date' command in ruby-container from pod mypod
325 kubectl exec mypod -c ruby-container -- date
326 # Switch to raw terminal mode, sends stdin to 'bash' in ruby-container from pod mypod
328 # and sends stdout/stderr from 'bash' back to the client
329 kubectl exec mypod -c ruby-container -i -t -- bash -il
330 # List contents of /usr from the first container of pod mypod and sort by modification time.
332 # If the command you want to execute in the pod has any flags in common (e.g. -i),
333 # you must use two dashes (--) to separate your command's flags/arguments.
334 # Also note, do not surround your command and its flags/arguments with quotes
335 # unless that is how you would execute it normally (i.e., do ls -t /usr, not "ls -t /usr").
336 kubectl exec mypod -i -t -- ls -t /usr
337 # Get output from running 'date' command from the first pod of the deployment mydeployment, using the first container by default
339 kubectl exec deploy/mydeployment -- date
340 # Get output from running 'date' command from the first pod of the service myservice, using the first container by default
342 kubectl exec svc/myservice -- date
343
348 kubectl(1),
349
353 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
354 com) based on the kubernetes source material, but hopefully they have
355 been automatically generated since!
356Manuals User KUBERNETES(1)(kubernetes)