From 71c7d7fff685960e4cc27c10fda0dd2a3a983060 Mon Sep 17 00:00:00 2001 From: Mike Pytlak Date: Fri, 1 Dec 2023 11:01:19 -0500 Subject: [PATCH] OSDOCS-8178: Refactor of vSphere TOC --- _topic_maps/_topic_map.yml | 8 +- installing/installing-preparing.adoc | 4 +- ...-installer-provisioned-customizations.adoc | 118 ------------------ .../installing-vsphere-three-node.adoc | 2 +- installing/installing_vsphere/ipi/_attributes | 1 + installing/installing_vsphere/ipi/images | 1 + ...-installer-provisioned-customizations.adoc | 118 ++++++++++++++++++ installing/installing_vsphere/ipi/modules | 1 + installing/installing_vsphere/ipi/snippets | 1 + .../preparing-to-install-on-vsphere.adoc | 2 +- 10 files changed, 131 insertions(+), 125 deletions(-) delete mode 100644 installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc create mode 120000 installing/installing_vsphere/ipi/_attributes create mode 120000 installing/installing_vsphere/ipi/images create mode 100644 installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc create mode 120000 installing/installing_vsphere/ipi/modules create mode 120000 installing/installing_vsphere/ipi/snippets diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 2294eafb2e5e..6fa6b87d4372 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -469,10 +469,12 @@ Topics: Topics: - Name: Preparing to install on vSphere File: preparing-to-install-on-vsphere + Dir: ipi + Topics: + - Name: Installing a cluster with customizations + File: installing-vsphere-installer-provisioned-customizations - Name: Installing a cluster on vSphere File: installing-vsphere-installer-provisioned - - Name: Installing a cluster on vSphere with customizations - File: installing-vsphere-installer-provisioned-customizations - Name: Installing a cluster on vSphere with network customizations File: installing-vsphere-installer-provisioned-network-customizations - Name: Installing a cluster on vSphere with user-provisioned infrastructure @@ -1037,7 +1039,7 @@ Topics: - Name: Configuring and managing Tang servers using the NBDE Tang Server Operator File: nbde-tang-server-operator-configuring-managing - Name: Identifying URL of a Tang server deployed with the NBDE Tang Server Operator - File: nbde-tang-server-operator-identifying-url + File: nbde-tang-server-operator-identifying-url - Name: cert-manager Operator for Red Hat OpenShift Dir: cert_manager_operator Distros: openshift-enterprise diff --git a/installing/installing-preparing.adoc b/installing/installing-preparing.adoc index 174467bdbe74..0979c13b1f6a 100644 --- a/installing/installing-preparing.adoc +++ b/installing/installing-preparing.adoc @@ -165,7 +165,7 @@ ifndef::openshift-origin[] |xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] | | -|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] +|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] |xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] | | @@ -336,7 +336,7 @@ ifdef::openshift-origin[] |xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] |xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] | -|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] +|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] |xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] | | diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc deleted file mode 100644 index 3a39626801dc..000000000000 --- a/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +++ /dev/null @@ -1,118 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="installing-vsphere-installer-provisioned-customizations"] -= Installing a cluster on vSphere with customizations -include::_attributes/common-attributes.adoc[] -:context: installing-vsphere-installer-provisioned-customizations -:platform: vSphere - -toc::[] - -In {product-title} version {product-version}, you can install a cluster on your -VMware vSphere instance by using installer-provisioned infrastructure. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. - -include::snippets/vcenter-support.adoc[] - -== Prerequisites - -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You provisioned xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. -* The {product-title} installer requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. -* If you use a firewall, you confirmed with the administrator that port 443 is accessible. Control plane nodes must be able to reach vCenter and ESXi hosts on port 443 for the installation to succeed. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. -+ -[NOTE] -==== -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] - -include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] - -include::modules/installation-vsphere-regions-zones.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* xref:../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-configuration-parameters-additional-vsphere_installation-config-parameters-vsphere[Additional VMware vSphere configuration parameters] - -* xref:../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#deprecated-parameters-vsphere_installation-config-parameters-vsphere[Deprecated VMware vSphere configuration parameters] - -* xref:../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration-sc-vsphere_persistent-storage-csi-migration[vSphere automatic migration] - -* xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-top-aware_persistent-storage-csi-vsphere[VMware vSphere CSI Driver Operator] - -include::modules/installation-initializing.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources -* xref:../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-config-parameters-vsphere[Installation configuration parameters] - -include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2] - -include::modules/installation-configure-proxy.adoc[leveloffset=+2] - -include::modules/configuring-vsphere-regions-zones.adoc[leveloffset=+2] - -include::modules/installation-launching-installer.adoc[leveloffset=+1] - -include::modules/cli-installing-cli.adoc[leveloffset=+1] - -include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] - -[id="installing-vsphere-installer-provisioned-customizations-registry"] -== Creating registry storage -After you install the cluster, you must create storage for the registry Operator. - -include::modules/registry-removed.adoc[leveloffset=+2] - -include::modules/installation-registry-storage-config.adoc[leveloffset=+2] - -include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] - -include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] - -For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#registry-configuring-storage-vsphere_configuring-registry-storage-vsphere[Configuring the registry for vSphere]. - -include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] - -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service - -include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+1] - -== Next steps - -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can -xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. -* xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. -* Optional: xref:../../installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc#vsphere-problem-detector-viewing-events_vsphere-problem-detector[View the events from the vSphere Problem Detector Operator] to determine if the cluster has permission or storage configuration issues. diff --git a/installing/installing_vsphere/installing-vsphere-three-node.adoc b/installing/installing_vsphere/installing-vsphere-three-node.adoc index b7a6a5ac8ac7..4bdf6566a15c 100644 --- a/installing/installing_vsphere/installing-vsphere-three-node.adoc +++ b/installing/installing_vsphere/installing-vsphere-three-node.adoc @@ -13,5 +13,5 @@ You can install a three-node cluster using either installer-provisioned or user- include::modules/installation-three-node-cluster-cloud-provider.adoc[leveloffset=+1] == Next steps -* xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[Installing a cluster on vSphere with customizations] +* xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[Installing a cluster on vSphere with customizations] * xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Installing a cluster on vSphere with user-provisioned infrastructure] diff --git a/installing/installing_vsphere/ipi/_attributes b/installing/installing_vsphere/ipi/_attributes new file mode 120000 index 000000000000..bf7c2529fdb4 --- /dev/null +++ b/installing/installing_vsphere/ipi/_attributes @@ -0,0 +1 @@ +../../../_attributes/ \ No newline at end of file diff --git a/installing/installing_vsphere/ipi/images b/installing/installing_vsphere/ipi/images new file mode 120000 index 000000000000..4399cbb3c0f3 --- /dev/null +++ b/installing/installing_vsphere/ipi/images @@ -0,0 +1 @@ +../../../images/ \ No newline at end of file diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc new file mode 100644 index 000000000000..d8f970c05dd5 --- /dev/null +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc @@ -0,0 +1,118 @@ +:_mod-docs-content-type: ASSEMBLY +[id="installing-vsphere-installer-provisioned-customizations"] += Installing a cluster on vSphere with customizations +include::_attributes/common-attributes.adoc[] +:context: installing-vsphere-installer-provisioned-customizations +:platform: vSphere + +toc::[] + +In {product-title} version {product-version}, you can install a cluster on your +VMware vSphere instance by using installer-provisioned infrastructure. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. + +include::snippets/vcenter-support.adoc[] + +== Prerequisites + +* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. +* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You provisioned xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. +* The {product-title} installer requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. +* If you use a firewall, you confirmed with the administrator that port 443 is accessible. Control plane nodes must be able to reach vCenter and ESXi hosts on port 443 for the installation to succeed. +* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. ++ +[NOTE] +==== +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] + +include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] + +include::modules/installation-vsphere-regions-zones.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-configuration-parameters-additional-vsphere_installation-config-parameters-vsphere[Additional VMware vSphere configuration parameters] + +* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#deprecated-parameters-vsphere_installation-config-parameters-vsphere[Deprecated VMware vSphere configuration parameters] + +* xref:../../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration-sc-vsphere_persistent-storage-csi-migration[vSphere automatic migration] + +* xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-top-aware_persistent-storage-csi-vsphere[VMware vSphere CSI Driver Operator] + +include::modules/installation-initializing.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources +* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-config-parameters-vsphere[Installation configuration parameters] + +include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2] + +include::modules/installation-configure-proxy.adoc[leveloffset=+2] + +include::modules/configuring-vsphere-regions-zones.adoc[leveloffset=+2] + +include::modules/installation-launching-installer.adoc[leveloffset=+1] + +include::modules/cli-installing-cli.adoc[leveloffset=+1] + +include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] + +[id="installing-vsphere-installer-provisioned-customizations-registry"] +== Creating registry storage +After you install the cluster, you must create storage for the registry Operator. + +include::modules/registry-removed.adoc[leveloffset=+2] + +include::modules/installation-registry-storage-config.adoc[leveloffset=+2] + +include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] + +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#registry-configuring-storage-vsphere_configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + +include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] + +include::modules/cluster-telemetry.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service + +include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+1] + +== Next steps + +* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* If necessary, you can +xref:../../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. +* xref:../../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. +* Optional: xref:../../../installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc#vsphere-problem-detector-viewing-events_vsphere-problem-detector[View the events from the vSphere Problem Detector Operator] to determine if the cluster has permission or storage configuration issues. diff --git a/installing/installing_vsphere/ipi/modules b/installing/installing_vsphere/ipi/modules new file mode 120000 index 000000000000..7e8b50bee77a --- /dev/null +++ b/installing/installing_vsphere/ipi/modules @@ -0,0 +1 @@ +../../../modules/ \ No newline at end of file diff --git a/installing/installing_vsphere/ipi/snippets b/installing/installing_vsphere/ipi/snippets new file mode 120000 index 000000000000..ce62fd7c41e2 --- /dev/null +++ b/installing/installing_vsphere/ipi/snippets @@ -0,0 +1 @@ +../../../snippets/ \ No newline at end of file diff --git a/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc index 69a42eda7aa3..ee0fccfffe11 100644 --- a/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc +++ b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc @@ -40,7 +40,7 @@ Installer-provisioned infrastructure allows the installation program to preconfi * **xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[Installing a cluster on vSphere]**: You can install {product-title} on vSphere by using installer-provisioned infrastructure installation with no customization. -* **xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[Installing a cluster on vSphere with customizations]**: You can install {product-title} on vSphere by using installer-provisioned infrastructure installation with the default customization options. +* **xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[Installing a cluster on vSphere with customizations]**: You can install {product-title} on vSphere by using installer-provisioned infrastructure installation with the default customization options. * **xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[Installing a cluster on vSphere with network customizations]**: You can install {product-title} on installer-provisioned vSphere infrastructure, with network customizations. You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements.