Skip to content

Commit 4dbf873

Browse files
authored
Merge pull request #78827 from abrennan89/11289
OSDOCS-11289: Additional fixes for module not rendering correctly
2 parents 6e3ced6 + 8e97c72 commit 4dbf873

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

modules/mgmt-power-remediation-baremetal-about.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="mgmt-power-remediation-baremetal-about_{context}"]
77
= About power-based remediation of bare metal
8+
89
In a bare metal cluster, remediation of nodes is critical to ensuring the overall health of the cluster. Physically remediating a cluster can be challenging and any delay in putting the machine into a safe or an operational state increases the time the cluster remains in a degraded state, and the risk that subsequent failures might bring the cluster offline. Power-based remediation helps counter such challenges.
910

1011
Instead of reprovisioning the nodes, power-based remediation uses a power controller to power off an inoperable node. This type of remediation is also called power fencing.
@@ -17,7 +18,7 @@ Power-based remediation provides the following capabilities:
1718
* Reduces the risk of data loss in hyperconverged environments
1819
* Reduces the downtime associated with recovering physical machines
1920
20-
[id="machine-health-checks-bare-metal_{context}"]
21+
[id="mgmt-power-remediation-baremetal-about-health-checks_{context}"]
2122
== MachineHealthChecks on bare metal
2223

2324
Machine deletion on bare metal cluster triggers reprovisioning of a bare metal host.
@@ -32,7 +33,7 @@ There are two ways to change the default remediation process from machine deleti
3233

3334
After using one of these methods, unhealthy machines are power-cycled by using Baseboard Management Controller (BMC) credentials.
3435

35-
[id="mgmt-understanding-remediation-process_{context}"]
36+
[id="mgmt-power-remediation-baremetal-about-understanding-remediation-process_{context}"]
3637
== Understanding the annotation-based remediation process
3738

3839
The remediation process operates as follows:
@@ -49,7 +50,7 @@ The remediation process operates as follows:
4950
If the power operations did not complete, the bare metal machine controller triggers the reprovisioning of the unhealthy node unless this is a control plane node or a node that was provisioned externally.
5051
====
5152

52-
[id="mgmt-understanding-metal3-remediation-process_{context}"]
53+
[id="mgmt-power-remediation-baremetal-about-understanding-metal3-remediation-process_{context}"]
5354
== Understanding the metal3-based remediation process
5455

5556
The remediation process operates as follows:
@@ -66,7 +67,7 @@ The remediation process operates as follows:
6667
If the power operations did not complete, the metal3 remediation controller triggers the reprovisioning of the unhealthy node unless this is a control plane node or a node that was provisioned externally.
6768
====
6869

69-
[id="mgmt-creating-mhc-baremetal_{context}"]
70+
[id="mgmt-power-remediation-baremetal-about-creating-mhc-baremetal_{context}"]
7071
== Creating a MachineHealthCheck resource for bare metal
7172

7273
.Prerequisites
@@ -76,9 +77,11 @@ If the power operations did not complete, the metal3 remediation controller trig
7677
* Network access to the BMC interface of the unhealthy node.
7778

7879
.Procedure
80+
7981
. Create a `healthcheck.yaml` file that contains the definition of your machine health check.
80-
. Apply the `healthcheck.yaml` file to your cluster using the following command:
8182

83+
. Apply the `healthcheck.yaml` file to your cluster using the following command:
84+
+
8285
[source,terminal]
8386
----
8487
$ oc apply -f healthcheck.yaml
@@ -110,7 +113,6 @@ spec:
110113
maxUnhealthy: "40%" <6>
111114
nodeStartupTimeout: "10m" <7>
112115
----
113-
114116
<1> Specify the name of the machine health check to deploy.
115117
<2> For bare metal clusters, you must include the `machine.openshift.io/remediation-strategy: external-baremetal` annotation in the `annotations` section to enable power-cycle remediation. With this remediation strategy, unhealthy hosts are rebooted instead of removed from the cluster.
116118
<3> Specify a label for the machine pool that you want to check.
@@ -170,7 +172,7 @@ spec:
170172
The `matchLabels` are examples only; you must map your machine groups based on your specific needs. The `annotations` section does not apply to metal3-based remediation. Annotation-based remediation and metal3-based remediation are mutually exclusive.
171173
====
172174

173-
["mgmt-troubleshooting-issue-power-remediation_{context}"]
175+
["mgmt-power-remediation-baremetal-about-troubleshooting_{context}"]
174176
== Troubleshooting issues with power-based remediation
175177

176178
To troubleshoot an issue with power-based remediation, verify the following:

0 commit comments

Comments
 (0)