From ef82efc5c0614516f4ded71da673fc63d17752ab Mon Sep 17 00:00:00 2001 From: Mike Pytlak Date: Thu, 21 Dec 2023 08:34:55 -0500 Subject: [PATCH] OSDOCS#8721: Refactor of vSphere install reqs for IPI --- _topic_maps/_topic_map.yml | 2 ++ ...etworks-installer-provisioned-vsphere.adoc | 23 --------------- ...-installer-provisioned-customizations.adoc | 19 ------------- ...er-provisioned-network-customizations.adoc | 19 ------------- ...talling-vsphere-installer-provisioned.adoc | 19 ------------- .../ipi/ipi-vsphere-installation-reqs.adoc | 28 +++++++++++++++++++ .../preparing-to-install-on-vsphere.adoc | 9 ------ .../installation-vsphere-infrastructure.adoc | 5 +--- ...-vsphere-installer-infra-requirements.adoc | 19 +++---------- ...phere-installer-infra-static-ip-nodes.adoc | 10 ++----- ...sphere-installer-network-requirements.adoc | 4 +-- modules/vmware-csi-driver-reqs.adoc | 8 ++---- .../node-tasks.adoc | 2 +- .../creating-windows-machineset-vsphere.adoc | 2 +- 14 files changed, 43 insertions(+), 126 deletions(-) create mode 100644 installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 17307ed8a9..2fca25f8fd 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -469,6 +469,8 @@ Topics: Dir: ipi Distros: openshift-origin,openshift-enterprise Topics: + - Name: vSphere installation requirements + File: ipi-vsphere-installation-reqs - Name: Installing a cluster File: installing-vsphere-installer-provisioned - Name: Installing a cluster with customizations diff --git a/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc b/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc index cb768bc2c1..b7a82e9156 100644 --- a/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc +++ b/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc @@ -35,29 +35,6 @@ include::modules/installation-about-restricted-network.adoc[leveloffset=+1] include::modules/cluster-entitlements.adoc[leveloffset=+1] -include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] - -include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* To remove a third-party vSphere CSI driver, see xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. -* To update the hardware version for your vSphere nodes, see xref:../../../updating/updating_a_cluster/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-hardware-on-nodes-running-on-vsphere[Updating hardware on nodes running in vSphere]. - -include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] - -[role="_additional-resources"] -.Additional resources - -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-scaling-machines-static-ip_post-install-node-tasks[Scaling machines to use static IP addresses] -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-machine-set-scaling-static-ip_post-install-node-tasks[Using a machine set to scale machines with configured static IP addresses] - - include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc index d8f970c05d..7eefbece72 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc @@ -28,25 +28,6 @@ Be sure to also review this site list if you are configuring a proxy. include::modules/cluster-entitlements.adoc[leveloffset=+1] -include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] - -include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* To remove a third-party vSphere CSI driver, see xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. -* To update the hardware version for your vSphere nodes, see xref:../../../updating/updating_a_cluster/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-hardware-on-nodes-running-on-vsphere[Updating hardware on nodes running in vSphere]. - -include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] - -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-scaling-machines-static-ip_post-install-node-tasks[Scaling machines to use static IP addresses] -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-machine-set-scaling-static-ip_post-install-node-tasks[Using a machine set to scale machines with configured static IP addresses] - include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc index 3e25c99fbf..01c5c4ea4e 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc @@ -30,25 +30,6 @@ Be sure to also review this site list if you are configuring a proxy. include::modules/cluster-entitlements.adoc[leveloffset=+1] -include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] - -include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* To remove a third-party vSphere CSI driver, see xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. -* To update the hardware version for your vSphere nodes, see xref:../../../updating/updating_a_cluster/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-hardware-on-nodes-running-on-vsphere[Updating hardware on nodes running in vSphere]. - -include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] - -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-scaling-machines-static-ip_post-install-node-tasks[Scaling machines to use static IP addresses] -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-machine-set-scaling-static-ip_post-install-node-tasks[Using a machine set to scale machines with configured static IP addresses] - include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc index 9f6befed5c..3f1761a8ff 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc @@ -28,25 +28,6 @@ Be sure to also review this site list if you are configuring a proxy. include::modules/cluster-entitlements.adoc[leveloffset=+1] -include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] - -include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* To remove a third-party vSphere CSI driver, see xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. -* To update the hardware version for your vSphere nodes, see xref:../../../updating/updating_a_cluster/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-hardware-on-nodes-running-on-vsphere[Updating hardware on nodes running in vSphere]. - -include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] - -include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] - -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-scaling-machines-static-ip_post-install-node-tasks[Scaling machines to use static IP addresses] -* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-machine-set-scaling-static-ip_post-install-node-tasks[Using a machine set to scale machines with configured static IP addresses] - include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc b/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc new file mode 100644 index 0000000000..fe6adc92be --- /dev/null +++ b/installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc @@ -0,0 +1,28 @@ +:_mod-docs-content-type: ASSEMBLY +[id="ipi-vsphere-installation-reqs"] += vSphere installation requirements +include::_attributes/common-attributes.adoc[] +:context: ipi-vsphere-installation-reqs + +toc::[] + +Before you begin an installation using installer-provisioned infrastructure, be sure that your vSphere environment meets the following installation requirements. + +include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] +include::modules/installation-vsphere-installer-network-requirements.adoc[leveloffset=+1] +include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* To remove a third-party vSphere CSI driver, see xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. +* To update the hardware version for your vSphere nodes, see xref:../../../updating/updating_a_cluster/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-hardware-on-nodes-running-on-vsphere[Updating hardware on nodes running in vSphere]. + +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] +include::modules/installation-vsphere-installer-infra-static-ip-nodes.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources + +* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-scaling-machines-static-ip_post-install-node-tasks[Scaling machines to use static IP addresses] +* xref:../../../post_installation_configuration/node-tasks.html#nodes-vsphere-machine-set-scaling-static-ip_post-install-node-tasks[Using a machine set to scale machines with configured static IP addresses] diff --git a/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc index 301886ef23..69e486e1c8 100644 --- a/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc +++ b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc @@ -57,15 +57,6 @@ User-provisioned infrastructure requires the user to provision all resources req * **xref:../../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[Installing a cluster on vSphere in a restricted network with user-provisioned infrastructure]**: {product-title} can be installed on VMware vSphere infrastructure that you provision in a restricted network. -include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] - -include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* To remove a third-party vSphere CSI driver, see xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver]. - == Configuring the vSphere connection settings * **xref:../../installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc#installing-vsphere-post-installation-configuration[Updating the vSphere connection settings following an installation]**: For installations on vSphere using the Assisted Installer, you must manually update the vSphere connection settings to complete the installation. For installer-provisioned or user-provisioned infrastructure installations on vSphere, you can optionally validate or modify the vSphere connection settings at any time. diff --git a/modules/installation-vsphere-infrastructure.adoc b/modules/installation-vsphere-infrastructure.adoc index d8aa05e2ac..23e853ab43 100644 --- a/modules/installation-vsphere-infrastructure.adoc +++ b/modules/installation-vsphere-infrastructure.adoc @@ -1,12 +1,9 @@ // Module included in the following assemblies: // +// * installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc // * installing/installing_vsphere/installing-vsphere.adoc // * installing/installing_vsphere/installing-vsphere-network-customizations.adoc -// * 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-restricted-networks-installer-provisioned-vsphere.adoc [id="installation-vsphere-infrastructure_{context}"] = VMware vSphere infrastructure requirements diff --git a/modules/installation-vsphere-installer-infra-requirements.adoc b/modules/installation-vsphere-installer-infra-requirements.adoc index 8e0e589176..e01f818f32 100644 --- a/modules/installation-vsphere-installer-infra-requirements.adoc +++ b/modules/installation-vsphere-installer-infra-requirements.adoc @@ -1,17 +1,10 @@ // 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/ipi/ipi-vsphere-installation-reqs.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 -ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vsphere"] -:restricted: -endif::[] - ifeval::["{context}" == "installing-vsphere"] :vsphere: endif::[] @@ -446,9 +439,9 @@ Configure the default gateway to use the DHCP server. All nodes must be in the s You must use the Dynamic Host Configuration Protocol (DHCP) for the network and ensure that the DHCP server is configured to provide persistent IP addresses to the cluster machines. In the DHCP lease, you must configure the DHCP to use the default gateway. All nodes must be in the same VLAN. You cannot scale the cluster using a second VLAN as a Day 2 operation. -ifdef::restricted[] -The VM in your restricted network must have access to vCenter so that it can provision and manage nodes, persistent volume claims (PVCs), and other resources. -endif::restricted[] + +If you are installing to a restricted environment, the VM in your restricted network must have access to vCenter so that it can provision and manage nodes, persistent volume claims (PVCs), and other resources. + Additionally, you must create the following networking resources before you install the {product-title} cluster: [NOTE] @@ -495,10 +488,6 @@ default. This record must be resolvable by both clients external to the cluster and from all the nodes within the cluster. |=== -ifeval::["{context}" == "installing-restricted-networks-installer-provisioned-vsphere"] -:!restricted: -endif::[] - ifeval::["{context}" == "installing-vsphere"] :!vsphere: endif::[] diff --git a/modules/installation-vsphere-installer-infra-static-ip-nodes.adoc b/modules/installation-vsphere-installer-infra-static-ip-nodes.adoc index 1e55fe7b6d..58cd2eb68e 100644 --- a/modules/installation-vsphere-installer-infra-static-ip-nodes.adoc +++ b/modules/installation-vsphere-installer-infra-static-ip-nodes.adoc @@ -1,10 +1,6 @@ -//// -Module included in the following assemblies: -* xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc[Installing a cluster on vSphere] -* xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc[Installing a cluster on vSphere with customizations] -* xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc[Installing a cluster on vSphere with network customizations] -* xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc[Installing a cluster on vSphere in a restricted network] -//// +// Module included in the following assemblies: +// +// * installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc :_mod-docs-content-type: CONCEPT [discrete] diff --git a/modules/installation-vsphere-installer-network-requirements.adoc b/modules/installation-vsphere-installer-network-requirements.adoc index a8edfcf9de..b5aee272a1 100644 --- a/modules/installation-vsphere-installer-network-requirements.adoc +++ b/modules/installation-vsphere-installer-network-requirements.adoc @@ -1,8 +1,6 @@ // Module included in the following assemblies: // -// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc -// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc -// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc +// * installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc :_mod-docs-content-type: CONCEPT [id="installation-vsphere-installer-network-requirements_{context}"] diff --git a/modules/vmware-csi-driver-reqs.adoc b/modules/vmware-csi-driver-reqs.adoc index a8afa7be78..71a0b7a12b 100644 --- a/modules/vmware-csi-driver-reqs.adoc +++ b/modules/vmware-csi-driver-reqs.adoc @@ -1,13 +1,9 @@ // Module included in the following assemblies: // +// * installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc // * installing/installing_vsphere/installing-vsphere.adoc // * installing/installing_vsphere/installing-vsphere-network-customizations.adoc -// * 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-restricted-networks-installer-provisioned-vsphere.adoc -// * installing/installing_vsphere/preparing-to-install-on-vsphere.adoc // * storage/container_storage_interface/persistent-storage-csi-vsphere.adoc :_mod-docs-content-type: CONCEPT @@ -26,4 +22,4 @@ If a third-party vSphere CSI driver is present in the cluster, {product-title} d [NOTE] ==== The VMware vSphere CSI Driver Operator is supported only on clusters deployed with `platform: vsphere` in the installation manifest. -==== \ No newline at end of file +==== diff --git a/post_installation_configuration/node-tasks.adoc b/post_installation_configuration/node-tasks.adoc index 81e57d3e97..d5daeda7df 100644 --- a/post_installation_configuration/node-tasks.adoc +++ b/post_installation_configuration/node-tasks.adoc @@ -167,7 +167,7 @@ After you deployed your cluster to run nodes with static IP addresses, you can s [role="_additional-resources"] .Additional resources -* xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installation-vsphere-installer-infra-requirements_installing-vsphere-installer-provisioned[Static IP addresses for vSphere nodes] +* xref:../installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc#installation-vsphere-installer-infra-requirements_ipi-vsphere-installation-reqs[Static IP addresses for vSphere nodes] // Scaling machines to use static IP addresses include::modules/nodes-vsphere-scaling-machines-static-ip.adoc[leveloffset=+2] diff --git a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc index 4c78cc89a3..d0b0b6ce23 100644 --- a/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc +++ b/windows_containers/creating_windows_machinesets/creating-windows-machineset-vsphere.adoc @@ -28,7 +28,7 @@ include::modules/creating-the-vsphere-windows-vm-golden-image.adoc[leveloffset=+ ==== Additional resources * xref:../../windows_containers/enabling-windows-container-workloads.adoc#configuring-secret-for-wmco_enabling-windows-container-workloads[Configuring a secret for the Windows Machine Config Operator] -* xref:../../installing/installing_vsphere/preparing-to-install-on-vsphere.adoc#installation-vsphere-infrastructure_preparing-to-install-on-vsphere[VMware vSphere infrastructure requirements] +* xref:../../installing/installing_vsphere/ipi/ipi-vsphere-installation-reqs.adoc#installation-vsphere-infrastructure_ipi-vsphere-installation-reqs[VMware vSphere infrastructure requirements] include::modules/enabling-internal-api-server-vsphere.adoc[leveloffset=+2]