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 Description	Type	Default Value	Required
probeHandler The action taken to determine the alive or health of a container	probe.Exec | probe.Http | probe.Tcp	Undefined	required
initialDelaySeconds The number of seconds before health checking is activated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes	int	Undefined	optional
timeoutSeconds The number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle\#container-probes	int	Undefined	optional
periodSeconds How often (in seconds) to perform the probe.	int	Undefined	optional
successThreshold Minimum consecutive successes for the probe to be considered successful after having failed.	int	Undefined	optional
failureThreshold Minimum consecutive failures for the probe to be considered failed after having succeeded.	int	Undefined	optional
terminationGracePeriod	int	Undefined	optional

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 Description	Type	Default Value	Required
command The command line to execute inside the container.	[str]	Undefined	required

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 Description	Type	Default Value	Required
url The full qualified url to send HTTP requests.	str	Undefined	required
headers Collection of custom headers to set in the request	{str: str}	Undefined	optional

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 Description	Type	Default Value	Required
url The full qualified url to open a socket.	str	Undefined	required

Examples

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

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