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

EXAMPLE

364                # Convert 'pod.yaml' to latest version and print to stdout.
365                kubectl convert -f pod.yaml
366
367                # Convert the live state of the resource specified by 'pod.yaml' to the latest version
368                # and print to stdout in JSON format.
369                kubectl convert -f pod.yaml --local -o json
370
371                # Convert all files under current directory to latest version and create them all.
372                kubectl convert -f . | kubectl create -f -
373
374
375
376

SEE ALSO

378       kubectl(1),
379
380
381

HISTORY

383       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
384       com) based on the kubernetes source material, but hopefully  they  have
385       been automatically generated since!
386
387
388
389Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum