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 --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="unix:///var/run/containerd.sock"
126 containerd endpoint
127 --context=""
130 The name of the kubeconfig context to use
131 --default-not-ready-toleration-seconds=300
134 Indicates the tolerationSeconds of the toleration for
135 notReady:NoExecute that is added by default to every pod that does not
136 already have such a toleration.
137 --default-unreachable-toleration-seconds=300
140 Indicates the tolerationSeconds of the toleration for unreach‐
141 able:NoExecute that is added by default to every pod that does not
142 already have such a toleration.
143 --docker="unix:///var/run/docker.sock"
146 docker endpoint
147 --docker-env-metadata-whitelist=""
150 a comma-separated list of environment variable keys that needs to
151 be collected for docker containers
152 --docker-only=false
155 Only report docker containers in addition to root stats
156 --docker-root="/var/lib/docker"
159 DEPRECATED: docker root is read from docker info (this is a fall‐
160 back, default: /var/lib/docker)
161 --docker-tls=false
164 use TLS to connect to docker
165 --docker-tls-ca="ca.pem"
168 path to trusted CA
169 --docker-tls-cert="cert.pem"
172 path to client certificate
173 --docker-tls-key="key.pem"
176 path to private key
177 --enable-load-reader=false
180 Whether to enable cpu load reader
181 --event-storage-age-limit="default=0"
184 Max length of time for which to store events (per type). Value is a
185 comma separated list of key values, where the keys are event types
186 (e.g.: creation, oom) or "default" and the value is a duration. Default
187 is applied to all non-specified event types
188 --event-storage-event-limit="default=0"
191 Max number of events to store (per type). Value is a comma sepa‐
192 rated list of key values, where the keys are event types (e.g.: cre‐
193 ation, oom) or "default" and the value is an integer. Default is
194 applied to all non-specified event types
195 --global-housekeeping-interval=1m0s
198 Interval between global housekeepings
199 --housekeeping-interval=10s
202 Interval between container housekeepings
203 --insecure-skip-tls-verify=false
206 If true, the server's certificate will not be checked for validity.
207 This will make your HTTPS connections insecure
208 --kubeconfig=""
211 Path to the kubeconfig file to use for CLI requests.
212 --log-backtrace-at=:0
215 when logging hits line file:N, emit a stack trace
216 --log-cadvisor-usage=false
219 Whether to log the usage of the cAdvisor container
220 --log-dir=""
223 If non-empty, write log files in this directory
224 --log-file=""
227 If non-empty, use this log file
228 --log-flush-frequency=5s
231 Maximum number of seconds between log flushes
232 --logtostderr=true
235 log to standard error instead of files
236 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
239 Comma-separated list of files to check for machine-id. Use the
240 first one that exists.
241 --match-server-version=false
244 Require server version to match client version
245 --mesos-agent="127.0.0.1:5051"
248 Mesos agent address
249 --mesos-agent-timeout=10s
252 Mesos agent timeout
253 -n, --namespace=""
256 If present, the namespace scope for this CLI request
257 --password=""
260 Password for basic authentication to the API server
261 --profile="none"
264 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
265 create|block|mutex)
266 --profile-output="profile.pprof"
269 Name of the file to write the profile to
270 --request-timeout="0"
273 The length of time to wait before giving up on a single server
274 request. Non-zero values should contain a corresponding time unit (e.g.
275 1s, 2m, 3h). A value of zero means don't timeout requests.
276 -s, --server=""
279 The address and port of the Kubernetes API server
280 --skip-headers=false
283 If true, avoid header prefixes in the log messages
284 --stderrthreshold=2
287 logs at or above this threshold go to stderr
288 --storage-driver-buffer-duration=1m0s
291 Writes in the storage driver will be buffered for this duration,
292 and committed to the non memory backends as a single transaction
293 --storage-driver-db="cadvisor"
296 database name
297 --storage-driver-host="localhost:8086"
300 database host:port
301 --storage-driver-password="root"
304 database password
305 --storage-driver-secure=false
308 use secure connection with database
309 --storage-driver-table="stats"
312 table name
313 --storage-driver-user="root"
316 database username
317 --token=""
320 Bearer token for authentication to the API server
321 --user=""
324 The name of the kubeconfig user to use
325 --username=""
328 Username for basic authentication to the API server
329 -v, --v=0
332 log level for V logs
333 --version=false
336 Print version information and quit
337 --vmodule=
340 comma-separated list of pattern=N settings for file-filtered log‐
341 ging
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!
370Eric Paris kubernetes User Manuals KUBERNETES(1)