Probe

io.k8s.api.core.v1.Probe source ↗

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

execExecActionExec specifies a command to execute in the container.

command[]stringCommand is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

failureThresholdinteger (int32)Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

grpcGRPCActionGRPC specifies a GRPC HealthCheckRequest.

portinteger (int32) requiredPort number of the gRPC service. Number must be in the range 1 to 65535.

servicestringService is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).If this is not specified, the default behavior is defined by gRPC.

httpGetHTTPGetActionHTTPGet specifies an HTTP GET request to perform.

hoststringHost name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.

httpHeaders[]HTTPHeaderCustom headers to set in the request. HTTP allows repeated headers.

namestring requiredThe header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.

valuestring requiredThe header field value

pathstringPath to access on the HTTP server.

portIntOrString requiredName or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

schemestringScheme to use for connecting to the host. Defaults to HTTP.

initialDelaySecondsinteger (int32)Number of seconds after the container has started before liveness probes are initiated.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

periodSecondsinteger (int32)How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.

successThresholdinteger (int32)Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

tcpSocketTCPSocketActionTCPSocket specifies a connection to a TCP port.

hoststringOptional: Host name to connect to, defaults to the pod IP.

portIntOrString requiredNumber or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.

terminationGracePeriodSecondsinteger (int64)Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down).This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate. Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

timeoutSecondsinteger (int32)Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes