1OC(1) June 2016 OC(1)
2
6 oc describe - Show details of a specific resource or group of resources
7
11 oc describe [OPTIONS]
12
16 Show details of a specific resource
17 This command joins many API calls together to form a detailed descrip‐
20 tion of a given resource.
21
25 --all-namespaces=false
26 If present, list the requested object(s) across all namespaces.
27 Namespace in current context is ignored even if specified with --names‐
28 pace.
29 -f, --filename=[]
32 Filename, directory, or URL to files containing the resource to
33 describe
34 --include-uninitialized=false
37 If true, the kubectl command applies to uninitialized objects. If
38 explicitly set to false, this flag overrides other flags that make the
39 kubectl commands apply to uninitialized objects, e.g., "--all". Objects
40 with empty metadata.initializers are regarded as initialized.
41 -R, --recursive=false
44 Process the directory used in -f, --filename recursively. Useful
45 when you want to manage related manifests organized within the same
46 directory.
47 -l, --selector=""
50 Selector (label query) to filter on, supports '=', '==', and
51 '!='.(e.g. -l key1=value1,key2=value2)
52 --show-events=true
55 If true, display events related to the described object.
56
60 --allow_verification_with_non_compliant_keys=false
61 Allow a SignatureVerifier to use keys which are technically
62 non-compliant with RFC6962.
63 --alsologtostderr=false
66 log to standard error as well as files
67 --application_metrics_count_limit=100
70 Max number of application metrics to store (per container)
71 --as=""
74 Username to impersonate for the operation
75 --as-group=[]
78 Group to impersonate for the operation, this flag can be repeated
79 to specify multiple groups.
80 --azure-container-registry-config=""
83 Path to the file containing Azure container registry configuration
84 information.
85 --boot_id_file="/proc/sys/kernel/random/boot_id"
88 Comma-separated list of files to check for boot-id. Use the first
89 one that exists.
90 --cache-dir="/builddir/.kube/http-cache"
93 Default HTTP cache directory
94 --certificate-authority=""
97 Path to a cert file for the certificate authority
98 --client-certificate=""
101 Path to a client certificate file for TLS
102 --client-key=""
105 Path to a client key file for TLS
106 --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
109 CIDRs opened in GCE firewall for LB traffic proxy health checks
110 --cluster=""
113 The name of the kubeconfig cluster to use
114 --container_hints="/etc/cadvisor/container_hints.json"
117 location of the container hints file
118 --containerd="unix:///var/run/containerd.sock"
121 containerd endpoint
122 --context=""
125 The name of the kubeconfig context to use
126 --default-not-ready-toleration-seconds=300
129 Indicates the tolerationSeconds of the toleration for
130 notReady:NoExecute that is added by default to every pod that does not
131 already have such a toleration.
132 --default-unreachable-toleration-seconds=300
135 Indicates the tolerationSeconds of the toleration for unreach‐
136 able:NoExecute that is added by default to every pod that does not
137 already have such a toleration.
138 --docker="unix:///var/run/docker.sock"
141 docker endpoint
142 --docker-tls=false
145 use TLS to connect to docker
146 --docker-tls-ca="ca.pem"
149 path to trusted CA
150 --docker-tls-cert="cert.pem"
153 path to client certificate
154 --docker-tls-key="key.pem"
157 path to private key
158 --docker_env_metadata_whitelist=""
161 a comma-separated list of environment variable keys that needs to
162 be collected for docker containers
163 --docker_only=false
166 Only report docker containers in addition to root stats
167 --docker_root="/var/lib/docker"
170 DEPRECATED: docker root is read from docker info (this is a fall‐
171 back, default: /var/lib/docker)
172 --enable_load_reader=false
175 Whether to enable cpu load reader
176 --event_storage_age_limit="default=24h"
179 Max length of time for which to store events (per type). Value is a
180 comma separated list of key values, where the keys are event types
181 (e.g.: creation, oom) or "default" and the value is a duration. Default
182 is applied to all non-specified event types
183 --event_storage_event_limit="default=100000"
186 Max number of events to store (per type). Value is a comma sepa‐
187 rated list of key values, where the keys are event types (e.g.: cre‐
188 ation, oom) or "default" and the value is an integer. Default is
189 applied to all non-specified event types
190 --global_housekeeping_interval=0
193 Interval between global housekeepings
194 --housekeeping_interval=0
197 Interval between container housekeepings
198 --insecure-skip-tls-verify=false
201 If true, the server's certificate will not be checked for validity.
202 This will make your HTTPS connections insecure
203 --kubeconfig=""
206 Path to the kubeconfig file to use for CLI requests.
207 --log-flush-frequency=0
210 Maximum number of seconds between log flushes
211 --log_backtrace_at=:0
214 when logging hits line file:N, emit a stack trace
215 --log_cadvisor_usage=false
218 Whether to log the usage of the cAdvisor container
219 --log_dir=""
222 If non-empty, write log files in this directory
223 --logtostderr=true
226 log to standard error instead of files
227 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
230 Comma-separated list of files to check for machine-id. Use the
231 first one that exists.
232 --match-server-version=false
235 Require server version to match client version
236 -n, --namespace=""
239 If present, the namespace scope for this CLI request
240 --request-timeout="0"
243 The length of time to wait before giving up on a single server
244 request. Non-zero values should contain a corresponding time unit (e.g.
245 1s, 2m, 3h). A value of zero means don't timeout requests.
246 -s, --server=""
249 The address and port of the Kubernetes API server
250 --stderrthreshold=2
253 logs at or above this threshold go to stderr
254 --storage_driver_buffer_duration=0
257 Writes in the storage driver will be buffered for this duration,
258 and committed to the non memory backends as a single transaction
259 --storage_driver_db="cadvisor"
262 database name
263 --storage_driver_host="localhost:8086"
266 database host:port
267 --storage_driver_password="root"
270 database password
271 --storage_driver_secure=false
274 use secure connection with database
275 --storage_driver_table="stats"
278 table name
279 --storage_driver_user="root"
282 database username
283 --token=""
286 Bearer token for authentication to the API server
287 --user=""
290 The name of the kubeconfig user to use
291 -v, --v=0
294 log level for V logs
295 --version=false
298 Print version information and quit
299 --vmodule=
302 comma-separated list of pattern=N settings for file-filtered log‐
303 ging
304
308 # Provide details about the ruby-25-centos7 image repository
309 oc describe imageRepository ruby-25-centos7
310 # Provide details about the ruby-sample-build build configuration
312 oc describe bc ruby-sample-build
313
318 oc(1),
319
323 June 2016, Ported from the Kubernetes man-doc generator
324Openshift Openshift CLI User Manuals OC(1)