1KUBERNETES(1)                      Jan 2015                      KUBERNETES(1)
2
3
4

NAME

6       kubectl convert - Convert config files between different API versions
7
8
9

SYNOPSIS

11       kubectl convert [OPTIONS]
12
13
14

DESCRIPTION

16       Convert config files between different API versions. Both YAML and JSON
17       formats are accepted.
18
19
20       The command takes filename, directory, or URL as input, and convert it
21       into format of version specified by --output-version flag. If target
22       version is not specified or not supported, convert to latest version.
23
24
25       The default output will be printed to stdout in YAML format. One can
26       use -o option to change to output destination.
27
28
29

OPTIONS

31       --allow-missing-template-keys=true
32           If true, ignore any errors in templates when a field or map key is
33       missing in the template. Only applies to golang and jsonpath output
34       formats.
35
36
37       -f, --filename=[]
38           Filename, directory, or URL to files to need to get converted.
39
40
41       -k, --kustomize=""
42           Process the kustomization directory. This flag can't be used
43       together with -f or -R.
44
45
46       --local=true
47           If true, convert will NOT try to contact api-server but run
48       locally.
49
50
51       -o, --output="yaml"
52           Output format. One of:
53       json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file.
54
55
56       --output-version=""
57           Output the formatted object with the given group version (for ex:
58       'extensions/v1beta1').
59
60
61       -R, --recursive=false
62           Process the directory used in -f, --filename recursively. Useful
63       when you want to manage related manifests organized within the same
64       directory.
65
66
67       --template=""
68           Template string or path to template file to use when
69       -o=go-template, -o=go-template-file. The template format is golang
70       templates [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].
71
72
73       --validate=true
74           If true, use a schema to validate the input before sending it
75
76
77

OPTIONS INHERITED FROM PARENT COMMANDS

