1OC(1) June 2016 OC(1)
2
6 oc extract - Extract secrets or config maps to disk
7
11 oc extract [OPTIONS]
12
16 Extract files out of secrets and config maps
17 The extract command makes it easy to download the contents of a config
20 map or secret into a directory. Each key in the config map or secret is
21 created as a separate file with the name of the key, as it is when you
22 mount a secret or config map into a container.
23 You may extract the contents of a secret or config map to standard out
26 by passing '-' to --to. The names of each key will be written to stdan‐
27 dard error.
28 You can limit which keys are extracted with the --keys=NAME flag, or
31 set the directory to extract to with --to=DIRECTORY.
32
36 --allow-missing-template-keys=true
37 If true, ignore any errors in templates when a field or map key is
38 missing in the template. Only applies to golang and jsonpath output
39 formats.
40 --confirm=false
43 If true, overwrite files that already exist.
44 -f, --filename=[]
47 Filename, directory, or URL to file to identify to extract the
48 resource.
49 --keys=[]
52 An optional list of keys to extract (default is all keys).
53 --no-headers=false
56 When using the default or custom-column output format, don't print
57 headers (default print headers).
58 -o, --output=""
61 Output format. One of: json|yaml|wide|name|custom-columns=...|cus‐
62 tom-columns-file=...|go-template=...|go-template-file=...|json‐
63 path=...|jsonpath-file=... See custom columns [ ⟨http://kuber‐
64 netes.io/docs/user-guide/kubectl-overview/#custom-columns⟩], golang
65 template [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩] and
66 jsonpath template [ ⟨http://kubernetes.io/docs/user-guide/jsonpath⟩].
67 --show-labels=false
70 When printing, show all labels as the last column (default hide
71 labels column)
72 --sort-by=""
75 If non-empty, sort list types using this field specification. The
76 field specification is expressed as a JSONPath expression (e.g.
77 '{.metadata.name}'). The field in the API resource specified by this
78 JSONPath expression must be an integer or a string.
79 --template=""
82 Template string or path to template file to use when -o=go-tem‐
83 plate, -o=go-template-file. The template format is golang templates [
84 ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].
85 --to="."
88 Directory to extract files to.
89
93 --allow_verification_with_non_compliant_keys=false
94 Allow a SignatureVerifier to use keys which are technically
95 non-compliant with RFC6962.
96 --alsologtostderr=false
99 log to standard error as well as files
100 --application_metrics_count_limit=100
103 Max number of application metrics to store (per container)
104 --as=""
107 Username to impersonate for the operation
108 --as-group=[]
111 Group to impersonate for the operation, this flag can be repeated
112 to specify multiple groups.
113 --azure-container-registry-config=""
116 Path to the file containing Azure container registry configuration
117 information.
118 --boot_id_file="/proc/sys/kernel/random/boot_id"
121 Comma-separated list of files to check for boot-id. Use the first
122 one that exists.
123 --cache-dir="/builddir/.kube/http-cache"
126 Default HTTP cache directory
127 --certificate-authority=""
130 Path to a cert file for the certificate authority
131 --client-certificate=""
134 Path to a client certificate file for TLS
135 --client-key=""
138 Path to a client key file for TLS
139 --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
142 CIDRs opened in GCE firewall for LB traffic proxy health checks
143 --cluster=""
146 The name of the kubeconfig cluster to use
147 --container_hints="/etc/cadvisor/container_hints.json"
150 location of the container hints file
151 --containerd="unix:///var/run/containerd.sock"
154 containerd endpoint
155 --context=""
158 The name of the kubeconfig context to use
159 --default-not-ready-toleration-seconds=300
162 Indicates the tolerationSeconds of the toleration for
163 notReady:NoExecute that is added by default to every pod that does not
164 already have such a toleration.
165 --default-unreachable-toleration-seconds=300
168 Indicates the tolerationSeconds of the toleration for unreach‐
169 able:NoExecute that is added by default to every pod that does not
170 already have such a toleration.
171 --docker="unix:///var/run/docker.sock"
174 docker endpoint
175 --docker-tls=false
178 use TLS to connect to docker
179 --docker-tls-ca="ca.pem"
182 path to trusted CA
183 --docker-tls-cert="cert.pem"
186 path to client certificate
187 --docker-tls-key="key.pem"
190 path to private key
191 --docker_env_metadata_whitelist=""
194 a comma-separated list of environment variable keys that needs to
195 be collected for docker containers
196 --docker_only=false
199 Only report docker containers in addition to root stats
200 --docker_root="/var/lib/docker"
203 DEPRECATED: docker root is read from docker info (this is a fall‐
204 back, default: /var/lib/docker)
205 --enable_load_reader=false
208 Whether to enable cpu load reader
209 --event_storage_age_limit="default=24h"
212 Max length of time for which to store events (per type). Value is a
213 comma separated list of key values, where the keys are event types
214 (e.g.: creation, oom) or "default" and the value is a duration. Default
215 is applied to all non-specified event types
216 --event_storage_event_limit="default=100000"
219 Max number of events to store (per type). Value is a comma sepa‐
220 rated list of key values, where the keys are event types (e.g.: cre‐
221 ation, oom) or "default" and the value is an integer. Default is
222 applied to all non-specified event types
223 --global_housekeeping_interval=0
226 Interval between global housekeepings
227 --housekeeping_interval=0
230 Interval between container housekeepings
231 --httptest.serve=""
234 if non-empty, httptest.NewServer serves on this address and blocks
235 --insecure-skip-tls-verify=false
238 If true, the server's certificate will not be checked for validity.
239 This will make your HTTPS connections insecure
240 --kubeconfig=""
243 Path to the kubeconfig file to use for CLI requests.
244 --log-flush-frequency=0
247 Maximum number of seconds between log flushes
248 --log_backtrace_at=:0
251 when logging hits line file:N, emit a stack trace
252 --log_cadvisor_usage=false
255 Whether to log the usage of the cAdvisor container
256 --log_dir=""
259 If non-empty, write log files in this directory
260 --logtostderr=true
263 log to standard error instead of files
264 --machine_id_file="/etc/machine-id,/var/lib/dbus/machine-id"
267 Comma-separated list of files to check for machine-id. Use the
268 first one that exists.
269 --match-server-version=false
272 Require server version to match client version
273 -n, --namespace=""
276 If present, the namespace scope for this CLI request
277 --request-timeout="0"
280 The length of time to wait before giving up on a single server
281 request. Non-zero values should contain a corresponding time unit (e.g.
282 1s, 2m, 3h). A value of zero means don't timeout requests.
283 -s, --server=""
286 The address and port of the Kubernetes API server
287 --stderrthreshold=2
290 logs at or above this threshold go to stderr
291 --storage_driver_buffer_duration=0
294 Writes in the storage driver will be buffered for this duration,
295 and committed to the non memory backends as a single transaction
296 --storage_driver_db="cadvisor"
299 database name
300 --storage_driver_host="localhost:8086"
303 database host:port
304 --storage_driver_password="root"
307 database password
308 --storage_driver_secure=false
311 use secure connection with database
312 --storage_driver_table="stats"
315 table name
316 --storage_driver_user="root"
319 database username
320 --token=""
323 Bearer token for authentication to the API server
324 --user=""
327 The name of the kubeconfig user to use
328 -v, --v=0
331 log level for V logs
332 --version=false
335 Print version information and quit
336 --vmodule=
339 comma-separated list of pattern=N settings for file-filtered log‐
340 ging
341
345 # extract the secret "test" to the current directory
346 oc extract secret/test
347 # extract the config map "nginx" to the /tmp directory
349 oc extract configmap/nginx --to=/tmp
350 # extract the config map "nginx" to STDOUT
352 oc extract configmap/nginx --to=-
353 # extract only the key "nginx.conf" from config map "nginx" to the /tmp directory
355 oc extract configmap/nginx --to=/tmp --keys=nginx.conf
356
361 oc(1),
362
366 June 2016, Ported from the Kubernetes man-doc generator
367Openshift Openshift CLI User Manuals OC(1)