1OC ADM(1)                          June 2016                         OC ADM(1)
2
3
4

NAME

6       oc adm diagnostics - Diagnose common cluster problems
7
8
9

SYNOPSIS

11       oc adm diagnostics [OPTIONS]
12
13
14

DESCRIPTION

16       This  utility  helps  troubleshoot  and  diagnose known problems for an
17       OpenShift cluster and/or local host. The base command runs  a  standard
18       set of diagnostics:
19
20
21       oc adm diagnostics
22
23
24       Available  diagnostics  vary based on client config and local OpenShift
25       host config. Config files in standard locations for client, master, and
26       node  are  used, or you may specify config files explicitly with flags.
27       For example:
28
29
30       oc   adm   diagnostics   --master-config=/etc/origin/master/master-con‐
31       fig.yaml
32
33              ·  Explicitly  specifying a config file raises an error if it is
34              not found.
35
36              · A client config with cluster-admin access is required for most
37              cluster diagnostics.
38
39              ·  Diagnostics  that  require a config file are skipped if it is
40              not found.
41
42              · The standard set also skips diagnostics considered too  heavy‐
43              weight.
44
45       An  individual  diagnostic  may  be  run as a subcommand which may have
46       flags for specifying options specific to that diagnostic.
47
48
49       Finally, the "all" subcommand runs all available diagnostics (including
50       heavyweight ones skipped in the standard set) and provides all individ‐
51       ual diagnostic flags.
52
53
54

OPTIONS

56       --cluster-context=""
57           Client context to use for cluster administrator
58
59
60       -l, --diaglevel=1
61           Level of diagnostic output: 4: Error, 3: Warn, 2: Notice, 1:  Info,
62       0: Debug
63
64
65       --host=false
66           If  true,  look  for  systemd  and journald units even without mas‐
67       ter/node config
68
69
70       --loglevel=0
71           Set the level of log output (0-10)
72
73
74       --logspec=""
75           Set per module logging with file|pattern=LEVEL,...
76
77
78       --master-config=""
79           Path to master config file (implies --host)
80
81
82       --node-config=""
83           Path to node config file (implies --host)
84
85
86       --prevent-modification=false
87           If true, may be set to prevent diagnostics making any  changes  via
88       the API
89
90
91

OPTIONS INHERITED FROM PARENT COMMANDS

