openshift-cli-set-probe man page

openshift cli set probe — Update a probe on a pod template

Synopsis

openshift cli set probe [Options]

Description

Set or remove a liveness or readiness probe from a pod or pod template

Each container in a pod may define one or more probes that are used for general health checking. A liveness probe is checked periodically to ensure the container is still healthy: if the probe fails, the container is restarted. Readiness probes set or clear the ready flag for each container, which controls whether the container's ports are included in the list of endpoints for a service and whether a deployment can proceed. A readiness check should indicate when your container is ready to accept incoming traffic or begin handling work. Setting both liveness and readiness probes for each container is highly recommended.

The three probe types 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.

Options

--all=false
Select all resources in the namespace of the specified resource types
-c, --containers="*"
The names of containers in the selected pod templates to change - may use wildcards
--failure-threshold=0
The number of failures before the probe is considered to have failed
-f, --filename=[]
Filename, directory, or URL to file 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.
--initial-delay-seconds=0
The time in seconds to wait before the probe begins checking
--liveness=false
Set or remove a liveness probe to verify this container is running
--no-headers=false
When using the default output, don't print headers.
--open-tcp=""
A port number or port name to attempt to open via TCP.
-o, --output=""
Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [ ⟨http://golang.org/pkg/text/template/#pk…⟩] and jsonpath template [ ⟨http://releases.k8s.io/release-1.3/docs…⟩].
--output-version=""
Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
--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
--remove=false
If true, remove the specified probe(s).
-l, --selector=""
Selector (label query) to filter on
-a, --show-all=true
When printing, show all resources (false means hide terminated pods.)
--show-labels=false
When printing, show all labels as the last column (default hide labels column)
--sort-by=""
If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. '{.metadata.name}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
--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 [ ⟨http://golang.org/pkg/text/template/#pk…⟩].
--timeout-seconds=0
The time in seconds to wait before considering the probe to have failed

Options Inherited from Parent Commands

--api-version=""
DEPRECATED: The API version to use when talking to the server

--as=""
Username to impersonate for the operation.

--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

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

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

--google-json-key=""
The Google Cloud Platform Service Account JSON Key to use for authentication.

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

--log-flush-frequency=0
Maximum number of seconds between log flushes

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

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

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

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

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

Example

# Clear both readiness and liveness probes off all containers
openshift cli set probe dc/registry --remove --readiness --liveness

# Set an exec action as a liveness probe to run 'echo ok'
openshift cli set probe dc/registry --liveness -- echo ok

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

# Set an HTTP readiness probe for port 8080 and path /healthz over HTTP on the pod IP
openshift cli 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
openshift cli set probe dc/router --readiness --get-url=https://127.0.0.1:1936/stats

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

See Also

openshift-cli-set(1),

History

June 2016, Ported from the Kubernetes man-doc generator

Referenced By

openshift-cli-set(1).

Openshift CLI User Manuals Openshift June 2016