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

NAME

6       oc status - Show an overview of the current project
7
8
9

SYNOPSIS

11       oc status [OPTIONS]
12
13
14

DESCRIPTION

16       Show a high level overview of the current project
17
18
19       This  command  will show services, deployment configs, build configura‐
20       tions, and active deployments. If you have any misconfigured components
21       information  about them will be shown. For more information about indi‐
22       vidual items, use the describe command (e.g. oc  describe  buildConfig,
23       oc describe deploymentConfig, oc describe service).
24
25
26       You  can specify an output format of "-o dot" to have this command out‐
27       put the generated status graph in DOT format that is suitable  for  use
28       by the "dot" command.
29
30
31

OPTIONS

33       --all-namespaces=false
34           If  true,  display  status  for  all  namespaces (must have cluster
35       admin)
36
37
38       -o, --output=""
39           Output format. One of: dot.
40
41
42       --suggest=false
43           See details for resolving issues.
44
45
46

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

300                # See an overview of the current project.
301                oc status
302
303                # Export the overview of the current project in an svg file.
304                oc status -o dot | dot -T svg -o project.svg
305
306                # See an overview of the current project including details for any identified issues.
307                oc status --suggest
308
309
310
311

SEE ALSO

313       oc(1),
314
315
316

HISTORY

318       June 2016, Ported from the Kubernetes man-doc generator
319
320
321
322Openshift                  Openshift CLI User Manuals                    OC(1)
Impressum