OC-SET-PROBE(1)

📦
version 4.22.0 · 2 versions
, in nixpkgs unstable

💅 oc set probe — the glow-up your pod templates deserve ✨

Okay so bestie, welcome to oc set probe from the oc set family (OpenShift CLI, June 2016 energy but make it iconic 🌸). This is the page where we learn how to add or yeet liveness, readiness, and startup probes from a pod or pod template. It's giving health check main character energy and honestly? Obsessed. 🫶

🌈 SYNOPSIS

oc set probe [OPTIONS]

That's it. That's the whole vibe check. 💅

✨ DESCRIPTION ✨

So like, this command sets or removes a liveness, readiness, or startup probe from a pod or pod template. Periodt. 🎀

Every container in a pod can define one or more probes, and those probes are literally the whole general health checking situation. Let me break down the three types for you bestie, because this is important:

  • Liveness probe — checked periodically to make sure the container is still healthy. If it fails? The container gets restarted. No cap, it's that serious. 💀
  • Readiness probe — sets or clears the ready flag for each container. This controls whether the container's ports are included in the list of endpoints for a service, and whether a deployment can proceed. Your readiness check should indicate when your container is ready to accept incoming traffic or begin handling work. Lowkey the most underrated one tbh.
  • Startup probe — gives your container some extra startup time before the liveness probe even starts. It's like a little grace period 🧚.
Setting both liveness and readiness probes for each container is highly recommended. Not me begging you to do this. 🙈

The three probe types (as in, what they actually do) are:

  • Open a TCP socket on the pod IP
  • Perform an HTTP GET against a URL on a container that must return 200 OK
  • Run a command in the container that must return exit code 0

Containers that take a variable amount of time to start should set generous initial-delay-seconds values. Otherwise, as your application evolves, you may suddenly begin to fail. That's the warning, bestie, and it's giving "learn from my mistakes" energy 😭.

🛠️ OPTIONS 🛠️

Every single flag, preserved for the culture. Slay. 👑

  • --all=false — If true, select all resources in the namespace of the specified resource types.
  • --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.
  • -c, --containers="*" — The names of containers in the selected pod templates to change. May use wildcards, so go wild 💫.
  • --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. It's a vibe check before the real thing.
  • --failure-threshold=0 — The number of failures before the probe is considered to have failed.
  • --field-manager="kubectl-set" — Name of the manager used to track field ownership.
  • -f, --filename=[] — Filename, directory, or URL to files to use to edit the resource.
  • --get-url="" — A URL to perform an HTTP GET on. You can omit the host, have a string port, or omit the scheme. Flexible queen 💅.
  • --initial-delay-seconds=0 — The time in seconds to wait before the probe begins checking.
  • -k, --kustomize="" — Process the kustomization directory. This flag can't be used together with -f or -R. Not me warning you twice. 🫶
  • --liveness=false — Set or remove a liveness probe to verify this container is running.
  • --local=false — If true, set image will NOT contact api-server but run locally.
  • --open-tcp="" — A port number or port name to attempt to open via TCP.
  • -o, --output="" — Output format. One of: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file).
  • --period-seconds=0 — The time in seconds between attempts.
  • --readiness=false — Set or remove a readiness probe to indicate when this container should receive traffic.
  • -R, --recursive=false — Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory. Big "organized bestie" energy ✨.
  • --remove=false — If true, remove the specified probe(s).
  • -l, --selector="" — Selector (label query) to filter on.
  • --show-managed-fields=false — If true, keep the managedFields when printing objects in JSON or YAML format.
  • --startup=false — Set or remove a startup probe to verify this container is running.
  • --success-threshold=0 — The number of successes required before the probe is considered successful.
  • --template="" — Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates — the docs are at http://golang.org/pkg/text/template/#pkg-overview.
  • --timeout-seconds=0 — The time in seconds to wait before considering the probe to have failed.

🗝️ OPTIONS INHERITED FROM PARENT COMMANDS 🗝️

These are the family heirlooms, passed down from the parent command. Respect the lineage. 👑

  • --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. Fr, be careful with this one 😬.
  • --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.
  • -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 🌸

These examples are iconic, bestie. Copy them exactly, no edits, I'm watching you. 👀

# Clear both readiness and liveness probes off all containers
oc set probe dc/myapp --remove --readiness --liveness

# Set an exec action as a liveness probe to run 'echo ok'
oc set probe dc/myapp --liveness -- echo ok

# Set a readiness probe to try to open a TCP socket on 3306
oc set probe rc/mysql --readiness --open-tcp=3306

# Set an HTTP startup probe for port 8080 and path /healthz over HTTP on the pod IP
oc set probe dc/webapp --startup --get-url=http://:8080/healthz

# Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP
oc set probe dc/webapp --readiness --get-url=http://:8080/healthz

# Set an HTTP readiness probe over HTTPS on 127.0.0.1 for a hostNetwork pod
oc set probe dc/router --readiness --get-url=https://127.0.0.1:1936/stats

# Set only the initial-delay-seconds field on all deployments
oc set probe dc --all --readiness --initial-delay-seconds=30

The way that last one sets only the initial-delay-seconds field on all deployments… minimal, elegant, iconic. 🎀

🔗 SEE ALSO 🔗

Go check it out, bestie, it's like the mothership command. 🛸

📜 HISTORY 📜

June 2016, Ported from the Kubernetes man-doc generator. Vintage, honestly. 🍓

Sign-off time 🫶 — this lil page is part of the Openshift CLI User Manuals from Openshift, dated June 2016. Stan a classic manual, bestie. Now go set those probes and slay ✨💖
📦 where this page comes from