1OC EX DIAGNOSTICS(1)               June 2016              OC EX DIAGNOSTICS(1)
2
3
4

NAME

6       oc ex diagnostics all - Diagnose common cluster problems
7
8
9

SYNOPSIS

11       oc ex diagnostics all [OPTIONS]
12
13
14

DESCRIPTION

16       This  utility  helps  troubleshoot  and  diagnose known problems for an
17       OpenShift cluster and/or local host. This subcommand exists to run  all
18       available diagnostics:
19
20
21       oc ex diagnostics all
22
23
24       Available  diagnostics  vary based on client config and local OpenShift
25       host config. All flags from the base command work similarly  here,  but
26       all possible flags for individual diagnostics are also available.
27
28
29

OPTIONS

31       --aggregatedlogging-logging-project=""
32           Project  that  has  deployed  aggregated logging. Default projects:
33       openshift-logging or logging
34
35
36       --appcreate-admission-timeout=10
37           Seconds to wait for the route to be admitted by a router
38
39
40       --appcreate-app-image="openshift/origin-deployer:v3.11.0"
41           Image for the test application to be created
42
43
44       --appcreate-app-name="diagnostic-appcreate"
45           Name for the test application to be created
46
47
48       --appcreate-app-port=8080
49           Port at which the test application listens
50
51
52       --appcreate-deploy-timeout=120
53           Seconds to wait for the app to be ready
54
55
56       --appcreate-http-retries=10
57           Number of times to retry an HTTP request to the app
58
59
60       --appcreate-http-timeout=500
61           Milliseconds to wait for an HTTP request to the app
62
63
64       --appcreate-keep-app=false
65           Do not delete the test app when complete
66
67
68       --appcreate-keep-project=false
69           Do not delete randomized project when complete
70
71
72       --appcreate-node-selector=""
73           Node selector for where the test app should land
74
75
76       --appcreate-project=""
77           Project name to use instead of generating from project-base
78
79
80       --appcreate-project-base="openshift-diagnostic-appcreate-"
81           Base name to create randomized project name
82
83
84       --appcreate-result-dir=""
85           Directory in which to write result details if desired
86
87
88       --appcreate-route-host=""
89           Create specific route instead of default
90
91
92       --appcreate-route-port=80
93           Router port to use for route connection test
94
95
96       --appcreate-skip-route-connect=false
97           Do not test connecting to the route
98
99
100       --appcreate-skip-route-test=false
101           Do not test route at all
102
103
104       --appcreate-skip-service-connect=false
105           Do not test connecting to the service
106
107
108       --cluster-context=""
109           Client context to use for cluster administrator
110
111
112       -l, --diaglevel=1
113           Level of diagnostic output: 4: Error, 3: Warn, 2: Notice, 1:  Info,
114       0: Debug
115
116
117       --diagnosticpod-images="openshift/origin-${component}:${version}"
118           Image template to use in creating a pod
119
120
121       --diagnosticpod-latest-images=false
122           If true, when expanding the image template, use latest version, not
123       release version
124
125
126       --etcdwritevolume-duration="1m"
127           How long to perform the write test
128
129
130       --host=false
131           If true, look for systemd and  journald  units  even  without  mas‐
132       ter/node config
133
134
135       --loglevel=0
136           Set the level of log output (0-10)
137
138
139       --logspec=""
140           Set per module logging with file|pattern=LEVEL,...
141
142
143       --master-config=""
144           Path to master config file (implies --host)
145
146
147       --networkcheck-logdir="/tmp/openshift/"
148           Path to store diagnostic results in case of errors
149
150
151       --networkcheck-pod-image=""
152           Override  the default diagnostic pod image. Any image with bash and
153       chroot support
154
155
156       --networkcheck-test-pod-image=""
157           Override the default diagnostic test  pod  image.  Any  image  that
158       accepts protocol --test-pod-protocol on port --test-pod-port
159
160
161       --networkcheck-test-pod-port=8080
162           Override the default diagnostic test pod port
163
164
165       --networkcheck-test-pod-protocol="TCP"
166           Override the default diagnostic test pod protocol
167
168
169       --node-config=""
170           Path to node config file (implies --host)
171
172
173       --prevent-modification=false
174           If  true,  may be set to prevent diagnostics making any changes via
175       the API
176
177
178

OPTIONS INHERITED FROM PARENT COMMANDS

