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

NAME

6       kubectl  patch  -  Update  field(s) of a resource using strategic merge
7       patch
8
9
10

SYNOPSIS

12       kubectl patch [OPTIONS]
13
14
15

DESCRIPTION

17       Update field(s) of a resource using strategic merge patch, a JSON merge
18       patch, or a JSON patch.
19
20
21       JSON and YAML formats are accepted.
22
23
24

OPTIONS

26       --allow-missing-template-keys=true
27           If  true, ignore any errors in templates when a field or map key is
28       missing in the template. Only applies to  golang  and  jsonpath  output
29       formats.
30
31
32       --dry-run=false
33           If  true, only print the object that would be sent, without sending
34       it.
35
36
37       -f, --filename=[]
38           Filename, directory, or URL to files identifying  the  resource  to
39       update
40
41
42       -k, --kustomize=""
43           Process  the  kustomization  directory.  This  flag  can't  be used
44       together with -f or -R.
45
46
47       --local=false
48           If true, patch will operate on the content of  the  file,  not  the
49       server-side resource.
50
51
52       -o, --output=""
53           Output    format.    One   of:   json|yaml|name|go-template|go-tem‐
54       plate-file|template|templatefile|jsonpath|jsonpath-file.
55
56
57       -p, --patch=""
58           The patch to be applied to the resource JSON file.
59
60
61       --record=false
62           Record current kubectl command in the resource annotation.  If  set
63       to  false,  do  not record the command. If set to true, record the com‐
64       mand. If not set, default to updating  the  existing  annotation  value
65       only if one already exists.
66
67
68       -R, --recursive=false
69           Process  the  directory  used in -f, --filename recursively. Useful
70       when you want to manage related manifests  organized  within  the  same
71       directory.
72
73
74       --template=""
75           Template  string  or  path  to template file to use when -o=go-tem‐
76       plate, -o=go-template-file. The template format is golang  templates  [
77http://golang.org/pkg/text/template/#pkg-overview⟩].
78
79
80       --type="strategic"
81           The type of patch being provided; one of [json merge strategic]
82
83
84

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

371                # Partially update a node using a strategic merge patch. Specify the patch as JSON.
372                kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
373
374                # Partially update a node using a strategic merge patch. Specify the patch as YAML.
375                kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
376
377                # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch.
378                kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
379
380                # Update a container's image; spec.containers[*].name is required because it's a merge key.
381                kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
382
383                # Update a container's image using a json patch with positional arrays.
384                kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
385
386
387
388

SEE ALSO

390       kubectl(1),
391
392
393

HISTORY

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