openshift-cli-set-probe man page

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


openshift cli set probe [Options]


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.


   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
   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.
   A URL to perform an HTTP GET on (you can omit the host, have a string port, or omit the scheme.
   The time in seconds to wait before the probe begins checking
   Set or remove a liveness probe to verify this container is running
   When using the default or custom-column output format, don't print headers.
   A port number or port name to attempt to open via TCP.
-o, --output=""
   Output format. One of: json|yaml|wide|name|custom-columns=...|custom-columns-file=...|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See custom columns [ ⟨⟩], golang template [ ⟨⟩] and jsonpath template [ ⟨⟩].
   Output the formatted object with the given group version (for ex: 'extensions/v1beta1').
   The time in seconds between attempts
   Set or remove a readiness probe to indicate when this container should receive traffic
   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.)
   When printing, show all labels as the last column (default hide labels column)
   If non-empty, sort list types using this field specification.  The field specification is expressed as a JSONPath expression (e.g. '{}'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
   The number of successes required before the probe is considered successful
   Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [ ⟨⟩].
   The time in seconds to wait before considering the probe to have failed

Options Inherited from Parent Commands

   DEPRECATED: The API version to use when talking to the server
   Username to impersonate for the operation
   Path to a cert. file for the certificate authority
   Path to a client certificate file for TLS
   Path to a client key file for TLS
   The name of the kubeconfig cluster to use
   Path to the config file to use for CLI requests.
   The name of the kubeconfig context to use
   The Google Cloud Platform Service Account JSON Key to use for authentication.
   If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
   Maximum number of seconds between log flushes
   Require server version to match client version
-n, --namespace=""
   If present, the namespace scope for this CLI request
   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.
   The address and port of the Kubernetes API server
   Bearer token for authentication to the API server
   The name of the kubeconfig user to use


  # 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 for a hostNetwork pod
  openshift cli set probe dc/router --readiness --get-url=
  # Set only the initial-delay-seconds field on all deployments
  openshift cli set probe dc --all --readiness --initial-delay-seconds=30

See Also



June 2016, Ported from the Kubernetes man-doc generator

Referenced By


Openshift CLI User Manuals June 2016