180       --allow_verification_with_non_compliant_keys=false
181           Allow  a  SignatureVerifier  to  use  keys  which  are  technically
182       non-compliant with RFC6962.
183
184
185       --alsologtostderr=false
186           log to standard error as well as files
187
188
189       --application_metrics_count_limit=100
190           Max number of application metrics to store (per container)
191
192
193       --as=""
194           Username to impersonate for the operation
195
196
197       --as-group=[]
198           Group  to  impersonate for the operation, this flag can be repeated
199       to specify multiple groups.
200
201
202       --azure-container-registry-config=""
203           Path to the file containing Azure container registry  configuration
204       information.
205
206
207       --boot_id_file="/proc/sys/kernel/random/boot_id"
208           Comma-separated  list  of files to check for boot-id. Use the first
209       one that exists.
210
211
212       --cache-dir="/builddir/.kube/http-cache"
213           Default HTTP cache directory
214
215
216       --certificate-authority=""
217           Path to a cert file for the certificate authority
218
219
220       --client-certificate=""
221           Path to a client certificate file for TLS
222
223
224       --client-key=""
225           Path to a client key file for TLS
226
227
228       --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
229           CIDRs opened in GCE firewall for LB traffic proxy  health checks
230
231
232       --cluster=""
233           The name of the kubeconfig cluster to use
234
235
236       --container_hints="/etc/cadvisor/container_hints.json"
237           location of the container hints file
238
239
240       --containerd="unix:///var/run/containerd.sock"
241           containerd endpoint
242
243
244       --context=""
245           The name of the kubeconfig context to use
246
247
248       --default-not-ready-toleration-seconds=300
249           Indicates    the    tolerationSeconds   of   the   toleration   for
250       notReady:NoExecute that is added by default to every pod that does  not
251       already have such a toleration.
252
253
254       --default-unreachable-toleration-seconds=300
255           Indicates  the  tolerationSeconds  of  the  toleration for unreach‐
256       able:NoExecute that is added by default to  every  pod  that  does  not
257       already have such a toleration.
258
259
260       --docker="unix:///var/run/docker.sock"
261           docker endpoint
262
263
264       --docker-tls=false
265           use TLS to connect to docker
266
267
268       --docker-tls-ca="ca.pem"
269           path to trusted CA
270
271
272       --docker-tls-cert="cert.pem"
273           path to client certificate
274
275
276       --docker-tls-key="key.pem"
277           path to private key
278
279
280       --docker_env_metadata_whitelist=""
281           a  comma-separated  list of environment variable keys that needs to
282       be collected for docker containers
283
284
285       --docker_only=false
286           Only report docker containers in addition to root stats
287
288
289       --docker_root="/var/lib/docker"
290           DEPRECATED: docker root is read from docker info (this is  a  fall‐
291       back, default: /var/lib/docker)
292
293
294       --enable_load_reader=false
295           Whether to enable cpu load reader
296
297
298       --event_storage_age_limit="default=24h"
299           Max length of time for which to store events (per type). Value is a
300       comma separated list of key values, where  the  keys  are  event  types
301       (e.g.: creation, oom) or "default" and the value is a duration. Default
302       is applied to all non-specified event types
303
304
305       --event_storage_event_limit="default=100000"
306           Max number of events to store (per type). Value is  a  comma  sepa‐
307       rated  list  of  key values, where the keys are event types (e.g.: cre‐
308       ation, oom) or "default" and  the  value  is  an  integer.  Default  is
309       applied to all non-specified event types
310
311
312       --global_housekeeping_interval=0
313           Interval between global housekeepings
314
315
316       --housekeeping_interval=0
317           Interval between container housekeepings
318
319
320       --insecure-skip-tls-verify=false
321           If true, the server's certificate will not be checked for validity.
322       This will make your HTTPS connections insecure
323
324
325       --kubeconfig=""
326           Path to the kubeconfig file to use for CLI requests.
327
328
329       --log-flush-frequency=0
330           Maximum number of seconds between log flushes
331
332
333       --log_backtrace_at=:0
334           when logging hits line file:N, emit a stack trace
335
336
337       --log_cadvisor_usage=false
338           Whether to log the usage of the cAdvisor container
339
340
341       --log_dir=""
342           If non-empty, write log files in this directory
343
344
345       --logtostderr=true
346           log to standard error instead of files
347
348
349       --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
350           Comma-separated list of files to  check  for  machine-id.  Use  the
351       first one that exists.
352
353
354       --match-server-version=false
355           Require server version to match client version
356
357
358       -n, --namespace=""
359           If present, the namespace scope for this CLI request
360
361
362       --request-timeout="0"
363           The  length  of  time  to  wait before giving up on a single server
364       request. Non-zero values should contain a corresponding time unit (e.g.
365       1s, 2m, 3h). A value of zero means don't timeout requests.
366
367
368       -s, --server=""
369           The address and port of the Kubernetes API server
370
371
372       --stderrthreshold=2
373           logs at or above this threshold go to stderr
374
375
376       --storage_driver_buffer_duration=0
377           Writes  in  the  storage driver will be buffered for this duration,
378       and committed to the non memory backends as a single transaction
379
380
381       --storage_driver_db="cadvisor"
382           database name
383
384
385       --storage_driver_host="localhost:8086"
386           database host:port
387
388
389       --storage_driver_password="root"
390           database password
391
392
393       --storage_driver_secure=false
394           use secure connection with database
395
396
397       --storage_driver_table="stats"
398           table name
399
400
401       --storage_driver_user="root"
402           database username
403
404
405       --token=""
406           Bearer token for authentication to the API server
407
408
409       --user=""
410           The name of the kubeconfig user to use
411
412
413       -v, --v=0
414           log level for V logs
415
416
417       --version=false
418           Print version information and quit
419
420
421       --vmodule=
422           comma-separated list of pattern=N settings for  file-filtered  log‐
423       ging
424
425
426

SEE ALSO

428       oc-ex-diagnostics(1),
429
430
431

HISTORY

433       June 2016, Ported from the Kubernetes man-doc generator
434
435
436
437Openshift                  Openshift CLI User Manuals     OC EX DIAGNOSTICS(1)
Impressum