ContainerHealthcheck

data class ContainerHealthcheck(val interval: String? = null, val retries: Int? = null, val startInterval: String? = null, val startPeriod: String? = null, val tests: List<String>, val timeout: String? = null)

Constructors

Link copied to clipboard
constructor(interval: String? = null, retries: Int? = null, startInterval: String? = null, startPeriod: String? = null, tests: List<String>, timeout: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val interval: String? = null

Time between running the check (ms|s|m|h). Defaults to 0s.

Link copied to clipboard
val retries: Int? = null

Consecutive failures needed to report unhealthy. Defaults to 0.

Link copied to clipboard
val startInterval: String? = null

Interval before the healthcheck starts (ms|s|m|h). Defaults to 0s.

Link copied to clipboard
val startPeriod: String? = null

Start period for the container to initialize before counting retries towards unstable (ms|s|m|h). Defaults to 0s.

Link copied to clipboard

Command to run to check health. For example, to run curl -f localhost/health set the command to be ["CMD", "curl", "-f", "localhost/health"].

Link copied to clipboard
val timeout: String? = null

Maximum time to allow one check to run (ms|s|m|h). Defaults to 0s.