workflow-defs-probe.md

Probe Schema

https://github.com/kitproj/kit/internal/types/workflow#/$defs/Task/properties/readinessProbe

A probe to check if the task is alive, it will be restarted if not.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	workflow.schema.json*

readinessProbe Type

object (Probe)

readinessProbe Properties

Property	Type	Required	Nullable	Defined by
tcpSocket	object	Optional	cannot be null	Untitled schema
httpGet	object	Optional	cannot be null	Untitled schema
initialDelaySeconds	integer	Optional	cannot be null	Untitled schema
periodSeconds	integer	Optional	cannot be null	Untitled schema
successThreshold	integer	Optional	cannot be null	Untitled schema
failureThreshold	integer	Optional	cannot be null	Untitled schema

tcpSocket

TCPSocketAction describes an action based on opening a socket

tcpSocket

• is optional

• Type: object (TCPSocketAction)

• cannot be null

• defined in: Untitled schema

tcpSocket Type

object (TCPSocketAction)

httpGet

HTTPGetAction describes an action based on HTTP Locks requests.

httpGet

• is optional

• Type: object (HTTPGetAction)

• cannot be null

• defined in: Untitled schema

httpGet Type

object (HTTPGetAction)

initialDelaySeconds

Number of seconds after the process has started before the probe is initiated.

initialDelaySeconds

• is optional

• Type: integer (initialDelaySeconds)

• cannot be null

• defined in: Untitled schema

initialDelaySeconds Type

integer (initialDelaySeconds)

periodSeconds

How often (in seconds) to perform the probe.

periodSeconds

• is optional

• Type: integer (periodSeconds)

• cannot be null

• defined in: Untitled schema

periodSeconds Type

integer (periodSeconds)

successThreshold

Minimum consecutive successes for the probe to be considered successful after having failed.

successThreshold

• is optional

• Type: integer (successThreshold)

• cannot be null

• defined in: Untitled schema

successThreshold Type

integer (successThreshold)

failureThreshold

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

failureThreshold

• is optional

• Type: integer (failureThreshold)

• cannot be null

• defined in: Untitled schema

failureThreshold Type

integer (failureThreshold)