1OC EX DIAGNOSTICS(1) June 2016 OC EX DIAGNOSTICS(1)
2
6 oc ex diagnostics all - Diagnose common cluster problems
7
11 oc ex diagnostics all [OPTIONS]
12
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 oc ex diagnostics all
22 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
31 --aggregatedlogging-logging-project=""
32 Project that has deployed aggregated logging. Default projects:
33 openshift-logging or logging
34 --appcreate-admission-timeout=10
37 Seconds to wait for the route to be admitted by a router
38 --appcreate-app-image="openshift/origin-deployer:v3.11.0"
41 Image for the test application to be created
42 --appcreate-app-name="diagnostic-appcreate"
45 Name for the test application to be created
46 --appcreate-app-port=8080
49 Port at which the test application listens
50 --appcreate-deploy-timeout=120
53 Seconds to wait for the app to be ready
54 --appcreate-http-retries=10
57 Number of times to retry an HTTP request to the app
58 --appcreate-http-timeout=500
61 Milliseconds to wait for an HTTP request to the app
62 --appcreate-keep-app=false
65 Do not delete the test app when complete
66 --appcreate-keep-project=false
69 Do not delete randomized project when complete
70 --appcreate-node-selector=""
73 Node selector for where the test app should land
74 --appcreate-project=""
77 Project name to use instead of generating from project-base
78 --appcreate-project-base="openshift-diagnostic-appcreate-"
81 Base name to create randomized project name
82 --appcreate-result-dir=""
85 Directory in which to write result details if desired
86 --appcreate-route-host=""
89 Create specific route instead of default
90 --appcreate-route-port=80
93 Router port to use for route connection test
94 --appcreate-skip-route-connect=false
97 Do not test connecting to the route
98 --appcreate-skip-route-test=false
101 Do not test route at all
102 --appcreate-skip-service-connect=false
105 Do not test connecting to the service
106 --cluster-context=""
109 Client context to use for cluster administrator
110 -l, --diaglevel=1
113 Level of diagnostic output: 4: Error, 3: Warn, 2: Notice, 1: Info,
114 0: Debug
115 --diagnosticpod-images="openshift/origin-${component}:${version}"
118 Image template to use in creating a pod
119 --diagnosticpod-latest-images=false
122 If true, when expanding the image template, use latest version, not
123 release version
124 --etcdwritevolume-duration="1m"
127 How long to perform the write test
128 --host=false
131 If true, look for systemd and journald units even without mas‐
132 ter/node config
133 --loglevel=0
136 Set the level of log output (0-10)
137 --logspec=""
140 Set per module logging with file|pattern=LEVEL,...
141 --master-config=""
144 Path to master config file (implies --host)
145 --networkcheck-logdir="/tmp/openshift/"
148 Path to store diagnostic results in case of errors
149 --networkcheck-pod-image=""
152 Override the default diagnostic pod image. Any image with bash and
153 chroot support
154 --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 --networkcheck-test-pod-port=8080
162 Override the default diagnostic test pod port
163 --networkcheck-test-pod-protocol="TCP"
166 Override the default diagnostic test pod protocol
167 --node-config=""
170 Path to node config file (implies --host)
171 --prevent-modification=false
174 If true, may be set to prevent diagnostics making any changes via
175 the API
176
180 --allow_verification_with_non_compliant_keys=false
181 Allow a SignatureVerifier to use keys which are technically
182 non-compliant with RFC6962.
183 --alsologtostderr=false
186 log to standard error as well as files
187 --application_metrics_count_limit=100
190 Max number of application metrics to store (per container)
191 --as=""
194 Username to impersonate for the operation
195 --as-group=[]
198 Group to impersonate for the operation, this flag can be repeated
199 to specify multiple groups.
200 --azure-container-registry-config=""
203 Path to the file containing Azure container registry configuration
204 information.
205 --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 --cache-dir="/builddir/.kube/http-cache"
213 Default HTTP cache directory
214 --certificate-authority=""
217 Path to a cert file for the certificate authority
218 --client-certificate=""
221 Path to a client certificate file for TLS
222 --client-key=""
225 Path to a client key file for TLS
226 --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 --cluster=""
233 The name of the kubeconfig cluster to use
234 --container_hints="/etc/cadvisor/container_hints.json"
237 location of the container hints file
238 --containerd="unix:///var/run/containerd.sock"
241 containerd endpoint
242 --context=""
245 The name of the kubeconfig context to use
246 --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 --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 --docker="unix:///var/run/docker.sock"
261 docker endpoint
262 --docker-tls=false
265 use TLS to connect to docker
266 --docker-tls-ca="ca.pem"
269 path to trusted CA
270 --docker-tls-cert="cert.pem"
273 path to client certificate
274 --docker-tls-key="key.pem"
277 path to private key
278 --docker_env_metadata_whitelist=""
281 a comma-separated list of environment variable keys that needs to
282 be collected for docker containers
283 --docker_only=false
286 Only report docker containers in addition to root stats
287 --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 --enable_load_reader=false
295 Whether to enable cpu load reader
296 --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 --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 --global_housekeeping_interval=0
313 Interval between global housekeepings
314 --housekeeping_interval=0
317 Interval between container housekeepings
318 --httptest.serve=""
321 if non-empty, httptest.NewServer serves on this address and blocks
322 --insecure-skip-tls-verify=false
325 If true, the server's certificate will not be checked for validity.
326 This will make your HTTPS connections insecure
327 --kubeconfig=""
330 Path to the kubeconfig file to use for CLI requests.
331 --log-flush-frequency=0
334 Maximum number of seconds between log flushes
335 --log_backtrace_at=:0
338 when logging hits line file:N, emit a stack trace
339 --log_cadvisor_usage=false
342 Whether to log the usage of the cAdvisor container
343 --log_dir=""
346 If non-empty, write log files in this directory
347 --logtostderr=true
350 log to standard error instead of files
351 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
354 Comma-separated list of files to check for machine-id. Use the
355 first one that exists.
356 --match-server-version=false
359 Require server version to match client version
360 -n, --namespace=""
363 If present, the namespace scope for this CLI request
364 --request-timeout="0"
367 The length of time to wait before giving up on a single server
368 request. Non-zero values should contain a corresponding time unit (e.g.
369 1s, 2m, 3h). A value of zero means don't timeout requests.
370 -s, --server=""
373 The address and port of the Kubernetes API server
374 --stderrthreshold=2
377 logs at or above this threshold go to stderr
378 --storage_driver_buffer_duration=0
381 Writes in the storage driver will be buffered for this duration,
382 and committed to the non memory backends as a single transaction
383 --storage_driver_db="cadvisor"
386 database name
387 --storage_driver_host="localhost:8086"
390 database host:port
391 --storage_driver_password="root"
394 database password
395 --storage_driver_secure=false
398 use secure connection with database
399 --storage_driver_table="stats"
402 table name
403 --storage_driver_user="root"
406 database username
407 --token=""
410 Bearer token for authentication to the API server
411 --user=""
414 The name of the kubeconfig user to use
415 -v, --v=0
418 log level for V logs
419 --version=false
422 Print version information and quit
423 --vmodule=
426 comma-separated list of pattern=N settings for file-filtered log‐
427 ging
428
432 oc-ex-diagnostics(1),
433
437 June 2016, Ported from the Kubernetes man-doc generator
438Openshift Openshift CLI User Manuals OC EX DIAGNOSTICS(1)