Cloud API Overview > @adpt/cloud > k8s > Probe
k8s.Probe interface
Signature:
export interface Probe
Properties
Property | Type | Description |
---|---|---|
exec | ExecAction | Exec specifies the action to take.Only one of exec, httpGet, or tcpSocket should be specified |
failureThreshold | number | Minimum consecutive failures for the probe to be considered failed after having succeeded.Defaults to 3. Minimum value is 1. |
httpGet | HTTPGetAction | Specifies the http request to perform. |
initialDelaySeconds | number | 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 | number | How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. |
successThreshold | number | Minimum consecutive successes for the probe to be considered successful after having failed.Must be 1 for liveness and startup. Minimum value is 1. |
tcpSocket | TCPSocketAction | Specifies an action involving a TCP port.TCP hooks not yet supported |
timeoutSeconds | number | 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 |