1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl cluster-info dump - Dump lots of relevant info for debugging
10 and diagnosis
11
15 kubectl cluster-info dump [OPTIONS]
16
20 Dumps cluster info out suitable for debugging and diagnosing cluster
21 problems. By default, dumps everything to stdout. You can optionally
22 specify a directory with --output-directory. If you specify a direc‐
23 tory, kubernetes will build a set of files in that directory. By de‐
24 fault only dumps things in the 'kube-system' namespace, but you can
25 switch to a different namespace with the --namespaces flag, or specify
26 --all-namespaces to dump all namespaces.
27 The command also dumps the logs of all of the pods in the cluster,
30 these logs are dumped into different directories based on namespace and
31 pod name.
32
36 -A, --all-namespaces=false If true, dump all namespaces. If true,
37 --namespaces is ignored.
38 --allow-missing-template-keys=true If true, ignore any errors in
41 templates when a field or map key is missing in the template. Only ap‐
42 plies to golang and jsonpath output formats.
43 --namespaces=[] A comma separated list of namespaces to dump.
46 -o, --output="json" Output format. One of: json|yaml|name|go-tem‐
49 plate|go-template-file|template|templatefile|jsonpath|json‐
50 path-as-json|jsonpath-file.
51 --output-directory="" Where to output the files. If empty or '-'
54 uses stdout, otherwise creates a directory hierarchy in that directory
55 --pod-running-timeout=20s The length of time (like 5s, 2m, or 3h,
58 higher than zero) to wait until at least one pod is running
59 --template="" Template string or path to template file to use when
62 -o=go-template, -o=go-template-file. The template format is golang tem‐
63 plates [http://golang.org/pkg/text/template/#pkg-overview].
64
68 --add-dir-header=false If true, adds the file directory to the
69 header of the log messages
70 --alsologtostderr=false log to standard error as well as files
73 --application-metrics-count-limit=100 Max number of application
76 metrics to store (per container)
77 --as="" Username to impersonate for the operation
80 --as-group=[] Group to impersonate for the operation, this flag
83 can be repeated to specify multiple groups.
84 --azure-container-registry-config="" Path to the file containing
87 Azure container registry configuration information.
88 --boot-id-file="/proc/sys/kernel/random/boot_id" Comma-separated
91 list of files to check for boot-id. Use the first one that exists.
92 --cache-dir="/builddir/.kube/cache" Default cache directory
95 --certificate-authority="" Path to a cert file for the certificate
98 authority
99 --client-certificate="" Path to a client certificate file for TLS
102 --client-key="" Path to a client key file for TLS
105 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
108 CIDRs opened in GCE firewall for L7 LB traffic proxy health
109 checks
110 --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
113 CIDRs opened in GCE firewall for L4 LB traffic proxy health
114 checks
115 --cluster="" The name of the kubeconfig cluster to use
118 --container-hints="/etc/cadvisor/container_hints.json" location of
121 the container hints file
122 --containerd="/run/containerd/containerd.sock" containerd endpoint
125 --containerd-namespace="k8s.io" containerd namespace
128 --context="" The name of the kubeconfig context to use
131 --default-not-ready-toleration-seconds=300 Indicates the tolera‐
134 tionSeconds of the toleration for notReady:NoExecute that is added by
135 default to every pod that does not already have such a toleration.
136 --default-unreachable-toleration-seconds=300 Indicates the tolera‐
139 tionSeconds of the toleration for unreachable:NoExecute that is added
140 by default to every pod that does not already have such a toleration.
141 --disable-root-cgroup-stats=false Disable collecting root Cgroup
144 stats
145 --docker="unix:///var/run/docker.sock" docker endpoint
148 --docker-env-metadata-whitelist="" a comma-separated list of envi‐
151 ronment variable keys matched with specified prefix that needs to be
152 collected for docker containers
153 --docker-only=false Only report docker containers in addition to
156 root stats
157 --docker-root="/var/lib/docker" DEPRECATED: docker root is read
160 from docker info (this is a fallback, default: /var/lib/docker)
161 --docker-tls=false use TLS to connect to docker
164 --docker-tls-ca="ca.pem" path to trusted CA
167 --docker-tls-cert="cert.pem" path to client certificate
170 --docker-tls-key="key.pem" path to private key
173 --enable-load-reader=false Whether to enable cpu load reader
176 --event-storage-age-limit="default=0" Max length of time for which
179 to store events (per type). Value is a comma separated list of key val‐
180 ues, where the keys are event types (e.g.: creation, oom) or "default"
181 and the value is a duration. Default is applied to all non-specified
182 event types
183 --event-storage-event-limit="default=0" Max number of events to
186 store (per type). Value is a comma separated list of key values, where
187 the keys are event types (e.g.: creation, oom) or "default" and the
188 value is an integer. Default is applied to all non-specified event
189 types
190 --global-housekeeping-interval=1m0s Interval between global house‐
193 keepings
194 --housekeeping-interval=10s Interval between container housekeep‐
197 ings
198 --insecure-skip-tls-verify=false If true, the server's certificate
201 will not be checked for validity. This will make your HTTPS connections
202 insecure
203 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
206 quests.
207 --log-backtrace-at=:0 when logging hits line file:N, emit a stack
210 trace
211 --log-cadvisor-usage=false Whether to log the usage of the cAdvi‐
214 sor container
215 --log-dir="" If non-empty, write log files in this directory
218 --log-file="" If non-empty, use this log file
221 --log-file-max-size=1800 Defines the maximum size a log file can
224 grow to. Unit is megabytes. If the value is 0, the maximum file size is
225 unlimited.
226 --log-flush-frequency=5s Maximum number of seconds between log
229 flushes
230 --logtostderr=true log to standard error instead of files
233 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
236 Comma-separated list of files to check for machine-id. Use the
237 first one that exists.
238 --match-server-version=false Require server version to match
241 client version
242 -n, --namespace="" If present, the namespace scope for this CLI
245 request
246 --one-output=false If true, only write logs to their native sever‐
249 ity level (vs also writing to each lower severity level
250 --password="" Password for basic authentication to the API server
253 --profile="none" Name of profile to capture. One of
256 (none|cpu|heap|goroutine|threadcreate|block|mutex)
257 --profile-output="profile.pprof" Name of the file to write the
260 profile to
261 --referenced-reset-interval=0 Reset interval for referenced bytes
264 (container_referenced_bytes metric), number of measurement cycles after
265 which referenced bytes are cleared, if set to 0 referenced bytes are
266 never cleared (default: 0)
267 --request-timeout="0" The length of time to wait before giving up
270 on a single server request. Non-zero values should contain a corre‐
271 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
272 out requests.
273 -s, --server="" The address and port of the Kubernetes API server
276 --skip-headers=false If true, avoid header prefixes in the log
279 messages
280 --skip-log-headers=false If true, avoid headers when opening log
283 files
284 --stderrthreshold=2 logs at or above this threshold go to stderr
287 --storage-driver-buffer-duration=1m0s Writes in the storage driver
290 will be buffered for this duration, and committed to the non memory
291 backends as a single transaction
292 --storage-driver-db="cadvisor" database name
295 --storage-driver-host="localhost:8086" database host:port
298 --storage-driver-password="root" database password
301 --storage-driver-secure=false use secure connection with database
304 --storage-driver-table="stats" table name
307 --storage-driver-user="root" database username
310 --tls-server-name="" Server name to use for server certificate
313 validation. If it is not provided, the hostname used to contact the
314 server is used
315 --token="" Bearer token for authentication to the API server
318 --update-machine-info-interval=5m0s Interval between machine info
321 updates.
322 --user="" The name of the kubeconfig user to use
325 --username="" Username for basic authentication to the API server
328 -v, --v=0 number for the log level verbosity
331 --version=false Print version information and quit
334 --vmodule= comma-separated list of pattern=N settings for
337 file-filtered logging
338 --warnings-as-errors=false Treat warnings received from the server
341 as errors and exit with a non-zero exit code
342
346 # Dump current cluster state to stdout
347 kubectl cluster-info dump
348 # Dump current cluster state to /path/to/cluster-state
350 kubectl cluster-info dump --output-directory=/path/to/cluster-state
351 # Dump all namespaces to stdout
353 kubectl cluster-info dump --all-namespaces
354 # Dump a set of namespaces to /path/to/cluster-state
356 kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
357
362 kubectl-cluster-info(1),
363
367 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
368 com) based on the kubernetes source material, but hopefully they have
369 been automatically generated since!
370Manuals User KUBERNETES(1)(kubernetes)