diff --git a/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc b/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc index d11911d49642..20fe1065007b 100644 --- a/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc +++ b/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc @@ -56,6 +56,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/csr-management.adoc[leveloffset=+2] diff --git a/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc b/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc index b5d21b345aa4..57d50829f6cb 100644 --- a/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc +++ b/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc @@ -44,6 +44,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/csr-management.adoc[leveloffset=+2] diff --git a/installing/installing_vmc/installing-vmc-user-infra.adoc b/installing/installing_vmc/installing-vmc-user-infra.adoc index 425ace14a80c..ba6120aa1be2 100644 --- a/installing/installing_vmc/installing-vmc-user-infra.adoc +++ b/installing/installing_vmc/installing-vmc-user-infra.adoc @@ -48,6 +48,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/csr-management.adoc[leveloffset=+2] diff --git a/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc index 6306274f3ad5..f8bddac4a894 100644 --- a/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc +++ b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc @@ -59,6 +59,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2] diff --git a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc index c4c0cebff1bb..f273b85af505 100644 --- a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc @@ -51,6 +51,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2] diff --git a/installing/installing_vsphere/installing-vsphere.adoc b/installing/installing_vsphere/installing-vsphere.adoc index 3e7746a588ff..7628a6864f14 100644 --- a/installing/installing_vsphere/installing-vsphere.adoc +++ b/installing/installing_vsphere/installing-vsphere.adoc @@ -51,6 +51,12 @@ of the required machines. This section describes the requirements for deploying {product-title} on user-provisioned infrastructure. +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#creating-machineset-vsphere_creating-machineset-vsphere[Creating a compute machine set on vSphere] + include::modules/installation-machine-requirements.adoc[leveloffset=+2] include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] include::modules/installation-vsphere-encrypted-vms.adoc[leveloffset=+2] diff --git a/modules/installation-vsphere-installer-infra-requirements.adoc b/modules/installation-vsphere-installer-infra-requirements.adoc index 4de4be9ea96e..ca6bc8f39adc 100644 --- a/modules/installation-vsphere-installer-infra-requirements.adoc +++ b/modules/installation-vsphere-installer-infra-requirements.adoc @@ -1,13 +1,22 @@ -// Module included in the following assemblies: +// Module included in the following assemblies for vSphere: // // * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc // * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc // * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere.adoc +// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc // * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc +// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc + +// Module included in the following assemblies for VMC: +// // * installing/installing_vmc/installing-vmc.adoc // * installing/installing_vmc/installing-vmc-customizations.adoc // * installing/installing_vmc/installing-vmc-network-customizations.adoc // * installing/installing_vmc/installing-restricted-networks-vmc.adoc +// * installing/installing_vmc/installing-vmc-user-infra.adoc +// * installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc +// * installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vsphere"] :restricted: @@ -16,20 +25,54 @@ ifeval::["{context}" == "installing-restricted-networks-vmc"] :restricted: endif::[] +ifeval::["{context}" == "installing-vsphere"] +:vsphere: +endif::[] +ifeval::["{context}" == "installing-vsphere-network-customizations"] +:vsphere: +endif::[] +ifeval::["{context}" == "installing-restricted-networks-vsphere"] +:vsphere: +endif::[] + +ifeval::["{context}" == "installing-vmc-user-infra"] +:vmc: +endif::[] +ifeval::["{context}" == "installing-vmc-network-customizations-user-infra"] +:vmc: +endif::[] +ifeval::["{context}" == "installing-restricted-networks-vmc-user-infra"] +:vmc: +endif::[] + + [id="installation-vsphere-installer-infra-requirements_{context}"] = vCenter requirements +ifndef::vsphere,vmc[] Before you install an {product-title} cluster on your vCenter that uses infrastructure that the installer provisions, you must prepare your environment. +endif::vsphere,vmc[] + +ifdef::vsphere,vmc[] +Before you install an {product-title} cluster on your vCenter that uses infrastructure that you provided, you must prepare your environment. +endif::vsphere,vmc[] [discrete] [id="installation-vsphere-installer-infra-requirements-account_{context}"] == Required vCenter account privileges +ifndef::vsphere,vmc[] 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. 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. An additional role is required if the installation program is to create a vSphere virtual machine folder. +endif::vsphere,vmc[] + +ifdef::vsphere,vmc[] +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. +endif::vsphere,vmc[] + .Roles and privileges required for installation in vSphere API [%collapsible] @@ -124,7 +167,7 @@ An additional role is required if the installation program is to create a vSpher `VirtualMachine.Provisioning.DeployTemplate` |vSphere vCenter Datacenter -|If the installation program creates the virtual machine folder +|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. | [%hardbreaks] `InventoryService.Tagging.ObjectAttachable` @@ -254,7 +297,7 @@ An additional role is required if the installation program is to create a vSpher `"Virtual machine".Provisioning."Deploy template"` |vSphere vCenter Datacenter -|If the installation program creates the virtual machine folder +|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. | [%hardbreaks] `"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 [id="installation-vsphere-installer-infra-requirements-vmotion_{context}"] == Using {product-title} with vMotion -If you intend on using vMotion in your vSphere environment, consider the following before installing a {product-title} cluster. +If you intend on using vMotion in your vSphere environment, consider the following before installing an {product-title} cluster. * {product-title} generally supports compute-only vMotion. Using Storage vMotion can cause issues and is not supported. + @@ -376,9 +419,15 @@ For more information about vMotion and anti-affinity rules, see the VMware vSphe [id="installation-vsphere-installer-infra-requirements-resources_{context}"] == Cluster resources +ifndef::vsphere,vmc[] 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. A standard {product-title} installation creates the following vCenter resources: +endif::vsphere,vmc[] + +ifdef::vsphere,vmc[] +When you deploy an {product-title} cluster that uses infrastructure that you provided, you must create the following resources in your vCenter instance: +endif::vsphere,vmc[] * 1 Folder * 1 Tag category @@ -417,12 +466,14 @@ It is recommended that each {product-title} node in the cluster must have access [discrete] [id="installation-vsphere-installer-infra-requirements-_{context}"] === Required IP Addresses +ifndef::vsphere,vmc[] An installer-provisioned vSphere installation requires two static IP addresses: * The **API** address is used to access the cluster API. * The **Ingress** address is used for cluster ingress traffic. You must provide these IP addresses to the installation program when you install the {product-title} cluster. +endif::vsphere,vmc[] [discrete] [id="installation-vsphere-installer-infra-requirements-dns-records_{context}"] @@ -457,3 +508,23 @@ endif::[] ifeval::["{context}" == "installing-restricted-networks-vmc"] :!restricted: endif::[] + +ifeval::["{context}" == "installing-vsphere"] +:!vsphere: +endif::[] +ifeval::["{context}" == "installing-vsphere-network-customizations"] +:!vsphere: +endif::[] +ifeval::["{context}" == "installing-restricted-networks-vsphere"] +:!vsphere: +endif::[] + +ifeval::["{context}" == "installing-vmc-user-infra"] +:!vmc: +endif::[] +ifeval::["{context}" == "installing-vmc-network-customizations-user-infra"] +:!vmc: +endif::[] +ifeval::["{context}" == "installing-restricted-networks-vmc-user-infra"] +:!vmc: +endif::[]