v1

Observe /

Configure health checks

Health checks allow you to configure tests to ensure maximum availability of your services. These health checks can be configured so that incoming traffic is only routed to available and healthy containers, and that containers which fail health checks are automatically terminated and restarted.

Health check types

Readiness probe

A readiness probe will simply test whether a container is able to receive traffic. Upon success the new container will be marked ready, if the probe fails the container will be marked for termination and another initialized.

Liveness probe

A liveness probe will test a given endpoint of a service to make sure that it is available and healthy. If the check fails the container will be marked for termination and a new container will be initialized.

Startup probe

A startup probe is only called during startup to make sure a new container has initialized successfully. Any configured readiness and liveness probes will not be called until the startup checks have succeeded. This allows you to check containers that may take a long time to startup while keeping more aggressive readiness and liveness probes for running containers. Consider using a startup probe if your containers are being terminated before they have a chance to initialize.

Health check settings

Protocol

Choose which protocol to test the container by: HTTP or CMD. HTTP will send a GET request which passes if the response has a status code greater than or equal to 200 and less than 400. CMD will execute the specified command inside the container which passes if command exits with a status code of 0.

Type

Choose whether to create a startup, readiness, or liveness probe.

Path/CMD

Enter the path or command (CMD) by which to test the container. The command will be run inside the container.

Port

Set the port to send the HTTP request to.

Initial Delay

Set the time (in seconds) to wait from container initialization before making the first check.

Interval

Set the time (in seconds) to wait between checks.

Timeout

Set the time (in seconds) to wait for a response from the container.

Max Failures

Specify the maximum number of attempts to check the container before failing.

Success Threshold

Set the number of successful checks required for a readiness probe to pass.

© 2022 Northflank Ltd. All rights reserved.