Skip to content

Commit 666e122

Browse files
authored
Merge pull request #43012 from willhaines/vsphere-resource-pool
Document IPI for vSphere w/ existing resource pool
2 parents 1626998 + bc3ce44 commit 666e122

4 files changed

+70
-43
lines changed

modules/installation-configuration-parameters.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1335,6 +1335,10 @@ in vSphere.
13351335
|Optional. The absolute path of an existing folder where the installation program creates the virtual machines. If you do not provide this value, the installation program creates a folder that is named with the infrastructure ID in the datacenter virtual machine folder.
13361336
|String, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`.
13371337

1338+
|`platform.vsphere.resourcePool`
1339+
|_Optional_. The absolute path of an existing resource pool where the installer creates the virtual machines. If you do not specify a value, resources are installed in the root of the cluster `/<datacenter_name>/host/<cluster_name>/Resources`.
1340+
|String, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`.
1341+
13381342
|`platform.vsphere.network`
13391343
|The network in the vCenter instance that contains the virtual IP addresses and DNS records that you configured.
13401344
|String

modules/installation-installer-provisioned-vsphere-config-yaml.adoc

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,14 @@ platform:
7979
datacenter: datacenter
8080
defaultDatastore: datastore
8181
folder: folder
82-
diskType: thin <6>
82+
resourcePool: resource_pool <6>
83+
diskType: thin <7>
8384
network: VM_Network
84-
cluster: vsphere_cluster_name <7>
85+
cluster: vsphere_cluster_name <8>
8586
apiVIP: api_vip
8687
ingressVIP: ingress_vip
8788
ifdef::restricted[]
88-
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <8>
89+
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-vmware.x86_64.ova <9>
8990
endif::restricted[]
9091
ifndef::openshift-origin[]
9192
fips: false
@@ -94,15 +95,15 @@ ifndef::restricted[]
9495
pullSecret: '{"auths": ...}'
9596
endif::restricted[]
9697
ifdef::restricted[]
97-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <9>
98+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <10>
9899
endif::restricted[]
99100
sshKey: 'ssh-ed25519 AAAA...'
100101
ifdef::restricted[]
101-
additionalTrustBundle: | <10>
102+
additionalTrustBundle: | <11>
102103
-----BEGIN CERTIFICATE-----
103104
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
104105
-----END CERTIFICATE-----
105-
imageContentSources: <11>
106+
imageContentSources: <12>
106107
- mirrors:
107108
- <local_registry>/<local_repository_name>/release
108109
source: quay.io/openshift-release-dev/ocp-release
@@ -136,16 +137,17 @@ simultaneous multithreading.
136137
====
137138
<4> Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines.
138139
<5> The cluster name that you specified in your DNS records.
139-
<6> The vSphere disk provisioning method.
140-
<7> The vSphere cluster to install the {product-title} cluster in. The installation program uses the root resource pool of the vSphere cluster as the default resource pool.
140+
<6> Optional: Provide an existing resource pool for machine creation. If you do not specify a value, the installation program uses the root resource pool of the vSphere cluster.
141+
<7> The vSphere disk provisioning method.
142+
<8> The vSphere cluster to install the {product-title} cluster in.
141143
ifdef::restricted[]
142-
<8> The location of the {op-system-first} image that is accessible from the bastion server.
143-
<9> For `<local_registry>`, specify the registry domain name, and optionally the
144+
<9> The location of the {op-system-first} image that is accessible from the bastion server.
145+
<10> For `<local_registry>`, specify the registry domain name, and optionally the
144146
port, that your mirror registry uses to serve content. For example
145147
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
146148
specify the base64-encoded user name and password for your mirror registry.
147-
<10> Provide the contents of the certificate file that you used for your mirror registry.
148-
<11> Provide the `imageContentSources` section from the output of the command to mirror the repository.
149+
<11> Provide the contents of the certificate file that you used for your mirror registry.
150+
<12> Provide the `imageContentSources` section from the output of the command to mirror the repository.
149151
endif::restricted[]
150152

151153
ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"]

