Skip to content

Commit 386579a

Browse files
authored
Merge pull request #78165 from AedinC/OSDOCS-10369
OSDOCS-10369:Add info on CPMS to OSD/ROSA docs.
2 parents 4824720 + 983db82 commit 386579a

File tree

3 files changed

+60
-4
lines changed

3 files changed

+60
-4
lines changed

architecture/control-plane.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ endif::openshift-dedicated,openshift-rosa[]
6868
6969
include::modules/etcd-overview.adoc[leveloffset=+1]
7070
71+
// These modules only apply to ROSA/OSD
72+
ifdef::openshift-dedicated,openshift-rosa[]
73+
include::modules/cpmso-feat-auto-update.adoc[leveloffset=+1]
74+
include::modules/cpmso-control-plane-recovery.adoc[leveloffset=+1]
75+
endif::openshift-dedicated,openshift-rosa[]
76+
7177
// These xrefs do not apply to OSD/ROSA
7278
ifndef::openshift-dedicated,openshift-rosa[]
7379
[role="_additional-resources"]

modules/cpmso-control-plane-recovery.adoc

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
// Module included in the following assemblies:
22
//
33
// * machine_management/cpmso-resiliency.adoc
4+
// * rosa/architecture/control-plane.adoc
5+
// * osd/architecture/control-plane.adoc
6+
7+
ifeval::["{context}" == "control-plane"]
8+
:rosa-classic:
9+
:osd:
10+
endif::[]
411

512
:_mod-docs-content-type: CONCEPT
613
[id="cpmso-control-plane-recovery_{context}"]
714
= Recovery of failed control plane machines
815

916
The Control Plane Machine Set Operator automates the recovery of control plane machines. When a control plane machine is deleted, the Operator creates a replacement with the configuration that is specified in the `ControlPlaneMachineSet` custom resource (CR).
1017

18+
ifndef::openshift-dedicated,openshift-rosa[]
1119
For clusters that use control plane machine sets, you can configure a machine health check. The machine health check deletes unhealthy control plane machines so that they are replaced.
1220

1321
[IMPORTANT]
@@ -17,4 +25,10 @@ If you configure a `MachineHealthCheck` resource for the control plane, set the
1725
This configuration ensures that the machine health check takes no action when multiple control plane machines appear to be unhealthy. Multiple unhealthy control plane machines can indicate that the etcd cluster is degraded or that a scaling operation to replace a failed machine is in progress.
1826
1927
If the etcd cluster is degraded, manual intervention might be required. If a scaling operation is in progress, the machine health check should allow it to finish.
20-
====
28+
====
29+
endif::openshift-dedicated,openshift-rosa[]
30+
31+
ifeval::["{context}" == "control-plane"]
32+
:!rosa-classic:
33+
:!osd:
34+
endif::[]

modules/cpmso-feat-auto-update.adoc

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,49 @@
11
// Module included in the following assemblies:
22
//
33
// * machine_management/control_plane_machine_management/cpmso-managing-machines.adoc
4+
// * rosa/architecture/control-plane.adoc
5+
// * osd/architecture/control-plane.adoc
6+
7+
ifeval::["{context}" == "control-plane"]
8+
:rosa-classic:
9+
:osd:
10+
endif::[]
411

512
:_mod-docs-content-type: CONCEPT
613
[id="cpmso-feat-auto-update_{context}"]
714
= Automatic updates to the control plane configuration
15+
//Not for ROSA/OSD:
16+
ifndef::openshift-dedicated,openshift-rosa[]
17+
The `RollingUpdate` update strategy automatically propagates changes to your control plane configuration.
18+
This update strategy is the default configuration for the control plane machine set.
19+
20+
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.
21+
When the replacement control plane machine is ready, the Operator deletes the control plane machine that is marked for replacement.
22+
The replacement machine then joins the control plane.
23+
24+
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.
25+
endif::openshift-dedicated,openshift-rosa[]
26+
27+
//For ROSA/OSD:
28+
ifdef::openshift-dedicated,openshift-rosa[]
29+
30+
On {product-title} clusters, control plane machine sets automatically propagate changes to your control plane configuration.
31+
When a control plane machine needs to be replaced, the Control Plane Machine Set Operator creates a replacement machine based on the configuration specified by the `ControlPlaneMachineSet` custom resource (CR). When the new control plane machine is ready, the Operator safely drains and terminates the old control plane machine in a way that mitigates any potential negative effects on cluster API or workload availability.
32+
33+
[IMPORTANT]
34+
====
35+
You cannot request that control plane machine replacements happen only during maintenance windows. The Control Plane Machine Set Operator acts to ensure cluster stability. Waiting for a maintenance window could result in cluster stability being compromised.
36+
====
837

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.
38+
A control plane machine can be marked for replacement at any time, typically because the machine has fallen out of spec or entered an unhealthy state. Such replacements are a normal part of a cluster's lifecycle and not a cause for concern. SRE will be alerted to the issue automatically if any part of a control plane node replacement fails.
1039

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.
40+
[NOTE]
41+
====
42+
Depending on when the {product-title} cluster was originally created, the introduction of control plane machine sets might leave one or two control plane nodes with labels or machine names that are inconsistent with the other control plane nodes. For example `clustername-master-0`, `clustername-master-1`,and `clustername-master-2-abcxyz`. Such naming inconsistencies do not affect the workings of the cluster and are not a cause for concern.
43+
====
44+
endif::openshift-dedicated,openshift-rosa[]
1245

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.
46+
ifeval::["{context}" == "control-plane"]
47+
:!rosa-classic:
48+
:!osd:
49+
endif::[]

0 commit comments

Comments
 (0)