79       --add-dir-header=false
80           If true, adds the file directory to the header
81
82
83       --alsologtostderr=false
84           log to standard error as well as files
85
86
87       --application-metrics-count-limit=100
88           Max number of application metrics to store (per container)
89
90
91       --as=""
92           Username to impersonate for the operation
93
94
95       --as-group=[]
96           Group to impersonate for the operation, this flag can be repeated
97       to specify multiple groups.
98
99
100       --azure-container-registry-config=""
101           Path to the file containing Azure container registry configuration
102       information.
103
104
105       --boot-id-file="/proc/sys/kernel/random/boot_id"
106           Comma-separated list of files to check for boot-id. Use the first
107       one that exists.
108
109
110       --cache-dir="/builddir/.kube/http-cache"
111           Default HTTP cache directory
112
113
114       --certificate-authority=""
115           Path to a cert file for the certificate authority
116
117
118       --client-certificate=""
119           Path to a client certificate file for TLS
120
121
122       --client-key=""
123           Path to a client key file for TLS
124
125
126       --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
127           CIDRs opened in GCE firewall for L7 LB traffic proxy  health checks
128
129
130       --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
131           CIDRs opened in GCE firewall for L4 LB traffic proxy  health checks
132
133
134       --cluster=""
135           The name of the kubeconfig cluster to use
136
137
138       --container-hints="/etc/cadvisor/container_hints.json"
139           location of the container hints file
140
141
142       --containerd="/run/containerd/containerd.sock"
143           containerd endpoint
144
145
146       --containerd-namespace="k8s.io"
147           containerd namespace
148
149
150       --context=""
151           The name of the kubeconfig context to use
152
153
154       --default-not-ready-toleration-seconds=300
155           Indicates the tolerationSeconds of the toleration for
156       notReady:NoExecute that is added by default to every pod that does not
157       already have such a toleration.
158
159
160       --default-unreachable-toleration-seconds=300
161           Indicates the tolerationSeconds of the toleration for
162       unreachable:NoExecute that is added by default to every pod that does
163       not already have such a toleration.
164
165
166       --disable-root-cgroup-stats=false
167           Disable collecting root Cgroup stats
168
169
170       --docker="unix:///var/run/docker.sock"
171           docker endpoint
172
173
174       --docker-env-metadata-whitelist=""
175           a comma-separated list of environment variable keys that needs to
176       be collected for docker containers
177
178
179       --docker-only=false
180           Only report docker containers in addition to root stats
181
182
183       --docker-root="/var/lib/docker"
184           DEPRECATED: docker root is read from docker info (this is a
185       fallback, default: /var/lib/docker)
186
187
188       --docker-tls=false
189           use TLS to connect to docker
190
191
192       --docker-tls-ca="ca.pem"
193           path to trusted CA
194
195
196       --docker-tls-cert="cert.pem"
197           path to client certificate
198
199
200       --docker-tls-key="key.pem"
201           path to private key
202
203
204       --enable-load-reader=false
205           Whether to enable cpu load reader
206
207
208       --event-storage-age-limit="default=0"
209           Max length of time for which to store events (per type). Value is a
210       comma separated list of key values, where the keys are event types
211       (e.g.: creation, oom) or "default" and the value is a duration. Default
212       is applied to all non-specified event types
213
214
215       --event-storage-event-limit="default=0"
216           Max number of events to store (per type). Value is a comma
217       separated list of key values, where the keys are event types (e.g.:
218       creation, oom) or "default" and the value is an integer. Default is
219       applied to all non-specified event types
220
221
222       --global-housekeeping-interval=1m0s
223           Interval between global housekeepings
224
225
226       --housekeeping-interval=10s
227           Interval between container housekeepings
228
229
230       --insecure-skip-tls-verify=false
231           If true, the server's certificate will not be checked for validity.
232       This will make your HTTPS connections insecure
233
234
235       --kubeconfig=""
236           Path to the kubeconfig file to use for CLI requests.
237
238
239       --log-backtrace-at=:0
240           when logging hits line file:N, emit a stack trace
241
242
243       --log-cadvisor-usage=false
244           Whether to log the usage of the cAdvisor container
245
246
247       --log-dir=""
248           If non-empty, write log files in this directory
249
250
251       --log-file=""
252           If non-empty, use this log file
253
254
255       --log-file-max-size=1800
256           Defines the maximum size a log file can grow to. Unit is megabytes.
257       If the value is 0, the maximum file size is unlimited.
258
259
260       --log-flush-frequency=5s
261           Maximum number of seconds between log flushes
262
263
264       --logtostderr=true
265           log to standard error instead of files
266
267
268       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
269           Comma-separated list of files to check for machine-id. Use the
270       first one that exists.
271
272
273       --match-server-version=false
274           Require server version to match client version
275
276
277       -n, --namespace=""
278           If present, the namespace scope for this CLI request
279
280
281       --password=""
282           Password for basic authentication to the API server
283
284
285       --profile="none"
286           Name of profile to capture. One of
287       (none|cpu|heap|goroutine|threadcreate|block|mutex)
288
289
290       --profile-output="profile.pprof"
291           Name of the file to write the profile to
292
293
294       --request-timeout="0"
295           The length of time to wait before giving up on a single server
296       request. Non-zero values should contain a corresponding time unit (e.g.
297       1s, 2m, 3h). A value of zero means don't timeout requests.
298
299
300       -s, --server=""
301           The address and port of the Kubernetes API server
302
303
304       --skip-headers=false
305           If true, avoid header prefixes in the log messages
306
307
308       --skip-log-headers=false
309           If true, avoid headers when opening log files
310
311
312       --stderrthreshold=2
313           logs at or above this threshold go to stderr
314
315
316       --storage-driver-buffer-duration=1m0s
317           Writes in the storage driver will be buffered for this duration,
318       and committed to the non memory backends as a single transaction
319
320
321       --storage-driver-db="cadvisor"
322           database name
323
324
325       --storage-driver-host="localhost:8086"
326           database host:port
327
328
329       --storage-driver-password="root"
330           database password
331
332
333       --storage-driver-secure=false
334           use secure connection with database
335
336
337       --storage-driver-table="stats"
338           table name
339
340
341       --storage-driver-user="root"
342           database username
343
344
345       --tls-server-name=""
346           Server name to use for server certificate validation. If it is not
347       provided, the hostname used to contact the server is used
348
349
350       --token=""
351           Bearer token for authentication to the API server
352
353
354       --update-machine-info-interval=5m0s
355           Interval between machine info updates.
356
357
358       --user=""
359           The name of the kubeconfig user to use
360
361
362       --username=""
363           Username for basic authentication to the API server
364
365
366       -v, --v=0
367           number for the log level verbosity
368
369
370       --version=false
371           Print version information and quit
372
373
374       --vmodule=
375           comma-separated list of pattern=N settings for file-filtered
376       logging
377
378
379

EXAMPLE

381                # Convert 'pod.yaml' to latest version and print to stdout.
382                kubectl convert -f pod.yaml
383
384                # Convert the live state of the resource specified by 'pod.yaml' to the latest version
385                # and print to stdout in JSON format.
386                kubectl convert -f pod.yaml --local -o json
387
388                # Convert all files under current directory to latest version and create them all.
389                kubectl convert -f . | kubectl create -f -
390
391
392
393

SEE ALSO

395       kubectl(1),
396
397
398

HISTORY

400       January 2015, Originally compiled by Eric Paris (eparis at redhat dot
401       com) based on the kubernetes source material, but hopefully they have
402       been automatically generated since!
403
404
405
406Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum