Skip to content

Commit 94ad17f

Browse files
committed
OSDOCS-6143: Added vCenter requirements section to vSphere UPI docs
1 parent 9e572e6 commit 94ad17f

7 files changed

+111
-4
lines changed

installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ of the required machines.
5656

5757
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
5858

59+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
60+
61+
[role="_additional-resources"]
62+
.Additional resources
63+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
64+
5965
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
6066
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
6167
include::modules/csr-management.adoc[leveloffset=+2]

installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,12 @@ of the required machines.
4444

4545
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
4646

47+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
48+
49+
[role="_additional-resources"]
50+
.Additional resources
51+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
52+
4753
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
4854
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
4955
include::modules/csr-management.adoc[leveloffset=+2]

installing/installing_vmc/installing-vmc-user-infra.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ of the required machines.
4848

4949
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
5050

51+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
52+
53+
[role="_additional-resources"]
54+
.Additional resources
55+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
56+
5157
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
5258
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5359
include::modules/csr-management.adoc[leveloffset=+2]

installing/installing_vsphere/installing-restricted-networks-vsphere.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ of the required machines.
5959

6060
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
6161

62+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
63+
64+
[role="_additional-resources"]
65+
.Additional resources
66+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
67+
6268
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
6369
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
6470
include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2]

installing/installing_vsphere/installing-vsphere-network-customizations.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ of the required machines.
5151

5252
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
5353

54+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
55+
56+
[role="_additional-resources"]
57+
.Additional resources
58+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
59+
5460
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
5561
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5662
include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2]

installing/installing_vsphere/installing-vsphere.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ of the required machines.
5151

5252
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
5353

54+
include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2]
55+
56+
[role="_additional-resources"]
57+
.Additional resources
58+
* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere]
59+
5460
include::modules/installation-machine-requirements.adoc[leveloffset=+2]
5561
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]
5662
include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2]

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

Lines changed: 75 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,22 @@
1-
// Module included in the following assemblies:
1+
// Module included in the following assemblies for vSphere:
22
//
33
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
44
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
55
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
6+
// * installing/installing_vsphere/installing-vsphere.adoc
7+
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
68
// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
9+
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
10+
11+
// Module included in the following assemblies for VMC:
12+
//
713
// * installing/installing_vmc/installing-vmc.adoc
814
// * installing/installing_vmc/installing-vmc-customizations.adoc
915
// * installing/installing_vmc/installing-vmc-network-customizations.adoc
1016
// * installing/installing_vmc/installing-restricted-networks-vmc.adoc
17+
// * installing/installing_vmc/installing-vmc-user-infra.adoc
18+
// * installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc
19+
// * installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc
1120

1221
ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vsphere"]
1322
:restricted:
@@ -16,20 +25,54 @@ ifeval::["{context}" == "installing-restricted-networks-vmc"]
1625
:restricted:
1726
endif::[]
1827

28+
ifeval::["{context}" == "installing-vsphere"]
29+
:vsphere:
30+
endif::[]
31+
ifeval::["{context}" == "installing-vsphere-network-customizations"]
32+
:vsphere:
33+
endif::[]
34+
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
35+
:vsphere:
36+
endif::[]
37+
38+
ifeval::["{context}" == "installing-vmc-user-infra"]
39+
:vmc:
40+
endif::[]
41+
ifeval::["{context}" == "installing-vmc-network-customizations-user-infra"]
42+
:vmc:
43+
endif::[]
44+
ifeval::["{context}" == "installing-restricted-networks-vmc-user-infra"]
45+
:vmc:
46+
endif::[]
47+
48+
1949
[id="installation-vsphere-installer-infra-requirements_{context}"]
2050
= vCenter requirements
2151

52+
ifndef::vsphere,vmc[]
2253
Before you install an {product-title} cluster on your vCenter that uses infrastructure that the installer provisions, you must prepare your environment.
54+
endif::vsphere,vmc[]
55+
56+
ifdef::vsphere,vmc[]
57+
Before you install an {product-title} cluster on your vCenter that uses infrastructure that you provided, you must prepare your environment.
58+
endif::vsphere,vmc[]
2359

2460
[discrete]
2561
[id="installation-vsphere-installer-infra-requirements-account_{context}"]
2662
== Required vCenter account privileges
2763

64+
ifndef::vsphere,vmc[]
2865
To install an {product-title} cluster in a vCenter, the installation program requires access to an account with privileges to read and create the required resources. Using an account that has global administrative privileges is the simplest way to access all of the necessary permissions.
2966

3067
If you cannot use an account with global administrative privileges, you must create roles to grant the privileges necessary for {product-title} cluster installation. While most of the privileges are always required, some are required only if you plan for the installation program to provision a folder to contain the {product-title} cluster on your vCenter instance, which is the default behavior. You must create or amend vSphere roles for the specified objects to grant the required privileges.
3168

