Skip to content

[enterprise-4.5] Add network customization for vSphere installer-provisioned #23923

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.

Sign up for GitHub

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
jboxman merged 1 commit into from
Jul 17, 2020
Merged

[enterprise-4.5] Add network customization for vSphere installer-provisioned #23923

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions _topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,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
Expand Down
77 changes: 77 additions & 0 deletions ...ng_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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].
2 changes: 1 addition & 1 deletion installing/installing_vsphere/installing-vsphere-network-customizations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
1 change: 1 addition & 0 deletions modules/cluster-entitlements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down
1 change: 1 addition & 0 deletions modules/installation-adding-vcenter-root-certificates.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions modules/installation-initializing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -380,3 +385,6 @@ endif::[]
ifeval::["{context}" == "installing-vsphere-installer-provisioned-customizations"]
:!vsphere:
endif::[]
ifeval::["{context}" == "installing-vsphere-installer-provisioned-network-customizations"]
:!vsphere:
endif::[]
19 changes: 19 additions & 0 deletions modules/installation-installer-provisioned-vsphere-config-yaml.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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::[]
8 changes: 8 additions & 0 deletions modules/installation-launching-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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::[]
1 change: 1 addition & 0 deletions modules/installation-obtaining-installer.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions modules/installation-registry-storage-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions modules/installation-vsphere-infrastructure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions modules/installation-vsphere-installer-infra-requirements.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions modules/nw-install-config-parameters.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions modules/nw-modifying-operator-install-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion modules/registry-configuring-storage-vsphere.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions modules/registry-removed.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions modules/ssh-agent-using.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand Down