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	type	description	default value
failureThreshold	int	Minimum consecutive failures for the probe to be considered failed after having succeeded.
initialDelaySeconds	int	The number of seconds before health checking is activated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
periodSeconds	int	How often (in seconds) to perform the probe.
probeHandler required	Exec	Http	Tcp
successThreshold	int	Minimum consecutive successes for the probe to be considered successful after having failed.
terminationGracePeriod	int	Duration in seconds before terminate gracefully upon probe failure.
timeoutSeconds	int	The number of seconds after which the probe times out. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

Examples

import kam.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	type	description	default value
command required	[str]	The command line to execute inside the container.

Examples

import kam.workload.container.probe as p

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

Schema Http

Http describes an action based on HTTP Get requests.

Attributes

name	type	description	default value
headers	{str:str}	Collection of custom headers to set in the request
url required	str	The full qualified url to send HTTP requests.

Examples

import kam.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	type	description	default value
url required	str	The full qualified url to open a socket.

Examples

import kam.workload.container.probe as p

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