Skip to main content
Version: v0.9

probe

Schema Probe

Probe describes a health check to be performed against a container to determine whether it is
alive or ready to receive traffic. There are three probe types: readiness, liveness, and startup.

Attributes

Name and DescriptionTypeDefault ValueRequired
probeHandler
The action taken to determine the alive or health of a container
probe.Exec | probe.Http | probe.TcpUndefinedrequired
initialDelaySeconds
The number of seconds before health checking is activated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes
intUndefinedoptional
timeoutSeconds
The number of seconds after which the probe times out.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes
intUndefinedoptional
periodSeconds
How often (in seconds) to perform the probe.
intUndefinedoptional
successThreshold
Minimum consecutive successes for the probe to be considered successful after having failed.
intUndefinedoptional
failureThreshold
Minimum consecutive failures for the probe to be considered failed after having succeeded.
intUndefinedoptional
terminationGracePeriodintUndefinedoptional

Examples

import catalog.models.schema.v1.workload.container.probe as p

probe = p.Probe {
probeHandler: p.Http {
path: "/healthz"
}
initialDelaySeconds: 10
}

Schema Exec

Exec describes a "run in container" action.

Attributes

Name and DescriptionTypeDefault ValueRequired
command
The command line to execute inside the container.
[str]Undefinedrequired

Examples

import catalog.models.schema.v1.workload.container.probe as p

execProbe = p.Exec {
command: ["probe.sh"]
}

Schema Http

Http describes an action based on HTTP Get requests.

Attributes

Name and DescriptionTypeDefault ValueRequired
url
The full qualified url to send HTTP requests.
strUndefinedrequired
headers
Collection of custom headers to set in the request
{str: str}Undefinedoptional

Examples

import catalog.models.schema.v1.workload.container.probe as p

httpProbe = p.Http {
url: "http://localhost:80"
headers: {
"X-HEADER": "VALUE"
}
}

Schema Tcp

Tcp describes an action based on opening a socket.

Attributes

Name and DescriptionTypeDefault ValueRequired
url
The full qualified url to open a socket.
strUndefinedrequired

Examples

import catalog.models.schema.v1.workload.container.probe as p

tcpProbe = p.Tcp {
url: "tcp://localhost:1234"
}