93       --allow_verification_with_non_compliant_keys=false
94           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
95       non-compliant with RFC6962.
96
97
98       --alsologtostderr=false
99           log to standard error as well as files
100
101
102       --application_metrics_count_limit=100
103           Max number of application metrics to store (per container)
104
105
106       --as=""
107           Username to impersonate for the operation
108
109
110       --as-group=[]
111           Group to impersonate for the operation, this flag can  be  repeated
112       to specify multiple groups.
113
114
115       --azure-container-registry-config=""
116           Path  to the file containing Azure container registry configuration
117       information.
118
119
120       --boot_id_file="/proc/sys/kernel/random/boot_id"
121           Comma-separated list of files to check for boot-id. Use  the  first
122       one that exists.
123
124
125       --cache-dir="/builddir/.kube/http-cache"
126           Default HTTP cache directory
127
128
129       --certificate-authority=""
130           Path to a cert file for the certificate authority
131
132
133       --client-certificate=""
134           Path to a client certificate file for TLS
135
136
137       --client-key=""
138           Path to a client key file for TLS
139
140
141       --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
142           CIDRs opened in GCE firewall for LB traffic proxy  health checks
143
144
145       --cluster=""
146           The name of the kubeconfig cluster to use
147
148
149       --container_hints="/etc/cadvisor/container_hints.json"
150           location of the container hints file
151
152
153       --containerd="unix:///var/run/containerd.sock"
154           containerd endpoint
155
156
157       --context=""
158           The name of the kubeconfig context to use
159
160
161       --default-not-ready-toleration-seconds=300
162           Indicates   the   tolerationSeconds   of   the    toleration    for
163       notReady:NoExecute  that is added by default to every pod that does not
164       already have such a toleration.
165
166
167       --default-unreachable-toleration-seconds=300
168           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
169       able:NoExecute  that  is  added  by  default to every pod that does not
170       already have such a toleration.
171
172
173       --docker="unix:///var/run/docker.sock"
174           docker endpoint
175
176
177       --docker-tls=false
178           use TLS to connect to docker
179
180
181       --docker-tls-ca="ca.pem"
182           path to trusted CA
183
184
185       --docker-tls-cert="cert.pem"
186           path to client certificate
187
188
189       --docker-tls-key="key.pem"
190           path to private key
191
192
193       --docker_env_metadata_whitelist=""
194           a comma-separated list of environment variable keys that  needs  to
195       be collected for docker containers
196
197
198       --docker_only=false
199           Only report docker containers in addition to root stats
200
201
202       --docker_root="/var/lib/docker"
203           DEPRECATED:  docker  root is read from docker info (this is a fall‐
204       back, default: /var/lib/docker)
205
206
207       --enable_load_reader=false
208           Whether to enable cpu load reader
209
210
211       --event_storage_age_limit="default=24h"
212           Max length of time for which to store events (per type). Value is a
213       comma  separated  list  of  key  values, where the keys are event types
214       (e.g.: creation, oom) or "default" and the value is a duration. Default
215       is applied to all non-specified event types
216
217
218       --event_storage_event_limit="default=100000"
219           Max  number  of  events to store (per type). Value is a comma sepa‐
220       rated list of key values, where the keys are event  types  (e.g.:  cre‐
221       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
222       applied to all non-specified event types
223
224
225       --global_housekeeping_interval=0
226           Interval between global housekeepings
227
228
229       --housekeeping_interval=0
230           Interval between container housekeepings
231
232
233       --insecure-skip-tls-verify=false
234           If true, the server's certificate will not be checked for validity.
235       This will make your HTTPS connections insecure
236
237
238       --kubeconfig=""
239           Path to the kubeconfig file to use for CLI requests.
240
241
242       --log-flush-frequency=0
243           Maximum number of seconds between log flushes
244
245
246       --log_backtrace_at=:0
247           when logging hits line file:N, emit a stack trace
248
249
250       --log_cadvisor_usage=false
251           Whether to log the usage of the cAdvisor container
252
253
254       --log_dir=""
255           If non-empty, write log files in this directory
256
257
258       --logtostderr=true
259           log to standard error instead of files
260
261
262       --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
263           Comma-separated  list  of  files  to  check for machine-id. Use the
264       first one that exists.
265
266
267       --match-server-version=false
268           Require server version to match client version
269
270
271       -n, --namespace=""
272           If present, the namespace scope for this CLI request
273
274
275       --request-timeout="0"
276           The length of time to wait before giving  up  on  a  single  server
277       request. Non-zero values should contain a corresponding time unit (e.g.
278       1s, 2m, 3h). A value of zero means don't timeout requests.
279
280
281       -s, --server=""
282           The address and port of the Kubernetes API server
283
284
285       --stderrthreshold=2
286           logs at or above this threshold go to stderr
287
288
289       --storage_driver_buffer_duration=0
290           Writes in the storage driver will be buffered  for  this  duration,
291       and committed to the non memory backends as a single transaction
292
293
294       --storage_driver_db="cadvisor"
295           database name
296
297
298       --storage_driver_host="localhost:8086"
299           database host:port
300
301
302       --storage_driver_password="root"
303           database password
304
305
306       --storage_driver_secure=false
307           use secure connection with database
308
309
310       --storage_driver_table="stats"
311           table name
312
313
314       --storage_driver_user="root"
315           database username
316
317
318       --token=""
319           Bearer token for authentication to the API server
320
321
322       --user=""
323           The name of the kubeconfig user to use
324
325
326       -v, --v=0
327           log level for V logs
328
329
330       --version=false
331           Print version information and quit
332
333
334       --vmodule=
335           comma-separated  list  of pattern=N settings for file-filtered log‐
336       ging
337
338
339

SEE ALSO

341       oc-adm(1),   oc-adm-diagnostics-aggregatedlogging(1),   oc-adm-diagnos‐
342       tics-all(1),     oc-adm-diagnostics-analyzelogs(1),     oc-adm-diagnos‐
343       tics-appcreate(1), oc-adm-diagnostics-clusterregistry(1),  oc-adm-diag‐
344       nostics-clusterrolebindings(1),     oc-adm-diagnostics-clusterroles(1),
345       oc-adm-diagnostics-clusterrouter(1),      oc-adm-diagnostics-configcon‐
346       texts(1), oc-adm-diagnostics-diagnosticpod(1), oc-adm-diagnostics-etcd‐
347       writevolume(1), oc-adm-diagnostics-inpod-networkcheck(1),  oc-adm-diag‐
348       nostics-inpod-poddiagnostic(1),       oc-adm-diagnostics-masternode(1),
349       oc-adm-diagnostics-metricsapiproxy(1),          oc-adm-diagnostics-net‐
350       workcheck(1),   oc-adm-diagnostics-nodedefinitions(1),  oc-adm-diagnos‐
351       tics-routecertificatevalidation(1),     oc-adm-diagnostics-securitycon‐
352       textconstraints(1),           oc-adm-diagnostics-serviceexternalips(1),
353       oc-adm-diagnostics-unitstatus(1),
354
355
356

HISTORY

358       June 2016, Ported from the Kubernetes man-doc generator
359
360
361
362Openshift                  Openshift CLI User Manuals                OC ADM(1)
Impressum