Skip to content

Commit 0ee4bca

Browse files
committed
OSDOCS-17046: MACH-6 CQA split CPMS config assemblies
1 parent 89bea73 commit 0ee4bca

32 files changed

+352
-240
lines changed

_topic_maps/_topic_map.yml

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2444,18 +2444,28 @@ Topics:
24442444
- Name: Configuration options for control plane machines
24452445
Dir: cpmso_provider_configurations
24462446
Topics:
2447-
- Name: Control plane configuration options for Amazon Web Services
2447+
- Name: Changing control plane configuration options for Amazon Web Services
24482448
File: cpmso-config-options-aws
2449-
- Name: Control plane configuration options for Microsoft Azure
2449+
- Name: Configuring Amazon Web Services features for control plane machines
2450+
File: cpmso-supported-features-aws
2451+
- Name: Changing control plane configuration options for Microsoft Azure
24502452
File: cpmso-config-options-azure
2451-
- Name: Control plane configuration options for Google Cloud
2453+
- Name: Configuring Microsoft Azure features for control plane machines
2454+
File: cpmso-supported-features-azure
2455+
- Name: Changing control plane configuration options for Google Cloud
24522456
File: cpmso-config-options-gcp
2453-
- Name: Control plane configuration options for Nutanix
2457+
- Name: Configuring Google Cloud features for control plane machines
2458+
File: cpmso-supported-features-gcp
2459+
- Name: Changing control plane configuration options for Nutanix
24542460
File: cpmso-config-options-nutanix
2455-
- Name: Control plane configuration options for Red Hat OpenStack Platform
2461+
- Name: Changing control plane configuration options for Red Hat OpenStack Platform
24562462
File: cpmso-config-options-openstack
2457-
- Name: Control plane configuration options for VMware vSphere
2463+
- Name: Configuring Red Hat OpenStack Platform features for control plane machines
2464+
File: cpmso-supported-features-openstack
2465+
- Name: Changing control plane configuration options for VMware vSphere
24582466
File: cpmso-config-options-vsphere
2467+
- Name: Configuring VMware vSphere features for control plane machines
2468+
File: cpmso-supported-features-vsphere
24592469
- Name: Control plane resiliency and recovery
24602470
File: cpmso-resiliency
24612471
- Name: Troubleshooting the control plane machine set

machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ include::modules/machine-feature-aws-imds-options.adoc[leveloffset=+2]
4747
//This link is for a note that does not apply to TP clusters, reassess for Cluster API GA
4848
[role="_additional-resources"]
4949
.Additional resources
50-
* xref:../../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images[Updated boot images]
50+
* xref:../../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images[Boot image management]
5151
////
5252

5353
// Dedicated Instances configuration options
Lines changed: 12 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,27 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="cpmso-config-options-aws"]
3-
= Control plane configuration options for Amazon Web Services
42
include::_attributes/common-attributes.adoc[]
3+
[id="cpmso-config-options-aws"]
4+
= Changing control plane configuration options for {aws-full}
55
:context: cpmso-config-options-aws
66

77
toc::[]
88

9-
You can change the configuration of your {aws-first} control plane machines and enable features by updating values in the control plane machine set.
10-
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 xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[update strategy].
9+
[role="_abstract"]
10+
You can update your control plane machines to reflect changes in your infrastructure or environment by editing values in the control plane machine set specification.
1111

12-
[id="cpmso-sample-yaml-aws_{context}"]
13-
== Sample YAML for configuring {aws-full} clusters
12+
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.
13+
For more information, see "Updating the control plane configuration".
1414

1515
The following example YAML snippets show provider specification and failure domain configurations for an {aws-short} cluster.
1616

1717
//Sample AWS provider specification
18-
include::modules/cpmso-yaml-provider-spec-aws.adoc[leveloffset=+2]
18+
include::modules/cpmso-yaml-provider-spec-aws.adoc[leveloffset=+1]
1919

