The Paketo Buildpack for Health Checker is a Cloud Native Buildpack that provides a health checker tool that can be used to validate application health.
This buildpack will participate either of the following conditions are met
$BP_HEALTH_CHECKER_ENABLEDis set.- An upstream buildpack requests
hcin the build plan.
The buildpack will do the following:
- If
$BP_HEALTH_CHECKER_ENABLEDis set totrue, requests that a health checker be installed by requiringhcin the buildplan. - Contributes the requested health checker set with
$BP_HEALTH_CHECKER_DEPENDENCYto a layer markedlaunchwith command on$PATH. - Creates a symlink to the health check process at
/workspace/health-check.
| Environment Variable | Description |
|---|---|
$BP_HEALTH_CHECKER_ENABLED |
If set to true the buildpack will contribute a health checker binary. Defaults to false, so no health checker is contributed. |
$BP_HEALTH_CHECKER_DEPENDENCY |
The dependency id, see buildpack.toml, of the health checker to install. Defaults to thc. |
The buildpack optionally accepts the following bindings:
| Key | Value | Description |
|---|---|---|
<dependency-digest> |
<uri> |
If needed, the buildpack will fetch the dependency with digest <dependency-digest> from <uri> |
This buildpack is released under version 2.0 of the Apache License.