Probe interface

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

Properties

disableProbe

Indicate whether the probe is disabled.

failureThreshold

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

initialDelaySeconds

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

periodSeconds

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

probeAction

The action of the probe.

successThreshold

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

timeoutSeconds

Number of seconds after which the probe times out. Minimum value is 1.

Property Details

disableProbe

Indicate whether the probe is disabled.

disableProbe: boolean

Property Value

boolean

failureThreshold

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

failureThreshold?: number

Property Value

number

initialDelaySeconds

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

initialDelaySeconds?: number

Property Value

number

periodSeconds

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

periodSeconds?: number

Property Value

number

probeAction

The action of the probe.

probeAction?: ProbeActionUnion

Property Value

successThreshold

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

successThreshold?: number

Property Value

number

timeoutSeconds

Number of seconds after which the probe times out. Minimum value is 1.

timeoutSeconds?: number

Property Value

number