modules/installation-vsphere-config-yaml.adoc

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -43,40 +43,41 @@ platform:
4343
datacenter: datacenter <10>
4444
defaultDatastore: datastore <11>
4545
folder: "/<datacenter_name>/vm/<folder_name>/<subfolder_name>" <12>
46-
diskType: thin <13>
46+
resourcePool: "/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>" <13>
47+
diskType: thin <14>
4748
ifndef::restricted[]
4849
ifndef::openshift-origin[]
49-
fips: false <14>
50+
fips: false <15>
5051
endif::openshift-origin[]
5152
ifndef::openshift-origin[]
52-
pullSecret: '{"auths": ...}' <15>
53+
pullSecret: '{"auths": ...}' <16>
5354
endif::openshift-origin[]
5455
ifdef::openshift-origin[]
55-
pullSecret: '{"auths": ...}' <14>
56+
pullSecret: '{"auths": ...}' <15>
5657
endif::openshift-origin[]
5758
endif::restricted[]
5859
ifdef::restricted[]
5960
ifndef::openshift-origin[]
60-
fips: false <14>
61-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <15>
61+
fips: false <15>
62+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <16>
6263
endif::openshift-origin[]
6364
ifdef::openshift-origin[]
64-
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <14>
65+
pullSecret: '{"auths":{"<local_registry>": {"auth": "<credentials>","email": "[email protected]"}}}' <15>
6566
endif::openshift-origin[]
6667
endif::restricted[]
6768
ifndef::openshift-origin[]
68-
sshKey: 'ssh-ed25519 AAAA...' <16>
69+
sshKey: 'ssh-ed25519 AAAA...' <17>
6970
endif::openshift-origin[]
7071
ifdef::openshift-origin[]
71-
sshKey: 'ssh-ed25519 AAAA...' <15>
72+
sshKey: 'ssh-ed25519 AAAA...' <16>
7273
endif::openshift-origin[]
7374
ifdef::restricted[]
7475
ifndef::openshift-origin[]
75-
additionalTrustBundle: | <17>
76+
additionalTrustBundle: | <18>
7677
-----BEGIN CERTIFICATE-----
7778
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
7879
-----END CERTIFICATE-----
79-
imageContentSources: <18>
80+
imageContentSources: <19>
8081
- mirrors:
8182
- <local_registry>/<local_repository_name>/release
8283
source: quay.io/openshift-release-dev/ocp-release
@@ -85,11 +86,11 @@ imageContentSources: <18>
8586
source: quay.io/openshift-release-dev/ocp-v4.0-art-dev
8687
endif::openshift-origin[]
8788
ifdef::openshift-origin[]
88-
additionalTrustBundle: | <16>
89+
additionalTrustBundle: | <17>
8990
-----BEGIN CERTIFICATE-----
9091
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
9192
-----END CERTIFICATE-----
92-
imageContentSources: <17>
93+
imageContentSources: <18>
9394
- mirrors:
9495
- <local_registry>/<local_repository_name>/release
9596
source: quay.io/openshift-release-dev/ocp-release
@@ -140,9 +141,10 @@ in vSphere.
140141
<10> The vSphere datacenter.
141142
<11> The default vSphere datastore to use.
142143
<12> Optional: For installer-provisioned infrastructure, the absolute path of an existing folder where the installation program creates the virtual machines, for example, `/<datacenter_name>/vm/<folder_name>/<subfolder_name>`. If you do not provide this value, the installation program creates a top-level folder in the datacenter virtual machine folder that is named with the infrastructure ID. If you are providing the infrastructure for the cluster, omit this parameter.
143-
<13> The vSphere disk provisioning method.
144+
<13> Optional: For installer-provisioned infrastructure, the absolute path of an existing resource pool where the installation program creates the virtual machines, for example, `/<datacenter_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>`. If you do not specify a value, resources are installed in the root of the cluster `/example_datacenter/host/example_cluster/Resources`.
145+
<14> The vSphere disk provisioning method.
144146
ifndef::openshift-origin[]
145-
<14> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
147+
<15> Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the {op-system-first} machines that {product-title} runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with {op-system} instead.
146148
+
147149
[IMPORTANT]
148150
====
@@ -151,13 +153,13 @@ The use of FIPS Validated / Modules in Process cryptographic libraries is only s
151153
endif::openshift-origin[]
152154
ifndef::restricted[]
153155
ifndef::openshift-origin[]
154-
<15> The pull secret that you obtained from {cluster-manager-url}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
155-
<16> The public portion of the default SSH key for the `core` user in
156+
<16> The pull secret that you obtained from {cluster-manager-url}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
157+
<17> The public portion of the default SSH key for the `core` user in
156158
{op-system-first}.
157159
endif::openshift-origin[]
158160
ifdef::openshift-origin[]
159-
<14> You obtained the {cluster-manager-url-pull}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
160-
<15> The public portion of the default SSH key for the `core` user in
161+
<15> You obtained the {cluster-manager-url-pull}. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for {product-title} components.
162+
<16> The public portion of the default SSH key for the `core` user in
161163
{op-system-first}.
162164
+
163165
[NOTE]
@@ -168,11 +170,11 @@ endif::openshift-origin[]
168170
endif::restricted[]
169171
ifdef::restricted[]
170172
ifndef::openshift-origin[]
171-
<15> For `<local_registry>`, specify the registry domain name, and optionally the
173+
<16> For `<local_registry>`, specify the registry domain name, and optionally the
172174
port, that your mirror registry uses to serve content. For example
173175
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
174176
specify the base64-encoded user name and password for your mirror registry.
175-
<16> The public portion of the default SSH key for the `core` user in
177+
<17> The public portion of the default SSH key for the `core` user in
176178
{op-system-first}.
177179
+
178180
[NOTE]
@@ -181,11 +183,11 @@ For production {product-title} clusters on which you want to perform installatio
181183
====
182184
endif::openshift-origin[]
183185
ifdef::openshift-origin[]
184-
<14> For `<local_registry>`, specify the registry domain name, and optionally the
186+
<15> For `<local_registry>`, specify the registry domain name, and optionally the
185187
port, that your mirror registry uses to serve content. For example
186188
`registry.example.com` or `registry.example.com:5000`. For `<credentials>`,
187189
specify the base64-encoded user name and password for your mirror registry.
188-
<15> The public portion of the default SSH key for the `core` user in
190+
<16> The public portion of the default SSH key for the `core` user in
189191
{op-system-first}.
190192
+
191193
[NOTE]
@@ -196,15 +198,15 @@ endif::openshift-origin[]
196198
endif::restricted[]
197199
ifdef::restricted[]
198200
ifndef::openshift-origin[]
199-
<17> Provide the contents of the certificate file that you used for your mirror
201+
<18> Provide the contents of the certificate file that you used for your mirror
200202
registry.
201-
<18> Provide the `imageContentSources` section from the output of the command to
203+
<19> Provide the `imageContentSources` section from the output of the command to
202204
mirror the repository.
203205
endif::openshift-origin[]
204206
ifdef::openshift-origin[]
205-
<16> Provide the contents of the certificate file that you used for your mirror
207+
<17> Provide the contents of the certificate file that you used for your mirror
206208
registry.
207-
<17> Provide the `imageContentSources` section from the output of the command to
209+
<18> Provide the `imageContentSources` section from the output of the command to
208210
mirror the repository.
209211
endif::openshift-origin[]
210212
endif::restricted[]

