1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl cluster-info dump - Dump relevant information for debugging and
10       diagnosis
11
12
13

SYNOPSIS

15       kubectl cluster-info dump [OPTIONS]
16
17
18

DESCRIPTION

20       Dump cluster information out  suitable  for  debugging  and  diagnosing
21       cluster  problems.  By default, dumps everything to stdout. You can op‐
22       tionally specify a directory with --output-directory.  If you specify a
23       directory,  Kubernetes will build a set of files in that directory.  By
24       default, only dumps things in the current namespace  and  'kube-system'
25       namespace, but you can switch to a different namespace with the --name‐
26       spaces flag, or specify --all-namespaces to dump all namespaces.
27
28
29       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
33
34

OPTIONS

36       -A, --all-namespaces=false      If true, dump all namespaces.  If true,
37       --namespaces is ignored.
38
39
40       --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
44
45       --namespaces=[]      A comma separated list of namespaces to dump.
46
47
48       -o,  --output="json"      Output format. One of: (json, yaml, name, go-
49       template, go-template-file, template, templatefile, jsonpath, jsonpath-
50       as-json, jsonpath-file).
51
52
53       --output-directory=""       Where to output the files.  If empty or '-'
54       uses stdout, otherwise creates a directory hierarchy in that directory
55
56
57       --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
60
61       --show-managed-fields=false       If  true, keep the managedFields when
62       printing objects in JSON or YAML format.
63
64
65       --template=""      Template string or path to template file to use when
66       -o=go-template, -o=go-template-file. The template format is golang tem‐
67       plates [http://golang.org/pkg/text/template/#pkg-overview].
68
69
70

OPTIONS INHERITED FROM PARENT COMMANDS

72       --as=""      Username to impersonate for the operation. User could be a
73       regular user or a service account in a namespace.
74
75
76       --as-group=[]       Group  to  impersonate for the operation, this flag
77       can be repeated to specify multiple groups.
78
79
80       --as-uid=""      UID to impersonate for the operation.
81
82
83       --azure-container-registry-config=""      Path to the  file  containing
84       Azure container registry configuration information.
85
86
87       --cache-dir="/builddir/.kube/cache"      Default cache directory
88
89
90       --certificate-authority=""      Path to a cert file for the certificate
91       authority
92
93
94       --client-certificate=""      Path to a client certificate file for TLS
95
96
97       --client-key=""      Path to a client key file for TLS
98
99
100       --cluster=""      The name of the kubeconfig cluster to use
101
102
103       --context=""      The name of the kubeconfig context to use
104
105
106       --insecure-skip-tls-verify=false      If true, the server's certificate
107       will not be checked for validity. This will make your HTTPS connections
108       insecure
109
110
111       --kubeconfig=""      Path to the kubeconfig file to  use  for  CLI  re‐
112       quests.
113
114
115       --match-server-version=false        Require  server  version  to  match
116       client version
117
118
119       -n, --namespace=""      If present, the namespace scope  for  this  CLI
120       request
121
122
123       --password=""      Password for basic authentication to the API server
124
125
126       --profile="none"         Name   of   profile   to   capture.   One   of
127       (none|cpu|heap|goroutine|threadcreate|block|mutex)
128
129
130       --profile-output="profile.pprof"      Name of the  file  to  write  the
131       profile to
132
133
134       --request-timeout="0"       The length of time to wait before giving up
135       on a single server request. Non-zero values  should  contain  a  corre‐
136       sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
137       out requests.
138
139
140       -s, --server=""      The address and port of the Kubernetes API server
141
142
143       --tls-server-name=""      Server name to  use  for  server  certificate
144       validation.  If  it  is  not provided, the hostname used to contact the
145       server is used
146
147
148       --token=""      Bearer token for authentication to the API server
149
150
151       --user=""      The name of the kubeconfig user to use
152
153
154       --username=""      Username for basic authentication to the API server
155
156
157       --version=false      Print version information and quit
158
159
160       --warnings-as-errors=false      Treat warnings received from the server
161       as errors and exit with a non-zero exit code
162
163
164

EXAMPLE

166                # Dump current cluster state to stdout
167                kubectl cluster-info dump
168
169                # Dump current cluster state to /path/to/cluster-state
170                kubectl cluster-info dump --output-directory=/path/to/cluster-state
171
172                # Dump all namespaces to stdout
173                kubectl cluster-info dump --all-namespaces
174
175                # Dump a set of namespaces to /path/to/cluster-state
176                kubectl cluster-info dump --namespaces default,kube-system --output-directory=/path/to/cluster-state
177
178
179
180

SEE ALSO

182       kubectl-cluster-info(1),
183
184
185

HISTORY

187       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
188       com) based on the kubernetes source material, but hopefully  they  have
189       been automatically generated since!
190
191
192
193Manuals                              User            KUBERNETES(1)(kubernetes)
Impressum