Skip to content

OSDOCS-15374#combining vSphere customization assemblies #96319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -617,8 +617,6 @@ Topics:
File: installing-vsphere-installer-provisioned
- Name: Installing a cluster with customizations
File: installing-vsphere-installer-provisioned-customizations
- Name: Installing a cluster with network customizations
File: installing-vsphere-installer-provisioned-network-customizations
- Name: Installing a cluster in a disconnected environment
File: installing-restricted-networks-installer-provisioned-vsphere
- Name: User-provisioned infrastructure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ include::_attributes/common-attributes.adoc[]
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.
{vmw-first} instance by using installer-provisioned infrastructure with customizations, including network configuration options. In each, you modify parameters in the `install-config.yaml` file before you install the cluster.

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.

You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster.

[id="prerequisites_installing-vsphere-installer-provisioned-customizations"]
== Prerequisites

* You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure].
* You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing.
* You reviewed your {vmw-short} platform licenses. Red{nbsp}Hat does not place any restrictions on your {vmw-short} licenses, but some {vmw-short} infrastructure components require licensing.
* 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/overview/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.
Expand All @@ -36,13 +40,13 @@ include::modules/installation-vsphere-regions-zones-host-groups.adoc[leveloffset
[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#installation-configuration-parameters-additional-vsphere_installation-config-parameters-vsphere[Additional {vmw-full} configuration parameters]

* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#deprecated-parameters-vsphere_installation-config-parameters-vsphere[Deprecated VMware vSphere configuration parameters]
* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#deprecated-parameters-vsphere_installation-config-parameters-vsphere[Deprecated {vmw-full} 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-migration.adoc#persistent-storage-csi-migration-sc-vsphere_persistent-storage-csi-migration[{vmw-short}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]
* xref:../../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-top-aware_persistent-storage-csi-vsphere[{vmw-full} CSI Driver Operator]

* xref:../../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]

Expand All @@ -56,6 +60,8 @@ include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[lev

include::modules/installation-configure-proxy.adoc[leveloffset=+2]

include::modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc[leveloffset=+2]

include::modules/configuring-vsphere-regions-zones.adoc[leveloffset=+2]

include::modules/configuring-vsphere-host-groups.adoc[leveloffset=+2]
Expand All @@ -64,6 +70,31 @@ include::modules/configuring-vsphere-host-groups.adoc[leveloffset=+2]
.Additional resources
* xref:../../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[Enabling features using feature gates]

// Specifying multiple NICS
include::modules/installation-vsphere-multiple-nics.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-configuration-parameters-network_installation-config-parameters-vsphere[Network configuration parameters]

// Network configuration phases
include::modules/nw-network-config.adoc[leveloffset=+1]

// Specifying advanced network configuration
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]

// Specifying multiple subnets for your network
include::modules/nw-operator-vsphere-multiple-subnets.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../../../rest_api/config_apis/infrastructure-config-openshift-io-v1.adoc#spec-platformspec-vsphere-nodenetworking[`.spec.platformSpec.vsphere.nodeNetworking`]

// Cluster Network Operator configuration
include::modules/nw-operator-cr.adoc[leveloffset=+1]

// Services for a user-managed load balancer
include::modules/nw-osp-services-external-load-balancer.adoc[leveloffset=+1]

Expand Down Expand Up @@ -96,11 +127,13 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1]

* 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/ipi-install-configure-network-components-to-run-on-the-control-plane.adoc[leveloffset=+1]

[id="next-steps_installing-vsphere-installer-provisioned-customizations"]
== 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.
* Optional: xref:../../../installing/installing_vsphere/using-vsphere-problem-detector-operator.adoc#vsphere-problem-detector-viewing-events_vsphere-problem-detector[View the events from the {vmw-short} Problem Detector Operator] to determine if the cluster has permission or storage configuration issues.
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ Installer-provisioned infrastructure is useful for installing in environments wi

* **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/ipi/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.

* **xref:../../installing/installing_vsphere/ipi/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.

Expand All @@ -41,9 +39,7 @@ You can install {product-title} on vSphere by using user-provisioned infrastruct
User-provisioned infrastructure requires the user to provision all resources required by {product-title}.
If you do not use infrastructure that the installation program provisions, you must manage and maintain the cluster resources yourself.

* **xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[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/upi/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/upi/installing-vsphere.adoc#installing-vsphere[Installing a cluster on vSphere with user-provisioned infrastructure]**: You can install {product-title} on VMware vSphere infrastructure that you provision or you can install {product-title} on VMware vSphere infrastructure that you provision with customized network configuration options

* **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.

Expand Down
Loading