modules/installation-vsphere-installer-infra-requirements.adoc

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,17 @@ An additional role is required if the installation program is to create a vSpher
5757
`StorageProfile.View`
5858
5959
|vSphere vCenter Cluster
60-
|Always
60+
|If VMs will be created in the cluster root
61+
|
62+
[%hardbreaks]
63+
`Host.Config.Storage`
64+
`Resource.AssignVMToPool`
65+
`VApp.AssignResourcePool`
66+
`VApp.Import`
67+
`VirtualMachine.Config.AddNewDisk`
68+
69+
|vSphere vCenter Resource Pool
70+
|If an existing resource pool is provided
6171
|
6272
[%hardbreaks]
6373
`Host.Config.Storage`
@@ -158,7 +168,7 @@ Additionally, the user requires some `ReadOnly` permissions, and some of the rol
158168
[cols="3a,3a,3a,3a",options="header"]
159169
|===
160170
|vSphere object
161-
|Folder type
171+
|When required
162172
|Propagate to children
163173
|Permissions required
164174
@@ -176,8 +186,12 @@ Additionally, the user requires some `ReadOnly` permissions, and some of the rol
176186
|True
177187
|Listed required privileges
178188
179-
|vSphere vCenter Cluster
180-
|Always
189+
.2+|vSphere vCenter Cluster
190+
|Existing resource pool
191+
|True
192+
|`ReadOnly` permission
193+
194+
|VMs in cluster root
181195
|True
182196
|Listed required privileges
183197
@@ -200,6 +214,11 @@ Additionally, the user requires some `ReadOnly` permissions, and some of the rol
200214
|Existing folder
201215
|True
202216
|Listed required privileges
217+
218+
|vSphere vCenter Resource Pool
219+
|Existing resource pool
220+
|True
221+
|Listed required privileges
203222
|===
204223
====
205224

0 commit comments

Comments
 (0)