From b7f686a77b6433a95aba7e00fc0a133a3b657456 Mon Sep 17 00:00:00 2001 From: James Brigman Date: Wed, 16 Jun 2021 00:52:25 -0400 Subject: [PATCH] OSDOCS-1977: Create Preparing to Install document for Installing OpenShift on vSphere --- _topic_map.yml | 2 + .../preparing-to-install-on-vsphere.adoc | 58 +++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 installing/installing_vsphere/preparing-to-install-on-vsphere.adoc diff --git a/_topic_map.yml b/_topic_map.yml index 01e55f853e9f..32f8335737dc 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -326,6 +326,8 @@ Topics: - Name: Installing on vSphere Dir: installing_vsphere Topics: + - Name: Preparing to install on vSphere + File: preparing-to-install-on-vsphere - Name: Installing a cluster on vSphere File: installing-vsphere-installer-provisioned - Name: Installing a cluster on vSphere with customizations diff --git a/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc new file mode 100644 index 000000000000..13ab2d4c70b9 --- /dev/null +++ b/installing/installing_vsphere/preparing-to-install-on-vsphere.adoc @@ -0,0 +1,58 @@ +[id="preparing-to-install-on-vsphere"] += Preparing to install on vSphere +include::modules/common-attributes.adoc[] +:context: preparing-to-install-on-vsphere + +toc::[] + + +[id="preparing-to-install-on-vsphere-prerequisites"] +== 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]. + +* If you use a firewall and plan to use Telemetry, you +xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] required by your cluster. + + +[id="choosing-a-method-to-install-ocp-on-vsphere"] +== Choosing a method to install {product-title} on vSphere + +You can install {product-title} on vSphere by using installer-provisioned or user-provisioned infrastructure. The default installation type uses installer-provisioned infrastructure, where the installation program provisions the underlying infrastructure for the cluster. You can also install OpenShift Container Platform on infrastructure that you provide. If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself. + +See the xref:../../architecture/architecture-installation.html#installation-process_architecture-installation[Installation process] for more information about installer-provisioned and user-provisioned installation processes. + +[IMPORTANT] +==== +The steps for performing a user-provisioned infrastructure installation are provided as an example only. Installing a cluster with infrastructure you provide requires knowledge of the vSphere platform and the installation process of {product-title}. Use the user-provisioned infrastructure installation instructions as a guide; you are free to create the required resources through other methods. +==== + + +=== Installer-provisioned infrastructure installation of {product-title} on vSphere + +Installer-provisioned infrastructure allows the installation program to pre-configure and automate the provisioning of resources required by {product-title}. + +* **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/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 OpenShift Container Platform network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. + +* **xref:../../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[Installing a cluster on vSphere in a restricted network]**: You can install a cluster on VMware vSphere infrastructure in a restricted network by creating an internal mirror of the installation release content. + You can use this method to deploy {product-title} on an internal network that is not visible to the Internet. + +=== User-provisioned infrastructure installation of {product-title} on vSphere + +User-provisioned infrastructure requires the user to provision all resources required by {product-title}. + +* **xref:../../installing/installing_vsphere/installing-vsphere.adoc#[Installing a cluster on vSphere with user-provisioned infrastructure]**: You can install {product-title} on VMware vSphere infrastructure that you provision. + +* **xref:../../installing/installing_vsphere/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[Installing a cluster on vSphere with network customizations with user-provisioned infrastructure]**: You can install {product-title} on VMware vSphere infrastructure that you provision with customized network configuration options. + +* **xref:../../installing/installing_vsphere/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. + +== Uninstalling an installer-provisioned infrastructure installation of {product-title} on vSphere + +* **xref:../../installing/installing_vsphere/uninstalling-cluster-vsphere-installer-provisioned.adoc#uninstalling-cluster-vsphere-installer-provisioned[Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure]**: You can remove a cluster that you deployed on VMware vSphere infrastructure that used installer-provisioned infrastructure.