spec
Raw probe spec. When custom: true, this is used as-is. Otherwise merged with values derived from type/path/port. Typical fields include initialDelaySeconds, periodSeconds, timeoutSeconds, failureThreshold.
object
Properties
Section titled “Properties”| Property | Type | Required | Default | Description |
|---|---|---|---|---|
exec | object | No | - | Exec specifies the action to take. |
failureThreshold | integer / null | No | - | Minimum consecutive failures for the probe to be consider… |
grpc | object | No | - | GRPC specifies an action involving a GRPC port. |
httpGet | object | No | - | HTTPGet specifies the http request to perform. |
initialDelaySeconds | integer / null | No | - | Number of seconds after the container has started before … |
periodSeconds | integer / null | No | - | How often (in seconds) to perform the probe. Default to 1… |
successThreshold | integer / null | No | - | Minimum consecutive successes for the probe to be conside… |
tcpSocket | object | No | - | TCPSocket specifies an action involving a TCP port. |
terminationGracePeriodSeconds | integer / null | No | - | Optional duration in seconds the pod needs to terminate g… |
timeoutSeconds | integer / null | No | - | Number of seconds after which the probe times out. Defaul… |
Property Details
Section titled “Property Details”failureThreshold
Section titled “failureThreshold”Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
initialDelaySeconds
Section titled “initialDelaySeconds”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
Section titled “periodSeconds”How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
successThreshold
Section titled “successThreshold”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.
terminationGracePeriodSeconds
Section titled “terminationGracePeriodSeconds”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.
timeoutSeconds
Section titled “timeoutSeconds”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