2020
//Sample AWS failure domain configuration
21-
include::modules/cpmso-yaml-failure-domain-aws.adoc[leveloffset=+2]
22-
23-
[id="cpmso-supported-features-aws_{context}"]
24-
== Enabling {aws-full} features for control plane machines
25-
26-
You can enable features by updating values in the control plane machine set.
27-
28-
//Restricting the API server to private (AWS control plane machine set version)
29-
include::modules/private-clusters-setting-api-private.adoc[leveloffset=+2]
30-
31-
[role="_additional-resources"]
32-
.Additional resources
33-
* xref:../../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc#nw-ingresscontroller-change-internal_nw-configuring-ingress-controller-endpoint-publishing-strategy[Configuring the Ingress Controller endpoint publishing scope to Internal]
34-
35-
//Selecting a larger Amazon Web Services instance type for control plane machines
36-
include::modules/cpms-changing-aws-instance-type.adoc[leveloffset=+2]
37-
38-
//Assigning machines to placement groups by using machine sets
39-
include::modules/machineset-aws-existing-placement-group.adoc[leveloffset=+2]
40-
41-
//Machine sets that enable the Amazon EC2 Instance Metadata Service
42-
include::modules/machineset-imds-options.adoc[leveloffset=+2]
21+
include::modules/cpmso-yaml-failure-domain-aws.adoc[leveloffset=+1]
4322

23+
[id="additional-resources_{context}"]
4424
[role="_additional-resources"]
45-
.Additional resources
46-
* xref:../../../machine_configuration/mco-update-boot-images.adoc#mco-update-boot-images[Updated boot images]
47-
48-
//Creating machines that use the Amazon EC2 Instance Metadata Service
49-
include::modules/machineset-creating-imds-options.adoc[leveloffset=+3]
50-
51-
//Machine sets that deploy machines as Dedicated Instances
52-
include::modules/machineset-dedicated-instances.adoc[leveloffset=+2]
53-
54-
//Creating Dedicated Instances by using machine sets
55-
include::modules/machineset-creating-dedicated-instances.adoc[leveloffset=+3]
56-
57-
//Configuring Capacity Reservation by using machine sets
58-
include::modules/machineset-capacity-reservation.adoc[leveloffset=+2,tag=!compute]
25+
== Additional resources
26+
* xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
27+
* xref:../../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-supported-features-aws.adoc#cpmso-supported-features-aws[Configuring {aws-full} features for control plane machines]
Lines changed: 12 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,27 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="cpmso-config-options-azure"]
3-
= Control plane configuration options for Microsoft Azure
42
include::_attributes/common-attributes.adoc[]
3+
[id="cpmso-config-options-azure"]
4+
= Changing control plane configuration options for {azure-full}
55
:context: cpmso-config-options-azure
66

77
toc::[]
88

9-
You can change the configuration of your {azure-first} control plane machines and enable features by updating values in the control plane machine set.
10-
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 xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[update strategy].
9+
[role="_abstract"]
10+
You can update your control plane machines to reflect changes in your infrastructure or environment by editing values in the control plane machine set specification.
1111

12-
[id="cpmso-sample-yaml-azure_{context}"]
13-
== Sample YAML for configuring {azure-full} clusters
12+
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.
13+
For more information, see "Updating the control plane configuration".
1414

1515
The following example YAML snippets show provider specification and failure domain configurations for an {azure-short} cluster.
1616

1717
//Sample Azure provider specification
18-
include::modules/cpmso-yaml-provider-spec-azure.adoc[leveloffset=+2]
18+
include::modules/cpmso-yaml-provider-spec-azure.adoc[leveloffset=+1]
1919

2020
//Sample Azure failure domain configuration
21-
include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+2]
22-
23-
[id="cpmso-supported-features-azure_{context}"]
24-
== Enabling {azure-full} features for control plane machines
25-
26-
You can enable features by updating values in the control plane machine set.
27-
28-
include::modules/private-clusters-setting-api-private.adoc[leveloffset=+2]
29-
30-
[role="_additional-resources"]
31-
.Additional resources
32-
* xref:../../../networking/ingress_load_balancing/configuring_ingress_cluster_traffic/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc#nw-ingresscontroller-change-internal_nw-configuring-ingress-controller-endpoint-publishing-strategy[Configuring the Ingress Controller endpoint publishing scope to Internal]
33-
34-
//Using the Azure Marketplace offering
35-
include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+2]
36-
37-
//Enabling Azure boot diagnostics
38-
include::modules/machineset-azure-boot-diagnostics.adoc[leveloffset=+2]
39-
40-
//Machine sets that deploy machines on ultra disks as data disks
41-
include::modules/machineset-azure-ultra-disk.adoc[leveloffset=+2]
21+
include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+1]
4222

23+
[id="additional-resources_{context}"]
4324
[role="_additional-resources"]
44-
.Additional resources
45-
* link:https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types#ultra-disks[{azure-full} ultra disks documentation]
46-
47-
//Creating machines on ultra disks by using machine sets
48-
include::modules/machineset-creating-azure-ultra-disk.adoc[leveloffset=+3]
49-
50-
//Troubleshooting resources for machine sets that enable ultra disks
51-
include::modules/machineset-troubleshooting-azure-ultra-disk.adoc[leveloffset=+3]
52-
53-
//Enabling customer-managed encryption keys for a machine set
54-
include::modules/machineset-customer-managed-encryption-azure.adoc[leveloffset=+2]
55-
56-
//Configuring trusted launch for Azure virtual machines by using machine sets
57-
include::modules/machineset-azure-trusted-launch.adoc[leveloffset=+2]
58-
59-
//Configuring Azure confidential virtual machines by using machine sets
60-
include::modules/machineset-azure-confidential-vms.adoc[leveloffset=+2]
61-
62-
//Configuring Capacity Reservation by using machine sets
63-
include::modules/machineset-capacity-reservation.adoc[leveloffset=+2,tag=!compute]
64-
65-
// Accelerated Networking for Microsoft Azure VMs
66-
include::modules/machineset-azure-accelerated-networking.adoc[leveloffset=+2]
67-
68-
//Not applicable for 4.12, possibly 4.13?
69-
//[role="_additional-resources"]
70-
//.Additional resources
71-
//* xref:../../../installing/installing_azure/ipi/installing-azure-customizations.adoc#machineset-azure-enabling-accelerated-networking-new-install_installing-azure-customizations[Enabling Accelerated Networking during installation]
72-
73-
// Enabling Accelerated Networking on an existing Microsoft Azure cluster
74-
include::modules/machineset-azure-enabling-accelerated-networking-existing.adoc[leveloffset=+3]
25+
== Additional resources
26+
* xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
27+
* xref:../../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-supported-features-azure.adoc#cpmso-supported-features-azure[Configuring {azure-full} features for control plane machines]
Lines changed: 11 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,27 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/common-attributes.adoc[]
33
[id="cpmso-config-options-gcp"]
4-
= Control plane configuration options for {gcp-full}
4+
= Changing control plane configuration options for {gcp-full}
55
:context: cpmso-config-options-gcp
66

77
toc::[]
88

9-
You can change the configuration of your {gcp-first} control plane machines and enable features by updating values in the control plane machine set.
10-
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 xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[update strategy].
9+
[role="_abstract"]
10+
You can update your control plane machines to reflect changes in your infrastructure or environment by editing values in the control plane machine set specification.
1111

12-
[id="cpmso-sample-yaml-gcp_{context}"]
13-
== Sample YAML for configuring {gcp-full} clusters
12+
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.
13+
For more information, see "Updating the control plane configuration".
1414

1515
The following example YAML snippets show provider specification and failure domain configurations for a {gcp-short} cluster.
1616

