1OC EX(1) June 2016 OC EX(1)
2
6 oc ex diagnostics - Diagnose common cluster problems
7
11 oc ex diagnostics [OPTIONS]
12
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 oc ex diagnostics
22 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 oc ex diagnostics --master-config=/etc/origin/master/master-config.yaml
31 · Explicitly specifying a config file raises an error if it is
33 not found.
34 · A client config with cluster-admin access is required for most
36 cluster diagnostics.
37 · Diagnostics that require a config file are skipped if it is
39 not found.
40 · The standard set also skips diagnostics considered too heavy‐
42 weight.
43 An individual diagnostic may be run as a subcommand which may have
45 flags for specifying options specific to that diagnostic.
46 Finally, the "all" subcommand runs all available diagnostics (including
49 heavyweight ones skipped in the standard set) and provides all individ‐
50 ual diagnostic flags.
51
55 --cluster-context=""
56 Client context to use for cluster administrator
57 -l, --diaglevel=1
60 Level of diagnostic output: 4: Error, 3: Warn, 2: Notice, 1: Info,
61 0: Debug
62 --host=false
65 If true, look for systemd and journald units even without mas‐
66 ter/node config
67 --loglevel=0
70 Set the level of log output (0-10)
71 --logspec=""
74 Set per module logging with file|pattern=LEVEL,...
75 --master-config=""
78 Path to master config file (implies --host)
79 --node-config=""
82 Path to node config file (implies --host)
83 --prevent-modification=false
86 If true, may be set to prevent diagnostics making any changes via
87 the API
88
92 --allow_verification_with_non_compliant_keys=false
93 Allow a SignatureVerifier to use keys which are technically
94 non-compliant with RFC6962.
95 --alsologtostderr=false
98 log to standard error as well as files
99 --application_metrics_count_limit=100
102 Max number of application metrics to store (per container)
103 --as=""
106 Username to impersonate for the operation
107 --as-group=[]
110 Group to impersonate for the operation, this flag can be repeated
111 to specify multiple groups.
112 --azure-container-registry-config=""
115 Path to the file containing Azure container registry configuration
116 information.
117 --boot_id_file="/proc/sys/kernel/random/boot_id"
120 Comma-separated list of files to check for boot-id. Use the first
121 one that exists.
122 --cache-dir="/builddir/.kube/http-cache"
125 Default HTTP cache directory
126 --certificate-authority=""
129 Path to a cert file for the certificate authority
130 --client-certificate=""
133 Path to a client certificate file for TLS
134 --client-key=""
137 Path to a client key file for TLS
138 --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
141 CIDRs opened in GCE firewall for LB traffic proxy health checks
142 --cluster=""
145 The name of the kubeconfig cluster to use
146 --container_hints="/etc/cadvisor/container_hints.json"
149 location of the container hints file
150 --containerd="unix:///var/run/containerd.sock"
153 containerd endpoint
154 --context=""
157 The name of the kubeconfig context to use
158 --default-not-ready-toleration-seconds=300
161 Indicates the tolerationSeconds of the toleration for
162 notReady:NoExecute that is added by default to every pod that does not
163 already have such a toleration.
164 --default-unreachable-toleration-seconds=300
167 Indicates the tolerationSeconds of the toleration for unreach‐
168 able:NoExecute that is added by default to every pod that does not
169 already have such a toleration.
170 --docker="unix:///var/run/docker.sock"
173 docker endpoint
174 --docker-tls=false
177 use TLS to connect to docker
178 --docker-tls-ca="ca.pem"
181 path to trusted CA
182 --docker-tls-cert="cert.pem"
185 path to client certificate
186 --docker-tls-key="key.pem"
189 path to private key
190 --docker_env_metadata_whitelist=""
193 a comma-separated list of environment variable keys that needs to
194 be collected for docker containers
195 --docker_only=false
198 Only report docker containers in addition to root stats
199 --docker_root="/var/lib/docker"
202 DEPRECATED: docker root is read from docker info (this is a fall‐
203 back, default: /var/lib/docker)
204 --enable_load_reader=false
207 Whether to enable cpu load reader
208 --event_storage_age_limit="default=24h"
211 Max length of time for which to store events (per type). Value is a
212 comma separated list of key values, where the keys are event types
213 (e.g.: creation, oom) or "default" and the value is a duration. Default
214 is applied to all non-specified event types
215 --event_storage_event_limit="default=100000"
218 Max number of events to store (per type). Value is a comma sepa‐
219 rated list of key values, where the keys are event types (e.g.: cre‐
220 ation, oom) or "default" and the value is an integer. Default is
221 applied to all non-specified event types
222 --global_housekeeping_interval=0
225 Interval between global housekeepings
226 --housekeeping_interval=0
229 Interval between container housekeepings
230 --httptest.serve=""
233 if non-empty, httptest.NewServer serves on this address and blocks
234 --insecure-skip-tls-verify=false
237 If true, the server's certificate will not be checked for validity.
238 This will make your HTTPS connections insecure
239 --kubeconfig=""
242 Path to the kubeconfig file to use for CLI requests.
243 --log-flush-frequency=0
246 Maximum number of seconds between log flushes
247 --log_backtrace_at=:0
250 when logging hits line file:N, emit a stack trace
251 --log_cadvisor_usage=false
254 Whether to log the usage of the cAdvisor container
255 --log_dir=""
258 If non-empty, write log files in this directory
259 --logtostderr=true
262 log to standard error instead of files
263 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
266 Comma-separated list of files to check for machine-id. Use the
267 first one that exists.
268 --match-server-version=false
271 Require server version to match client version
272 -n, --namespace=""
275 If present, the namespace scope for this CLI request
276 --request-timeout="0"
279 The length of time to wait before giving up on a single server
280 request. Non-zero values should contain a corresponding time unit (e.g.
281 1s, 2m, 3h). A value of zero means don't timeout requests.
282 -s, --server=""
285 The address and port of the Kubernetes API server
286 --stderrthreshold=2
289 logs at or above this threshold go to stderr
290 --storage_driver_buffer_duration=0
293 Writes in the storage driver will be buffered for this duration,
294 and committed to the non memory backends as a single transaction
295 --storage_driver_db="cadvisor"
298 database name
299 --storage_driver_host="localhost:8086"
302 database host:port
303 --storage_driver_password="root"
306 database password
307 --storage_driver_secure=false
310 use secure connection with database
311 --storage_driver_table="stats"
314 table name
315 --storage_driver_user="root"
318 database username
319 --token=""
322 Bearer token for authentication to the API server
323 --user=""
326 The name of the kubeconfig user to use
327 -v, --v=0
330 log level for V logs
331 --version=false
334 Print version information and quit
335 --vmodule=
338 comma-separated list of pattern=N settings for file-filtered log‐
339 ging
340
344 oc-ex(1), oc-ex-diagnostics-aggregatedlogging(1), oc-ex-diagnos‐
345 tics-all(1), oc-ex-diagnostics-analyzelogs(1), oc-ex-diagnos‐
346 tics-appcreate(1), oc-ex-diagnostics-clusterregistry(1), oc-ex-diagnos‐
347 tics-clusterrolebindings(1), oc-ex-diagnostics-clusterroles(1),
348 oc-ex-diagnostics-clusterrouter(1), oc-ex-diagnostics-configcon‐
349 texts(1), oc-ex-diagnostics-diagnosticpod(1), oc-ex-diagnostics-etcd‐
350 writevolume(1), oc-ex-diagnostics-inpod-networkcheck(1), oc-ex-diagnos‐
351 tics-inpod-poddiagnostic(1), oc-ex-diagnostics-masternode(1),
352 oc-ex-diagnostics-metricsapiproxy(1), oc-ex-diagnostics-net‐
353 workcheck(1), oc-ex-diagnostics-nodedefinitions(1), oc-ex-diagnos‐
354 tics-routecertificatevalidation(1), oc-ex-diagnostics-securitycon‐
355 textconstraints(1), oc-ex-diagnostics-serviceexternalips(1),
356 oc-ex-diagnostics-unitstatus(1),
357
361 June 2016, Ported from the Kubernetes man-doc generator
362Openshift Openshift CLI User Manuals OC EX(1)