Skip to content

Commit 19ff68c

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #52831 from jeana-redhat/OSDOCS-4236-CPMS-config-changes
[OSDOCS-4236]: Updating control plane config
2 parents 6a475b0 + 7e41832 commit 19ff68c

22 files changed

+349
-97
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1979,8 +1979,8 @@ Topics:
19791979
File: cpmso-getting-started
19801980
- Name: Control Plane Machine Set Operator configuration
19811981
File: cpmso-configuration
1982-
#- Name: Using the Control Plane Machine Set Operator
1983-
# File: cpmso-using
1982+
- Name: Using the Control Plane Machine Set Operator
1983+
File: cpmso-using
19841984
- Name: Control plane resiliency and recovery
19851985
File: cpmso-resiliency
19861986
#- Name: Troubleshooting the Control Plane Machine Set Operator

‎machine_management/control_plane_machine_management/cpmso-configuration.adoc

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ These example YAML file and snippets demonstrate the base structure for a contro
1010

1111
//Sample YAML for a control plane machine set custom resource
1212
include::modules/cpmso-yaml-sample-cr.adoc[leveloffset=+1]
13-
////
13+
1414
[role="_additional-resources"]
1515
.Additional resources
16-
* xr@f:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-feat-config-update_cpmso-using[Updating the control plane configuration]
17-
////
16+
* xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-getting-started[Getting started with the Control Plane Machine Set Operator]
17+
18+
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-feat-config-update_cpmso-using[Updating the control plane configuration]
19+
20+
[discrete]
21+
[id="cpmso-sample-yaml-provider-specific_{context}"]
22+
=== Provider-specific configuration
23+
1824
The `<platform_failure_domains>` and `<platform_provider_spec>` sections of the control plane machine set resources are provider-specific. Refer to the example YAML for your cluster:
1925

2026
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-aws_cpmso-configuration[Sample YAML snippets for configuring Amazon Web Services clusters]
@@ -35,6 +41,10 @@ include::modules/cpmso-yaml-failure-domain-aws.adoc[leveloffset=+2]
3541
//Sample AWS provider specification
3642
include::modules/cpmso-yaml-provider-spec-aws.adoc[leveloffset=+2]
3743

44+
[role="_additional-resources"]
45+
.Additional resources
46+
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-aws_cpmso-using[Enabling Amazon Web Services features for control plane machines]
47+
3848
[id="cpmso-sample-yaml-azure_{context}"]
3949
== Sample YAML for configuring Microsoft Azure clusters
4050

@@ -46,6 +56,10 @@ include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+2]
4656
//Sample Azure provider specification
4757
include::modules/cpmso-yaml-provider-spec-azure.adoc[leveloffset=+2]
4858

59+
[role="_additional-resources"]
60+
.Additional resources
61+
* xref:../../machine_management/control_plane_machine_management/cpmso-using.adoc#cpmso-supported-features-azure_cpmso-using[Enabling Microsoft Azure features for control plane machines]
62+
4963
[id="cpmso-sample-yaml-vsphere_{context}"]
5064
== Sample YAML for configuring VMware vSphere clusters
5165

‎machine_management/control_plane_machine_management/cpmso-using.adoc

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,71 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
The Control Plane Machine Set Operator automates the following capabilities:
9+
The Control Plane Machine Set Operator automates several essential aspects of control plane management.
1010

1111
//Vertical resizing of the control plane
12-
include::modules/cpmso-feat-vertical-resize.adoc[leveloffset=+1]
12+
//include::modules/cpmso-feat-vertical-resize.adoc[leveloffset=+1]
1313

1414
//Updating the control plane configuration
1515
include::modules/cpmso-feat-config-update.adoc[leveloffset=+1]
1616

