|
1 | 1 | :_mod-docs-content-type: ASSEMBLY
|
2 | 2 | [id="microshift-greenboot"]
|
3 |
| -= The Greenboot health check |
| 3 | += The Greenboot health check framework |
4 | 4 | include::_attributes/attributes-microshift.adoc[]
|
5 | 5 | :context: microshift-greenboot
|
6 | 6 |
|
7 | 7 | toc::[]
|
8 | 8 |
|
9 |
| -Greenboot is the generic health check framework for the `systemd` service on RPM-OSTree-based systems. The `microshift-greenboot` RPM and `greenboot-default-health-checks` are RPM packages installed with {microshift-short}. Greenboot is used to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example: |
| 9 | +Greenboot is the generic health check framework for the `systemd` service on `rpm-ostree` systems such as {op-system-ostree-first}. This framework is included in {microshift-short} installations with the `microshift-greenboot` and `greenboot-default-health-checks` RPM packages. |
10 | 10 |
|
11 |
| -* This health check framework is especially useful when you need to check for software problems and perform system rollbacks on edge devices where direct serviceability is either limited or non-existent. |
12 |
| -* When health check scripts are installed and configured, health checks run every time the system starts. |
13 |
| -* Using Greenboot can reduce your risk of being locked out of edge devices during updates and prevent a significant interruption of service if an update fails. |
14 |
| -* When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability. |
| 11 | +Greenboot health checks run at various times to assess system health and automate a rollback to the last healthy state in the event of software trouble, for example: |
15 | 12 |
|
16 |
| -A {microshift-short} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM also includes health check scripts verifying that DNS and `ostree` services are accessible. In addition, you can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example. |
| 13 | +* Default health check scripts run each time the system starts. |
| 14 | +* In addition the to the default health checks, you can write, install, and configure application health check scripts to also run every time the system starts. |
| 15 | +* Greenboot can reduce your risk of being locked out of edge devices during updates and prevent a significant interruption of service if an update fails. |
| 16 | +* When a failure is detected, the system boots into the last known working configuration using the `rpm-ostree` rollback capability. This feature is especially useful automation for edge devices where direct serviceability is either limited or non-existent. |
| 17 | +
|
| 18 | +A {microshift-short} application health check script is included in the `microshift-greenboot` RPM. The `greenboot-default-health-checks` RPM includes health check scripts verifying that DNS and `ostree` services are accessible. You can create your own health check scripts for the workloads you are running. You can write one that verifies that an application has started, for example. |
17 | 19 |
|
18 | 20 | [NOTE]
|
19 | 21 | ====
|
20 |
| -Rollback is not possible in the case of an update failure on a system not using OSTree. This is true even though health checks might run. |
| 22 | +Rollback is not possible in the case of an update failure on a system not using `rpm-ostree`. This is true even though health checks might run. |
21 | 23 | ====
|
22 | 24 |
|
23 | 25 | include::modules/microshift-greenboot-dir-structure.adoc[leveloffset=+1]
|
|
0 commit comments