Skip to content

Commit b490112

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #53107 from jeana-redhat/OSDOCS-4594-CPMS-vSphere
[OSDOCS-4594]: Adding vSphere CPMS config details
2 parents 909b513 + 2649a0e commit b490112

7 files changed

+55
-24
lines changed

‎machine_management/control_plane_machine_management/cpmso-configuration.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@ The `<platform_failure_domains>` and `<platform_provider_spec>` sections of the
2020
* 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]
2121
2222
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-azure_cpmso-configuration[Sample YAML snippets for configuring Microsoft Azure clusters]
23-
////
24-
//todo: need vSphere content for this section, omitting for now.
25-
* xr@f:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-vsphere_cpmso-configuration[Sample YAML snippets for configuring VMware vSphere clusters]
26-
////
23+
24+
* xref:../../machine_management/control_plane_machine_management/cpmso-configuration.adoc#cpmso-sample-yaml-vsphere_cpmso-configuration[Sample YAML snippets for configuring VMware vSphere clusters]
2725
2826
2927
[id="cpmso-sample-yaml-aws_{context}"]
@@ -47,13 +45,11 @@ include::modules/cpmso-yaml-failure-domain-azure.adoc[leveloffset=+2]
4745

4846
//Sample Azure provider specification
4947
include::modules/cpmso-yaml-provider-spec-azure.adoc[leveloffset=+2]
50-
////
51-
//todo: need vSphere content for this section, omitting for now.
48+
5249
[id="cpmso-sample-yaml-vsphere_{context}"]
5350
== Sample YAML for configuring VMware vSphere clusters
5451

5552
Some sections of the control plane machine set CR are provider-specific. The example YAML in this section shows a provider specification configuration for a VMware vSphere cluster.
5653

5754
//Sample VMware vSphere provider specification
5855
include::modules/cpmso-yaml-provider-spec-vsphere.adoc[leveloffset=+2]
59-
////

‎modules/cpmso-yaml-failure-domain-aws.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-failure-domain-aws_{context}"]

‎modules/cpmso-yaml-failure-domain-azure.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-failure-domain-azure_{context}"]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-provider-spec-aws_{context}"]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-provider-spec-azure_{context}"]

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

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,53 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-provider-spec-vsphere_{context}"]
77
= Sample vSphere provider specification
88

9-
When you create a control plane machine set for an existing cluster, the provider specification must match the `providerSpec` configuration in the control plane `machine` CR that is created by the installation program. You can omit any field that is set in the failure domain section of the CR.
10-
11-
In the following example, `<cluster_id>` is the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command:
12-
13-
[source,terminal]
14-
----
15-
$ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
16-
----
9+
When you create a control plane machine set for an existing cluster, the provider specification must match the `providerSpec` configuration in the control plane `machine` CR that is created by the installation program.
1710

1811
.Sample vSphere `providerSpec` values
1912
[source,yaml]
2013
----
21-
14+
providerSpec:
15+
value:
16+
apiVersion: machine.openshift.io/v1beta1
17+
credentialsSecret:
18+
name: vsphere-cloud-credentials <1>
19+
diskGiB: 120 <2>
20+
kind: VSphereMachineProviderSpec <3>
21+
memoryMiB: 16384 <4>
22+
metadata:
23+
creationTimestamp: null
24+
network: <5>
25+
devices:
26+
- networkName: <vm_network_name>
27+
numCPUs: 4 <6>
28+
numCoresPerSocket: 4 <7>
29+
snapshot: ""
30+
template: <vm_template_name> <8>
31+
userDataSecret:
32+
name: master-user-data <9>
33+
workspace:
34+
datacenter: <vcenter_datacenter_name> <10>
35+
datastore: <vcenter_datastore_name> <11>
36+
folder: <path_to_vcenter_vm_folder> <12>
37+
resourcePool: <vsphere_resource_pool> <13>
38+
server: <vcenter_server_ip> <14>
2239
----
40+
<1> Specifies the secret name for the cluster. Do not change this value.
41+
<2> Specifies the VM disk size for the control plane machines.
42+
<3> Specifies the cloud provider platform type. Do not change this value.
43+
<4> Specifies the memory allocated for the control plane machines.
44+
<5> Specifies the network on which the control plane is deployed.
45+
<6> Specifies the number of CPUs allocated for the control plane machines.
46+
<7> Specifies the number of cores for each control plane CPU.
47+
<8> Specifies the vSphere VM template to use, such as `user-5ddjd-rhcos`.
48+
<9> Specifies the control plane user data secret. Do not change this value.
49+
<10> Specifies the vCenter Datacenter for the control plane.
50+
<11> Specifies the vCenter Datastore for the control plane.
51+
<12> Specifies the path to the vSphere VM folder in vCenter, such as `/dc1/vm/user-inst-5ddjd`.
52+
<13> Specifies the vSphere resource pool for your VMs.
53+
<14> Specifies the vCenter server IP or fully qualified domain name.

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * machine_management/control-plane-machine-management.adoc
3+
// * machine_management/cpmso-configuration.adoc
44

55
:_content-type: REFERENCE
66
[id="cpmso-yaml-sample-cr_{context}"]
@@ -54,11 +54,15 @@ $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster
5454
+
5555
[IMPORTANT]
5656
====
57-
Before you activate the Operator, you must ensure that the `ControlPlaneMachineSet` CR configuration is correct for your cluster requirements.
58-
//For more information about activating the Control Plane Machine Set Operator, see "Getting started with the Control Plane Machine Set Operator".
57+
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".
5958
====
6059
<5> Specifies the update strategy for the cluster. The allowed values are `OnDelete` and `RollingUpdate`. The default value is `RollingUpdate`.
6160
//For more information about update strategies, see "Updating the control plane configuration".
6261
<6> Specifies the cloud provider platform name. Do not change this value.
6362
<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.
63+
+
64+
[NOTE]
65+
====
66+
VMware vSphere does not support failure domains.
67+
====
6468
<8> Specifies the `<platform_provider_spec>` configuration for the cluster. The format and values of this section are provider-specific. For more information, see the sample provider specification for your cloud provider.

0 commit comments

Comments
 (0)