1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl cluster-info dump - Dump lots of relevant info for debugging
7 and diagnosis
8
12 kubectl cluster-info dump [OPTIONS]
13
17 Dumps cluster info out suitable for debugging and diagnosing cluster
18 problems. By default, dumps everything to stdout. You can optionally
19 specify a directory with --output-directory. If you specify a direc‐
20 tory, kubernetes will build a set of files in that directory. By
21 default only dumps things in the 'kube-system' namespace, but you can
22 switch to a different namespace with the --namespaces flag, or specify
23 --all-namespaces to dump all namespaces.
24 The command also dumps the logs of all of the pods in the cluster,
27 these logs are dumped into different directories based on namespace and
28 pod name.
29
33 -A, --all-namespaces=false
34 If true, dump all namespaces. If true, --namespaces is ignored.
35 --allow-missing-template-keys=true
38 If true, ignore any errors in templates when a field or map key is
39 missing in the template. Only applies to golang and jsonpath output
40 formats.
41 --namespaces=[]
44 A comma separated list of namespaces to dump.
45 -o, --output="json"
48 Output format. One of: json|yaml|name|go-template|go-tem‐
49 plate-file|template|templatefile|jsonpath|jsonpath-file.
50 --output-directory=""
53 Where to output the files. If empty or '-' uses stdout, otherwise
54 creates a directory hierarchy in that directory
55 --pod-running-timeout=20s
58 The length of time (like 5s, 2m, or 3h, higher than zero) to wait
59 until at least one pod is running
60 --template=""
63 Template string or path to template file to use when -o=go-tem‐
64 plate, -o=go-template-file. The template format is golang templates [
65 ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].
66
70 --alsologtostderr=false
71 log to standard error as well as files
72 --application-metrics-count-limit=100
75 Max number of application metrics to store (per container)
76 --as=""
79 Username to impersonate for the operation
80 --as-group=[]
83 Group to impersonate for the operation, this flag can be repeated
84 to specify multiple groups.
85 --azure-container-registry-config=""
88 Path to the file containing Azure container registry configuration
89 information.
90 --boot-id-file="/proc/sys/kernel/random/boot_id"
93 Comma-separated list of files to check for boot-id. Use the first
94 one that exists.
95 --cache-dir="/builddir/.kube/http-cache"
98 Default HTTP cache directory
99 --certificate-authority=""
102 Path to a cert file for the certificate authority
103 --client-certificate=""
106 Path to a client certificate file for TLS
107 --client-key=""
110 Path to a client key file for TLS
111 --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
114 CIDRs opened in GCE firewall for LB traffic proxy health checks
115 --cluster=""
118 The name of the kubeconfig cluster to use
119 --container-hints="/etc/cadvisor/container_hints.json"
122 location of the container hints file
123 --containerd="/run/containerd/containerd.sock"
126 containerd endpoint
127 --containerd-namespace="k8s.io"
130 containerd namespace
131 --context=""
134 The name of the kubeconfig context to use
135 --default-not-ready-toleration-seconds=300
138 Indicates the tolerationSeconds of the toleration for
139 notReady:NoExecute that is added by default to every pod that does not
140 already have such a toleration.
141 --default-unreachable-toleration-seconds=300
144 Indicates the tolerationSeconds of the toleration for unreach‐
145 able:NoExecute that is added by default to every pod that does not
146 already have such a toleration.
147 --docker="unix:///var/run/docker.sock"
150 docker endpoint
151 --docker-env-metadata-whitelist=""
154 a comma-separated list of environment variable keys that needs to
155 be collected for docker containers
156 --docker-only=false
159 Only report docker containers in addition to root stats
160 --docker-root="/var/lib/docker"
163 DEPRECATED: docker root is read from docker info (this is a fall‐
164 back, default: /var/lib/docker)
165 --docker-tls=false
168 use TLS to connect to docker
169 --docker-tls-ca="ca.pem"
172 path to trusted CA
173 --docker-tls-cert="cert.pem"
176 path to client certificate
177 --docker-tls-key="key.pem"
180 path to private key
181 --enable-load-reader=false
184 Whether to enable cpu load reader
185 --event-storage-age-limit="default=0"
188 Max length of time for which to store events (per type). Value is a
189 comma separated list of key values, where the keys are event types
190 (e.g.: creation, oom) or "default" and the value is a duration. Default
191 is applied to all non-specified event types
192 --event-storage-event-limit="default=0"
195 Max number of events to store (per type). Value is a comma sepa‐
196 rated list of key values, where the keys are event types (e.g.: cre‐
197 ation, oom) or "default" and the value is an integer. Default is
198 applied to all non-specified event types
199 --global-housekeeping-interval=1m0s
202 Interval between global housekeepings
203 --housekeeping-interval=10s
206 Interval between container housekeepings
207 --insecure-skip-tls-verify=false
210 If true, the server's certificate will not be checked for validity.
211 This will make your HTTPS connections insecure
212 --kubeconfig=""
215 Path to the kubeconfig file to use for CLI requests.
216 --log-backtrace-at=:0
219 when logging hits line file:N, emit a stack trace
220 --log-cadvisor-usage=false
223 Whether to log the usage of the cAdvisor container
224 --log-dir=""
227 If non-empty, write log files in this directory
228 --log-file=""
231 If non-empty, use this log file
232 --log-file-max-size=1800
235 Defines the maximum size a log file can grow to. Unit is megabytes.
236 If the value is 0, the maximum file size is unlimited.
237 --log-flush-frequency=5s
240 Maximum number of seconds between log flushes
241 --logtostderr=true
244 log to standard error instead of files
245 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
248 Comma-separated list of files to check for machine-id. Use the
249 first one that exists.
250 --match-server-version=false
253 Require server version to match client version
254 -n, --namespace=""
257 If present, the namespace scope for this CLI request
258 --password=""
261 Password for basic authentication to the API server
262 --profile="none"
265 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
266 create|block|mutex)
267 --profile-output="profile.pprof"
270 Name of the file to write the profile to
271 --request-timeout="0"
274 The length of time to wait before giving up on a single server
275 request. Non-zero values should contain a corresponding time unit (e.g.
276 1s, 2m, 3h). A value of zero means don't timeout requests.
277 -s, --server=""
280 The address and port of the Kubernetes API server
281 --skip-headers=false
284 If true, avoid header prefixes in the log messages
285 --skip-log-headers=false
288 If true, avoid headers when opening log files
289 --stderrthreshold=2
292 logs at or above this threshold go to stderr
293 --storage-driver-buffer-duration=1m0s
296 Writes in the storage driver will be buffered for this duration,
297 and committed to the non memory backends as a single transaction
298 --storage-driver-db="cadvisor"
301 database name
302 --storage-driver-host="localhost:8086"
305 database host:port
306 --storage-driver-password="root"
309 database password
310 --storage-driver-secure=false
313 use secure connection with database
314 --storage-driver-table="stats"
317 table name
318 --storage-driver-user="root"
321 database username
322 --token=""
325 Bearer token for authentication to the API server
326 --update-machine-info-interval=5m0s
329 Interval between machine info updates.
330 --user=""
333 The name of the kubeconfig user to use
334 --username=""
337 Username for basic authentication to the API server
338 -v, --v=0
341 number for the log level verbosity
342 --version=false
345 Print version information and quit
346 --vmodule=
349 comma-separated list of pattern=N settings for file-filtered log‐
350 ging
351
355 # Dump current cluster state to stdout
356 kubectl cluster-info dump
357 # Dump current cluster state to /path/to/cluster-state
359 kubectl cluster-info dump --output-directory=/path/to/cluster-state
360 # Dump all namespaces to stdout
362 kubectl cluster-info dump --all-namespaces
363 # Dump a set of namespaces to /path/to/cluster-state
365 kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
366
371 kubectl-cluster-info(1),
372
376 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
377 com) based on the kubernetes source material, but hopefully they have
378 been automatically generated since!
379Eric Paris kubernetes User Manuals KUBERNETES(1)