Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Probe

Package version

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

Hierarchy

  • Probe

Index

Properties

disableProbe

disableProbe: boolean

Indicate whether the probe is disabled.

Optional failureThreshold

failureThreshold: undefined | number

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

Optional initialDelaySeconds

initialDelaySeconds: undefined | number

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

Optional periodSeconds

periodSeconds: undefined | number

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

Optional probeAction

probeAction: ProbeActionUnion

The action of the probe.

Optional successThreshold

successThreshold: undefined | 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.

Optional timeoutSeconds

timeoutSeconds: undefined | number

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

Generated using TypeDoc