diff --git a/_topic_map.yml b/_topic_map.yml index 613b1f4a772f..cb677c6d8f4a 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -247,6 +247,8 @@ Topics: 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 File: installing-vsphere - Name: Installing a cluster on vSphere with user-provisioned infrastructure and network customizations diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc new file mode 100644 index 000000000000..3739e0e4d1b1 --- /dev/null +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc @@ -0,0 +1,77 @@ +[id="installing-vsphere-installer-provisioned-network-customizations"] += Installing a cluster on vSphere with network customizations +include::modules/common-attributes.adoc[] +:context: installing-vsphere-installer-provisioned-network-customizations + +toc::[] + +In {product-title} version {product-version}, you can install a cluster on your +VMware vSphere instance by using installer-provisioned infrastructure with customized network configuration options. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. + +You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster. + +.Prerequisites + +* Provision +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. +* Review details about the +xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +processes. +* If you use a firewall, you must +xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure 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-infra-requirements.adoc[leveloffset=+1] + +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-initializing.adoc[leveloffset=+1] + +include::modules/installation-configuration-parameters.adoc[leveloffset=+2] + +// additional install-config network parameters +include::modules/nw-install-config-parameters.adoc[leveloffset=+2] + +include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2] + +// begin network customization +include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] +include::modules/nw-operator-cr.adoc[leveloffset=+1] +// end network customization + +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-network-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] + +.Next steps + +* xref:../../installing/install_config/customizations.adoc#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]. diff --git a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc index 37c528b7fa84..33c6f3b159c6 100644 --- a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc @@ -7,7 +7,7 @@ toc::[] In {product-title} version {product-version}, you can install a cluster on VMware vSphere infrastructure that you provision with customized network -configuration options. By customizing your network configuration, your cluster +configuration options. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. diff --git a/modules/cluster-entitlements.adoc b/modules/cluster-entitlements.adoc index 3b98c6265889..fc20ec5e2d33 100644 --- a/modules/cluster-entitlements.adoc +++ b/modules/cluster-entitlements.adoc @@ -26,6 +26,7 @@ // * installing/installing_vsphere/installing-vsphere.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_ibm_z/installing-ibm-z.adoc ifeval::["{context}" == "installing-restricted-networks-bare-metal"] diff --git a/modules/installation-adding-vcenter-root-certificates.adoc b/modules/installation-adding-vcenter-root-certificates.adoc index ada03a64c88f..e5f6e596ccbe 100644 --- a/modules/installation-adding-vcenter-root-certificates.adoc +++ b/modules/installation-adding-vcenter-root-certificates.adoc @@ -2,6 +2,7 @@ // // * 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 [id="installation-adding-vcenter-root-certificates_{context}"] = Adding vCenter root CA certificates to your system trust diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc index 7f5cca8b9adf..6a920c5a3aec 100644 --- a/modules/installation-initializing.adoc +++ b/modules/installation-initializing.adoc @@ -21,6 +21,8 @@ // * installing/installing_rhv/installing-rhv-customizations.adoc // * installing/installing_rhv/installing-rhv-default.adoc // * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc + // Consider also adding the installation-configuration-parameters.adoc module. //YOU MUST SET AN IFEVAL FOR EACH NEW MODULE @@ -86,6 +88,9 @@ endif::[] ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"] :vsphere: endif::[] +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:vsphere: +endif::[] [id="installation-initializing_{context}"] = Creating the installation configuration file @@ -380,3 +385,6 @@ endif::[] ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"] :!vsphere: endif::[] +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:!vsphere: +endif::[] diff --git a/modules/installation-installer-provisioned-vsphere-config-yaml.adoc b/modules/installation-installer-provisioned-vsphere-config-yaml.adoc index 987ab31ccd01..022c594e9e7f 100644 --- a/modules/installation-installer-provisioned-vsphere-config-yaml.adoc +++ b/modules/installation-installer-provisioned-vsphere-config-yaml.adoc @@ -2,6 +2,10 @@ // // * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:network: +endif::[] + [id="installation-installer-provisioned-vsphere-config-yaml_{context}"] = Sample `install-config.yaml` file for an installer-provisioned VMware vSphere cluster @@ -37,6 +41,17 @@ controlPlane: <2> diskSizeGB: 120 metadata: name: cluster <5> +ifdef::network[] +networking: + clusterNetwork: + - cidr: 10.128.0.0/14 + hostPrefix: 23 + machineNetwork: + - cidr: 10.0.0.0/16 + networkType: OpenShiftSDN + serviceNetwork: + - 172.30.0.0/16 +endif::network[] platform: vsphere: vcenter: your.vcenter.server @@ -78,3 +93,7 @@ simultaneous multithreading. ==== <4> Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines. <5> The cluster name that you specified in your DNS records. + +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:!network: +endif::[] diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index 0a4dc1b69d54..855f4b1d37fd 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -94,6 +94,10 @@ ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations :custom-config: :vsphere: endif::[] +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:custom-config: +:vsphere: +endif::[] [id="installation-launching-installer_{context}"] = Deploying the cluster @@ -420,3 +424,7 @@ ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations :!custom-config: :!vsphere: endif::[] +ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"] +:!custom-config: +:!vsphere: +endif::[] diff --git a/modules/installation-obtaining-installer.adoc b/modules/installation-obtaining-installer.adoc index 1c1a95a71135..c272daa4455d 100644 --- a/modules/installation-obtaining-installer.adoc +++ b/modules/installation-obtaining-installer.adoc @@ -22,6 +22,7 @@ // * installing/installing_vsphere/installing-vsphere.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_ibm_z/installing-ibm-z.adoc // * installing/installing_rhv/installing-rhv-default.adoc // * installing/installing_rhv/installing-rhv-customizations.adoc diff --git a/modules/installation-registry-storage-config.adoc b/modules/installation-registry-storage-config.adoc index af6128ebfcc2..005c00d5ad80 100644 --- a/modules/installation-registry-storage-config.adoc +++ b/modules/installation-registry-storage-config.adoc @@ -7,6 +7,15 @@ // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc // * installing/installing_vsphere/installing-vsphere.adoc // * installing/installing_ibm_z/installing-ibm-z.adoc +// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc +// * installing/installing_bare_metal/installing-bare-metal.adoc +// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.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-installer-provisioned.adoc +// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc +// * registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc +// * registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc ifeval::["{context}" == "installing-aws-user-infra"] :aws: diff --git a/modules/installation-vsphere-infrastructure.adoc b/modules/installation-vsphere-infrastructure.adoc index 2a2384713598..eb2d85a0bb97 100644 --- a/modules/installation-vsphere-infrastructure.adoc +++ b/modules/installation-vsphere-infrastructure.adoc @@ -4,6 +4,7 @@ // * installing/installing_vsphere/installing-vsphere.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 [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 fe5b03ee669c..89232dd8a482 100644 --- a/modules/installation-vsphere-installer-infra-requirements.adoc +++ b/modules/installation-vsphere-installer-infra-requirements.adoc @@ -2,6 +2,7 @@ // // * 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 [id="installation-vsphere-installer-infra-requirements_{context}"] = vCenter requirements diff --git a/modules/nw-install-config-parameters.adoc b/modules/nw-install-config-parameters.adoc index 92578ab2c9c9..b879cceecde2 100644 --- a/modules/nw-install-config-parameters.adoc +++ b/modules/nw-install-config-parameters.adoc @@ -5,6 +5,7 @@ // * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc // * installing/installing_gcp/installing-gcp-network-customizations.adoc // * installing/installing_vsphere/installing-vsphere-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc ifeval::["{context}" == "installing-aws-network-customizations"] :ovn-preview: diff --git a/modules/nw-modifying-operator-install-config.adoc b/modules/nw-modifying-operator-install-config.adoc index 0506e9aee204..41b83146c464 100644 --- a/modules/nw-modifying-operator-install-config.adoc +++ b/modules/nw-modifying-operator-install-config.adoc @@ -5,6 +5,7 @@ // * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc // * installing/installing_vsphere/installing-vsphere-network-customizations.adoc // * installing/installing_gcp/installing-gcp-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc ifeval::["{context}" == "installing-bare-metal-network-customizations"] :ignition-config: diff --git a/modules/registry-configuring-storage-vsphere.adoc b/modules/registry-configuring-storage-vsphere.adoc index 0fb4a3bf8d01..460c735aa7a8 100644 --- a/modules/registry-configuring-storage-vsphere.adoc +++ b/modules/registry-configuring-storage-vsphere.adoc @@ -2,7 +2,10 @@ // // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc // * installing/installing_vsphere/installing-vsphere.adoc -// * registry/configuring_registry_storage-vsphere.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +// * registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc [id="registry-configuring-storage-vsphere_{context}"] = Configuring registry storage for VMware vSphere diff --git a/modules/registry-removed.adoc b/modules/registry-removed.adoc index 7fb4dc687634..1d2ee20ae939 100644 --- a/modules/registry-removed.adoc +++ b/modules/registry-removed.adoc @@ -2,8 +2,14 @@ // // * installing/installing_bare_metal/installing-bare-metal.adoc // * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc +// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc // * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc // * installing/installing_vsphere/installing-vsphere.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-installer-provisioned.adoc +// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc +// * registry/configuring-registry-operator.adoc // * registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc // * registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc diff --git a/modules/ssh-agent-using.adoc b/modules/ssh-agent-using.adoc index 56628527ae4c..3b51f01d7312 100644 --- a/modules/ssh-agent-using.adoc +++ b/modules/ssh-agent-using.adoc @@ -25,6 +25,7 @@ // * installing/installing_vsphere/installing-vsphere.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_ibm_z/installing-ibm-z.adoc ifeval::["{context}" == "installing-restricted-networks-vsphere"]