--- title: Installing a cluster on vSphere with network customizations --- # Installing a cluster on vSphere with network customizations {#installing-vsphere-network-customizations} In OpenShift Container Platform version 4.22, you can install a cluster on VMware vSphere infrastructure that you provision 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. You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster. > [!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 OpenShift Container Platform. Use the user-provisioned infrastructure installation instructions as a guide; you are free to create the required resources through other methods. ## Prerequisites {#prerequisites_installing-vsphere-network-customizations_installing-vsphere-network-customizations} - You have completed the tasks in "Preparing to install a cluster using user-provisioned infrastructure". - You reviewed your VMware platform licenses. Red Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. - You reviewed details about the OpenShift Container Platform installation and update processes. - You read the documentation on selecting a cluster installation method and preparing it for users. - Completing the installation requires that you upload the Red Hat Enterprise Linux CoreOS (RHCOS) OVA on vSphere hosts. The machine from which you complete this process requires access to port 443 on the vCenter and ESXi hosts. Verify 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 configured it to allow the sites that your cluster requires access to. ## Internet access for OpenShift Container Platform {#cluster-entitlements_installing-vsphere-network-customizations} In OpenShift Container Platform 4.22, you require access to the internet to install your cluster. You must have internet access to perform the following actions: - Access Red Hat Hybrid Cloud Console to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. - Access Quay.io to obtain the packages that are required to install your cluster. - Obtain the packages that are required to perform cluster updates. > [!IMPORTANT] > If your cluster cannot have direct internet access, you can perform a restricted network installation on some types of infrastructure that you provision. During that process, you download the required content and use it to populate a mirror registry with the installation packages. With some installation types, the environment that you install your cluster in will not require internet access. Before you update the cluster, you update the content of the mirror registry. ## VMware vSphere region and zone enablement {#installation-vsphere-regions-zones_installing-vsphere-network-customizations} You can deploy an OpenShift Container Platform cluster to multiple vSphere data centers. Each data center can run multiple clusters. This configuration reduces the risk of a hardware failure or network outage that can cause your cluster to fail. To enable regions and zones, you must define multiple failure domains for your OpenShift Container Platform cluster. > [!IMPORTANT] > The VMware vSphere region and zone enablement feature requires the vSphere Container Storage Interface (CSI) driver as the default storage driver in the cluster. As a result, the feature is only available on a newly installed cluster. > > For a cluster that was upgraded from a previous release, you must enable CSI automatic migration for the cluster. You can then configure multiple regions and zones for the upgraded cluster. The default installation configuration deploys a cluster to a single vSphere data center. If you want to deploy a cluster to multiple vSphere data centers, you must create an installation configuration file that enables the region and zone feature. The default `install-config.yaml` file includes `vcenters` and `failureDomains` fields, where you can specify multiple vSphere data centers and clusters for your OpenShift Container Platform cluster. You can use the default `failureDomains` from `install-config.yaml` if you want to install an OpenShift Container Platform cluster in a vSphere environment that consists of single data center. The following list describes terms associated with defining zones and regions for your cluster: - Failure domain: Establishes the relationships between a region and zone. You define a failure domain by using vCenter objects, such as a `datastore` object. A failure domain defines the vCenter location for OpenShift Container Platform cluster nodes. - Region: Specifies a vCenter data center. You define a region by using a tag from the `openshift-region` tag category. - Zone: Specifies a vCenter cluster. You define a zone by using a tag from the `openshift-zone` tag category. > [!NOTE] > If you plan on specifying more than one failure domain in your `install-config.yaml` file, you must create tag categories, zone tags, and region tags in advance of creating the configuration file. You must create a vCenter tag for each vCenter data center, which represents a region. Additionally, you must create a vCenter tag for each cluster than runs in a data center, which represents a zone. After you create the tags, you must attach each tag to their respective data centers and clusters. The following table outlines an example of the relationship among regions, zones, and tags for a configuration with multiple vSphere data centers running in a single VMware vCenter.
Data center (region) Cluster (zone) Tags
us-east us-east-1 us-east-1a
us-east-1b
us-east-2 us-east-2a
us-east-2b
us-west us-west-1 us-west-1a
us-west-1b
us-west-2 us-west-2a
us-west-2b
**Additional resources** {._additional-resources} - [Additional VMware vSphere configuration parameters](/openshift-docs-markdown/installing/installing_vsphere/installation-config-parameters-vsphere#installation-configuration-parameters-additional-vsphere_installation-config-parameters-vsphere) - [Deprecated VMware vSphere configuration parameters](/openshift-docs-markdown/installing/installing_vsphere/installation-config-parameters-vsphere#deprecated-parameters-vsphere_installation-config-parameters-vsphere) - [vSphere automatic migration](/openshift-docs-markdown/storage/container_storage_interface/persistent-storage-csi-migration#persistent-storage-csi-migration-sc-vsphere_persistent-storage-csi-migration) - [VMware vSphere CSI Driver Operator](/openshift-docs-markdown/storage/container_storage_interface/persistent-storage-csi-vsphere#persistent-storage-csi-vsphere-top-aware_persistent-storage-csi-vsphere) ## Manually creating the installation configuration file {#installation-initializing-manual_installing-vsphere-network-customizations} Installing the cluster requires that you manually create the installation configuration file. > [!IMPORTANT] > The Cloud Controller Manager Operator performs a connectivity check on a provided hostname or IP address. Ensure that you specify a hostname or an IP address to a reachable vCenter server. If you provide metadata to a non-existent vCenter server, installation of the cluster fails at the bootstrap stage. **Prerequisites** - You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery. - You have obtained the OpenShift Container Platform installation program and the pull secret for your cluster. **Procedure** 1. Create an installation directory to store your required installation assets in: ```terminal $ mkdir ``` > [!IMPORTANT] > You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. 2. Customize the provided sample `install-config.yaml` file template and save the file in the ``. > [!NOTE] > You must name this configuration file `install-config.yaml`. 3. If you are installing a three-node cluster or a cluster with user-provisioned infrastructure, set the `compute.replicas` parameter to `0`. In a three-node cluster, this ensures that the cluster’s control planes are schedulable. For more information, see "Installing a three-node cluster". In a cluster with user-provisioned infrastructure, you must manually deploy compute machines before you finish installing OpenShift Container Platform. 4. Back up the `install-config.yaml` file so that you can use it to install many clusters. > [!IMPORTANT] > Back up the `install-config.yaml` file now, because the installation process consumes the file in the next step. **Additional resources** {._additional-resources} - [Installation configuration parameters](/openshift-docs-markdown/installing/installing_vsphere/installation-config-parameters-vsphere#installation-config-parameters-vsphere) ### Sample install-config.yaml file for a VMware vSphere cluster {#installation-vsphere-config-yaml_installing-vsphere-network-customizations} You can customize the `install-config.yaml` file to specify more details about your OpenShift Container Platform cluster’s platform or change the values of the required parameters. > [!IMPORTANT] > Carefully review the "Installation configuration parameters for vSphere" page for detailed parameter explanations. ```yaml apiVersion: v1 baseDomain: example.com metadata: name: test sshKey: ssh-ed25519 AAAA... compute: - name: platform: {} replicas: 0 controlPlane: name: platform: {} replicas: 3 networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 platform: vsphere: failureDomains: - name: region: server: topology: computeCluster: "//host/" datacenter: datastore: "//datastore/" networks: - zone: vcenters: - datacenters: - server: user: administrator@vsphere.local ``` where: `compute` : Specifes the parameters that apply to compute nodes. `controlPlane` : Specifies the parameters that apply to control plane nodes. `networking` : Specifies the parameters that apply to cluster networking configuration. `platform` : Specifies the parameters that apply to the configuration of the platform hosting the cluster. ### Configuring the cluster-wide proxy during installation {#installation-configure-proxy_installing-vsphere-network-customizations} Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the `install-config.yaml` file. **Prerequisites** - You have an existing `install-config.yaml` file. - You have reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, the proxy handles all cluster egress traffic, including calls to hosting cloud provider APIs. You added sites to the `Proxy` object’s `spec.noProxy` field to bypass the proxy if necessary. > [!NOTE] > The `Proxy` object `status.noProxy` field includes the values of the `networking.machineNetwork[].cidr`, `networking.clusterNetwork[].cidr`, and `networking.serviceNetwork[]` fields from your installation configuration. > > For installations on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the `Proxy` object `status.noProxy` field also includes the instance metadata endpoint (`169.254.169.254`). **Procedure** 1. Edit your `install-config.yaml` file and add the proxy settings. For example: ```yaml apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://:@: httpsProxy: https://:@: noProxy: example.com additionalTrustBundle: | -----BEGIN CERTIFICATE----- -----END CERTIFICATE----- additionalTrustBundlePolicy: # ... ``` where: `proxy.httpProxy` : Specifies a proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be `http`. `proxy.httpsProxy` : Specifies a proxy URL to use for creating HTTPS connections outside the cluster. `proxy.noProxy` : Specifies a comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with `.` to match subdomains only. For example, `.y.com` matches `x.y.com`, but not `y.com`. Use `*` to bypass the proxy for all destinations. You must include vCenter’s IP address and the IP range that you use for its machines. `additionalTrustBundle` : If you specify this value, the installation program generates a config map named `user-ca-bundle` in the `openshift-config` namespace to hold the additional CA certificates. If you specify `additionalTrustBundle` and at least one proxy setting, the `Proxy` object references the `user-ca-bundle` config map in the `trustedCA` field. The Cluster Network Operator then creates a `trusted-ca-bundle` config map that merges the contents specified for the `trustedCA` parameter with the RHCOS trust bundle. You must set the `additionalTrustBundle` field unless an authority from the RHCOS trust bundle signs the proxy’s identity certificate. `additionalTrustBundlePolicy` : Specifies the policy that determines the configuration of the `Proxy` object to reference the `user-ca-bundle` config map in the `trustedCA` field. The allowed values are `Proxyonly` and `Always`. Use `Proxyonly` to reference the `user-ca-bundle` config map only when you configure an `http/https` proxy. Use `Always` to always reference the `user-ca-bundle` config map. The default value is `Proxyonly`. Optional parameter. > [!NOTE] > The installation program does not support the proxy `readinessEndpoints` field. > [!NOTE] > If the installation program times out, restart and then complete the deployment by using the `wait-for` command of the installation program. For example: > > ```terminal > $ ./openshift-install wait-for install-complete --log-level debug > ``` 2. Save the file and reference it when installing OpenShift Container Platform. The installation program creates a cluster-wide proxy named `cluster` that uses the proxy settings in the `install-config.yaml` file. If you do not give proxy settings, the installation program still creates a `cluster` `Proxy` object, but it has a nil `spec`. > [!NOTE] > Only the `Proxy` object named `cluster` is supported, and you cannot create additional proxies. ### Configuring regions and zones for a VMware vCenter {#configuring-vsphere-regions-zones_installing-vsphere-network-customizations} You can modify the default installation configuration file, so that you can deploy an OpenShift Container Platform cluster to multiple vSphere data centers. The default `install-config.yaml` file configuration from the previous release of OpenShift Container Platform is deprecated. You can continue to use the deprecated default configuration, but the `openshift-installer` will prompt you with a warning message that indicates the use of deprecated fields in the configuration file. **Prerequisites** - You have an existing `install-config.yaml` installation configuration file. > [!IMPORTANT] > You must specify at least one failure domain for your OpenShift Container Platform cluster, so that you can provision data center objects for your VMware vCenter server. Consider specifying multiple failure domains if you need to provision virtual machine nodes in different data centers, clusters, datastores, and other components. To enable regions and zones, you must define multiple failure domains for your OpenShift Container Platform cluster. - You have installed the `govc` command line tool. > [!IMPORTANT] > The example uses the `govc` command. The `govc` command is an open source command available from VMware; it is not available from Red Hat. The Red Hat support team does not maintain the `govc` command. Instructions for downloading and installing `govc` are found on the VMware documentation website. **Procedure** 1. Create the `openshift-region` and `openshift-zone` vCenter tag categories by running the following commands: > [!IMPORTANT] > If you specify different names for the `openshift-region` and `openshift-zone` vCenter tag categories, the installation of the OpenShift Container Platform cluster fails. ```terminal $ govc tags.category.create -d "OpenShift region" openshift-region ``` ```terminal $ govc tags.category.create -d "OpenShift zone" openshift-zone ``` 2. For each region where you want to deploy your cluster, create a region tag by running the following command: ```terminal $ govc tags.create -c ``` 3. For each zone where you want to deploy your cluster, create a zone tag by running the following command: ```terminal $ govc tags.create -c ``` 4. Attach region tags to each vCenter data center object by running the following command: ```terminal $ govc tags.attach -c / ``` 5. Attach the zone tags to each vCenter cluster object by running the following command: ```terminal $ govc tags.attach -c //host/ ``` 6. Change to the directory that contains the installation program and initialize the cluster deployment according to your chosen installation requirements. ```yaml {title="Sample install-config.yaml file with multiple data centers defined in a vSphere center"} # ... compute: --- vsphere: zones: - "" - "" # ... controlPlane: # ... vsphere: zones: - "" - "" # ... platform: vsphere: vcenters: # ... datacenters: - - failureDomains: - name: region: zone: server: topology: datacenter: computeCluster: "//host/" networks: - datastore: "//datastore/" resourcePool: "//host//Resources/" folder: "//vm/" - name: region: zone: server: topology: datacenter: computeCluster: "//host/" networks: - datastore: "//datastore/" resourcePool: "//host//Resources/" folder: "//vm/" # ... ``` ## Network configuration phases {#nw-network-config_installing-vsphere-network-customizations} You can customize your OpenShift Container Platform network plugin configuration, such as cluster network CIDR and service network ranges, during two phases before installation to integrate with your existing network environment. Phase 1 : You can customize the following network-related fields in the `install-config.yaml` file before you create the manifest files: - `networking.networkType` - `networking.clusterNetwork` - `networking.serviceNetwork` - `networking.machineNetwork` - `nodeNetworking` For more information, see "Installation configuration parameters". > [!NOTE] > Set the `networking.machineNetwork` to match the Classless Inter-Domain Routing (CIDR) where the preferred subnet is located. > [!IMPORTANT] > The CIDR range `172.17.0.0/16` is reserved by `libVirt`. You cannot use any other CIDR range that overlaps with the `172.17.0.0/16` CIDR range for networks in your cluster. Phase 2 : After creating the manifest files by running `openshift-install create manifests`, you can define a customized Cluster Network Operator manifest with only the fields you want to modify. You can use the manifest to specify an advanced network configuration. During phase 2, you cannot override the values that you specified in phase 1 in the `install-config.yaml` file. However, you can customize the network plugin during phase 2. ## Specifying advanced network configuration {#modifying-nwoperator-config-startup_installing-vsphere-network-customizations} You can use advanced network configuration for your OpenShift Container Platform network plugin to integrate your cluster into your existing network environment. You can specify advanced network configuration only before you install the cluster. > [!IMPORTANT] > Customizing your network configuration by modifying the OpenShift Container Platform manifest files created by the installation program is not supported. Applying a manifest file that you create, as in the following procedure, is supported. **Prerequisites** - You have created the `install-config.yaml` file and completed any modifications to it. **Procedure** 1. Change to the directory that contains the installation program and create the manifests: ```terminal $ ./openshift-install create manifests --dir ``` where `` specifies the name of the directory that contains the `install-config.yaml` file for your cluster. 2. Create a stub manifest file for the advanced network configuration that is named `cluster-network-03-config.yml` in the `/manifests/` directory: ```yaml apiVersion: operator.openshift.io/v1 kind: Network metadata: name: cluster spec: ``` 3. Specify the advanced network configuration for your cluster in the `cluster-network-03-config.yml` file, such as in the following example: The following example enables IPsec for the OVN-Kubernetes network provider: ```yaml apiVersion: operator.openshift.io/v1 kind: Network metadata: name: cluster spec: defaultNetwork: ovnKubernetesConfig: ipsecConfig: mode: Full ``` 4. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The installation program consumes the `manifests/` directory when you create the Ignition config files. 5. Remove the Kubernetes manifest files that define the control plane machines and compute `MachineSets`: ```terminal $ rm -f openshift/99_openshift-cluster-api_master-machines-*.yaml openshift/99_openshift-cluster-api_worker-machineset-*.yaml ``` Because you create and manage these resources yourself, you do not have to initialize them. - You can preserve the `MachineSet` files to create compute machines by using the machine API, but you must update references to them to match your environment. ### Specifying multiple subnets for your network {#nw-operator-vsphere-multiple-subnets_installing-vsphere-network-customizations} Before you install an OpenShift Container Platform cluster on a vSphere host, you can specify multiple subnets for a networking implementation so that the vSphere cloud controller manager (CCM) can select the appropriate subnet for a given networking situation. vSphere can use the subnet for managing pods and services on your cluster. For this configuration, you must specify internal and external Classless Inter-Domain Routing (CIDR) implementations in the vSphere CCM configuration. Each CIDR implementation lists an IP address range that the CCM uses to decide what subnets interact with traffic from internal and external networks. > [!IMPORTANT] > Failure to configure internal and external CIDR implementations in the vSphere CCM configuration can cause the vSphere CCM to select the wrong subnet. This situation causes the following error: > > ``` > ERROR Bootstrap failed to complete: timed out waiting for the condition > ERROR Failed to wait for bootstrapping to complete. This error usually happens when there is a problem with control plane hosts that prevents the control plane operators from creating the control plane. > ``` > > This configuration can cause new nodes that associate with a `MachineSet` object with a single subnet to become unusable as each new node receives the `node.cloudprovider.kubernetes.io/uninitialized` taint. These situations can cause communication issues with the Kubernetes API server that can cause installation of the cluster to fail. **Prerequisites** - You created Kubernetes manifest files for your OpenShift Container Platform cluster. **Procedure** 1. From the directory where you store your OpenShift Container Platform cluster manifest files, open the `manifests/cluster-infrastructure-02-config.yml` manifest file. 2. Add a `nodeNetworking` object to the file and specify internal and external network subnet CIDR implementations for the object. > [!TIP] > For most networking situations, consider setting the standard multiple-subnet configuration. This configuration requires that you set the same IP address ranges in the `nodeNetworking.internal.networkSubnetCidr` and `nodeNetworking.external.networkSubnetCidr` parameters. ```yaml {title="Example of a configured cluster-infrastructure-02-config.yml manifest file"} apiVersion: config.openshift.io/v1 kind: Infrastructure metadata: name: cluster spec: cloudConfig: key: config name: cloud-provider-config platformSpec: type: VSphere vsphere: failureDomains: - name: generated-failure-domain ... nodeNetworking: external: networkSubnetCidr: - - internal: networkSubnetCidr: - - # ... ``` **Additional resources** {._additional-resources} - [Cluster Network Operator configuration](/openshift-docs-markdown/installing/installing_vsphere/upi/installing-vsphere-network-customizations#nw-operator-cr_installing-vsphere-network-customizations) - [`.spec.platformSpec.vsphere.nodeNetworking`](/openshift-docs-markdown/rest_api/config_apis/infrastructure-config-openshift-io-v1#spec-platformspec-vsphere-nodenetworking) ## Cluster Network Operator configuration {#nw-operator-cr_installing-vsphere-network-customizations} To manage cluster networking, configure the Cluster Network Operator (CNO) `Network` custom resource (CR) named `cluster` so the cluster uses the correct IP ranges and network plugin settings for reliable pod and service connectivity. Some settings and fields are inherited at the time of install or by the `default.Network.type` plugin, OVN-Kubernetes. The CNO configuration inherits the following fields during cluster installation from the `Network` API in the `Network.config.openshift.io` API group: `clusterNetwork` : IP address pools from which pod IP addresses are allocated. `serviceNetwork` : IP address pool for services. `defaultNetwork.type` : Cluster network plugin. `OVNKubernetes` is the only supported plugin during installation. You can specify the cluster network plugin configuration for your cluster by setting the fields for the `defaultNetwork` object in the CNO object named `cluster`. ### Cluster Network Operator configuration object {#nw-operator-cr-cno-object_installing-vsphere-network-customizations} The fields for the Cluster Network Operator (CNO) are described in the following table: **Cluster Network Operator configuration object**
Field Type Description
metadata.name string The name of the CNO object. This name is always cluster.
spec.clusterNetwork array A list specifying the blocks of IP addresses from which pod IP addresses are allocated and the subnet prefix length assigned to each individual node in the cluster. If you use dual-stack networking, specify IPv4 and IPv6 address families. For example:

spec:
  clusterNetwork:
  - cidr: 10.128.0.0/19
    hostPrefix: 23
  - cidr: fd01::/48
    hostPrefix: 64


If you install a cluster on AWS with dual-stack networking, the order of addresses must match the dual-stack configuration you selected. For example, if you specified the DualStackIPv4Primary, list the IPv4 address first.
spec.serviceNetwork array A block of IP addresses for services. If you use dual-stack networking, specify IPv4 and IPv6 address families. For example:

spec:
  serviceNetwork:
  - 172.30.0.0/14
  - fd02::/112


If you install a cluster on AWS with dual-stack networking, the order of addresses must match the dual-stack configuration you selected. For example, if you specified the DualStackIPv4Primary, list the IPv4 address first.

You can customize this field only in the install-config.yaml file before you create the manifests. The value is read-only in the manifest file.
spec.defaultNetwork object Configures the network plugin for the cluster network.
spec.additionalRoutingCapabilities.providers array This setting enables a dynamic routing provider. The FRR routing capability provider is required for the route advertisement feature. The only supported value is FRR.

  • FRR: The FRR routing provider


spec:
  additionalRoutingCapabilities:
    providers:
    - FRR
> [!IMPORTANT] > For a cluster that needs to deploy objects across multiple networks, ensure that you specify the same value for the `clusterNetwork.hostPrefix` parameter for each network type that is defined in the `install-config.yaml` file. Setting a different value for each `clusterNetwork.hostPrefix` parameter can impact the OVN-Kubernetes network plugin, where the plugin cannot effectively route object traffic among different nodes. ### defaultNetwork object configuration {#nw-operator-cr-defaultnetwork_installing-vsphere-network-customizations} The values for the `defaultNetwork` object are defined in the following table: **`defaultNetwork` object**
Field Type Description
type string OVNKubernetes. The Red Hat OpenShift Networking network plugin is selected during installation. This value cannot be changed after cluster installation.
Note
OpenShift Container Platform uses the OVN-Kubernetes network plugin by default.
ovnKubernetesConfig object This object is only valid for the OVN-Kubernetes network plugin.
### Configuration for the OVN-Kubernetes network plugin {#nw-operator-configuration-parameters-for-ovn-sdn_installing-vsphere-network-customizations} The following table describes the configuration fields for the OVN-Kubernetes network plugin: **`ovnKubernetesConfig` object**
Field Type Description
mtu integer The maximum transmission unit (MTU) for the Geneve (Generic Network Virtualization Encapsulation) overlay network. This is detected automatically based on the MTU of the primary network interface. You do not normally need to override the detected MTU.

If the auto-detected value is not what you expect it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.

If your cluster requires different MTU values for different nodes, you must set this value to 100 less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of 9001, and some have an MTU of 1500, you must set this value to 1400.
genevePort integer The port to use for all Geneve packets. The default value is 6081. This value cannot be changed after cluster installation.
ipsecConfig object Specify a configuration object for customizing the IPsec configuration.
ipv4 object Specifies a configuration object for IPv4 settings.
ipv6 object Specifies a configuration object for IPv6 settings.
policyAuditConfig object Specify a configuration object for customizing network policy audit logging. If unset, the defaults audit log settings are used.
routeAdvertisements string Specifies whether to advertise cluster network routes. The default value is Disabled.
  • Enabled: Import routes to the cluster network and advertise cluster network routes as configured in RouteAdvertisements objects.
  • Disabled: Do not import routes to the cluster network or advertise cluster network routes.
gatewayConfig object Optional: Specify a configuration object for customizing how egress traffic is sent to the node gateway. Valid values are Shared and Local. The default value is Shared. In the default setting, the Open vSwitch (OVS) outputs traffic directly to the node IP interface. If you are using hardware offloading, Red Hat recommends to use the default Shared gateway mode to bypass the host routing plane. In the Local setting, it traverses the host network; consequently, it gets applied to the routing table of the host.

Note
While migrating egress traffic, you can expect some disruption to workloads and service traffic until the Cluster Network Operator (CNO) successfully rolls out the changes.
**`ovnKubernetesConfig.ipv4` object**
Field Type Description
internalTransitSwitchSubnet string If your existing network infrastructure overlaps with the 100.88.0.0/16 IPv4 subnet, you can specify a different IP address range for internal use by OVN-Kubernetes. The subnet for the distributed transit switch that enables east-west traffic. This subnet cannot overlap with any other subnets used by OVN-Kubernetes or on the host itself. It must be large enough to accommodate one IP address per node in your cluster.

The default value is 100.88.0.0/16.
internalJoinSubnet string If your existing network infrastructure overlaps with the 100.64.0.0/16 IPv4 subnet, you can specify a different IP address range for internal use by OVN-Kubernetes. You must ensure that the IP address range does not overlap with any other subnet used by your OpenShift Container Platform installation. The IP address range must be larger than the maximum number of nodes that can be added to the cluster. For example, if the clusterNetwork.cidr value is 10.128.0.0/14 and the clusterNetwork.hostPrefix value is /23, then the maximum number of nodes is 2^(23-14)=512.

The default value is 100.64.0.0/16.
**`ovnKubernetesConfig.ipv6` object**
Field Type Description
internalTransitSwitchSubnet string If your existing network infrastructure overlaps with the fd97::/64 IPv6 subnet, you can specify a different IP address range for internal use by OVN-Kubernetes. The subnet for the distributed transit switch that enables east-west traffic. This subnet cannot overlap with any other subnets used by OVN-Kubernetes or on the host itself. It must be large enough to accommodate one IP address per node in your cluster.

The default value is fd97::/64.
internalJoinSubnet string If your existing network infrastructure overlaps with the fd98::/64 IPv6 subnet, you can specify a different IP address range for internal use by OVN-Kubernetes. You must ensure that the IP address range does not overlap with any other subnet used by your OpenShift Container Platform installation. The IP address range must be larger than the maximum number of nodes that can be added to the cluster.

The default value is fd98::/64.
**`policyAuditConfig` object**
Field Type Description
rateLimit integer The maximum number of messages to generate every second per node. The default value is 20 messages per second.
maxFileSize integer The maximum size for the audit log in bytes. The default value is 50000000 or 50 MB.
maxLogFiles integer The maximum number of log files that are retained.
destination string One of the following additional audit log targets:

libc
The libc syslog() function of the journald process on the host.
udp:<host>:<port>
A syslog server. Replace <host>:<port> with the host and port of the syslog server.
unix:<file>
A UNIX Domain Socket file specified by <file>.
null
Do not send the audit logs to any additional target.
syslogFacility string The syslog facility, such as kern, as defined by RFC5424. The default value is local0.
**`gatewayConfig` object**
Field Type Description
routingViaHost boolean Set this field to true to send egress traffic from pods to the host networking stack. For highly-specialized installations and applications that rely on manually configured routes in the kernel routing table, you might want to route egress traffic to the host networking stack. By default, egress traffic is processed in OVN to exit the cluster and is not affected by specialized routes in the kernel routing table. The default value is false.

This field has an interaction with the Open vSwitch hardware offloading feature. If you set this field to true, you do not receive the performance benefits of the offloading because egress traffic is processed by the host networking stack.
ipForwarding object You can control IP forwarding for all traffic on OVN-Kubernetes managed interfaces by using the ipForwarding specification in the Network resource. Specify Restricted to only allow IP forwarding for Kubernetes related traffic. Specify Global to allow forwarding of all IP traffic. For new installations, the default is Restricted. For updates to OpenShift Container Platform 4.14 or later, the default is Global.
Note
The default value of Restricted sets the IP forwarding to drop.
ipv4 object Optional: Specify an object to configure the internal OVN-Kubernetes masquerade address for host to service traffic for IPv4 addresses.
ipv6 object Optional: Specify an object to configure the internal OVN-Kubernetes masquerade address for host to service traffic for IPv6 addresses.
**`gatewayConfig.ipv4` object**
Field Type Description
internalMasqueradeSubnet string The masquerade IPv4 addresses that are used internally to enable host to service traffic. The host is configured with these IP addresses and the shared gateway bridge interface. The default value is 169.254.169.0/29.
Important
For OpenShift Container Platform 4.17 and later versions, clusters use 169.254.0.0/17 as the default masquerade subnet. For upgraded clusters, there is no change to the default masquerade subnet.
**`gatewayConfig.ipv6` object**
Field Type Description
internalMasqueradeSubnet string The masquerade IPv6 addresses that are used internally to enable host to service traffic. The host is configured with these IP addresses and the shared gateway bridge interface. The default value is fd69::/125.
Important
For OpenShift Container Platform 4.17 and later versions, clusters use fd69::/112 as the default masquerade subnet. For upgraded clusters, there is no change to the default masquerade subnet.
**`ipsecConfig` object**
Field Type Description
mode string Specifies the behavior of the IPsec implementation. Must be one of the following values:

  • Disabled: IPsec is not enabled on cluster nodes.
  • External: IPsec is enabled for network traffic with external hosts.
  • Full: IPsec is enabled for pod traffic and network traffic with external hosts.
```yaml {title="Example OVN-Kubernetes configuration with IPsec enabled"} defaultNetwork: type: OVNKubernetes ovnKubernetesConfig: mtu: 1400 genevePort: 6081 ipsecConfig: mode: Full ``` ## Creating the Ignition config files {#installation-generate-ignition-configs_installing-vsphere-network-customizations} Because you must manually start the cluster machines, you must generate the Ignition config files that the cluster needs to make its machines. > [!IMPORTANT] > - The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for *Recovering from expired control plane certificates* for more information. > - It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. **Prerequisites** - Obtain the OpenShift Container Platform installation program and the pull secret for your cluster. **Procedure** - Obtain the Ignition config files: ```terminal $ ./openshift-install create ignition-configs --dir ``` For ``, specify the directory name to store the files that the installation program creates. > [!IMPORTANT] > If you created an `install-config.yaml` file, specify the directory that contains it. Otherwise, specify an empty directory. Some installation assets, like bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OpenShift Container Platform version. The following files are generated in the directory: ``` . ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign ``` ## Extracting the infrastructure name {#installation-extracting-infraid_installing-vsphere-network-customizations} To identify your cluster resources in VMware vSphere, extract the unique infrastructure name from the Ignition config files. The Ignition config files contain a unique cluster identifier that you can use to uniquely identify your cluster in VMware vSphere. If you plan to use the cluster identifier as the name of your virtual machine folder, you must extract it. > [!WARNING] > Do not run the `openshift-install create manifests` command again after creating any Google Cloud resources. Running the command again generates a new cluster identifier, which will cause errors in existing resources. If you need to regenerate the manifests because you modified the `install-config.yaml` file, delete any Google Cloud resources you created and re-create them with the new cluster identifier. **Prerequisites** - You obtained the OpenShift Container Platform installation program and the pull secret for your cluster. - You generated the Ignition config files for your cluster. - You installed the `jq` package. **Procedure** - To extract and view the infrastructure name from the Ignition config file metadata, run the following command: ```terminal $ jq -r .infraID /metadata.json ``` where `` is the path to the directory that you stored the installation files in. ```terminal {title="Example output"} openshift-vw9j6 ``` The output of this command is your cluster name and a random string. ## Installing RHCOS and starting the OpenShift Container Platform bootstrap process {#installation-vsphere-machines_installing-vsphere-network-customizations} To install OpenShift Container Platform on user-provisioned infrastructure on VMware vSphere, you must install Red Hat Enterprise Linux CoreOS (RHCOS) on vSphere hosts. When you install RHCOS, you must provide the Ignition config file that was generated by the OpenShift Container Platform installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the OpenShift Container Platform bootstrap process begins automatically after the RHCOS machines have rebooted. **Prerequisites** - You have obtained the Ignition config files for your cluster. - You have access to an HTTP server that you can access from your computer and that the machines that you create can access. - You have created a [vSphere cluster](https://docs.vmware.com/en/VMware-vSphere/6.0/com.vmware.vsphere.vcenterhost.doc/GUID-B1018F28-3F14-4DFE-9B4B-F48BBDB72C10.html). **Procedure** 1. Upload the bootstrap Ignition config file, which is named `/bootstrap.ign`, that the installation program created to your HTTP server. Note the URL of this file. 2. Save the following secondary Ignition config file for your bootstrap node to your computer as `/merge-bootstrap.ign`: ```text { "ignition": { "config": { "merge": [ { "source": "", "verification": {} } ] }, "timeouts": {}, "version": "3.2.0" }, "networkd": {}, "passwd": {}, "storage": {}, "systemd": {} } ``` The `` placeholder specifies the URL of the bootstrap Ignition config file that you hosted. When you create the virtual machine (VM) for the bootstrap machine, you use this Ignition config file. 3. Locate the following Ignition config files that the installation program created: - `/master.ign` - `/worker.ign` - `/merge-bootstrap.ign` 4. Convert the Ignition config files to Base64 encoding. Later in this procedure, you must add these files to the extra configuration parameter `guestinfo.ignition.config.data` in your VM. For example, if you use a Linux operating system, you can use the `base64` command to encode the files. ```terminal $ base64 -w0 /master.ign > /master.64 ``` ```terminal $ base64 -w0 /worker.ign > /worker.64 ``` ```terminal $ base64 -w0 /merge-bootstrap.ign > /merge-bootstrap.64 ``` > [!IMPORTANT] > If you plan to add more compute machines to your cluster after you finish installation, do not delete these files. 5. Obtain the RHCOS OVA image. Images are available from the [RHCOS image mirror](https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/4.18/) page. > [!IMPORTANT] > The RHCOS images might not change with every release of OpenShift Container Platform. You must download an image with the highest version that is less than or equal to the OpenShift Container Platform version that you install. Use the image version that matches your OpenShift Container Platform version if it is available. The filename contains the OpenShift Container Platform version number in the format `rhcos-vmware..ova`. 6. In the vSphere Client, create a folder in your data center to store your VMs. 1. Click the **VMs and Templates** view. 2. Right-click the name of your data center. 3. Click **New Folder** → **New VM and Template Folder**. 4. In the window that is displayed, enter the folder name. If you did not specify an existing folder in the `install-config.yaml` file, then create a folder with the same name as the infrastructure ID. You use this folder name so vCenter dynamically provisions storage in the appropriate location for its Workspace configuration. 7. In the vSphere Client, create a template for the OVA image and then clone the template as needed. > [!NOTE] > In the following steps, you create a template and then clone the template for all of your cluster machines. You then provide the location for the Ignition config file for that cloned machine type when you provision the VMs. 1. From the **Hosts and Clusters** tab, right-click your cluster name and select **Deploy OVF Template**. 2. On the **Select an OVF** tab, specify the name of the RHCOS OVA file that you downloaded. 3. On the **Select a name and folder** tab, set a **Virtual machine name** for your template, such as `Template-RHCOS`. Click the name of your vSphere cluster and select the folder you created in the previous step. 4. On the **Select a compute resource** tab, click the name of your vSphere cluster. 5. On the **Select storage** tab, configure the storage options for your VM. - Select **Thin Provision** or **Thick Provision**, based on your storage preferences. - Select the datastore that you specified in your `install-config.yaml` file. - If you want to encrypt your virtual machines, select **Encrypt this virtual machine**. See the section titled "Requirements for encrypting virtual machines" for more information. 6. On the **Select network** tab, specify the network that you configured for the cluster, if available. 7. When creating the OVF template, do not specify values on the **Customize template** tab or configure the template any further. > [!IMPORTANT] > Do not start the original VM template. The VM template must remain off and must be cloned for new RHCOS machines. Starting the VM template configures the VM template as a VM on the platform, which prevents it from being used as a template that compute machine sets can apply configurations to. 8. Optional: Update the configured virtual hardware version in the VM template, if necessary. Follow [Upgrading a virtual machine to the latest hardware version](https://kb.vmware.com/s/article/1010675) in the VMware documentation for more information. > [!IMPORTANT] > It is recommended that you update the hardware version of the VM template to version 15 before creating VMs from it, if necessary. Using hardware version 13 for your cluster nodes running on vSphere is now deprecated. If your imported template defaults to hardware version 13, you must ensure that your ESXi host is on 6.7U3 or later before upgrading the VM template to hardware version 15. If your vSphere version is less than 6.7U3, you can skip this upgrade step; however, a future version of OpenShift Container Platform is scheduled to remove support for hardware version 13 and vSphere versions less than 6.7U3. 9. After the template deploys, deploy a VM for a machine in the cluster. 1. Right-click the template name and click **Clone** → **Clone to Virtual Machine**. 2. On the **Select a name and folder** tab, specify a name for the VM. You might include the machine type in the name, such as `control-plane-0` or `compute-1`. > [!NOTE] > Ensure that all virtual machine names across a vSphere installation are unique. 3. On the **Select a name and folder** tab, select the name of the folder that you created for the cluster. 4. On the **Select a compute resource** tab, select the name of a host in your data center. 5. On the **Select clone options** tab, select **Customize this virtual machine’s hardware**. 6. On the **Customize hardware** tab, click **Advanced Parameters**. > [!IMPORTANT] > The following configuration suggestions are for example purposes only. As a cluster administrator, you must configure resources according to the resource demands placed on your cluster. To best manage cluster resources, consider creating a resource pool from the cluster’s root resource pool. - Optional: Override default DHCP networking in vSphere. To enable static IP networking: - Set your static IP configuration: ```terminal {title="Example command"} $ export IPCFG="ip=::::::none nameserver=srv1 [nameserver=srv2 [nameserver=srv3 [...]]]" ``` ```terminal {title="Example command"} $ export IPCFG="ip=192.168.100.101::192.168.100.254:255.255.255.0:::none nameserver=8.8.8.8" ``` - Set the `guestinfo.afterburn.initrd.network-kargs` property before you boot a VM from an OVA in vSphere: ```terminal {title="Example command"} $ govc vm.change -vm "" -e "guestinfo.afterburn.initrd.network-kargs=${IPCFG}" ``` - Add the following configuration parameter names and values by specifying data in the **Attribute** and **Values** fields. Ensure that you select the **Add** button for each parameter that you create. - `guestinfo.ignition.config.data`: Locate the base-64 encoded files that you created previously in this procedure, and paste the contents of the base64-encoded Ignition config file for this machine type. - `guestinfo.ignition.config.data.encoding`: Specify `base64`. - `disk.EnableUUID`: Specify `TRUE`. - `stealclock.enable`: If this parameter was not defined, add it and specify `TRUE`. - Create a child resource pool from the cluster’s root resource pool. Perform resource allocation in this child resource pool. 7. In the **Virtual Hardware** panel of the **Customize hardware** tab, modify the specified values as required. Ensure that the amount of RAM, CPU, and disk storage meets the minimum requirements for the machine type. 8. Complete the remaining configuration steps. On clicking the **Finish** button, you have completed the cloning operation. 9. From the **Virtual Machines** tab, right-click on your VM and then select **Power** → **Power On**. 10. Check the console output to verify that Ignition ran. ```terminal {title="Example command"} Ignition: ran on 2022/03/14 14:48:33 UTC (this boot) Ignition: user-provided config was applied ``` **Next steps** - Create the rest of the machines for your cluster by following the preceding steps for each machine. > [!IMPORTANT] > You must create the bootstrap and control plane machines at this time. Because some pods are deployed on compute machines by default, also create at least two compute machines before you install the cluster. ## Adding more compute machines to a cluster in vSphere {#machine-vsphere-machines_installing-vsphere-network-customizations} To scale a user-provisioned OpenShift Container Platform cluster on VMware vSphere, you can add more compute machines by cloning the vSphere template into a virtual machine (VM). **Prerequisites** - Obtain the base64-encoded Ignition file for your compute machines. - You have access to the vSphere template that you created for your cluster. **Procedure** 1. Right-click the template’s name and click **Clone** → **Clone to Virtual Machine**. 2. On the **Select a name and folder** tab, specify a name for the VM. You might include the machine type in the name, such as `compute-1`. > [!NOTE] > Ensure that all virtual machine names across a vSphere installation are unique. 3. On the **Select a name and folder** tab, select the name of the folder that you created for the cluster. 4. On the **Select a compute resource** tab, select the name of a host in your data center. 5. On the **Select storage** tab, select storage for your configuration and disk files. 6. On the **Select clone options** tab, select **Customize this virtual machine’s hardware**. 7. On the **Customize hardware** tab, click **Advanced Parameters**. - Add the following configuration parameter names and values by specifying data in the **Attribute** and **Values** fields. Ensure that you select the **Add** button for each parameter that you create. - `guestinfo.ignition.config.data`: Paste the contents of the base64-encoded compute Ignition config file for this machine type. - `guestinfo.ignition.config.data.encoding`: Specify `base64`. - `disk.EnableUUID`: Specify `TRUE`. 8. In the **Virtual Hardware** panel of the **Customize hardware** tab, modify the specified values as required. Ensure that the amount of RAM, CPU, and disk storage meets the minimum requirements for the machine type. If many networks exist, select **Add New Device** > **Network Adapter**, and then enter your network information in the fields provided by the **New Network** menu item. 9. Complete the remaining configuration steps. On clicking the **Finish** button, you have completed the cloning operation. 10. From the **Virtual Machines** tab, right-click on your VM and then select **Power** → **Power On**. **Next steps** - Continue to create more compute machines for your cluster. ## Disk partitioning {#installation-disk-partitioning_installing-vsphere-network-customizations} In most cases, data partitions are originally created by installing RHCOS, rather than by installing another operating system. In such cases, the OpenShift Container Platform installer should be allowed to configure your disk partitions. However, there are two cases where you might want to intervene to override the default partitioning when installing an OpenShift Container Platform node: - Create separate partitions: For greenfield installations on an empty disk, you might want to add separate storage to a partition. This is officially supported for making `/var` or a subdirectory of `/var`, such as `/var/lib/etcd`, a separate partition, but not both. > [!IMPORTANT] > For disk sizes larger than 100GB, and especially disk sizes larger than 1TB, create a separate `/var` partition. See "Creating a separate `/var` partition" and this [Red Hat Knowledgebase article](https://access.redhat.com/solutions/5587281) for more information. > [!IMPORTANT] > Kubernetes supports only two file system partitions. If you add more than one partition to the original configuration, Kubernetes cannot monitor all of them. - Retain existing partitions: For a brownfield installation where you are reinstalling OpenShift Container Platform on an existing node and want to retain data partitions installed from your previous operating system, there are both boot arguments and options to `coreos-installer` that allow you to retain existing data partitions. ## Creating a separate `/var` partition {#_creating_a_separate_var_partition} In general, disk partitioning for OpenShift Container Platform should be left to the installer. However, there are cases where you might want to create separate partitions in a part of the filesystem that you expect to grow. OpenShift Container Platform supports the addition of a single partition to attach storage to either the `/var` partition or a subdirectory of `/var`. For example: - `/var/lib/containers`: Holds container-related content that can grow as more images and containers are added to a system. - `/var/lib/etcd`: Holds data that you might want to keep separate for purposes such as performance optimization of etcd storage. - `/var`: Holds data that you might want to keep separate for purposes such as auditing. > [!IMPORTANT] > For disk sizes larger than 100GB, and especially larger than 1TB, create a separate `/var` partition. Storing the contents of a `/var` directory separately makes it easier to grow storage for those areas as needed and reinstall OpenShift Container Platform at a later date and keep that data intact. With this method, you will not have to pull all your containers again, nor will you have to copy massive log files when you update systems. Because `/var` must be in place before a fresh installation of Red Hat Enterprise Linux CoreOS (RHCOS), the following procedure sets up the separate `/var` partition by creating a machine config manifest that is inserted during the `openshift-install` preparation phases of an OpenShift Container Platform installation. **Procedure** 1. Create a directory to hold the OpenShift Container Platform installation files: ```terminal $ mkdir $HOME/clusterconfig ``` 2. Run `openshift-install` to create a set of files in the `manifest` and `openshift` subdirectories. Answer the system questions as you are prompted: ```terminal $ openshift-install create manifests --dir $HOME/clusterconfig ? SSH Public Key ... $ ls $HOME/clusterconfig/openshift/ 99_kubeadmin-password-secret.yaml 99_openshift-cluster-api_master-machines-0.yaml 99_openshift-cluster-api_master-machines-1.yaml 99_openshift-cluster-api_master-machines-2.yaml ... ``` 3. Create a Butane config that configures the additional partition. For example, name the file `$HOME/clusterconfig/98-var-partition.bu`, change the disk device name to the name of the storage device on the `worker` systems, and set the storage size as appropriate. This example places the `/var` directory on a separate partition: ```yaml variant: openshift version: 4.22.0 metadata: labels: machineconfiguration.openshift.io/role: worker name: 98-var-partition storage: disks: - device: /dev/disk/by-id/ partitions: - label: var start_mib: size_mib: number: 5 filesystems: - device: /dev/disk/by-partlabel/var path: /var format: xfs mount_options: [defaults, prjquota] with_mount_unit: true ``` where: `` : Specifies the storage device name of the disk that you want to partition. `` : When adding a data partition to the boot disk, a minimum value of 25000 mebibytes is recommended. The root file system is automatically resized to fill all available space up to the specified offset. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of RHCOS might overwrite the beginning of the data partition. `` : Specifies the size of the data partition in mebibytes. `prjquota` : This mount option must be enabled for filesystems used for container storage. > [!NOTE] > When creating a separate `/var` partition, you cannot use different instance types for worker nodes, if the different instance types do not have the same device name. 4. Create a manifest from the Butane config and save it to the `clusterconfig/openshift` directory. For example, run the following command: ```terminal $ butane $HOME/clusterconfig/98-var-partition.bu -o $HOME/clusterconfig/openshift/98-var-partition.yaml ``` 5. Run `openshift-install` again to create Ignition configs from a set of files in the `manifest` and `openshift` subdirectories: ```terminal $ openshift-install create ignition-configs --dir $HOME/clusterconfig $ ls $HOME/clusterconfig/ auth bootstrap.ign master.ign metadata.json worker.ign ``` Now you can use the Ignition config files as input to the vSphere installation procedures to install Red Hat Enterprise Linux CoreOS (RHCOS) systems. ## Waiting for the bootstrap process to complete {#installation-installing-bare-metal_installing-vsphere-network-customizations} The OpenShift Container Platform bootstrap process begins after the cluster nodes first boot into the persistent RHCOS environment that has been installed to disk. The configuration information provided through the Ignition config files is used to initialize the bootstrap process and install OpenShift Container Platform on the machines. You must wait for the bootstrap process to complete. **Prerequisites** - You have created the Ignition config files for your cluster. - You have configured suitable network, DNS, and load balancing infrastructure. - You have obtained the installation program and generated the Ignition config files for your cluster. - You installed RHCOS on your cluster machines and provided the Ignition config files that the OpenShift Container Platform installation program generated. - Your machines have direct internet access or have an HTTP or HTTPS proxy available. **Procedure** 1. Monitor the bootstrap process: ```terminal $ ./openshift-install --dir wait-for bootstrap-complete \ --log-level=info ``` where: `` : Specifies the path to the directory that stores the installation files. `--log-level=info` : Specifies `warn`, `debug`, or `error` instead of `info` to view different installation details. ```terminal {title="Example output"} INFO Waiting up to 20m0s for the Kubernetes API at https://api.test.example.com:6443... INFO API v1.35.4 up INFO Waiting up to 1h0m0s for bootstrapping to complete... INFO It is now safe to remove the bootstrap resources ``` The bootstrapping completion wait time varies per platform. The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines. 2. After the bootstrap process is complete, remove the bootstrap machine from the load balancer. > [!IMPORTANT] > You must remove the bootstrap machine from the load balancer at this point. You can also remove or reformat the bootstrap machine itself. ## Logging in to the cluster by using the CLI {#cli-logging-in-kubeadmin_installing-vsphere-network-customizations} To log in to your cluster as the default system user, export the `kubeconfig` file. This configuration enables the CLI to authenticate and connect to the specific API server created during OpenShift Container Platform installation. The `kubeconfig` file is specific to a cluster and OpenShift Container Platform generates it during installation. **Prerequisites** - You deployed an OpenShift Container Platform cluster. - You installed the OpenShift CLI (`oc`). **Procedure** 1. Export the `kubeadmin` credentials by running the following command: ```terminal $ export KUBECONFIG=/auth/kubeconfig ``` where: `` : Specifies the path to the directory that stores the installation files. 2. Verify you can run `oc` commands successfully using the exported configuration by running the following command: ```terminal $ oc whoami ``` ```terminal {title="Example output"} system:admin ``` **Next steps** - "Customize your cluster" - "Remote health reporting" ## Approving the certificate signing requests for your machines {#installation-approve-csrs_installing-vsphere-network-customizations} To allow newly added machines to join your OpenShift Container Platform cluster, confirm that the cluster approves pending certificate signing requests (CSRs), or approve them yourself. Approve client requests first, then server requests. **Prerequisites** - You added machines to your cluster. **Procedure** 1. Confirm that the cluster recognizes the machines: ```terminal $ oc get nodes ``` ```terminal {title="Example output"} NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.35.4 master-1 Ready master 63m v1.35.4 master-2 Ready master 64m v1.35.4 ``` The output lists all of the machines that you created. > [!NOTE] > The preceding output might not include the compute nodes until you approve some CSRs. 2. Review the pending CSRs and ensure that you see the client requests with the `Pending` or `Approved` status for each machine that you added to the cluster: ```terminal $ oc get csr ``` ```terminal {title="Example output"} NAME AGE REQUESTOR CONDITION csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending ... ``` In this example, two machines are joining the cluster. You might see more approved CSRs in the list. 3. If the CSRs were not approved, after all of the pending CSRs for the machines you added are in `Pending` status, approve the CSRs for your cluster machines: > [!NOTE] > You must approve your CSRs within an hour of adding the machines to the cluster. If you do not approve them within an hour, the certificates rotate, and more than two certificates are present for each node. You must approve all of these certificates. After you approve the client CSR, the kubelet creates a secondary CSR for the serving certificate, which requires manual approval. The `machine-approver` then automatically approves later serving certificate renewal requests if the kubelet requests a new certificate with the same parameters. > [!NOTE] > For clusters running on platforms that are not machine API enabled, such as bare metal and other user-provisioned infrastructure, you must implement a method of automatically approving the kubelet serving certificate requests (CSRs). If you do not approve a request, the `oc exec`, `oc rsh`, and `oc logs` commands cannot succeed, because the API server requires a serving certificate when it connects to the kubelet. Any operation that contacts the kubelet endpoint requires this certificate approval to be in place. The method must watch for new CSRs, confirm that the `node-bootstrapper` service account in the `system:node` or `system:admin` groups submitted the CSR, and confirm the identity of the node. - To approve them individually, run the following command for each valid CSR: ```terminal $ oc adm certificate approve ``` where: `` : Specifies the name of a CSR from the list of current CSRs. - To approve all pending CSRs, run the following command: ```terminal $ oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve ``` > [!NOTE] > Some Operators might not become available until you approve some CSRs. Each node submits two CSRs, so you might need to run the command to approve CSRs many times. 4. After you approve your client requests, review the server requests for each machine that you added to the cluster: ```terminal $ oc get csr ``` ```terminal {title="Example output"} NAME AGE REQUESTOR CONDITION csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending ... ``` 5. If the remaining CSRs are not approved, and are in the `Pending` status, approve the CSRs for your cluster machines: - To approve them individually, run the following command for each valid CSR: ```terminal $ oc adm certificate approve ``` where: `` : Specifies the name of a CSR from the list of current CSRs. - To approve all pending CSRs, run the following command: ```terminal $ oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs oc adm certificate approve ``` 6. After you approve all client and server CSRs, the machines have the `Ready` status. Verify this by running the following command: ```terminal $ oc get nodes ``` ```terminal {title="Example output"} NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.35.4 master-1 Ready master 73m v1.35.4 master-2 Ready master 74m v1.35.4 worker-0 Ready worker 11m v1.35.4 worker-1 Ready worker 11m v1.35.4 ``` > [!NOTE] > You might need to wait a few minutes after approval of the server CSRs for the machines to change to the `Ready` status. ### Initial Operator configuration {#installation-operators-config_installing-vsphere-network-customizations} After the control plane initializes, you must immediately configure some Operators so that they all become available. **Prerequisites** - Your control plane has initialized. **Procedure** 1. Watch the cluster components come online: ```terminal $ watch -n5 oc get clusteroperators ``` ```terminal {title="Example output"} NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.22.0 True False False 19m baremetal 4.22.0 True False False 37m cloud-credential 4.22.0 True False False 40m cluster-autoscaler 4.22.0 True False False 37m config-operator 4.22.0 True False False 38m console 4.22.0 True False False 26m csi-snapshot-controller 4.22.0 True False False 37m dns 4.22.0 True False False 37m etcd 4.22.0 True False False 36m image-registry 4.22.0 True False False 31m ingress 4.22.0 True False False 30m insights 4.22.0 True False False 31m kube-apiserver 4.22.0 True False False 26m kube-controller-manager 4.22.0 True False False 36m kube-scheduler 4.22.0 True False False 36m kube-storage-version-migrator 4.22.0 True False False 37m machine-api 4.22.0 True False False 29m machine-approver 4.22.0 True False False 37m machine-config 4.22.0 True False False 36m marketplace 4.22.0 True False False 37m monitoring 4.22.0 True False False 29m network 4.22.0 True False False 38m node-tuning 4.22.0 True False False 37m openshift-apiserver 4.22.0 True False False 32m openshift-controller-manager 4.22.0 True False False 30m openshift-samples 4.22.0 True False False 32m operator-lifecycle-manager 4.22.0 True False False 37m operator-lifecycle-manager-catalog 4.22.0 True False False 37m operator-lifecycle-manager-packageserver 4.22.0 True False False 32m service-ca 4.22.0 True False False 38m storage 4.22.0 True False False 37m ``` 2. Configure the Operators that are not available. ### Image registry removed during installation {#registry-removed_installing-vsphere-network-customizations} On platforms that do not provide shareable object storage, the OpenShift Image Registry Operator bootstraps itself as `Removed`. This allows `openshift-installer` to complete installations on these platform types. After installation, you must edit the Image Registry Operator configuration to switch the `managementState` from `Removed` to `Managed`. When this has completed, you must configure storage. ### Image registry storage configuration {#installation-registry-storage-config_installing-vsphere-network-customizations} The Image Registry Operator is not initially available for platforms that do not provide default storage. After installation, you must configure your registry to use storage so that the Registry Operator is made available. Configure a persistent volume, which is required for production clusters. Where applicable, you can configure an empty directory as the storage location for non-production clusters. You can also allow the image registry to use block storage types by using the `Recreate` rollout strategy during upgrades. #### Configuring block registry storage for VMware vSphere {#installation-registry-storage-block-recreate-rollout_installing-vsphere-network-customizations} To allow the image registry to use block storage types such as vSphere Virtual Machine Disk (VMDK) during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy. > [!IMPORTANT] > Block storage volumes are supported but not recommended for use with image registry on production clusters. An installation where the registry is configured on block storage is not highly available because the registry cannot have more than one replica. **Procedure** 1. Enter the following command to set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy, and runs with only `1` replica: ```terminal $ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}' ``` 2. Provision the persistent volume (PV) for the block storage device, and create a persistent volume claim (PVC) for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode. 1. Create a `pvc.yaml` file with the following contents to define a VMware vSphere `PersistentVolumeClaim` object: ```yaml kind: PersistentVolumeClaim apiVersion: v1 metadata: name: image-registry-storage namespace: openshift-image-registry spec: accessModes: - ReadWriteOnce resources: requests: storage: 100Gi ``` where: `metadata.name` : Specifies a unique name that represents the `PersistentVolumeClaim` object. `metadata.namespace` : Specifies the `namespace` for the `PersistentVolumeClaim` object, which is `openshift-image-registry`. `spec.accessModes` : Specifies the access mode of the persistent volume claim. With `ReadWriteOnce`, the volume can be mounted with read and write permissions by a single node. `spec.resources.requests.storage` : Specifies the size of the persistent volume claim. 1. Enter the following command to create the `PersistentVolumeClaim` object from the file: ```terminal $ oc create -f pvc.yaml -n openshift-image-registry ``` 1. Enter the following command to edit the registry configuration so that it references the correct PVC: ```terminal $ oc edit config.imageregistry.operator.openshift.io -o yaml ``` ```yaml {title="Example output"} storage: pvc: claim: ``` By creating a custom PVC, you can leave the `claim` field blank for the default automatic creation of an `image-registry-storage` PVC. **Additional resources** {._additional-resources} - [Configuring the registry for vSphere](/openshift-docs-markdown/registry/configuring_registry_storage/configuring-registry-storage-vsphere#registry-configuring-storage-vsphere_configuring-registry-storage-vsphere) ## Completing installation on user-provisioned infrastructure {#installation-complete-user-infra_installing-vsphere-network-customizations} To finalize the installation on user-provisioned infrastructure, complete the cluster deployment after configuring the Operators. This ensures the cluster is fully operational on the infrastructure that you provide. **Prerequisites** - Your control plane has initialized. - You have completed the initial Operator configuration. **Procedure** 1. Confirm that all the cluster components are online with the following command: ```terminal $ watch -n5 oc get clusteroperators ``` ```terminal {title="Example output"} NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.22.0 True False False 19m baremetal 4.22.0 True False False 37m cloud-credential 4.22.0 True False False 40m cluster-autoscaler 4.22.0 True False False 37m config-operator 4.22.0 True False False 38m console 4.22.0 True False False 26m csi-snapshot-controller 4.22.0 True False False 37m dns 4.22.0 True False False 37m etcd 4.22.0 True False False 36m image-registry 4.22.0 True False False 31m ingress 4.22.0 True False False 30m insights 4.22.0 True False False 31m kube-apiserver 4.22.0 True False False 26m kube-controller-manager 4.22.0 True False False 36m kube-scheduler 4.22.0 True False False 36m kube-storage-version-migrator 4.22.0 True False False 37m machine-api 4.22.0 True False False 29m machine-approver 4.22.0 True False False 37m machine-config 4.22.0 True False False 36m marketplace 4.22.0 True False False 37muser monitoring 4.22.0 True False False 29m network 4.22.0 True False False 38m node-tuning 4.22.0 True False False 37m openshift-apiserver 4.22.0 True False False 32muser openshift-controller-manager 4.22.0 True False False 30m openshift-samples 4.22.0 True False False 32m operator-lifecycle-manager 4.22.0 True False False 37m operator-lifecycle-manager-catalog 4.22.0 True False False 37m operator-lifecycle-manager-packageserver 4.22.0 True False False 32m service-ca 4.22.0 True False False 38m storage 4.22.0 True False False 37m ``` Alternatively, the following command notifies you when all of the clusters are available. The command also retrieves and displays credentials: ```terminal $ ./openshift-install --dir wait-for install-complete ``` where: `` : Specifies the path to the directory that you stored the installation files in. ```terminal {title="Example output"} INFO Waiting up to 30m0s for the cluster to initialize... ``` The command succeeds when the Cluster Version Operator finishes deploying the OpenShift Container Platform cluster from Kubernetes API server. > [!IMPORTANT] > - The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for *Recovering from expired control plane certificates* for more information. > - It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation. 2. Confirm that the Kubernetes API server is communicating with the pods. 1. To view a list of all pods, use the following command: ```terminal $ oc get pods --all-namespaces ``` ```terminal {title="Example output"} NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m ``` 2. View the logs for a pod that is listed in the output of the previous command by using the following command: ```terminal $ oc logs -n ``` where: `` : Specifies the pod name and namespace, as shown in the output of an earlier command. If the pod logs display, the Kubernetes API server can communicate with the cluster machines. 3. For an installation with Fibre Channel Protocol (FCP), additional steps are required to enable multipathing. Do not enable multipathing during installation. See "Enabling multipathing with kernel arguments on RHCOS" in the *Postinstallation machine configuration tasks* documentation for more information. **Additional resources** {._additional-resources} - [Adding compute machines to vSphere](/openshift-docs-markdown/machine_management/user_infra/adding-vsphere-compute-user-infra#adding-vsphere-compute-user-infra) ## Configuring vSphere DRS anti-affinity rules for control plane nodes {#anti-affinity-vsphere_installing-vsphere-network-customizations} vSphere Distributed Resource Scheduler (DRS) anti-affinity rules can be configured to support higher availability of OpenShift Container Platform Control Plane nodes. Anti-affinity rules ensure that the vSphere Virtual Machines for the OpenShift Container Platform Control Plane nodes are not scheduled to the same vSphere Host. > [!IMPORTANT] > - The following information applies to compute DRS only and does not apply to storage DRS. > - The `govc` command is an open-source command available from VMware; it is not available from Red Hat. The `govc` command is not supported by the Red Hat support. > - Instructions for downloading and installing `govc` are found on the VMware documentation website. **Procedure** 1. Create an anti-affinity rule by running the following command: ```terminal $ govc cluster.rule.create \ -name openshift4-control-plane-group \ -dc MyDatacenter -cluster MyCluster \ -enable \ -anti-affinity master-0 master-1 master-2 ``` After creating the rule, your control plane nodes are automatically migrated by vSphere so they are not running on the same hosts. This might take some time while vSphere reconciles the new rule. > [!NOTE] > The migration occurs automatically and might cause brief OpenShift API outage or latency until the migration finishes. 2. If a control plane VM name changes or migrates to a new vSphere Cluster, update the DRS anti-affinity rule manually. Remove the existing rule by running the following command: ```terminal $ govc cluster.rule.remove \ -name openshift4-control-plane-group \ -dc MyDatacenter -cluster MyCluster ``` ```terminal {title="Example Output"} [13-10-22 09:33:24] Reconfigure /MyDatacenter/host/MyCluster...OK ``` 3. Create the rule again with updated names by running the following command: ```terminal $ govc cluster.rule.create \ -name openshift4-control-plane-group \ -dc MyDatacenter -cluster MyOtherCluster \ -enable \ -anti-affinity master-0 master-1 master-2 ``` ## Telemetry access for OpenShift Container Platform {#cluster-telemetry_installing-vsphere-network-customizations} To provide metrics about cluster health and the success of updates, the Telemetry service requires internet access. When connected, this service runs automatically by default and registers your cluster to [OpenShift Cluster Manager](https://console.redhat.com/openshift). After you confirm that your [OpenShift Cluster Manager](https://console.redhat.com/openshift) inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager,use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. For more information about subscription watch, see "Data Gathered and Used by Red Hat’s subscription services" in the *Additional resources* section. **Additional resources** {._additional-resources} - [Preparing to install a cluster using user-provisioned infrastructure](/openshift-docs-markdown/installing/installing_vsphere/upi/upi-vsphere-preparing-to-install#upi-vsphere-preparing-to-install) - [OpenShift Container Platform installation and update processes](/openshift-docs-markdown/architecture/architecture-installation#architecture-installation) - [Selecting a cluster installation method and preparing it for users](/openshift-docs-markdown/installing/overview/installing-preparing#installing-preparing) - [Configuring your firewall to allow required sites](/openshift-docs-markdown/installing/install_config/configuring-firewall#configuring-firewall-module_configuring-firewall) - [About remote health monitoring](/openshift-docs-markdown/support/remote_health_monitoring/about-remote-health-monitoring#about-remote-health-monitoring) - [Customize your cluster](/openshift-docs-markdown/post_installation_configuration/cluster-tasks#available_cluster_customizations) - [Remote health reporting](/openshift-docs-markdown/support/remote_health_monitoring/remote-health-reporting#remote-health-reporting) - [Set up your registry and configure registry storage](/openshift-docs-markdown/registry/configuring_registry_storage/configuring-registry-storage-vsphere#configuring-registry-storage-vsphere) - [View the events from the vSphere Problem Detector Operator to determine if the cluster has permission or storage configuration issues](/openshift-docs-markdown/installing/installing_vsphere/using-vsphere-problem-detector-operator#vsphere-problem-detector-viewing-events_vsphere-problem-detector) - [Creating an encrypted storage class for encrypted virtual machines](/openshift-docs-markdown/storage/container_storage_interface/persistent-storage-csi-vsphere#vsphere-pv-encryption)