OC(1)

💅 OC(1) — the oc patch glow-up

okay bestie, welcome to the OpenShift CLI manual page for oc patch. yes it's a whole manpage, yes we're gonna read it together, and yes it's gonna slay. grab a boba 🧋

---

✨ NAME ✨

oc patch — update fields of a resource 💫

🌸 SYNOPSIS 🌸

oc patch [OPTIONS]

🦋 DESCRIPTION 🦋

So like, this command updates fields of a resource. how? using strategic merge patch, a JSON merge patch, or a JSON patch. pick your fighter, they all ate.

Both JSON and YAML formats are accepted. versatile icon behavior, honestly 🌈

⚠️ Note: strategic merge patch is not supported for custom resources. she does not come to every party, that's just the vibe check, no cap.

🎀 OPTIONS 🎀

okay so here's the full menu, no skipping, we're doing all of them 💖

• --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 it's the client strategy, it only prints the object that would be sent, without sending it. if it's the server strategy, it submits a server-side request without persisting the resource. literally "look but don't touch" energy 🙈
• --field-manager="kubectl-patch" — name of the manager used to track field ownership. yes it's kubectl-patch, that's not a typo, that's canon.
• -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 — it's giving "you can sit with us but not with them" 💀
• --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, kyaml, 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. super 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.
• --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 👑

these are the generational flags, passed down like family recipes 🫶

• --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.
• --as-user-extra=[] — user extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
• --cache-dir="/homeless-shelter/.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 😭 bestie please be careful with this one, it's giving red flag 🚩
• --kubeconfig="" — path to the kubeconfig file to use for CLI requests.
• --kuberc="" — path to the kuberc file to use for preferences. this can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
• --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. she waits forever, loyal queen 💜
• -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 ⭐

the moment you've all been waiting for, the examples, the main characters themselves 🎬

# 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}}'

like?? the range?? from strategic merge JSON all the way to subresource merge patches?? she contains multitudes 🔥

🌈 SEE ALSO 🌈

• oc(1)

(yes that's it, she's the whole family tree, iykyk)

💀 HISTORY 💀

June 2016, Ported from the Kubernetes man-doc generator. vintage. archival. a little bit iconic ngl.

---

and that's the whole page, bestie — go forth and patch responsibly 🫶✨

this has been the Openshift CLI User Manuals for OC(1), brought to you by Openshift, dated June 2016. mwah 💋