17+
//Automatically updating the control plane configuration
18+
include::modules/cpmso-feat-auto-update.adoc[leveloffset=+2]
19+
1720
//Testing changes to the control plane configuration
1821
include::modules/cpmso-feat-test-changes.adoc[leveloffset=+2]
22+
23+
[id="cpmso-supported-features-aws_{context}"]
24+
== Enabling Amazon Web Services features for control plane machines
25+
26+
You can enable Amazon Web Services (AWS) features on control plane machines by changing the configuration of your control plane machine set. When you save an update to the control plane machine set, the Control Plane Machine Set Operator updates the control plane machines according to your configured update strategy.
27+
28+
//Machine sets that enable the Amazon EC2 Instance Metadata Service
29+
include::modules/machineset-imds-options.adoc[leveloffset=+2]
30+
31+
//Creating machines that use the Amazon EC2 Instance Metadata Service
32+
include::modules/machineset-creating-imds-options.adoc[leveloffset=+3]
33+
34+
//Machine sets that deploy machines as Dedicated Instances
35+
include::modules/machineset-dedicated-instances.adoc[leveloffset=+2]
36+
37+
//Creating Dedicated Instances by using machine sets
38+
include::modules/machineset-creating-dedicated-instances.adoc[leveloffset=+3]
39+
40+
[id="cpmso-supported-features-azure_{context}"]
41+
== Enabling Microsoft Azure features for control plane machines
42+
43+
You can enable Microsoft Azure features on control plane machines by changing the configuration of your control plane machine set. When you save an update to the control plane machine set, the Control Plane Machine Set Operator updates the control plane machines according to your configured update strategy.
44+
45+
//Selecting an Azure Marketplace image
46+
include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+2]
47+
48+
//Enabling Azure boot diagnostics
49+
include::modules/machineset-azure-boot-diagnostics.adoc[leveloffset=+2]
50+
51+
//Machine sets that deploy machines on ultra disks as data disks
52+
include::modules/machineset-azure-ultra-disk.adoc[leveloffset=+2]
53+
54+
[role="_additional-resources"]
55+
.Additional resources
56+
* link:https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#ultra-disks[Microsoft Azure ultra disks documentation]
57+
58+
//Creating machines on ultra disks by using machine sets
59+
include::modules/machineset-creating-azure-ultra-disk.adoc[leveloffset=+3]
60+
61+
//Troubleshooting resources for machine sets that enable ultra disks
62+
include::modules/machineset-troubleshooting-azure-ultra-disk.adoc[leveloffset=+3]
63+
64+
//Enabling customer-managed encryption keys for a machine set
65+
include::modules/machineset-customer-managed-encryption-azure.adoc[leveloffset=+2]
66+
67+
// Accelerated Networking for Microsoft Azure VMs
68+
include::modules/machineset-azure-accelerated-networking.adoc[leveloffset=+2]
69+
70+
//Not applicable for 4.12, possibly 4.13?
71+
//[role="_additional-resources"]
72+
//.Additional resources
73+
//* xref:../../installing/installing_azure/installing-azure-customizations.adoc#machineset-azure-enabling-accelerated-networking-new-install_installing-azure-customizations[Enabling Accelerated Networking during installation]
74+
75+
// Enabling Accelerated Networking on an existing Microsoft Azure cluster
76+
include::modules/machineset-azure-enabling-accelerated-networking-existing.adoc[leveloffset=+3]

‎machine_management/creating_machinesets/creating-machineset-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ include::modules/machineset-creating-imds-options.adoc[leveloffset=+2]
2929
//Machine sets that deploy machines as Dedicated Instances
3030
include::modules/machineset-dedicated-instances.adoc[leveloffset=+1]
3131

32-
//Creating Dedicated Instances by using compute machine sets
32+
//Creating Dedicated Instances by using machine sets
3333
include::modules/machineset-creating-dedicated-instances.adoc[leveloffset=+2]
3434

3535
//Machine sets that deploy machines as Spot Instances

‎machine_management/creating_machinesets/creating-machineset-azure.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::modules/machineset-creating.adoc[leveloffset=+1]
2323
//Selecting an Azure Marketplace image
2424
include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+1]
2525

26-
//Enabling Azure boot diagnostics on compute machines
26+
//Enabling Azure boot diagnostics
2727
include::modules/machineset-azure-boot-diagnostics.adoc[leveloffset=+1]
2828

2929
//Machine sets that deploy machines as Spot VMs
@@ -47,13 +47,13 @@ include::modules/machineset-azure-ultra-disk.adoc[leveloffset=+1]
4747
* xref:../../storage/container_storage_interface/persistent-storage-csi-azure.adoc#machineset-azure-ultra-disk_persistent-storage-csi-azure[Machine sets that deploy machines on ultra disks using CSI PVCs]
4848
* xref:../../storage/persistent_storage/persistent-storage-azure.adoc#machineset-azure-ultra-disk_persistent-storage-azure[Machine sets that deploy machines on ultra disks using in-tree PVCs]
4949
50-
//Creating machines on ultra disks by using compute machine sets
50+
//Creating machines on ultra disks by using machine sets
5151
include::modules/machineset-creating-azure-ultra-disk.adoc[leveloffset=+2]
5252

53-
//Troubleshooting resources for compute machine sets that enable ultra disks
53+
//Troubleshooting resources for machine sets that enable ultra disks
5454
include::modules/machineset-troubleshooting-azure-ultra-disk.adoc[leveloffset=+2]
5555

