Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.
Chapter 5. Greenboot workload health check scripts
Greenboot health check scripts are helpful on edge devices where direct serviceability is either limited or non-existent. You can create health check scripts to assess the health of your workloads and applications. These additional health check scripts are useful components of software problem checks and automatic system rollbacks.
A MicroShift health check script is included in the microshift-greenboot
RPM. You can also create your own health check scripts based on the workloads you are running. For example, you can write one that verifies that a service has started.
5.1. How workload health check scripts work Link kopierenLink in die Zwischenablage kopiert!
The workload or application health check script described in this tutorial uses the MicroShift health check functions that are available in the /usr/share/microshift/functions/greenboot.sh
file. This enables you to reuse procedures already implemented for the MicroShift core services.
The script starts by running checks that the basic functions of the workload are operating as expected. To run the script successfully:
- Execute the script from a root user account.
- Enable the MicroShift service.
The health check performs the following actions:
-
Gets a wait timeout of the current boot cycle for the
wait_for
function. -
Calls the
namespace_images_downloaded
function to wait until pod images are available. -
Calls the
namespace_pods_ready
function to wait until pods are ready. -
Calls the
namespace_pods_not_restarting
function to verify pods are not restarting.
Restarting pods can indicate a crash loop.
5.2. Included greenboot health checks Link kopierenLink in die Zwischenablage kopiert!
Health check scripts are available in /usr/lib/greenboot/check
, a read-only directory in RPM-OSTree systems. The following health checks are included with the greenboot-default-health-checks
framework.
Check if repository URLs are still DNS solvable:
This script is under
/usr/lib/greenboot/check/required.d/01_repository_dns_check.sh
and ensures that DNS queries to repository URLs are still available.Check if update platforms are still reachable:
This script is under
/usr/lib/greenboot/check/wanted.d/01_update_platform_check.sh
and tries to connect and get a 2XX or 3XX HTTP code from the update platforms defined in/etc/ostree/remotes.d
.Check if the current boot has been triggered by the hardware watchdog:
This script is under
/usr/lib/greenboot/check/required.d/02_watchdog.sh
and checks whether the current boot has been watchdog-triggered or not.- If the watchdog-triggered reboot occurs within the grace period, the current boot is marked as red. Greenboot does not trigger a rollback to the previous deployment.
- If the watchdog-triggered reboot occurs after the grace period, the current boot is not marked as red. Greenboot does not trigger a rollback to the previous deployment.
-
A 24-hour grace period is enabled by default. This grace period can be either disabled by modifying
GREENBOOT_WATCHDOG_CHECK_ENABLED
in/etc/greenboot/greenboot.conf to false
, or configured by changing theGREENBOOT_WATCHDOG_GRACE_PERIOD=number_of_hours
variable value in/etc/greenboot/greenboot.conf
.
5.3. How to create a health check script for your application Link kopierenLink in die Zwischenablage kopiert!
You can create workload or application health check scripts in the text editor of your choice using the example in this documentation. Save the scripts in the /etc/greenboot/check/required.d
directory. When a script in the /etc/greenboot/check/required.d
directory exits with an error, greenboot triggers a reboot in an attempt to heal the system.
Any script in the /etc/greenboot/check/required.d
directory triggers a reboot if it exits with an error.
If your health check logic requires any post-check steps, you can also create additional scripts and save them in the relevant greenboot directories. For example:
-
You can also place shell scripts you want to run after a boot has been declared successful in
/etc/greenboot/green.d
. -
You can place shell scripts you want to run after a boot has been declared failed in
/etc/greenboot/red.d
. For example, if you have steps to heal the system before restarting, you can create scripts for your use case and place them in the/etc/greenboot/red.d
directory.
5.3.1. About the workload health check script example Link kopierenLink in die Zwischenablage kopiert!
The following example uses the MicroShift health check script as a template. You can use this example with the provided libraries as a guide for creating basic health check scripts for your applications.
5.3.1.1. Basic prerequisites for creating a health check script Link kopierenLink in die Zwischenablage kopiert!
- The workload must be installed.
- You must have root access.
5.3.1.2. Example and functional requirements Link kopierenLink in die Zwischenablage kopiert!
You can start with the following example health check script. Modify it for your use case. In your workload health check script, you must complete the following minimum steps:
- Set the environment variables.
- Define the user workload namespaces.
- List the expected pod count.
Choose a name prefix for your application that ensures it runs after the 40_microshift_running_check.sh
script, which implements the Red Hat build of MicroShift health check procedure for its core services.
Example workload health check script
5.4. Testing a workload health check script Link kopierenLink in die Zwischenablage kopiert!
Prerequisites
- You have root access.
- You have installed a workload.
- You have created a health check script for the workload.
- The Red Hat build of MicroShift service is enabled.
Procedure
To test that greenboot is running a health check script file, reboot the host by running the following command:
sudo reboot
$ sudo reboot
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Examine the output of greenboot health checks by running the following command:
sudo journalctl -o cat -u greenboot-healthcheck.service
$ sudo journalctl -o cat -u greenboot-healthcheck.service
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteMicroShift core service health checks run before the workload health checks.
Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow