Skip to content

Commit 7404051

Browse files
committed
OSDOCS-8777: move offline embedding to install book
1 parent 2356f88 commit 7404051

8 files changed

+24
-22
lines changed

_topic_maps/_topic_map_ms.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,15 @@ Name: Installing
4949
Dir: microshift_install
5050
Distros: microshift
5151
Topics:
52-
- Name: Installing from RPM
52+
- Name: Installing from an RPM package
5353
File: microshift-install-rpm
54+
- Name: Mirroring container images for disconnected installations
55+
File: microshift-deploy-with-mirror-registry
5456
- Name: Embedding in a RHEL for Edge image
5557
File: microshift-embed-in-rpm-ostree
56-
- Name: Greenboot health check
58+
- Name: Embedding in a RHEL for Edge image for offline use
59+
File: microshift-embed-in-rpm-ostree-offline-use
60+
- Name: Understanding system health checks
5761
File: microshift-greenboot
5862
- Name: Troubleshooting installation issues
5963
File: microshift-installing-troubleshooting
@@ -424,8 +428,6 @@ Name: Running applications
424428
Dir: microshift_running_apps
425429
Distros: microshift
426430
Topics:
427-
- Name: Embedding MicroShift containers for offline deployments
428-
File: microshift-embed-microshift-offline-deploy
429431
- Name: Embedding applications on RHEL for Edge
430432
File: microshift-embedded-apps-on-rhel-edge
431433
- Name: Embedding applications for offline use
@@ -440,8 +442,6 @@ Topics:
440442
File: microshift-greenboot-workload-scripts
441443
- Name: Pod security authentication and authorization
442444
File: microshift-authentication
443-
- Name: Mirror registry deployment
444-
File: microshift-deploy-with-mirror-registry
445445
---
446446
Name: Backup and restore
447447
Dir: microshift_backup_and_restore

microshift_running_apps/microshift-deploy-with-mirror-registry.adoc renamed to microshift_install/microshift-deploy-with-mirror-registry.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-deploy-with-mirror-registry"]
3-
= {microshift-short} deployment with a mirror registry
3+
= Mirroring container images for disconnected installations
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-deployment-mirror
66

microshift_running_apps/microshift-embed-microshift-offline-deploy.adoc renamed to microshift_install/microshift-embed-in-rpm-ostree-offline-use.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="microshift-embed-microshift-offline-deployments"]
3-
= Running a cluster in an offline deployment
2+
[id="microshift-embed-in-rpm-ostree-for-offline-use"]
3+
= Embedding in a {op-system-ostree} image for offline use
44
include::_attributes/attributes-microshift.adoc[]
5-
:context: microshift-embed-apps-offline-use
5+
:context: microshift-embed-rpm-ostree-offline-use
66

77
toc::[]
88

microshift_install/microshift-embed-in-rpm-ostree.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-embed-in-rpm-ostree"]
3-
= Embedding {microshift-short} in a {op-system-ostree} image
3+
= Embedding in a {op-system-ostree} image
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-embed-in-rpm-ostree
66

microshift_install/microshift-greenboot.adoc

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,25 @@
11
:_mod-docs-content-type: ASSEMBLY
22
[id="microshift-greenboot"]
3-
= The Greenboot health check
3+
= The Greenboot health check framework
44
include::_attributes/attributes-microshift.adoc[]
55
:context: microshift-greenboot
66

77
toc::[]
88

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.
1010

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:
1512

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.
1719

1820
[NOTE]
1921
====
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.
2123
====
2224

2325
include::modules/microshift-greenboot-dir-structure.adoc[leveloffset=+1]

modules/microshift-accessing-cluster-locally.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $ chmod go-r ~/.kube/config
3939

4040
.Verification
4141

42-
* Verify that {product-title} is running by entering the following command:
42+
* Verify that {microshift-short} is running by entering the following command:
4343
+
4444
[source,terminal]
4545
----

modules/microshift-adding-repos-to-image-builder.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Use the following procedure to add the {microshift-short} repositories to Image
1717
1818
.Procedure
1919

20-
. Create an Image Builder configuration file for adding the `{rpm-repo-version}` RPM repository source required to pull {product-title} RPMs by running the following command:
20+
. Create an Image Builder configuration file for adding the `{rpm-repo-version}` RPM repository source required to pull {microshift-short} RPMs by running the following command:
2121
+
2222
[source,text,subs="attributes+"]
2323
----

modules/microshift-adding-service-to-blueprint.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ version = "*"
3333
enabled = ["microshift"]
3434
EOF
3535
----
36-
36+
+
3737
[NOTE]
3838
====
3939
The wildcard `*` in the commands uses the latest {microshift-short} RPMs. If you need a specific version, substitute the wildcard for the version you want. For example, insert `4.14.1` to download the {microshift-short} 4.14.1 RPMs.

0 commit comments

Comments
 (0)