56-
//Enabling customer-managed encryption keys for a compute machine set
56+
//Enabling customer-managed encryption keys for a machine set
5757
include::modules/machineset-customer-managed-encryption-azure.adoc[leveloffset=+1]
5858

5959
// Accelerated Networking for Microsoft Azure VMs

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * machine_management/control_plane_machine_management/cpmso-using.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="cpmso-feat-auto-update_{context}"]
7+
= Automatically updating the control plane configuration
8+
9+
You can use the `RollingUpdate` update strategy to automatically propagate changes to your control plane configuration.
10+
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.
12+
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.

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

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,39 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/cpmso-about.adoc
3+
// * machine_management/control_plane_machine_management/cpmso-using.adoc
44

5-
:_content-type: CONCEPT
5+
:_content-type: PROCEDURE
66
[id="cpmso-feat-config-update_{context}"]
7-
= Updating the control plane configuration
7+
= Updating the control plane configuration
8+
9+
You can make changes to the configuration of the machines in the control plane by updating the specification in the control plane machine set custom resource (CR).
10+
11+
The Control Plane Machine Set Operator monitors the control plane machines and compares their configuration with the specification in the control plane machine set CR. When there is a discrepancy between the specification in the CR and the configuration of a control plane machine, the Operator marks that control plane machine for replacement.
12+
13+
[NOTE]
14+
====
15+
For more information about the parameters in the CR, see "Control Plane Machine Set Operator configuration".
16+
====
17+
18+
.Prerequisites
19+
20+
* Your cluster has an activated and functioning Control Plane Machine Set Operator.
21+
22+
.Procedure
23+
24+
. Edit your control plane machine set CR by running the following command:
25+
+
26+
[source,terminal]
27+
----
28+
$ oc --namespace openshift-machine-api edit controlplanemachineset.machine.openshift.io cluster
29+
----
30+
31+
. Change the values of any fields that you want to update in your cluster configuration.
32+
33+
. Save your changes.
34+
35+
.Next steps
36+
37+
* For clusters that use the default `RollingUpdate` update strategy, the Operator automatically propagates the changes to your control plane configuration.
38+
39+
* 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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/cpmso-about.adoc
3+
// * machine_management/control_plane_machine_management/cpmso-using.adoc
44

55
:_content-type: CONCEPT
66
[id="cpmso-feat-test-changes_{context}"]
7-
= Testing changes to the control plane configuration
7+
= Testing changes to the control plane configuration
8+
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.
10+
11+
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.
12+
13+
If multiple control plane machines are deleted, the Operator creates all of the required replacement machines simultaneously.

‎modules/cpmso-yaml-provider-spec-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ providerSpec:
5757
userDataSecret:
5858
name: master-user-data <12>
5959
----
60-
<1> Specifies the Amazon Machine Images (AMI) ID for the cluster. The AMI must belong to the same region as the cluster.
60+
<1> Specifies the {op-system-first} Amazon Machine Images (AMI) ID for the cluster. The AMI must belong to the same region as the cluster. If you want to use an AWS Marketplace image, you must complete the {product-title} subscription from the link:https://aws.amazon.com/marketplace/fulfillment?productId=59ead7de-2540-4653-a8b0-fa7926d5c845[AWS Marketplace] to obtain an AMI ID for your region.
6161
<2> Specifies the configuration of an encrypted EBS volume.
6262
<3> Specifies the secret name for the cluster. Do not change this value.
6363
<4> Specifies the AWS Identity and Access Management (IAM) instance profile. Do not change this value.

‎modules/cpmso-yaml-sample-cr.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
5656
====
5757
Before you activate the Operator, you must ensure that the `ControlPlaneMachineSet` CR configuration is correct for your cluster requirements. For more information about activating the Control Plane Machine Set Operator, see "Getting started with the Control Plane Machine Set Operator".
5858
====
59-
<5> Specifies the update strategy for the cluster. The allowed values are `OnDelete` and `RollingUpdate`. The default value is `RollingUpdate`.
60-
//For more information about update strategies, see "Updating the control plane configuration".
59+
<5> Specifies the update strategy for the cluster. The allowed values are `OnDelete` and `RollingUpdate`. The default value is `RollingUpdate`. For more information about update strategies, see "Updating the control plane configuration".
6160
<6> Specifies the cloud provider platform name. Do not change this value.
6261
<7> Specifies the `<platform_failure_domains>` configuration for the cluster. The format and values of this section are provider-specific. For more information, see the sample failure domain configuration for your cloud provider.
6362
+

0 commit comments

Comments
 (0)