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|template|go-template|go-tem‐
49 plate-file|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 --allow-verification-with-non-compliant-keys=false
71 Allow a SignatureVerifier to use keys which are technically
72 non-compliant with RFC6962.
73 --alsologtostderr=false
76 log to standard error as well as files
77 --application-metrics-count-limit=100
80 Max number of application metrics to store (per container)
81 --as=""
84 Username to impersonate for the operation
85 --as-group=[]
88 Group to impersonate for the operation, this flag can be repeated
89 to specify multiple groups.
90 --azure-container-registry-config=""
93 Path to the file containing Azure container registry configuration
94 information.
95 --boot-id-file="/proc/sys/kernel/random/boot_id"
98 Comma-separated list of files to check for boot-id. Use the first
99 one that exists.
100 --cache-dir="/builddir/.kube/http-cache"
103 Default HTTP cache directory
104 --certificate-authority=""
107 Path to a cert file for the certificate authority
108 --client-certificate=""
111 Path to a client certificate file for TLS
112 --client-key=""
115 Path to a client key file for TLS
116 --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
119 CIDRs opened in GCE firewall for LB traffic proxy health checks
120 --cluster=""
123 The name of the kubeconfig cluster to use
124 --container-hints="/etc/cadvisor/container_hints.json"
127 location of the container hints file
128 --containerd="unix:///var/run/containerd.sock"
131 containerd endpoint
132 --context=""
135 The name of the kubeconfig context to use
136 --default-not-ready-toleration-seconds=300
139 Indicates the tolerationSeconds of the toleration for
140 notReady:NoExecute that is added by default to every pod that does not
141 already have such a toleration.
142 --default-unreachable-toleration-seconds=300
145 Indicates the tolerationSeconds of the toleration for unreach‐
146 able:NoExecute that is added by default to every pod that does not
147 already have such a toleration.
148 --docker="unix:///var/run/docker.sock"
151 docker endpoint
152 --docker-env-metadata-whitelist=""
155 a comma-separated list of environment variable keys that needs to
156 be collected for docker containers
157 --docker-only=false
160 Only report docker containers in addition to root stats
161 --docker-root="/var/lib/docker"
164 DEPRECATED: docker root is read from docker info (this is a fall‐
165 back, default: /var/lib/docker)
166 --docker-tls=false
169 use TLS to connect to docker
170 --docker-tls-ca="ca.pem"
173 path to trusted CA
174 --docker-tls-cert="cert.pem"
177 path to client certificate
178 --docker-tls-key="key.pem"
181 path to private key
182 --enable-load-reader=false
185 Whether to enable cpu load reader
186 --event-storage-age-limit="default=0"
189 Max length of time for which to store events (per type). Value is a
190 comma separated list of key values, where the keys are event types
191 (e.g.: creation, oom) or "default" and the value is a duration. Default
192 is applied to all non-specified event types
193 --event-storage-event-limit="default=0"
196 Max number of events to store (per type). Value is a comma sepa‐
197 rated list of key values, where the keys are event types (e.g.: cre‐
198 ation, oom) or "default" and the value is an integer. Default is
199 applied to all non-specified event types
200 --global-housekeeping-interval=1m0s
203 Interval between global housekeepings
204 --google-json-key=""
207 The Google Cloud Platform Service Account JSON Key to use for
208 authentication.
209 --housekeeping-interval=10s
212 Interval between container housekeepings
213 --insecure-skip-tls-verify=false
216 If true, the server's certificate will not be checked for validity.
217 This will make your HTTPS connections insecure
218 --kubeconfig=""
221 Path to the kubeconfig file to use for CLI requests.
222 --log-backtrace-at=:0
225 when logging hits line file:N, emit a stack trace
226 --log-cadvisor-usage=false
229 Whether to log the usage of the cAdvisor container
230 --log-dir=""
233 If non-empty, write log files in this directory
234 --log-flush-frequency=5s
237 Maximum number of seconds between log flushes
238 --logtostderr=true
241 log to standard error instead of files
242 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
245 Comma-separated list of files to check for machine-id. Use the
246 first one that exists.
247 --match-server-version=false
250 Require server version to match client version
251 --mesos-agent="127.0.0.1:5051"
254 Mesos agent address
255 --mesos-agent-timeout=10s
258 Mesos agent timeout
259 -n, --namespace=""
262 If present, the namespace scope for this CLI request
263 --request-timeout="0"
266 The length of time to wait before giving up on a single server
267 request. Non-zero values should contain a corresponding time unit (e.g.
268 1s, 2m, 3h). A value of zero means don't timeout requests.
269 -s, --server=""
272 The address and port of the Kubernetes API server
273 --stderrthreshold=2
276 logs at or above this threshold go to stderr
277 --storage-driver-buffer-duration=1m0s
280 Writes in the storage driver will be buffered for this duration,
281 and committed to the non memory backends as a single transaction
282 --storage-driver-db="cadvisor"
285 database name
286 --storage-driver-host="localhost:8086"
289 database host:port
290 --storage-driver-password="root"
293 database password
294 --storage-driver-secure=false
297 use secure connection with database
298 --storage-driver-table="stats"
301 table name
302 --storage-driver-user="root"
305 database username
306 --token=""
309 Bearer token for authentication to the API server
310 --user=""
313 The name of the kubeconfig user to use
314 -v, --v=0
317 log level for V logs
318 --version=false
321 Print version information and quit
322 --vmodule=
325 comma-separated list of pattern=N settings for file-filtered log‐
326 ging
327
331 # Dump current cluster state to stdout
332 kubectl cluster-info dump
333 # Dump current cluster state to /path/to/cluster-state
335 kubectl cluster-info dump --output-directory=/path/to/cluster-state
336 # Dump all namespaces to stdout
338 kubectl cluster-info dump --all-namespaces
339 # Dump a set of namespaces to /path/to/cluster-state
341 kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
342
347 kubectl-cluster-info(1),
348
352 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
353 com) based on the kubernetes source material, but hopefully they have
354 been automatically generated since!
355Eric Paris kubernetes User Manuals KUBERNETES(1)