NAME¶

oc patch - Update fields of a resource

SYNOPSIS¶

oc patch [OPTIONS]

DESCRIPTION¶

Update fields of a resource using strategic merge patch, a JSON merge patch, or a JSON patch.

JSON and YAML formats are accepted.

Note: Strategic merge patch is not supported for custom resources.

OPTIONS¶

--allow-missing-template-keys=true
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.

--dry-run="none"
Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource.

--field-manager="kubectl-patch"
Name of the manager used to track field ownership.

-f, --filename=[]
Filename, directory, or URL to files identifying the resource to update

-k, --kustomize=""
Process the kustomization directory. This flag can't be used together with -f or -R.

--local=false
If true, patch will operate on the content of the file, not the server-side resource.

-o, --output=""
Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).

-p, --patch=""
The patch to be applied to the resource JSON file.

--patch-file=""
A file containing a patch to be applied to the resource.

-R, --recursive=false
Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.

--show-managed-fields=false
If true, keep the managedFields when printing objects in JSON or YAML format.

--subresource=""
If specified, patch will operate on the subresource of the requested object. Must be one of [status scale]. This flag is beta and may change in the future.

--template=""
Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨http://golang.org/pkg/text/template/#pkg-overview⟩].

--type="strategic"
The type of patch being provided; one of [json merge strategic]

OPTIONS INHERITED FROM PARENT COMMANDS¶

--as=""
Username to impersonate for the operation. User could be a regular user or a service account in a namespace.

--as-group=[]
Group to impersonate for the operation, this flag can be repeated to specify multiple groups.

--as-uid=""
UID to impersonate for the operation.

--cache-dir="/home/abuild/.kube/cache"
Default cache directory

--certificate-authority=""
Path to a cert file for the certificate authority

--client-certificate=""
Path to a client certificate file for TLS

--client-key=""
Path to a client key file for TLS

--cluster=""
The name of the kubeconfig cluster to use

--context=""
The name of the kubeconfig context to use

--disable-compression=false
If true, opt-out of response compression for all requests to the server

--insecure-skip-tls-verify=false
If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure

--kubeconfig=""
Path to the kubeconfig file to use for CLI requests.

--match-server-version=false
Require server version to match client version

-n, --namespace=""
If present, the namespace scope for this CLI request

--profile="none"
Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output="profile.pprof"
Name of the file to write the profile to

--request-timeout="0"
The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.

-s, --server=""
The address and port of the Kubernetes API server

--tls-server-name=""
Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used

--token=""
Bearer token for authentication to the API server

--user=""
The name of the kubeconfig user to use

--warnings-as-errors=false
Treat warnings received from the server as errors and exit with a non-zero exit code

EXAMPLE¶

  # Partially update a node using a strategic merge patch, specifying the patch as JSON


  oc patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'


  


  # Partially update a node using a strategic merge patch, specifying the patch as YAML


  oc patch node k8s-node-1 -p $'spec:\n unschedulable: true'


  


  # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch


  oc patch -f node.json -p '{"spec":{"unschedulable":true}}'


  


  # Update a container's image; spec.containers[*].name is required because it's a merge key


  oc patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'


  


  # Update a container's image using a JSON patch with positional arrays


  oc patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'


  


  # Update a deployment's replicas through the 'scale' subresource using a merge patch


  oc patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'

SEE ALSO¶

oc(1),

HISTORY¶

June 2016, Ported from the Kubernetes man-doc generator