class documentation

class Healthcheck(DictType): (source)

View In Hierarchy

Defines a healthcheck configuration for a container or service. Args: test (:py:class:`list` or str): Test to perform to determine container health. Possible values: - Empty list: Inherit healthcheck from parent image - ``["NONE"]``: Disable healthcheck - ``["CMD", args...]``: exec arguments directly. - ``["CMD-SHELL", command]``: Run command in the system's default shell. If a string is provided, it will be used as a ``CMD-SHELL`` command. interval (int): The time to wait between checks in nanoseconds. It should be 0 or at least 1000000 (1 ms). timeout (int): The time to wait before considering the check to have hung. It should be 0 or at least 1000000 (1 ms). retries (int): The number of consecutive failures needed to consider a container as unhealthy. start_period (int): Start period for the container to initialize before starting health-retries countdown in nanoseconds. It should be 0 or at least 1000000 (1 ms).

Method __init__ Undocumented
Method interval.setter Undocumented
Method retries.setter Undocumented
Method start_period.setter Undocumented
Method test.setter Undocumented
Method timeout.setter Undocumented
Property interval Undocumented
Property retries Undocumented
Property start_period Undocumented
Property test Undocumented
Property timeout Undocumented
def __init__(self, **kwargs): (source)

Undocumented

@interval.setter
def interval(self, value): (source)

Undocumented

@retries.setter
def retries(self, value): (source)

Undocumented

@start_period.setter
def start_period(self, value): (source)

Undocumented

@test.setter
def test(self, value): (source)

Undocumented

@timeout.setter
def timeout(self, value): (source)

Undocumented

Undocumented

Undocumented

@property
start_period = (source)

Undocumented

Undocumented

Undocumented