Skip to content

Commit f8f3731

Browse files
authored
Merge pull request #49265 from ogradyp/TELCODOCS-78
TELCODOCS-78: Creating a node health check module added
2 parents ace7733 + a67309d commit f8f3731

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * ../nodes/nodes/eco-node-health-check-operator.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="eco-node-health-check-operator-creating-node-health-check_{context}"]
7+
= Creating a node health check
8+
Using the web console, you can create a node health check to identify unhealthy nodes and specify the remediation type and strategy to fix them.
9+
10+
.Procedure
11+
12+
. From the *Administrator* perspective of the {product-title} web console, click *Compute* -> *NodeHealthChecks* -> *CreateNodeHealthCheck*.
13+
. Specify whether to configure the node health check using the *Form view* or the *YAML view*.
14+
. Enter a *Name* for the node health check. The name must consist of lower case, alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character.
15+
. Specify the *Remediator* type, and *Self node remediation* or *Other*. The Self node remediation option is part of the Self Node Remediation Operator that is installed with the Node Health Check Operator. Selecting *Other* requires an *API version*, *Kind*, *Name*, and *Namespace* to be entered, which then points to the remediation template resource of a remediator.
16+
. Make a *Nodes* selection by specifying the labels of the nodes you want to remediate. The selection matches labels that you want to check. If more than one label is specified, the nodes must contain each label. The default value is empty, which selects both worker and control-plane nodes.
17+
+
18+
[NOTE]
19+
====
20+
When creating a node health check with the Self Node Remediation Operator, you must select either `node-role.kubernetes.io/worker` or `node-role.kubernetes.io/control-plane` as the value.
21+
====
22+
+
23+
. Specify the minimum number of healthy nodes, using either a percentage or a number, required for a *NodeHealthCheck* to remediate nodes in the targeted pool. If the number of healthy nodes equals to or exceeds the limit set by *Min healthy*, remediation occurs. The default value is 51%.
24+
. Specify a list of *Unhealthy conditions* that if a node meets determines whether the node is considered unhealthy, and requires remediation. You can specify the *Type*, *Status* and *Duration*. You can also create your own custom type.
25+
. Click *Create* to create the node health check.
26+
27+
.Verification
28+
29+
* Navigate to the *Compute* -> *NodeHealthCheck* page and verify that the corresponding node health check is listed, and their status displayed. Once created, node health checks can be paused, modified, and deleted.

nodes/nodes/eco-node-health-check-operator.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ include::modules/eco-node-health-check-operator-installation-web-console.adoc[le
1919

2020
include::modules/eco-node-health-check-operator-installation-cli.adoc[leveloffset=+1]
2121

22+
include::modules/eco-node-health-check-operator-creating-node-health-check.adoc[leveloffset=+1]
23+
2224
[id="gather-data-nhc"]
2325
== Gathering data about the Node Health Check Operator
2426
To collect debugging information about the Node Health Check Operator, use the `must-gather` tool. For information about the `must-gather` image for the Node Health Check Operator, see xref:../../support/gathering-cluster-data.adoc#gathering-data-specific-features_gathering-cluster-data[Gathering data about specific features].

0 commit comments

Comments
 (0)