Dagger.HealthcheckConfig (dagger v0.20.8)

Image healthcheck configuration.

Summary

Types

t()

Functions

args(healthcheck_config)

Healthcheck command arguments.

id(healthcheck_config)

A unique identifier for this HealthcheckConfig.

interval(healthcheck_config)

Interval between running healthcheck. Example:30s

retries(healthcheck_config)

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

shell(healthcheck_config)

Healthcheck command is a shell command.

start_interval(healthcheck_config)

StartInterval configures the duration between checks during the startup phase. Example:5s

start_period(healthcheck_config)

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

timeout(healthcheck_config)

Healthcheck timeout. Example:3s

Types

t()

@type t() :: %Dagger.HealthcheckConfig{client: term(), query_builder: term()}

Functions

args(healthcheck_config)

@spec args(t()) :: {:ok, [String.t()]} | {:error, term()}

Healthcheck command arguments.

id(healthcheck_config)

@spec id(t()) :: {:ok, Dagger.HealthcheckConfigID.t()} | {:error, term()}

A unique identifier for this HealthcheckConfig.

interval(healthcheck_config)

@spec interval(t()) :: {:ok, String.t()} | {:error, term()}

Interval between running healthcheck. Example:30s

retries(healthcheck_config)

@spec retries(t()) :: {:ok, integer()} | {:error, term()}

The maximum number of consecutive failures before the container is marked as unhealthy. Example:3

shell(healthcheck_config)

@spec shell(t()) :: {:ok, boolean()} | {:error, term()}

Healthcheck command is a shell command.

start_interval(healthcheck_config)

@spec start_interval(t()) :: {:ok, String.t()} | {:error, term()}

StartInterval configures the duration between checks during the startup phase. Example:5s

start_period(healthcheck_config)

@spec start_period(t()) :: {:ok, String.t()} | {:error, term()}

StartPeriod allows for failures during this initial startup period which do not count towards maximum number of retries. Example:0s

timeout(healthcheck_config)

@spec timeout(t()) :: {:ok, String.t()} | {:error, term()}

Healthcheck timeout. Example:3s