A tool that can be used in OCI images to perform health checks under Docker.
Both Kubernetes and Docker have the capability to run health checks against your running containers, however, unlike Kubernetes Docker does not have a tool built-in to do this. It requires your application to have the functionatliy or for a tool to be present in the image.
May folks use curl
for this and it's not a bad tool, but it's overkill. In addition, may people would like to strip out tools like curl
because they can be misused if your application is compromised.
The tiny health checker is a small binary that can only make HTTP requests to localhost. The port and path are configurable, but that's it. This is sufficient for health checks, but should be difficult to misuse if your container is compromised.
USAGE:
thc
ENV:
THC_PORT sets the port to which a connection will be made, default: 8080
THC_PATH sets the path to which a connection will be made, default `/`
CONN_TIMEOUT sets the connection timeout, default: 10
REQ_TIMEOUT sets the request timeout, defaults: 15
**NOTE** Host is not configurable and will always be localhost
Connects to http://localhost:8080/
.
thc
Connects to http://localhost:9090/
.
THC_PORT=9090 thc
Connects to http://localhost:9090/foo
.
THC_PORT=9090 THC_PATH=/foo thc
- the leading slash (
/
) is optional