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

NAME

6       kubectl replace - Replace a resource by filename or stdin
7
8
9

SYNOPSIS

11       kubectl replace [OPTIONS]
12
13
14

DESCRIPTION

16       Replace a resource by filename or stdin.
17
18
19       JSON  and YAML formats are accepted. If replacing an existing resource,
20       the complete resource spec must be provided. This can be obtained by
21
22
23       $ kubectl get TYPE NAME -o yaml
24
25
26       Please     refer     to     the     models     in     ⟨https://htmlpre
27       view.github.io/?https://github.com/kubernetes/kuber
28       netes/blob/HEAD/docs/api-reference/v1/definitions.html⟩ to  find  if  a
29       field is mutable.
30
31
32

OPTIONS

34       --allow-missing-template-keys=true
35           If  true, ignore any errors in templates when a field or map key is
36       missing in the template. Only applies to  golang  and  jsonpath  output
37       formats.
38
39
40       --cascade=true
41           If  true,  cascade  the  deletion  of the resources managed by this
42       resource (e.g. Pods created by a ReplicationController).  Default true.
43
44
45       -f, --filename=[]
46           to use to replace the resource.
47
48
49       --force=false
50           Only  used  when  grace-period=0.  If  true,   immediately   remove
51       resources  from  API  and bypass graceful deletion. Note that immediate
52       deletion of some resources may result in inconsistency or data loss and
53       requires confirmation.
54
55
56       --grace-period=-1
57           Period of time in seconds given to the resource to terminate grace‐
58       fully. Ignored if negative. Set to 1 for immediate shutdown.  Can  only
59       be set to 0 when --force is true (force deletion).
60
61
62       -o, --output=""
63           Output    format.    One   of:   json|yaml|name|go-template|go-tem‐
64       plate-file|template|templatefile|jsonpath|jsonpath-file.
65
66
67       -R, --recursive=false
68           Process the directory used in -f,  --filename  recursively.  Useful
69       when  you  want  to  manage related manifests organized within the same
70       directory.
71
72
73       --save-config=false
74           If true, the configuration of current object will be saved  in  its
75       annotation.  Otherwise,  the annotation will be unchanged. This flag is
76       useful when you want to perform kubectl apply on  this  object  in  the
77       future.
78
79
80       --template=""
81           Template  string  or  path  to template file to use when -o=go-tem‐
82       plate, -o=go-template-file. The template format is golang  templates  [
83http://golang.org/pkg/text/template/#pkg-overview⟩].
84
85
86       --timeout=0s
87           The length of time to wait before giving up on a delete, zero means
88       determine a timeout from the size of the object
89
90
91       --validate=true
92           If true, use a schema to validate the input before sending it
93
94
95       --wait=false
96           If true, wait for resources to be gone before returning. This waits
97       for finalizers.
98
99
100

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

378                # Replace a pod using the data in pod.json.
379                kubectl replace -f ./pod.json
380
381                # Replace a pod based on the JSON passed into stdin.
382                cat pod.json | kubectl replace -f -
383
384                # Update a single-container pod's image version (tag) to v4
385                kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
386
387                # Force replace, delete and then re-create the resource
388                kubectl replace --force -f ./pod.json
389
390
391
392

SEE ALSO

394       kubectl(1),
395
396
397

HISTORY

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