1KUBERNETES(1)(kubernetes)                            KUBERNETES(1)(kubernetes)
2
3
4
5Eric Paris Jan 2015
6
7

NAME

9       kubectl replace - Replace a resource by filename or stdin
10
11
12

SYNOPSIS

14       kubectl replace [OPTIONS]
15
16
17

DESCRIPTION

19       Replace a resource by filename or stdin.
20
21
22       JSON  and YAML formats are accepted. If replacing an existing resource,
23       the complete resource spec must be provided. This can be obtained by
24
25
26       $ kubectl get TYPE NAME -o yaml
27
28
29

OPTIONS

31       --allow-missing-template-keys=true      If true, ignore any  errors  in
32       templates  when a field or map key is missing in the template. Only ap‐
33       plies to golang and jsonpath output formats.
34
35
36       --cascade="background"      Must be "background", "orphan",  or  "fore‐
37       ground".  Selects  the  deletion  cascading strategy for the dependents
38       (e.g. Pods created by a ReplicationController). Defaults to background.
39
40
41       --dry-run="none"      Must be "none", "server", or "client". If  client
42       strategy, only print the object that would be sent, without sending it.
43       If server strategy, submit server-side request without  persisting  the
44       resource.
45
46
47       --field-manager="kubectl-replace"       Name  of  the  manager  used to
48       track field ownership.
49
50
51       -f, --filename=[]      to use to replace the resource.
52
53
54       --force=false      If true, immediately remove resources from  API  and
55       bypass  graceful  deletion.  Note  that  immediate deletion of some re‐
56       sources may result in inconsistency or data loss and requires confirma‐
57       tion.
58
59
60       --grace-period=-1       Period of time in seconds given to the resource
61       to terminate gracefully. Ignored if negative. Set to  1  for  immediate
62       shutdown. Can only be set to 0 when --force is true (force deletion).
63
64
65       -k,  --kustomize=""       Process  a kustomization directory. This flag
66       can't be used together with -f or -R.
67
68
69       -o, --output=""       Output  format.  One  of:  json|yaml|name|go-tem‐
70       plate|go-template-file|template|templatefile|jsonpath|json‐
71       path-as-json|jsonpath-file.
72
73
74       --raw=""      Raw URI to PUT to the server.  Uses the transport  speci‐
75       fied by the kubeconfig file.
76
77
78       -R, --recursive=false      Process the directory used in -f, --filename
79       recursively. Useful when you want to manage related manifests organized
80       within the same directory.
81
82
83       --save-config=false       If  true, the configuration of current object
84       will be saved in its annotation. Otherwise, the annotation will be  un‐
85       changed.  This flag is useful when you want to perform kubectl apply on
86       this object in the future.
87
88
89       --template=""      Template string or path to template file to use when
90       -o=go-template, -o=go-template-file. The template format is golang tem‐
91       plates [http://golang.org/pkg/text/template/#pkg-overview].
92
93
94       --timeout=0s      The length of time to wait  before  giving  up  on  a
95       delete, zero means determine a timeout from the size of the object
96
97
98       --validate=true      If true, use a schema to validate the input before
99       sending it
100
101
102       --wait=false      If true, wait for resources to be gone before return‐
103       ing. This waits for finalizers.
104
105
106

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

386                # Replace a pod using the data in pod.json.
387                kubectl replace -f ./pod.json
388
389                # Replace a pod based on the JSON passed into stdin.
390                cat pod.json | kubectl replace -f -
391
392                # Update a single-container pod's image version (tag) to v4
393                kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -
394
395                # Force replace, delete and then re-create the resource
396                kubectl replace --force -f ./pod.json
397
398
399
400

SEE ALSO

402       kubectl(1),
403
404
405

HISTORY

407       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
408       com) based on the kubernetes source material, but hopefully  they  have
409       been automatically generated since!
410
411
412
413Manuals                              User            KUBERNETES(1)(kubernetes)
Impressum