1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl patch - Update fields of a resource
10
14 kubectl patch [OPTIONS]
15
19 Update fields of a resource using strategic merge patch, a JSON merge
20 patch, or a JSON patch.
21 JSON and YAML formats are accepted.
24 Note: Strategic merge patch is not supported for custom resources.
27
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 --dry-run="none" Must be "none", "server", or "client". If client
37 strategy, only print the object that would be sent, without sending it.
38 If server strategy, submit server-side request without persisting the
39 resource.
40 --field-manager="kubectl-patch" Name of the manager used to track
43 field ownership.
44 -f, --filename=[] Filename, directory, or URL to files identifying
47 the resource to update
48 -k, --kustomize="" Process the kustomization directory. This flag
51 can't be used together with -f or -R.
52 --local=false If true, patch will operate on the content of the
55 file, not the server-side resource.
56 -o, --output="" Output format. One of: (json, yaml, name, go-tem‐
59 plate, go-template-file, template, templatefile, jsonpath, jsonpath-as-
60 json, jsonpath-file).
61 -p, --patch="" The patch to be applied to the resource JSON file.
64 --patch-file="" A file containing a patch to be applied to the re‐
67 source.
68 --record=false Record current kubectl command in the resource an‐
71 notation. If set to false, do not record the command. If set to true,
72 record the command. If not set, default to updating the existing anno‐
73 tation value only if one already exists.
74 -R, --recursive=false Process the directory used in -f, --filename
77 recursively. Useful when you want to manage related manifests organized
78 within the same directory.
79 --show-managed-fields=false If true, keep the managedFields when
82 printing objects in JSON or YAML format.
83 --subresource="" If specified, patch will operate on the subre‐
86 source of the requested object. Must be one of [status scale]. This
87 flag is alpha and may change in the future.
88 --template="" Template string or path to template file to use when
91 -o=go-template, -o=go-template-file. The template format is golang tem‐
92 plates [http://golang.org/pkg/text/template/#pkg-overview].
93 --type="strategic" The type of patch being provided; one of [json
96 merge strategic]
97
101 --as="" Username to impersonate for the operation. User could be a
102 regular user or a service account in a namespace.
103 --as-group=[] Group to impersonate for the operation, this flag
106 can be repeated to specify multiple groups.
107 --as-uid="" UID to impersonate for the operation.
110 --azure-container-registry-config="" Path to the file containing
113 Azure container registry configuration information.
114 --cache-dir="/builddir/.kube/cache" Default cache directory
117 --certificate-authority="" Path to a cert file for the certificate
120 authority
121 --client-certificate="" Path to a client certificate file for TLS
124 --client-key="" Path to a client key file for TLS
127 --cluster="" The name of the kubeconfig cluster to use
130 --context="" The name of the kubeconfig context to use
133 --disable-compression=false If true, opt-out of response compres‐
136 sion for all requests to the server
137 --insecure-skip-tls-verify=false If true, the server's certificate
140 will not be checked for validity. This will make your HTTPS connections
141 insecure
142 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
145 quests.
146 --match-server-version=false Require server version to match
149 client version
150 -n, --namespace="" If present, the namespace scope for this CLI
153 request
154 --password="" Password for basic authentication to the API server
157 --profile="none" Name of profile to capture. One of
160 (none|cpu|heap|goroutine|threadcreate|block|mutex)
161 --profile-output="profile.pprof" Name of the file to write the
164 profile to
165 --request-timeout="0" The length of time to wait before giving up
168 on a single server request. Non-zero values should contain a corre‐
169 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
170 out requests.
171 -s, --server="" The address and port of the Kubernetes API server
174 --tls-server-name="" Server name to use for server certificate
177 validation. If it is not provided, the hostname used to contact the
178 server is used
179 --token="" Bearer token for authentication to the API server
182 --user="" The name of the kubeconfig user to use
185 --username="" Username for basic authentication to the API server
188 --version=false Print version information and quit
191 --warnings-as-errors=false Treat warnings received from the server
194 as errors and exit with a non-zero exit code
195
199 # Partially update a node using a strategic merge patch, specifying the patch as JSON
200 kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
201 # Partially update a node using a strategic merge patch, specifying the patch as YAML
203 kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
204 # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch
206 kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
207 # Update a container's image; spec.containers[*].name is required because it's a merge key
209 kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
210 # Update a container's image using a JSON patch with positional arrays
212 kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
213 # Update a deployment's replicas through the scale subresource using a merge patch.
215 kubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'
216
221 kubectl(1),
222
226 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
227 com) based on the kubernetes source material, but hopefully they have
228 been automatically generated since!
229Manuals User KUBERNETES(1)(kubernetes)