Skip to content

Commit 5daaf3e

Browse files
committed
Updated docs for the standalone NMO
1 parent 6be3428 commit 5daaf3e

7 files changed

+78
-67
lines changed

modules/eco-resuming-node-maintenance-cli.adoc

Lines changed: 0 additions & 18 deletions
This file was deleted.

modules/eco-resuming-node-from-maintenance-mode-with-cr.adoc renamed to modules/eco-resuming-node-maintenance-cr-cli.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
:_content-type: PROCEDURE
66
[id="eco-resuming-node-from-maintenance-mode-with-cr_{context}"]
7-
= Resuming a node from maintenance mode with the NodeMaintenance CR
7+
= Resuming a node from maintenance mode by using the CLI
88

99
You can resume a node from maintenance mode that was initiated with a `NodeMaintenance` CR by deleting the `NodeMaintenance` CR.
1010

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
//nodes/nodes/eco-node-maintenance-operator.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="eco-resuming-node-maintenance-web-console_{context}"]
7+
= Resuming a node from maintenance mode by using the web console
8+
9+
To resume a node from maintenance mode, you can delete a `NodeMaintenance` custom resource (CR) by using the web console.
10+
11+
.Prerequisites
12+
13+
* Log in as a user with `cluster-admin` privileges.
14+
* Install the Node Maintenance Operator from the *OperatorHub*.
15+
16+
.Procedure
17+
18+
. From the *Administrator* perspective in the web console, navigate to *Operators**Installed Operators*.
19+
20+
. Select the Node Maintenance Operator from the list of Operators.
21+
22+
. In the *Node Maintenance* tab, select the `NodeMaintenance` CR that you want to delete.
23+
24+
. Click the Options menu {kebab} at the end of the node and select *Delete NodeMaintenance*.
25+
26+
.Verification
27+
28+
. In the {product-title} console, click *Compute → Nodes*.
29+
30+
. Inspect the `Status` column of the node for which you deleted the `NodeMaintenance` CR and verify that its status is `Ready`.

modules/eco-setting-node-maintenance-cli.adoc

Lines changed: 0 additions & 31 deletions
This file was deleted.

modules/eco-setting-node-to-maintenance-mode-with-cr.adoc renamed to modules/eco-setting-node-maintenance-cr-cli.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
//nodes/nodes/eco-node-maintenance-operator.adoc
44

55
:_content-type: PROCEDURE
6-
[id="eco-setting-node-to-maintenance-mode-with-cr_{context}"]
7-
= Setting a node to maintenance mode with a NodeMaintenance CR
6+
[id="eco-setting-node-maintenance-cr-cli_{context}"]
7+
= Setting a node to maintenance mode by using the CLI
88

99
You can put a node into maintenance mode with a `NodeMaintenance` custom resource (CR). When you apply a `NodeMaintenance` CR, all allowed pods are evicted and the node is rendered unschedulable. Evicted pods are queued to be moved to another node in the cluster.
1010

@@ -15,21 +15,21 @@ You can put a node into maintenance mode with a `NodeMaintenance` custom resourc
1515
1616
.Procedure
1717

18-
. Create the following node maintenance CR, and save the file as `nodemaintenance-cr.yaml`:
18+
. Create the following `NodeMaintenance` CR, and save the file as `nodemaintenance-cr.yaml`:
1919
+
2020
[source,yaml]
2121
----
2222
apiVersion: nodemaintenance.medik8s.io/v1beta1
2323
kind: NodeMaintenance
2424
metadata:
25-
name: maintenance-example <1>
25+
name: nodemaintenance-cr <1>
2626
spec:
2727
nodeName: node-1.example.com <2>
2828
reason: "NIC replacement" <3>
2929
----
30-
<1> The name of the node maintenance CR
31-
<2> The name of the node to be put into maintenance mode
32-
<3> A plain text description of the reason for maintenance
30+
<1> The name of the node maintenance CR.
31+
<2> The name of the node to be put into maintenance mode.
32+
<3> A plain text description of the reason for maintenance.
3333
+
3434
. Apply the node maintenance CR by running the following command:
3535
+
@@ -38,11 +38,11 @@ spec:
3838
$ oc apply -f nodemaintenance-cr.yaml
3939
----
4040

