Skip to content

Commit 7a3c7e0

Browse files
committed
[OSDOCS-4610]: CPMSO content crosslinking
1 parent 47ab055 commit 7a3c7e0

File tree

5 files changed

+54
-4
lines changed

5 files changed

+54
-4
lines changed

machine_management/control_plane_machine_management/cpmso-about.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,11 @@ The Control Plane Machine Set Operator has the following limitations:
4141
Attempting to deploy control plane machines as AWS Spot Instances or Azure Spot VMs might cause the cluster to lose etcd quorum. A cluster that loses all control plane machines simultaneously is unrecoverable.
4242
====
4343

44-
* 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.
44+
* 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.
45+
46+
[role="_additional-resources"]
47+
[id="additional-resources_cpmso-about"]
48+
== Additional resources
49+
50+
* xref:../../operators/operator-reference.adoc#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator reference]
51+
* xref:../../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource]

machine_management/control_plane_machine_management/cpmso-getting-started.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Clusters without a generated CR:: For clusters that do not include a generated C
2222

2323
If you are uncertain about the state of the `ControlPlaneMachineSet` CR in your cluster, you can xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-checking-status_cpmso-getting-started[verify the CR status].
2424

25-
[discrete]
2625
[id="cpmso-platform-matrix_{context}"]
2726
== Supported cloud providers
2827

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+
// * operators/operator-reference.adoc
4+
5+
[id="control-plane-machine-set-operator_{context}"]
6+
= Control Plane Machine Set Operator
7+
8+
[NOTE]
9+
====
10+
This Operator is available for Amazon Web Services (AWS), Microsoft Azure, and VMware vSphere.
11+
====
12+
13+
[discrete]
14+
== Purpose
15+
16+
The Control Plane Machine Set Operator automates the management of control plane machine resources within an {product-title} cluster.
17+
18+
[discrete]
19+
== Project
20+
21+
link:https://github.com/openshift/cluster-control-plane-machine-set-operator[cluster-control-plane-machine-set-operator]
22+
23+
[discrete]
24+
== CRDs
25+
26+
* `controlplanemachineset.machine.openshift.io`
27+
** Scope: Namespaced
28+
** CR: `ControlPlaneMachineSet`
29+
** Validation: Yes

operators/operator-reference.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ include::modules/cloud-credential-operator.adoc[leveloffset=+1]
3131
[id="additional-resources_cluster-op-ref-cco"]
3232
=== Additional resources
3333

34-
* xref:../rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[CredentialsRequest custom resource]
3534
* xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator]
35+
* xref:../rest_api/security_apis/credentialsrequest-cloudcredential-openshift-io-v1.adoc#credentialsrequest-cloudcredential-openshift-io-v1[`CredentialsRequest` custom resource]
3636

3737
include::modules/cluster-authentication-operator.adoc[leveloffset=+1]
3838
include::modules/cluster-autoscaler-operator.adoc[leveloffset=+1]
@@ -56,6 +56,16 @@ include::modules/cluster-version-operator.adoc[leveloffset=+1]
5656
* xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators in {product-title}]
5757

5858
include::modules/console-operator.adoc[leveloffset=+1]
59+
include::modules/control-plane-machine-set-operator.adoc[leveloffset=+1]
60+
61+
[role="_additional-resources"]
62+
[discrete]
63+
[id="additional-resources_cluster-op-ref-cpmso"]
64+
=== Additional resources
65+
66+
* xref:../machine_management/control_plane_machine_management/cpmso-about.adoc#cpmso-about[About the Control Plane Machine Set Operator]
67+
* xref:../rest_api/machine_apis/controlplanemachineset-machine-openshift-io-v1.adoc#controlplanemachineset-machine-openshift-io-v1[`ControlPlaneMachineSet` custom resource]
68+
5969
include::modules/cluster-dns-operator.adoc[leveloffset=+1]
6070
include::modules/etcd-operator.adoc[leveloffset=+1]
6171
include::modules/ingress-operator.adoc[leveloffset=+1]

post_installation_configuration/cluster-tasks.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,6 +512,11 @@ include::modules/nodes-cluster-worker-latency-profiles-about.adoc[leveloffset=+2
512512

513513
include::modules/nodes-cluster-worker-latency-profiles-using.adoc[leveloffset=+2]
514514

515+
[id="post-install-cpms-setup"]
516+
== Managing control plane machines
517+
518+
xref:../machine_management/control_plane_machine_management/cpmso-about.adoc#cpmso-about[Control plane machine sets] provide management capabilities for control plane machines that are similar to what compute machine sets provide for compute machines. The availability and initial status of control plane machine sets on your cluster depend on your cloud provider and the version of {product-title} that you installed. For more information, see xref:../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-getting-started[Getting started with the Control Plane Machine Set Operator].
519+
515520
[id="post-install-creating-infrastructure-machinesets-production"]
516521
== Creating infrastructure machine sets for production environments
517522

@@ -521,7 +526,7 @@ In a production deployment, it is recommended that you deploy at least three com
521526

522527
For information on infrastructure nodes and which components can run on infrastructure nodes, see xref:../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets[Creating infrastructure machine sets].
523528

524-
To create an infrastructure node, you can xref:../post_installation_configuration/cluster-tasks.adoc#machineset-creating_post-install-cluster-tasks[use a machine set], post_installation_configuration/cluster-tasks.adoc#creating-an-infra-node_post-install-cluster-tasks[assign a label to the nodes], or xref:../post_installation_configuration/cluster-tasks.adoc#creating-infra-machines_post-install-cluster-tasks[use a machine config pool].
529+
To create an infrastructure node, you can xref:../post_installation_configuration/cluster-tasks.adoc#machineset-creating_post-install-cluster-tasks[use a machine set], xref:../post_installation_configuration/cluster-tasks.adoc#creating-an-infra-node_post-install-cluster-tasks[assign a label to the nodes], or xref:../post_installation_configuration/cluster-tasks.adoc#creating-infra-machines_post-install-cluster-tasks[use a machine config pool].
525530

526531
For sample machine sets that you can use with these procedures, see xref:../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets-clouds[Creating machine sets for different clouds].
527532

0 commit comments

Comments
 (0)