Struct HealthcheckConfig 

pub struct HealthcheckConfig {
    pub test: Option<Vec<String>>,
    pub interval: Option<u64>,
    pub timeout: Option<u64>,
    pub retries: Option<u8>,
    pub start_period: Option<u64>,
    pub start_interval: Option<u64>,
}

Configuration for container healthchecks.

Fields

test: Option<Vec<String>>

The test to perform. Possible values are:

• [] inherit healthcheck from image or parent image
• ["NONE"] disable healthcheck
• ["CMD", args...] exec arguments directly
• ["CMD-SHELL", command] run command with system’s default shell

interval: Option<u64>

The time to wait between checks in nanoseconds. It should be 0 or at least 1_000_000 (1 ms). 0 means inherit.

timeout: Option<u64>

The time to wait before considering the check to have hung in nanoseconds. It should be 0 or at least 1_000_000 (1 ms). 0 means inherit.

retries: Option<u8>

The number of consecutive failures needed to consider a container as unhealthy. 0 means inherit.

start_period: Option<u64>

Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1_000_000 (1 ms). 0 means inherit.

start_interval: Option<u64>

The time to wait between checks in nanoseconds during the start period. It should be 0 or at least 1_000_000 (1 ms). 0 means inherit.

Implementations

impl HealthcheckConfig

pub fn new() -> Self

Creates a new empty HealthConfig.

pub fn test(&mut self, test: Vec<String>) -> &mut Self

Sets the test command for the healthcheck.

pub fn interval(&mut self, interval: Duration) -> &mut Self

Sets the interval between health checks. The duration will be converted to nanoseconds.

pub fn timeout(&mut self, timeout: Duration) -> &mut Self

Sets the timeout for a single health check. The duration will be converted to nanoseconds.

pub fn retries(&mut self, retries: u8) -> &mut Self

Sets the number of retries before marking the container as unhealthy.

pub fn start_period(&mut self, start_period: Duration) -> &mut Self

Sets the start period for the container. Health checks will not be considered failed during this period. The duration will be converted to nanoseconds.

Trait Implementations

impl Clone for HealthcheckConfig

fn clone(&self) -> HealthcheckConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HealthcheckConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HealthcheckConfig

fn default() -> HealthcheckConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HealthcheckConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HealthcheckConfig

fn eq(&self, other: &HealthcheckConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HealthcheckConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HealthcheckConfig

impl StructuralPartialEq for HealthcheckConfig