41-
. Check the progress of the maintenance task by running the following command, replacing `<node-name>` with the name of your node:
41+
. Check the progress of the maintenance task by running the following command, replacing `<node-name>` with the name of your node; for example, `node-1.example.com`:
4242
+
4343
[source,terminal]
4444
----
45-
$ oc describe node <node-name>
45+
$ oc describe node node-1.example.com
4646
----
4747
+
4848
.Example output
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Module included in the following assemblies:
2+
//
3+
//nodes/nodes/eco-node-maintenance-operator.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="eco-setting-node-maintenance-web-console_{context}"]
7+
= Setting a node to maintenance mode by using the web console
8+
9+
To set a node to maintenance mode, you can create a `NodeMaintenance` custom resource (CR) by using the web console.
10+
11+
.Prerequisites
12+
13+
* Log in as a user with `cluster-admin` privileges.
14+
* Install the Node Maintenance Operator from the *OperatorHub*.
15+
16+
.Procedure
17+
18+
. From the *Administrator* perspective in the web console, navigate to *Operators**Installed Operators*.
19+
20+
. Select the Node Maintenance Operator from the list of Operators.
21+
22+
. In the *Node Maintenance* tab, click *Create NodeMaintenance*.
23+
24+
. In the *Create NodeMaintenance* page, select the *Form view* or the *YAML view* to configure the `NodeMaintenance` CR.
25+
26+
. To apply the `NodeMaintenance` CR that you have configured, click *Create*.
27+
28+
.Verification
29+
30+
In the *Node Maintenance* tab, inspect the `Status` column and verify that its status is `Succeeded`.

nodes/nodes/eco-node-maintenance-operator.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,11 @@ The Node Maintenance Operator is supported in a restricted network environment.
2929

3030
[id="setting-node-in-maintenance-mode"]
3131
== Setting a node to maintenance mode
32-
You can place a node into maintenance from the CLI or by using a `NodeMaintenance` CR.
32+
You can place a node into maintenance from the web console or in the CLI by using a `NodeMaintenance` CR.
3333

34-
include::modules/eco-setting-node-maintenance-cli.adoc[leveloffset=+2]
34+
include::modules/eco-setting-node-maintenance-cr-web-console.adoc[leveloffset=+2]
3535

36-
include::modules/eco-setting-node-to-maintenance-mode-with-cr.adoc[leveloffset=+2]
37-
38-
You can check the status of current `NodeMaintenance` CR tasks.
36+
include::modules/eco-setting-node-maintenance-cr-cli.adoc[leveloffset=+2]
3937

4038
include::modules/eco-checking_status_of_node_maintenance_cr_tasks.adoc[leveloffset=+3]
4139

@@ -44,11 +42,13 @@ include::modules/eco-checking_status_of_node_maintenance_cr_tasks.adoc[leveloffs
4442

4543
You can resume a node from maintenance mode from the CLI or by using a `NodeMaintenance` CR. Resuming a node brings it out of maintenance mode and makes it schedulable again.
4644

47-
include::modules/eco-resuming-node-maintenance-cli.adoc[leveloffset=+2]
45+
include::modules/eco-resuming-node-maintenance-cr-web-console.adoc[leveloffset=+2]
4846

49-
include::modules/eco-resuming-node-from-maintenance-mode-with-cr.adoc[leveloffset=+2]
47+
include::modules/eco-resuming-node-maintenance-cr-cli.adoc[leveloffset=+2]
5048

5149
[role="_additional-resources"]
5250
[id="additional-resources-node-maintenance-operator-installation"]
5351
== Additional resources
54-
* xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster]
52+
* xref:../../support/gathering-cluster-data.adoc#gathering-cluster-data[Gathering data about your cluster]
53+
* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-evacuating_nodes-nodes-working[Understanding how to evacuate pods on nodes]
54+
* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-marking_nodes-nodes-working[Understanding how to mark nodes as unschedulable or schedulable]

0 commit comments

Comments
 (0)