3269
An additional role is required if the installation program is to create a vSphere virtual machine folder.
70+
endif::vsphere,vmc[]
71+
72+
ifdef::vsphere,vmc[]
73+
To install an {product-title} cluster in a vCenter, your vSphere account must include privileges for reading and creating the required resources. Using an account that has global administrative privileges is the simplest way to access all of the necessary permissions.
74+
endif::vsphere,vmc[]
75+
3376

3477
.Roles and privileges required for installation in vSphere API
3578
[%collapsible]
@@ -124,7 +167,7 @@ An additional role is required if the installation program is to create a vSpher
124167
`VirtualMachine.Provisioning.DeployTemplate`
125168
126169
|vSphere vCenter Datacenter
127-
|If the installation program creates the virtual machine folder
170+
|If the installation program creates the virtual machine folder. For UPI, `VirtualMachine.Inventory.Create` and `VirtualMachine.Inventory.Delete` privileges are optional if your cluster does not use the Machine API.
128171
|
129172
[%hardbreaks]
130173
`InventoryService.Tagging.ObjectAttachable`
@@ -254,7 +297,7 @@ An additional role is required if the installation program is to create a vSpher
254297
`"Virtual machine".Provisioning."Deploy template"`
255298
256299
|vSphere vCenter Datacenter
257-
|If the installation program creates the virtual machine folder
300+
|If the installation program creates the virtual machine folder. For UPI, `VirtualMachine.Inventory.Create` and `VirtualMachine.Inventory.Delete` privileges are optional if your cluster does not use the Machine API.
258301
|
259302
[%hardbreaks]
260303
`"vSphere Tagging"."Assign or Unassign vSphere Tag on Object"`
@@ -360,7 +403,7 @@ For more information about creating an account with only the required privileges
360403
[id="installation-vsphere-installer-infra-requirements-vmotion_{context}"]
361404
== Using {product-title} with vMotion
362405

363-
If you intend on using vMotion in your vSphere environment, consider the following before installing a {product-title} cluster.
406+
If you intend on using vMotion in your vSphere environment, consider the following before installing an {product-title} cluster.
364407

365408
* {product-title} generally supports compute-only vMotion. Using Storage vMotion can cause issues and is not supported.
366409
+
@@ -376,9 +419,15 @@ For more information about vMotion and anti-affinity rules, see the VMware vSphe
376419
[id="installation-vsphere-installer-infra-requirements-resources_{context}"]
377420
== Cluster resources
378421

422+
ifndef::vsphere,vmc[]
379423
When you deploy an {product-title} cluster that uses installer-provisioned infrastructure, the installation program must be able to create several resources in your vCenter instance.
380424

381425
A standard {product-title} installation creates the following vCenter resources:
426+
endif::vsphere,vmc[]
427+
428+
ifdef::vsphere,vmc[]
429+
When you deploy an {product-title} cluster that uses infrastructure that you provided, you must create the following resources in your vCenter instance:
430+
endif::vsphere,vmc[]
382431

383432
* 1 Folder
384433
* 1 Tag category
@@ -417,12 +466,14 @@ It is recommended that each {product-title} node in the cluster must have access
417466
[discrete]
418467
[id="installation-vsphere-installer-infra-requirements-_{context}"]
419468
=== Required IP Addresses
469+
ifndef::vsphere,vmc[]
420470
An installer-provisioned vSphere installation requires two static IP addresses:
421471

422472
* The **API** address is used to access the cluster API.
423473
* The **Ingress** address is used for cluster ingress traffic.
424474

425475
You must provide these IP addresses to the installation program when you install the {product-title} cluster.
476+
endif::vsphere,vmc[]
426477

427478
[discrete]
428479
[id="installation-vsphere-installer-infra-requirements-dns-records_{context}"]
@@ -457,3 +508,23 @@ endif::[]
457508
ifeval::["{context}" == "installing-restricted-networks-vmc"]
458509
:!restricted:
459510
endif::[]
511+
512+
ifeval::["{context}" == "installing-vsphere"]
513+
:!vsphere:
514+
endif::[]
515+
ifeval::["{context}" == "installing-vsphere-network-customizations"]
516+
:!vsphere:
517+
endif::[]
518+
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
519+
:!vsphere:
520+
endif::[]
521+
522+
ifeval::["{context}" == "installing-vmc-user-infra"]
523+
:!vmc:
524+
endif::[]
525+
ifeval::["{context}" == "installing-vmc-network-customizations-user-infra"]
526+
:!vmc:
527+
endif::[]
528+
ifeval::["{context}" == "installing-restricted-networks-vmc-user-infra"]
529+
:!vmc:
530+
endif::[]

0 commit comments

Comments
 (0)