KUBERNETES(1)(kubernetes)

✨ KUBERNETES(1)(kubernetes) ✨

okay bestie, you know how there's a whole manual family called kubernetes? this is one of those pages, and it's about kubectl replace. buckle up 💖

🌸 NAME 🌸

kubectl replace — replace a resource by file name or stdin. that's it, that's the whole vibe 🎀

---

✨ SYNOPSIS ✨

kubectl replace [OPTIONS]

---

🦋 DESCRIPTION 🦋

Replace a resource by file name or stdin. yes bestie, exactly what it sounds like 🫶

JSON and YAML formats are accepted. If you're replacing an existing resource, the complete resource spec must be provided — no half-efforts, no crumbs, full spec only 💅. You can grab that full spec like this:

$ kubectl get TYPE NAME -o yaml

so iconic. steal it, edit it, send it back. 🔥

---

💖 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, so don't get any ideas elsewhere 🙈
• --cascade="background" — must be "background", "orphan", or "foreground". this selects the deletion cascading strategy for the dependents (e.g. Pods created by a ReplicationController). defaults to background. your dependents, your choice ✨
• --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. fake it but make it real-ish 💅
• --field-manager="kubectl-replace" — name of the manager used to track field ownership. it's giving accountability 🎀
• -f, --filename=[] — the files, directories or URLs that contain the configurations to replace. this is the main character flag ngl 👑
• --force=false — if true, immediately remove resources from API and bypass graceful deletion. note that immediate deletion of some resources may result in inconsistency or data loss and requires confirmation. ⚠️ so, like, be careful bestie, fr fr
• --grace-period=-1 — period of time in seconds given to the resource to terminate gracefully. ignored if negative. set to 1 for immediate shutdown. can only be set to 0 when --force is true (force deletion). the rules are the rules 💀
• -k, --kustomize="" — process a kustomization directory. this flag can't be used together with -f or -R. pick a lane, bestie 🦋
• -o, --output="" — output format. one of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file). so many options, all valid, all slay 🌈
• --raw="" — raw URI to PUT to the server. uses the transport specified by the kubeconfig file.
• -R, --recursive=false — process the directory used in -f, --filename recursively. useful when you want to manage related manifests organized within the same directory. nested? we love nested 🌸
• --save-config=false — if true, the configuration of current object will be saved in its annotation. otherwise, the annotation will be unchanged. this flag is useful when you want to perform kubectl apply on this object in the future. future-proofing, we love to see it ✨
• --show-managed-fields=false — if true, keep the managedFields when printing objects in JSON or YAML format.
• --subresource="" — if specified, replace will operate on the subresource of the requested object. going deeper, iykyk 💜
• --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.
• --timeout=0s — the length of time to wait before giving up on a delete, zero means determine a timeout from the size of the object. patience, but make it configurable 🧚
• --validate="strict" — must be one of: strict (or true), warn, ignore (or false). "true" or "strict" will use a schema to validate the input and fail the request if invalid. it will perform server side validation if ServerSideFieldValidation is enabled on the api-server, but will fall back to less reliable client-side validation if not. "warn" will warn about unknown or duplicate fields without blocking the request if server-side field validation is enabled on the API server, and behave as "ignore" otherwise. "false" or "ignore" will not perform any schema validation, silently dropping any unknown or duplicate fields. strict is the default because we're not messing around 💅
• --wait=false — if true, wait for resources to be gone before returning. this waits for finalizers. goodbye means actually goodbye 😭

---

💫 OPTIONS INHERITED FROM PARENT COMMANDS 💫

these are the family heirlooms, passed down from kubectl itself 🫶

• --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="/home/username/.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 no, but okay, your call
• --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.
• --password="" — password for basic authentication to the API server.
• --profile="none" — name of profile to capture. one of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace).
• --profile-output="profile.pprof" — name of the file to write the profile to.
• --proxy-url="" — proxy URL to use for requests to the API server.
• --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.
• --username="" — username for basic authentication to the API server.
• --version=false — --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version.
• --warnings-as-errors=false — treat warnings received from the server as errors and exit with a non-zero exit code.

---

🎀 EXAMPLE 🎀

the receipts, bestie. all of them 👑

# Replace a pod using the data in pod.json
kubectl replace -f ./pod.json

# Replace a pod based on the JSON passed into stdin
cat pod.json | kubectl replace -f -

# Update a single-container pod's image version (tag) to v4
kubectl get pod mypod -o yaml | sed 's/\(image: myimage\):.*$/\1:v4/' | kubectl replace -f -

# Force replace, delete and then re-create the resource
kubectl replace --force -f ./pod.json

that third one? piping through sed? that's main character energy, no cap 🔥

---

👑 SEE ALSO 👑

• kubectl(1)

---

📜 HISTORY 📜

January 2015, originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! 😭 iconic origin story honestly.

---

and that's the whole page, bestie 💖 this one's from the kubernetes manual, the User section, dated Jan 2015 — shoutout to Eric Paris for writing the original back in January 2015, and to the auto-generators that (hopefully) handle it now. go replace something responsibly. mwah 🫶✨