Skip to content

Commit 56a9574

Browse files
jeana-redhatjeana-redhat
committed
Reorganize CPMS info
1 parent b139d50 commit 56a9574

File tree

5 files changed

+56
-12
lines changed

5 files changed

+56
-12
lines changed

‎machine_management/control_plane_machine_management/cpmso-using.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,20 @@ toc::[]
88

99
Control plane machine sets automate several essential aspects of control plane management.
1010

11+
//Replacing a control plane machine
12+
include::modules/cpmso-feat-replace.adoc[leveloffset=+1]
13+
1114
//Vertical resizing of the control plane
1215
//include::modules/cpmso-feat-vertical-resize.adoc[leveloffset=+1]
1316

1417
//Updating the control plane configuration
1518
include::modules/cpmso-feat-config-update.adoc[leveloffset=+1]
1619

17-
//Automatically updating the control plane configuration
20+
//Automatic updates to the control plane configuration
1821
include::modules/cpmso-feat-auto-update.adoc[leveloffset=+2]
1922

20-
//Testing changes to the control plane configuration
21-
include::modules/cpmso-feat-test-changes.adoc[leveloffset=+2]
23+
//Manual updates to the control plane configuration
24+
include::modules/cpmso-feat-ondelete-update.adoc[leveloffset=+2]
2225

2326
[id="cpmso-supported-features-aws_{context}"]
2427
== Enabling Amazon Web Services features for control plane machines

‎modules/cpmso-feat-auto-update.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
:_content-type: CONCEPT
66
[id="cpmso-feat-auto-update_{context}"]
7-
= Automatically updating the control plane configuration
7+
= Automatic updates to the control plane configuration
88

9-
You can use the `RollingUpdate` update strategy to automatically propagate changes to your control plane configuration.
9+
The `RollingUpdate` update strategy automatically propagates changes to your control plane configuration. This update strategy is the default configuration for the control plane machine set.
1010

11-
For clusters that use the default `RollingUpdate` update strategy, the Operator creates a replacement control plane machine with the configuration that is specified in the CR. When the replacement control plane machine is ready, the Operator deletes the control plane machine that is marked for replacement. The replacement machine then joins the control plane.
11+
For clusters that use the `RollingUpdate` update strategy, the Operator creates a replacement control plane machine with the configuration that is specified in the CR. When the replacement control plane machine is ready, the Operator deletes the control plane machine that is marked for replacement. The replacement machine then joins the control plane.
1212

13-
If multiple control plane machines are marked for replacement, the Operator repeats this replacement process one machine at a time until each machine is replaced.
13+
If multiple control plane machines are marked for replacement, the Operator protects etcd health during replacement by repeating this replacement process one machine at a time until it has replaced each machine.

‎modules/cpmso-feat-config-update.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ $ oc edit controlplanemachineset.machine.openshift.io cluster \
3535

3636
.Next steps
3737

38-
* For clusters that use the default `RollingUpdate` update strategy, the changes to your control plane configuration are propagated automatically.
38+
* For clusters that use the default `RollingUpdate` update strategy, the control plane machine set propagates changes to your control plane configuration automatically.
3939
4040
* For clusters that are configured to use the `OnDelete` update strategy, you must replace your control plane machines manually.

‎modules/cpmso-feat-test-changes.adoc renamed to ‎modules/cpmso-feat-ondelete-update.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
// * machine_management/control_plane_machine_management/cpmso-using.adoc
44

55
:_content-type: CONCEPT
6-
[id="cpmso-feat-test-changes_{context}"]
7-
= Testing changes to the control plane configuration
6+
[id="cpmso-feat-ondelete-update_{context}"]
7+
= Manual updates to the control plane configuration
88

9-
You can use the `OnDelete` update strategy to test changes to your control plane configuration. With this update strategy, you replace control plane machines manually. Manually replacing machines allows you to test changes to your configuration on a single machine before applying the changes more broadly.
9+
You can use the `OnDelete` update strategy to propagate changes to your control plane configuration by replacing machines manually. Manually replacing machines allows you to test changes to your configuration on a single machine before applying the changes more broadly.
1010

1111
For clusters that are configured to use the `OnDelete` update strategy, the Operator creates a replacement control plane machine when you delete an existing machine. When the replacement control plane machine is ready, the etcd Operator allows the existing machine to be deleted. The replacement machine then joins the control plane.
1212

13-
If multiple control plane machines are deleted, the Operator creates all of the required replacement machines simultaneously.
13+
If multiple control plane machines are deleted, the Operator creates all of the required replacement machines simultaneously. The Operator maintains etcd health by preventing more than one machine being removed from the control plane at once.

‎modules/cpmso-feat-replace.adoc

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/control_plane_machine_management/cpmso-using.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="cpmso-feat-replace_{context}"]
7+
= Replacing a control plane machine
8+
9+
To replace a control plane machine in a cluster that has a control plane machine set, you delete the machine manually. The control plane machine set replaces the deleted machine with one using the specification in the control plane machine set custom resource (CR).
10+
11+
.Procedure
12+
13+
. List the control plane machines in your cluster by running the following command:
14+
+
15+
[source,terminal]
16+
----
17+
$ oc get machines \
18+
-l machine.openshift.io/cluster-api-machine-role==master \
19+
-n openshift-machine-api
20+
----
21+
22+
. Delete a control plane machine by running the following command:
23+
+
24+
[source,terminal]
25+
----
26+
$ oc delete machine \
27+
-n openshift-machine-api \
28+
<control_plane_machine_name> <1>
29+
----
30+
<1> Specify the name of the control plane machine to delete.
31+
+
32+
[NOTE]
33+
====
34+
If you delete multiple control plane machines, the control plane machine set replaces them according to the configured update strategy:
35+
36+
* For clusters that use the default `RollingUpdate` update strategy, the Operator replaces one machine at a time until each machine is replaced.
37+
38+
* For clusters that are configured to use the `OnDelete` update strategy, the Operator creates all of the required replacement machines simultaneously.
39+
40+
Both strategies maintain etcd health during control plane machine replacement.
41+
====

0 commit comments

Comments
 (0)