/ 
API-Docker-0.004
/ API::Docker::Type::HealthConfig

NAME

API::Docker::Type::HealthConfig - A test to perform to check that the container is healthy

VERSION

version 0.004

DESCRIPTION

Generated from the HealthConfig definition of spec/v1.51.yaml.

Healthcheck commands should be side-effect free.

test

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

A non-zero exit code indicates a failed healthcheck:

  • 0 healthy

  • 1 unhealthy

  • 2 reserved (treated as unhealthy)

  • other values: error running probe

interval

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

timeout

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

If the health check command does not complete within this timeout, the check is considered failed and the health check process is forcibly terminated without a graceful shutdown.

retries

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

start_period

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

start_interval

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

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/Getty/p5-api-docker/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHOR

Torsten Raudssus <getty@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2026 by Torsten Raudssus <torsten@raudssus.de> https://raudssus.de/.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.