Skip to main content
Schemaobject

io.k8s.api.core.v1.Probe

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

Source
specs/apis__batch__v1_openapi.json
Revision
9a79c3bd90f7
Active snapshot
2a9112600697
exec
optional

Exec specifies a command to execute in the container.

failureThreshold integer (int32)
optional

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

grpc
optional

GRPC specifies a GRPC HealthCheckRequest.

httpGet
optional

HTTPGet specifies an HTTP GET request to perform.

initialDelaySeconds integer (int32)
optional

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

periodSeconds integer (int32)
optional

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

successThreshold integer (int32)
optional

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.

tcpSocket
optional

TCPSocket specifies a connection to a TCP port.

terminationGracePeriodSeconds integer (int64)
optional

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

timeoutSeconds integer (int32)
optional

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