Configuring a Liveness Check in Connected Mode
Flex Gateway includes the following CLI command to test gateway health:
flexctl probe --check=livenessIf the Flex Gateway instance is running normally, the command returns an exit code of 0. Otherwise, the gateway is unhealthy and the command returns a 1.
You can either run the liveness check command manually or configure the command to run automatically. By default, Flex Gateways deployed on Kubernetes have an automatic liveness probe configured. The liveness probe periodically runs the liveness check command and automatically restarts the Flex Gateway pod after a specified number of failed liveness checks.
Docker and Linux deployments do not have preconfigured liveness probes.
Configure a Kubernetes Liveness Probe
By default, Flex Gateways running on Kubernetes include a liveness probe configured in the Helm chart. The liveness probe automatically runs flexctl probe --check=liveness at an interval of 10 seconds and restarts unhealthy pods after 5 failed tests.
The liveness probe is configured by default with the following values:
livenessProbe:
exec:
command:
- flexctl
- probe
- --check=liveness
initialDelaySeconds: 10
periodSeconds: 10
failureThreshold: 5
timeoutSeconds: 1| Parameter | Description |
|---|---|
|
The liveness check command |
|
The time in seconds to wait after startup before executing the first liveness test |
|
The period in seconds between each liveness check |
|
The number of failed liveness tests before the Kubernetes pod is restarted |
|
The time in seconds before the test times out |
To modify the default liveness probe parameters, you must update your Helm chart. You can modify these parameters during or after the initial installation of the Helm chart. For more information about how to modify a Helm chart, see Update Pod Settings for a Flex Gateway Deployment Through a Helm Chart
Docker and Linux Liveness Probes
For Docker or Linux deployments, there is no default liveness probe configured to check health or restart unhealthy Flex Gateways. However, you can still run the the liveness check command manually or configure it for automated use with third-party services. Besides the Kubernetes liveness probe, MuleSoft does not provide support for third-party liveness probes or health checks.
One method of running the liveness check command with Docker is to configure HEALTHCHECK in your docker run command. For more information, see Docker run HEALTHCHECK.