Configuring Docker Health Checks Before Upgrading Large Instances
Introduction
During the execution of large upgrades, for example when upgrading to Codebeamer release 22.10-LTS, health checks should be taken into consideration since these checks might report the Codebeamer instance as unhealthy.
If an automatic healing mechanism kills the unhealthy Codebeamer instance during an upgrade, the upgrade fails. Such an issue can be hard to investigate as the Codebeamer instance does not die from a problem in the application, consequently, application logs do not contain any relevant information about the failure.
General Case
In Codebeamer, the default health check endpoint is <url>/<contextPath>/hc/ping.spr. For example: https://codebeamer.com/cb/hc/ping.spr.
 |
Automatic healing mechanisms that depend on this endpoint should be disabled before large upgrades, otherwise, the upgrade fails the reasons for which do not show up in the application logs.
|
Using Docker
The health check script is located at /home/appuser/healthcheck.sh in the docker image. You can download the docker image from this location: https://www.docker.com/get-started. This script uses the default Codebeamer health check endpoint: <url>/<contextPath>/hc/ping.spr.
For more information on building the docker image, see Building a Docker Image for Codebeamer 2.2 and Later Versions.
|
|
Automatic healing mechanisms that depend on this script should be disabled before large upgrades, otherwise, the upgrade fails the reasons for which do not show up in the application logs.
|