1OC(1) June 2016 OC(1)
2
6 oc explain - Documentation of resources
7
11 oc explain [OPTIONS]
12
16 Documentation of resources.
17 Possible resource types include: pods (po), services (svc), replica‐
20 tioncontrollers (rc), nodes (no), events (ev), componentstatuses (cs),
21 limitranges (limits), persistentvolumes (pv), persistentvolumeclaims
22 (pvc), resourcequotas (quota), namespaces (ns) or endpoints (ep).
23
27 --api-version=""
28 Get different explanations for particular API version
29 --recursive=false
32 Print the fields of fields (Currently only 1 level deep)
33
37 --allow_verification_with_non_compliant_keys=false
38 Allow a SignatureVerifier to use keys which are technically
39 non-compliant with RFC6962.
40 --alsologtostderr=false
43 log to standard error as well as files
44 --application_metrics_count_limit=100
47 Max number of application metrics to store (per container)
48 --as=""
51 Username to impersonate for the operation
52 --as-group=[]
55 Group to impersonate for the operation, this flag can be repeated
56 to specify multiple groups.
57 --azure-container-registry-config=""
60 Path to the file containing Azure container registry configuration
61 information.
62 --boot_id_file="/proc/sys/kernel/random/boot_id"
65 Comma-separated list of files to check for boot-id. Use the first
66 one that exists.
67 --cache-dir="/builddir/.kube/http-cache"
70 Default HTTP cache directory
71 --certificate-authority=""
74 Path to a cert file for the certificate authority
75 --client-certificate=""
78 Path to a client certificate file for TLS
79 --client-key=""
82 Path to a client key file for TLS
83 --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
86 CIDRs opened in GCE firewall for LB traffic proxy health checks
87 --cluster=""
90 The name of the kubeconfig cluster to use
91 --container_hints="/etc/cadvisor/container_hints.json"
94 location of the container hints file
95 --containerd="unix:///var/run/containerd.sock"
98 containerd endpoint
99 --context=""
102 The name of the kubeconfig context to use
103 --default-not-ready-toleration-seconds=300
106 Indicates the tolerationSeconds of the toleration for
107 notReady:NoExecute that is added by default to every pod that does not
108 already have such a toleration.
109 --default-unreachable-toleration-seconds=300
112 Indicates the tolerationSeconds of the toleration for unreach‐
113 able:NoExecute that is added by default to every pod that does not
114 already have such a toleration.
115 --docker="unix:///var/run/docker.sock"
118 docker endpoint
119 --docker-tls=false
122 use TLS to connect to docker
123 --docker-tls-ca="ca.pem"
126 path to trusted CA
127 --docker-tls-cert="cert.pem"
130 path to client certificate
131 --docker-tls-key="key.pem"
134 path to private key
135 --docker_env_metadata_whitelist=""
138 a comma-separated list of environment variable keys that needs to
139 be collected for docker containers
140 --docker_only=false
143 Only report docker containers in addition to root stats
144 --docker_root="/var/lib/docker"
147 DEPRECATED: docker root is read from docker info (this is a fall‐
148 back, default: /var/lib/docker)
149 --enable_load_reader=false
152 Whether to enable cpu load reader
153 --event_storage_age_limit="default=24h"
156 Max length of time for which to store events (per type). Value is a
157 comma separated list of key values, where the keys are event types
158 (e.g.: creation, oom) or "default" and the value is a duration. Default
159 is applied to all non-specified event types
160 --event_storage_event_limit="default=100000"
163 Max number of events to store (per type). Value is a comma sepa‐
164 rated list of key values, where the keys are event types (e.g.: cre‐
165 ation, oom) or "default" and the value is an integer. Default is
166 applied to all non-specified event types
167 --global_housekeeping_interval=0
170 Interval between global housekeepings
171 --housekeeping_interval=0
174 Interval between container housekeepings
175 --httptest.serve=""
178 if non-empty, httptest.NewServer serves on this address and blocks
179 --insecure-skip-tls-verify=false
182 If true, the server's certificate will not be checked for validity.
183 This will make your HTTPS connections insecure
184 --kubeconfig=""
187 Path to the kubeconfig file to use for CLI requests.
188 --log-flush-frequency=0
191 Maximum number of seconds between log flushes
192 --log_backtrace_at=:0
195 when logging hits line file:N, emit a stack trace
196 --log_cadvisor_usage=false
199 Whether to log the usage of the cAdvisor container
200 --log_dir=""
203 If non-empty, write log files in this directory
204 --logtostderr=true
207 log to standard error instead of files
208 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
211 Comma-separated list of files to check for machine-id. Use the
212 first one that exists.
213 --match-server-version=false
216 Require server version to match client version
217 -n, --namespace=""
220 If present, the namespace scope for this CLI request
221 --request-timeout="0"
224 The length of time to wait before giving up on a single server
225 request. Non-zero values should contain a corresponding time unit (e.g.
226 1s, 2m, 3h). A value of zero means don't timeout requests.
227 -s, --server=""
230 The address and port of the Kubernetes API server
231 --stderrthreshold=2
234 logs at or above this threshold go to stderr
235 --storage_driver_buffer_duration=0
238 Writes in the storage driver will be buffered for this duration,
239 and committed to the non memory backends as a single transaction
240 --storage_driver_db="cadvisor"
243 database name
244 --storage_driver_host="localhost:8086"
247 database host:port
248 --storage_driver_password="root"
251 database password
252 --storage_driver_secure=false
255 use secure connection with database
256 --storage_driver_table="stats"
259 table name
260 --storage_driver_user="root"
263 database username
264 --token=""
267 Bearer token for authentication to the API server
268 --user=""
271 The name of the kubeconfig user to use
272 -v, --v=0
275 log level for V logs
276 --version=false
279 Print version information and quit
280 --vmodule=
283 comma-separated list of pattern=N settings for file-filtered log‐
284 ging
285
289 # Get the documentation of the resource and its fields
290 oc explain pods
291 # Get the documentation of a specific field of a resource
293 oc explain pods.spec.containers
294
299 oc(1),
300
304 June 2016, Ported from the Kubernetes man-doc generator
305Openshift Openshift CLI User Manuals OC(1)