Skip to content

Commit 84c157d

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #71212 from jeana-redhat/OSDOCS-9551-clarify-CPMS-limitations
OSDOCS-9551: Further clarify CPMS non-IPI incompatibility
2 parents e1cc46a + 8072c45 commit 84c157d

File tree

2 files changed

+56
-23
lines changed

2 files changed

+56
-23
lines changed

‎machine_management/control_plane_machine_management/cpmso-about.adoc

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,8 @@ Control plane machine sets provide for control plane machines similar management
1818
//Control Plane Machine Set Operator overview
1919
include::modules/cpmso-overview.adoc[leveloffset=+1]
2020

21-
[id="cpmso-limitations_{context}"]
22-
== Limitations
23-
24-
The Control Plane Machine Set Operator has the following limitations:
25-
26-
* The Operator requires the Machine API Operator to be operational and is therefore not supported on clusters with manually provisioned machines. When installing a {product-title} cluster with manually provisioned machines for a platform that creates an active generated `ControlPlaneMachineSet` custom resource (CR), you must remove the Kubernetes manifest files that define the control plane machine set as instructed in the installation process.
27-
28-
* Only Amazon Web Services (AWS), Google Cloud Platform (GCP), {ibm-power-server-name}, Microsoft Azure, Nutanix, VMware vSphere, and {rh-openstack-first} clusters are supported.
29-
30-
* Only clusters with three control plane machines are supported.
31-
32-
* Horizontal scaling of the control plane is not supported.
33-
34-
* Deploying Azure control plane machines on Ephemeral OS disks increases risk for data loss and is not supported.
35-
36-
* Deploying control plane machines as AWS Spot Instances, GCP preemptible VMs, or Azure Spot VMs is not supported.
37-
+
38-
[IMPORTANT]
39-
====
40-
Attempting to deploy control plane machines as AWS Spot Instances, GCP preemptible VMs, or Azure Spot VMs might cause the cluster to lose etcd quorum. A cluster that loses all control plane machines simultaneously is unrecoverable.
41-
====
42-
43-
* Making changes to the control plane machine set during or prior to installation is not supported. You must make any changes to the control plane machine set only after installation.
21+
//Control Plane Machine Set Operator limitations
22+
include::modules/cpmso-limitations.adoc[leveloffset=+1]
4423

4524
[role="_additional-resources"]
4625
[id="additional-resources_cpmso-about"]

‎modules/cpmso-limitations.adoc

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/cpmso-about.adoc
4+
5+
:_mod-docs-content-type: REFERENCE
6+
[id="cpmso-limitations_{context}"]
7+
= Control Plane Machine Set Operator limitations
8+
9+
The Control Plane Machine Set Operator has the following limitations:
10+
11+
* Only Amazon Web Services (AWS), Google Cloud Platform (GCP), {ibm-power-server-name}, Microsoft Azure, Nutanix, VMware vSphere, and {rh-openstack-first} clusters are supported.
12+
13+
* Clusters that do not have preexisting machines that represent the control plane nodes cannot use a control plane machine set or enable the use of a control plane machine set after installation. Generally, preexisting control plane machines are only present if a cluster was installed using infrastructure provisioned by the installation program.
14+
+
15+
To determine if a cluster has the required preexisting control plane machines, run the following command as a user with administrator privileges:
16+
+
17+
[source,terminal]
18+
----
19+
$ oc get machine \
20+
-n openshift-machine-api \
21+
-l machine.openshift.io/cluster-api-machine-role=master
22+
----
23+
+
24+
.Example output showing preexisting control plane machines
25+
[source,text]
26+
----
27+
NAME PHASE TYPE REGION ZONE AGE
28+
<cluster_id>-master-0 Running m6i.xlarge us-west-1 us-west-1a 5h19m
29+
<cluster_id>-master-1 Running m6i.xlarge us-west-1 us-west-1b 5h19m
30+
<cluster_id>-master-2 Running m6i.xlarge us-west-1 us-west-1a 5h19m
31+
----
32+
+
33+
.Example output missing preexisting control plane machines
34+
[source,text]
35+
----
36+
No resources found in openshift-machine-api namespace.
37+
----
38+
39+
* The Operator requires the Machine API Operator to be operational and is therefore not supported on clusters with manually provisioned machines. When installing a {product-title} cluster with manually provisioned machines for a platform that creates an active generated `ControlPlaneMachineSet` custom resource (CR), you must remove the Kubernetes manifest files that define the control plane machine set as instructed in the installation process.
40+
41+
* Only clusters with three control plane machines are supported.
42+
43+
* Horizontal scaling of the control plane is not supported.
44+
45+
* Deploying Azure control plane machines on Ephemeral OS disks increases risk for data loss and is not supported.
46+
47+
* Deploying control plane machines as AWS Spot Instances, GCP preemptible VMs, or Azure Spot VMs is not supported.
48+
+
49+
[IMPORTANT]
50+
====
51+
Attempting to deploy control plane machines as AWS Spot Instances, GCP preemptible VMs, or Azure Spot VMs might cause the cluster to lose etcd quorum. A cluster that loses all control plane machines simultaneously is unrecoverable.
52+
====
53+
54+
* Making changes to the control plane machine set during or prior to installation is not supported. You must make any changes to the control plane machine set only after installation.

0 commit comments

Comments
 (0)