1717
//Sample GCP provider specification
18-
include::modules/cpmso-yaml-provider-spec-gcp.adoc[leveloffset=+2]
18+
include::modules/cpmso-yaml-provider-spec-gcp.adoc[leveloffset=+1]
1919

2020
//Sample GCP failure domain configuration
21-
include::modules/cpmso-yaml-failure-domain-gcp.adoc[leveloffset=+2]
22-
23-
[id="cpmso-supported-features-gcp_{context}"]
24-
== Enabling {gcp-full} features for control plane machines
25-
26-
You can enable features by updating values in the control plane machine set.
27-
28-
//Note: GCP GPU features should be compatible with CPMS, but dev cannot think of a use case. Leaving them out to keep things less cluttered. If a customer use case emerges, we can just add the necessary modules in here.
29-
30-
//Configuring persistent disk types by using machine sets
31-
include::modules/machineset-gcp-pd-disk-types.adoc[leveloffset=+2]
32-
33-
//Configuring Confidential VM by using machine sets
34-
include::modules/machineset-gcp-confidential-vm.adoc[leveloffset=+2]
35-
36-
//Configuring Shielded VM options by using machine sets
37-
include::modules/machineset-gcp-shielded-vms.adoc[leveloffset=+2]
21+
include::modules/cpmso-yaml-failure-domain-gcp.adoc[leveloffset=+1]
3822

23+
[id="additional-resources_{context}"]
3924
[role="_additional-resources"]
40-
.Additional resources
41-
* link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm[What is Shielded VM?]
42-
** link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#secure-boot[Secure Boot]
43-
** link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#vtpm[Virtual Trusted Platform Module (vTPM)]
44-
** link:https://cloud.google.com/compute/shielded-vm/docs/shielded-vm#integrity-monitoring[Integrity monitoring]
45-
46-
//Enabling customer-managed encryption keys for a machine set
47-
include::modules/machineset-gcp-enabling-customer-managed-encryption.adoc[leveloffset=+2]
25+
== Additional resources
26+
* xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
27+
* xref:../../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-supported-features-gcp.adoc#cpmso-supported-features-gcp[Configuring {gcp-full} features for control plane machines]
Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,27 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="cpmso-config-options-nutanix"]
3-
= Control plane configuration options for Nutanix
42
include::_attributes/common-attributes.adoc[]
3+
[id="cpmso-config-options-nutanix"]
4+
= Changing control plane configuration options for Nutanix
55
:context: cpmso-config-options-nutanix
66

77
toc::[]
88

9-
You can change the configuration of your Nutanix control plane machines by updating values in the control plane machine set.
10-
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 xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[update strategy].
9+
[role="_abstract"]
10+
You can update your control plane machines to reflect changes in your infrastructure or environment by editing values in the control plane machine set specification.
1111

12-
[id="cpmso-sample-yaml-nutanix_{context}"]
13-
== Sample YAML for configuring Nutanix clusters
12+
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.
13+
For more information, see "Updating the control plane configuration".
1414

15-
The following example YAML snippet shows a provider specification configuration for a Nutanix cluster.
15+
The following example YAML snippets show provider specification and failure domain configurations for a Nutanix cluster.
1616

1717
//Sample Nutanix provider specification
18-
include::modules/cpmso-yaml-provider-spec-nutanix.adoc[leveloffset=+2]
18+
include::modules/cpmso-yaml-provider-spec-nutanix.adoc[leveloffset=+1]
1919

2020
//Failure domains for Nutanix clusters
21-
include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+2]
21+
include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+1]
2222

23+
[id="additional-resources_{context}"]
2324
[role="_additional-resources"]
24-
.Additional resources
25+
== Additional resources
26+
* xref:../../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-config-update_cpmso-managing-machines[Updating the control plane configuration]
2527
* xref:../../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster]

0 commit comments

Comments
 (0)