--- title: Installing a cluster on Nutanix in a disconnected environment --- # Installing a cluster on Nutanix in a disconnected environment {#installing-restricted-networks-nutanix-installer-provisioned} In OpenShift Container Platform 4.22, you can install a cluster on Nutanix infrastructure in a restricted network by creating an internal mirror of the installation release content. ## Prerequisites {#_prerequisites} - You have reviewed details about the OpenShift Container Platform installation and update processes. - The installation program requires access to port 9440 on Prism Central and Prism Element. You verified that port 9440 is accessible. - If you use a firewall, you have met these prerequisites: - You confirmed that port 9440 is accessible. Control plane nodes must be able to reach Prism Central and Prism Element on port 9440 for the installation to succeed. - You configured the firewall to grant access to the sites that OpenShift Container Platform requires. This includes the use of Telemetry. - If your Nutanix environment is using the default self-signed SSL/TLS certificate, replace it with a certificate that is signed by a CA. The installation program requires a valid CA-signed certificate to access to the Prism Central API. For more information about replacing the self-signed certificate, see the Nutanix AOS Security Guide. If your Nutanix environment uses an internal CA to issue certificates, you must configure a cluster-wide proxy as part of the installation process. For more information, see "Configuring a custom PKI". > [!IMPORTANT] > Use 2048-bit certificates. The installation fails if you use 4096-bit certificates with Prism Central 2022.x. - You have a container image registry, such as Red Hat Quay. If you do not already have a registry, you can create a mirror registry using the *mirror registry for Red Hat OpenShift*. - You have used the oc-mirror OpenShift CLI (oc) plugin to mirror all of the required OpenShift Container Platform content and other images, including the Nutanix CSI Operator, to your mirror registry. > [!IMPORTANT] > Because the installation media is on the mirror host, you can use that computer to complete all installation steps. ## About installations in restricted networks {#installation-about-restricted-networks_installing-restricted-networks-nutanix-installer-provisioned} You can install OpenShift Container Platform 4.22 in a restricted network without an active internet connection to obtain software components. Restricted network installations can use installer-provisioned or user-provisioned infrastructure, depending on the cloud platform to which you are installing the cluster. If you choose to perform a restricted network installation on a cloud platform, you still require access to its cloud APIs. Some cloud functions, such as Amazon Web Service’s Route 53 DNS and IAM services, require internet access. Depending on your network, you might require less internet access for an installation on bare-metal hardware, Nutanix, or on VMware vSphere. To complete a restricted network installation, you must create a registry that mirrors the contents of the OpenShift image registry and contains the installation media. You can create this registry on a mirror host, which can access both the internet and your closed network, or by using other methods that meet your restrictions. ### Additional limits {#installation-restricted-network-limits_installing-restricted-networks-nutanix-installer-provisioned} Clusters in restricted networks have the following additional limitations and restrictions: - The `ClusterVersion` status includes an `Unable to retrieve available updates` error. - By default, you cannot use the contents of the Developer Catalog because you cannot access the required image stream tags. ## Generating a key pair for cluster node SSH access {#ssh-agent-using_installing-restricted-networks-nutanix-installer-provisioned} During an OpenShift Container Platform installation, you can provide an SSH public key to the installation program. The key is passed to the Red Hat Enterprise Linux CoreOS (RHCOS) nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the `~/.ssh/authorized_keys` list for the `core` user on each node, which enables password-less authentication. The key is added to the `~/.ssh/authorized_keys` list for the `core` user on each node, which enables password-less authentication. After the key is passed to the nodes, you can use the key pair to SSH in to the RHCOS nodes as the user `core`. To access the nodes through SSH, the private key identity must be managed by SSH for your local user. If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The `./openshift-install gather` command also requires the SSH public key to be in place on the cluster nodes. > [!IMPORTANT] > Do not skip this procedure in production environments, where disaster recovery and debugging is required. > [!NOTE] > You must use a local key, not one that you configured with platform-specific approaches. **Procedure** 1. If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command: ```terminal $ ssh-keygen -t ed25519 -N '' -f / ``` Specifies the path and file name, such as `~/.ssh/id_ed25519`, of the new SSH key. If you have an existing key pair, ensure your public key is in the your `~/.ssh` directory. > [!NOTE] > If you plan to install an OpenShift Container Platform cluster that uses the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the `x86_64`, `ppc64le`, and `s390x` architectures, do not create a key that uses the `ed25519` algorithm. Instead, create a key that uses the `rsa` or `ecdsa` algorithm. 2. View the public SSH key: ```terminal $ cat /.pub ``` For example, run the following to view the `~/.ssh/id_ed25519.pub` public key: ```terminal $ cat ~/.ssh/id_ed25519.pub ``` 3. Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the `./openshift-install gather` command. > [!NOTE] > On some distributions, default SSH private key identities such as `~/.ssh/id_rsa` and `~/.ssh/id_dsa` are managed automatically. 1. If the `ssh-agent` process is not already running for your local user, start it as a background task: ```terminal $ eval "$(ssh-agent -s)" ``` ```terminal {title="Example output"} Agent pid 31874 ``` > [!NOTE] > If your cluster is in FIPS mode, only use FIPS-compliant algorithms to generate the SSH key. The key must be either RSA or ECDSA. 4. Add your SSH private key to the `ssh-agent`: ```terminal $ ssh-add / ``` Specify the path and file name for your SSH private key, such as `~/.ssh/id_ed25519`. ```terminal {title="Example output"} Identity added: /home/// () ``` **Next steps** - When you install OpenShift Container Platform, provide the SSH public key to the installation program. ## Adding Nutanix root CA certificates to your system trust {#installation-adding-nutanix-root-certificates_installing-restricted-networks-nutanix-installer-provisioned} Because the installation program requires access to the Prism Central API, you must add your Nutanix trusted root CA certificates to your system trust before you install an OpenShift Container Platform cluster. **Procedure** 1. From the Prism Central web console, download the Nutanix root CA certificates. 2. Extract the compressed file that contains the Nutanix root CA certificates. 3. Add the files for your operating system to the system trust. For example, on a Fedora operating system, run the following command: ```terminal # cp certs/lin/* /etc/pki/ca-trust/source/anchors ``` 4. Update your system trust. For example, on a Fedora operating system, run the following command: ```terminal # update-ca-trust extract ``` ## Downloading the RHCOS cluster image {#installation-nutanix-download-rhcos_installing-restricted-networks-nutanix-installer-provisioned} Prism Central requires access to the Red Hat Enterprise Linux CoreOS (RHCOS) image to install the cluster. You can use the installation program to locate and download the RHCOS image and make it available through an internal HTTP server or Nutanix Objects. **Prerequisites** - Obtain the OpenShift Container Platform installation program and the pull secret for your cluster. For a restricted network installation, these files are on your mirror host. **Procedure** 1. Change to the directory that contains the installation program and run the following command: ```terminal $ ./openshift-install coreos print-stream-json ``` 2. Use the output of the command to find the location of the Nutanix image, and click the link to download it. ```terminal {title="Example output"} "nutanix": { "release": "411.86.202210041459-0", "formats": { "qcow2": { "disk": { "location": "https://rhcos.mirror.openshift.com/art/storage/releases/rhcos-4.11/411.86.202210041459-0/x86_64/rhcos-411.86.202210041459-0-nutanix.x86_64.qcow2", "sha256": "42e227cac6f11ac37ee8a2f9528bb3665146566890577fd55f9b950949e5a54b" ``` 3. Make the image available through an internal HTTP server or Nutanix Objects. 4. Note the location of the downloaded image. You update the `platform` section in the installation configuration file (`install-config.yaml`) with the image’s location before deploying the cluster. ```yaml {title="Snippet of an install-config.yaml file that specifies the RHCOS image"} platform: nutanix: clusterOSImage: http://example.com/images/rhcos-411.86.202210041459-0-nutanix.x86_64.qcow2 ``` ## Creating the installation configuration file {#installation-initializing_installing-restricted-networks-nutanix-installer-provisioned} You can customize the OpenShift Container Platform cluster you install on Nutanix. **Prerequisites** - You have the OpenShift Container Platform installation program and the pull secret for your cluster. For a restricted network installation, these files are on your mirror host. - You have the `imageContentSourcePolicy.yaml` file that was created when you mirrored your registry. - You have the location of the Red Hat Enterprise Linux CoreOS (RHCOS) image you download. - You have obtained the contents of the certificate for your mirror registry. - You have retrieved a Red Hat Enterprise Linux CoreOS (RHCOS) image and uploaded it to an accessible location. - You have verified that you have met the Nutanix networking requirements. For more information, see "Preparing to install on Nutanix". **Procedure** 1. Create the `install-config.yaml` file. 1. Change to the directory that contains the installation program and run the following command: ```terminal $ ./openshift-install create install-config --dir ``` - ``: For ``, specify the directory name to store the files that the installation program creates. When specifying the directory: - Verify that the directory has the `execute` permission. This permission is required to run Terraform binaries under the installation directory. - Use an empty directory. Some installation assets, such as bootstrap X.509 certificates, have short expiration intervals, therefore 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. At the prompts, provide the configuration details for your cloud: 1. Optional: Select an SSH key to use to access your cluster machines. > [!NOTE] > For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses. 2. Select **nutanix** as the platform to target. 3. Enter the Prism Central domain name or IP address. 4. Enter the port that is used to log into Prism Central. 5. Enter the credentials that are used to log into Prism Central. The installation program connects to Prism Central. 6. Select the Prism Element that will manage the OpenShift Container Platform cluster. 7. Select the network subnet to use. 8. Enter the virtual IP address that you configured for control plane API access. 9. Enter the virtual IP address that you configured for cluster ingress. 10. Enter the base domain. This base domain must be the same one that you configured in the DNS records. 11. Enter a descriptive name for your cluster. The cluster name you enter must match the cluster name you specified when configuring the DNS records. 2. In the `install-config.yaml` file, set the value of `platform.nutanix.clusterOSImage` to the image location or name. For example: ```yaml platform: nutanix: clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 ``` 3. Edit the `install-config.yaml` file to give the additional information that is required for an installation in a restricted network. 1. Update the `pullSecret` value to contain the authentication information for your registry: ```yaml pullSecret: '{"auths":{":5000": {"auth": "","email": "you@example.com"}}}' ``` For ``, specify the registry domain name that you specified in the certificate for your mirror registry, and for ``, specify the base64-encoded user name and password for your mirror registry. 2. Add the `additionalTrustBundle` parameter and value. ```yaml additionalTrustBundle: | -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- ``` The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry. 3. Add the image content resources, which resemble the following YAML excerpt: ```yaml imageContentSources: - mirrors: - :5000//release source: quay.io/openshift-release-dev/ocp-release - mirrors: - :5000//release source: registry.redhat.io/ocp/release ``` For these values, use the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry. 4. Optional: Update one or more of the default configuration parameters in the `install.config.yaml` file to customize the installation. For more information about the parameters, see "Installation configuration parameters". > [!NOTE] > If you are installing a three-node cluster, be sure to set the `compute.replicas` parameter to `0`. This ensures that cluster’s control planes are schedulable. For more information, see "Installing a three-node cluster on {platform}". 5. Back up the `install-config.yaml` file so that you can use it to install multiple clusters. > [!IMPORTANT] > The `install-config.yaml` file is consumed during the installation process. If you want to reuse the file, you must back it up now. **Additional resources** {._additional-resources} - [Installation configuration parameters for Nutanix](/openshift-docs-markdown/installing/installing_nutanix/installation-config-parameters-nutanix#installation-config-parameters-nutanix) ### Sample customized install-config.yaml file for Nutanix {#installation-nutanix-config-yaml_installing-restricted-networks-nutanix-installer-provisioned} You can customize the `install-config.yaml` file to specify more details about your OpenShift Container Platform cluster’s platform or modify the values of the required parameters. > [!IMPORTANT] > This sample YAML file is provided for reference only. You must obtain your `install-config.yaml` file by using the installation program and modify it. ```yaml apiVersion: v1 baseDomain: example.com compute: - hyperthreading: Enabled name: worker replicas: 3 platform: nutanix: cpus: 2 coresPerSocket: 2 memoryMiB: 8196 osDisk: diskSizeGiB: 120 categories: - key: value: controlPlane: hyperthreading: Enabled name: master replicas: 3 platform: nutanix: cpus: 4 coresPerSocket: 2 memoryMiB: 16384 osDisk: diskSizeGiB: 120 categories: - key: value: metadata: creationTimestamp: null name: test-cluster networking: clusterNetwork: - cidr: 10.128.0.0/14 hostPrefix: 23 machineNetwork: - cidr: 10.0.0.0/16 networkType: OVNKubernetes serviceNetwork: - 172.30.0.0/16 platform: nutanix: apiVIP: 10.40.142.7 ingressVIP: 10.40.142.8 defaultMachinePlatform: bootType: Legacy categories: - key: value: project: type: name name: prismCentral: endpoint: address: your.prismcentral.domainname port: 9440 password: username: prismElements: - endpoint: address: your.prismelement.domainname port: 9440 uuid: 0005b0f1-8f43-a0f2-02b7-3cecef193712 subnetUUIDs: - c7938dc6-7659-453e-a688-e26020c68e43 clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 credentialsMode: Manual publish: External pullSecret: '{"auths":{"": {"auth": "","email": "you@example.com"}}}' fips: false sshKey: ssh-ed25519 AAAA... additionalTrustBundle: | -----BEGIN CERTIFICATE----- ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ -----END CERTIFICATE----- imageContentSources: - mirrors: - //release source: quay.io/openshift-release-dev/ocp-release - mirrors: - //release source: quay.io/openshift-release-dev/ocp-v4.0-art-dev ``` The installation program prompts you for the values of `baseDomain`, `metadata.name`, `platform.nutanix.apiVIP`, `platform.nutanix.ingressVIP`, `platform.nutanix.prismCentral.endpoint.address`, `platform.nutanix.prismCentral.endpoint.port`, `platform.nutanix.prismCentral.password`, and `platform.nutanix.prismCentral.username`. where: `compute` : The `compute` section is a sequence of mappings. The first line of the `compute` section must begin with a hyphen, `-`. Although this section currently defines a single machine pool, it is possible that future versions of OpenShift Container Platform will support defining multiple compute pools during installation. `hyperthreading` : Whether to enable or disable simultaneous multithreading, or `hyperthreading`. By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines. > [!IMPORTANT] > If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance. `platform.nutanix` : Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines. `categories` : Optional: Provide one or more pairs of a prism category key and a prism category value. These category key-value pairs must exist in Prism Central. You can provide separate categories to compute machines, control plane machines, or all machines. `controlPlane` : The `controlPlane` section is a single mapping. The first line of the `controlPlane` section must not begin with a hyphen. Only one control plane pool is used. `networkType` : The cluster network plugin to install. The default value `OVNKubernetes` is the only supported value. `project` : Optional: Specify a project with which VMs are associated. Specify either `name` or `uuid` for the project type, and then provide the corresponding UUID or project name. You can associate projects to compute machines, control plane machines, or all machines. `` : Required. The installation program prompts you for this value. `` : Required. The installation program prompts you for this value. `clusterOSImage` : Optional: By default, the installation program downloads and installs the Red Hat Enterprise Linux CoreOS (RHCOS) image. If Prism Central does not have internet access, you can override the default behavior by hosting the RHCOS image on any HTTP server or Nutanix Objects and pointing the installation program to the image. `` : Specify the registry domain name, and optionally the port, that your mirror registry uses to serve content. For example `registry.example.com` or `registry.example.com:5000`. `` : Specify the base64-encoded user name and password for your mirror registry. `fips` : Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the Red Hat Enterprise Linux CoreOS (RHCOS) machines that OpenShift Container Platform runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with RHCOS instead. > [!IMPORTANT] > When running Red Hat Enterprise Linux (RHEL) or Red Hat Enterprise Linux CoreOS (RHCOS) booted in FIPS mode, OpenShift Container Platform core components use the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. `sshKey` : Optional: You can provide the `sshKey` value that you use to access the machines in your cluster. > [!NOTE] > For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your `ssh-agent` process uses. `additionalTrustBundle` : Provide the contents of the certificate file that you used for your mirror registry. `imageContentSources` : Provide these values from the `metadata.name: release-0` section of the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry. ### Configuring failure domains {#installation-configuring-nutanix-failure-domains_installing-restricted-networks-nutanix-installer-provisioned} Failure domains improve the fault tolerance of an OpenShift Container Platform cluster by distributing control plane and compute machines across multiple Nutanix Prism Elements (clusters). > [!TIP] > It is recommended that you configure three failure domains to ensure high-availability. **Prerequisites** - You have an installation configuration file (`install-config.yaml`). **Procedure** 1. Edit the `install-config.yaml` file and add the following stanza to configure the first failure domain: ```yaml apiVersion: v1 baseDomain: example.com compute: # ... platform: nutanix: failureDomains: - name: prismElement: name: uuid: subnetUUIDs: - # ... ``` where: `` : Specifies a unique name for the failure domain. The name is limited to 64 or fewer characters, which can include lower-case letters, digits, and a dash (`-`). The dash cannot be in the leading or ending position of the name. `` : Optional. Specifies the name of the Prism Element. ` : Specifies the UUID of the Prism Element. ` : Specifies the one or more UUIDs of the Prism Element subnet objects. Among them, one of the subnet’s IP address prefixes (CIDRs) must contain the virtual IP addresses that the OpenShift Container Platform cluster uses. A maximum of 32 subnets for each failure domain (Prism Element) in an OpenShift Container Platform cluster is supported. All `subnetUUID` values must be unique. 2. As required, configure additional failure domains. 3. To distribute control plane and compute machines across the failure domains, do one of the following: - If compute and control plane machines can share the same set of failure domains, add the failure domain names under the cluster’s default machine configuration. ```yaml {title="Example of control plane and compute machines sharing a set of failure domains"} apiVersion: v1 baseDomain: example.com compute: # ... platform: nutanix: defaultMachinePlatform: failureDomains: - failure-domain-1 - failure-domain-2 - failure-domain-3 # ... ``` - If compute and control plane machines must use different failure domains, add the failure domain names under the respective machine pools. ```yaml {title="Example of control plane and compute machines using different failure domains"} apiVersion: v1 baseDomain: example.com compute: # ... controlPlane: platform: nutanix: failureDomains: - failure-domain-1 - failure-domain-2 - failure-domain-3 # ... compute: platform: nutanix: failureDomains: - failure-domain-1 - failure-domain-2 # ... ``` 4. Save the file. ### Configuring the cluster-wide proxy during installation {#installation-configure-proxy_installing-restricted-networks-nutanix-installer-provisioned} 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. `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. ## Installing the OpenShift CLI on Linux {#cli-installing-cli-linux_installing-restricted-networks-nutanix-installer-provisioned} To manage your cluster and deploy applications from the command line on Linux, install the OpenShift CLI (`oc`) binary. You can download the OpenShift CLI (`oc`) from the Red  Customer Portal. > [!IMPORTANT] > If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in OpenShift Container Platform. > > Download and install the new version of `oc`. **Procedure** 1. Navigate to the [Download OpenShift Container Platform](https://access.redhat.com/downloads/content/290) page on the Red Hat Customer Portal. 2. Select the architecture from the **Product Variant** list. 3. Select the appropriate version from the **Version** list. 4. Click **Download Now** next to the **OpenShift v4.22 Linux Clients** entry and save the file. 5. Unpack the archive: ```terminal $ tar xvf ``` 6. Place the `oc` binary in a directory that is on your `PATH`. To check your `PATH`, run the following command: ```terminal $ echo $PATH ``` **Verification** - After you install the OpenShift CLI, it is available using the `oc` command: ```terminal $ oc ``` ## Installing the OpenShift CLI on Windows {#cli-installing-cli-windows_installing-restricted-networks-nutanix-installer-provisioned} To manage your cluster and deploy applications from the command line on Windows, install the OpenShift CLI (`oc`) binary. You can download the OpenShift CLI (`oc`) from the Red  Customer Portal. > [!IMPORTANT] > If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in OpenShift Container Platform. > > Download and install the new version of `oc`. **Procedure** 1. Navigate to the [Download OpenShift Container Platform](https://access.redhat.com/downloads/content/290) page on the Red Hat Customer Portal. 2. Select the appropriate version from the **Version** list. 3. Click **Download Now** next to the **OpenShift v4.22 Windows Client** entry and save the file. 4. Extract the archive with a ZIP program. 5. Move the `oc` binary to a directory that is on your `PATH` variable. To check your `PATH` variable, open the Command Prompt and run the following command: ```terminal C:\> path ``` **Verification** - After you install the OpenShift CLI, it is available using the `oc` command: ```terminal C:\> oc ``` ## Installing the OpenShift CLI on macOS {#cli-installing-cli-macos_installing-restricted-networks-nutanix-installer-provisioned} To manage your cluster and deploy applications from the command line on macOS, install the OpenShift CLI (`oc`) binary. You can download the OpenShift CLI (`oc`) from the Red  Customer Portal. > [!IMPORTANT] > If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in OpenShift Container Platform. > > Download and install the new version of `oc`. **Procedure** 1. Navigate to the [Download OpenShift Container Platform](https://access.redhat.com/downloads/content/290) page on the Red Hat Customer Portal. 2. Select the architecture from the **Product Variant** list. 3. Select the appropriate version from the **Version** list. 4. Click **Download Now** next to the **OpenShift v4.22 macOS Clients** entry and save the file. > [!NOTE] > For macOS arm64, choose the **OpenShift v4.22 macOS arm64 Client** entry. 5. Extract the archive. 6. Move the `oc` binary to a directory on your `PATH` variable. To check your `PATH` variable, open a terminal and run the following command: ```terminal $ echo $PATH ``` **Verification** - Verify your installation by using an `oc` command: ```terminal $ oc ``` ## Configuring IAM for Nutanix {#manually-create-iam-nutanix_installing-restricted-networks-nutanix-installer-provisioned} Installing the cluster requires that the Cloud Credential Operator (CCO) operate in manual mode. While the installation program configures the CCO for manual mode, you must specify the identity and access management secrets. **Prerequisites** - You have configured the `ccoctl` binary. - You have an `install-config.yaml` file. **Procedure** 1. Create a YAML file that contains the credentials data in the following format: ```yaml {title="Credentials data format"} credentials: - type: basic_auth data: prismCentral: username: password: prismElements: - name: username: password: ``` where: `type` : Specifies the authentication type. Only basic authentication is supported. `prismCentral` : Specifies the Prism Central credentials. `prismElements` : Optional: Specifies the Prism Element credentials. 2. Set a `$RELEASE_IMAGE` variable with the release image from your installation file by running the following command: ```terminal $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}') ``` 3. Extract the list of `CredentialsRequest` custom resources (CRs) from the OpenShift Container Platform release image by running the following command: ```terminal $ oc adm release extract \ --from=$RELEASE_IMAGE \ --credentials-requests \ --included \ --install-config=/install-config.yaml \ --to= ``` where: `--included` : Includes only the manifests that your specific cluster configuration requires. `` : Specifies the location of the `install-config.yaml` file. `` : Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. ```yaml {title="Sample CredentialsRequest object"} apiVersion: cloudcredential.openshift.io/v1 kind: CredentialsRequest metadata: annotations: include.release.openshift.io/self-managed-high-availability: "true" labels: controller-tools.k8s.io: "1.0" name: openshift-machine-api-nutanix namespace: openshift-cloud-credential-operator spec: providerSpec: apiVersion: cloudcredential.openshift.io/v1 kind: NutanixProviderSpec secretRef: name: nutanix-credentials namespace: openshift-machine-api ``` 4. Use the `ccoctl` tool to process all `CredentialsRequest` objects by running the following command: ```terminal $ ccoctl nutanix create-shared-secrets \ --credentials-requests-dir= \ --output-dir= \ --credentials-source-filepath= ``` where: `` : Specifies the path to the directory that contains the files for the component `CredentialsRequests` objects. `` : Optional: Specifies the directory in which you want the `ccoctl` utility to create objects. By default, the utility creates objects in the directory in which the commands are run. `` : Optional: Specifies the directory that contains the credentials data YAML file. By default, `ccoctl` expects this file to be in `/.nutanix/credentials`. 5. Edit the `install-config.yaml` configuration file so that the `credentialsMode` parameter is set to `Manual`. ```yaml {title="Example install-config.yaml configuration file"} apiVersion: v1 baseDomain: cluster1.example.com credentialsMode: Manual ... ``` Add the `credentialsMode` line to set the parameter to `Manual`. 6. Create the installation manifests by running the following command: ```terminal $ openshift-install create manifests --dir ``` For ``, specify the path to the directory that contains the `install-config.yaml` file for your cluster. 7. Copy the generated credential files to the target manifests directory by running the following command: ```terminal $ cp /manifests/*credentials.yaml .//manifests ``` **Verification** - Ensure that the appropriate secrets exist in the `manifests` directory. ```terminal $ ls .//manifests ``` ```text {title="Example output"} cluster-config.yaml cluster-dns-02-config.yml cluster-infrastructure-02-config.yml cluster-ingress-02-config.yml cluster-network-01-crd.yml cluster-network-02-config.yml cluster-proxy-01-config.yaml cluster-scheduler-02-config.yml cvo-overrides.yaml kube-cloud-config.yaml kube-system-configmap-root-ca.yaml machine-config-server-tls-secret.yaml openshift-config-secret-pull-secret.yaml openshift-cloud-controller-manager-nutanix-credentials-credentials.yaml openshift-machine-api-nutanix-credentials-credentials.yaml ``` ## Deploying the cluster {#installation-launching-installer_installing-restricted-networks-nutanix-installer-provisioned} To deploy your OpenShift Container Platform cluster, you initialize installation by running the `openshift-install create cluster` command from the directory that contains the installation program. The installation program provisions the required infrastructure and completes the cluster setup. > [!IMPORTANT] > You can run the `create cluster` command of the installation program only once, during initial installation. **Prerequisites** - You have the OpenShift Container Platform installation program and the pull secret for your cluster. - You have verified that the cloud provider account on your host has the correct permissions to deploy the cluster. An account with incorrect permissions causes the installation process to fail with an error message that displays the missing permissions. **Procedure** - In the directory that contains the installation program, initialize the cluster deployment by running the following command: ```terminal $ ./openshift-install create cluster --dir \ --log-level=info ``` where: - ``: Specifies the location of your customized `./install-config.yaml` file. - `--log-level`: Specifies the log level. To view different installation details, specify `warn`, `debug`, or `error` instead of `info`. **Verification** When the cluster deployment completes successfully: - The terminal displays directions for accessing your cluster, including a link to the web console and credentials for the `kubeadmin` user. - Credential information also outputs to `/.openshift_install.log`. > [!IMPORTANT] > Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster. The following example shows the expected output: ```terminal ... INFO Install complete! INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig' INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com INFO Login to the console with user: "kubeadmin", and password: "password" INFO Time elapsed: 36m22s ``` > [!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. ## Disabling the default software catalog sources {#olm-restricted-networks-operatorhub_installing-restricted-networks-nutanix-installer-provisioned} To use only trusted or locally available Operator catalogs, disable the default software catalog sources that OpenShift Container Platform configures during installation. In a restricted network environment, you must disable the default catalogs as a cluster administrator. **Procedure** - Disable the sources for the default catalogs by adding `disableAllDefaultSources: true` to the `OperatorHub` object: ```terminal $ oc patch OperatorHub cluster --type json \ -p '[{"op": "add", "path": "/spec/disableAllDefaultSources", "value": true}]' ``` > [!TIP] > Or, you can use the web console to manage catalog sources. From the **Administration** → **Cluster Settings** → **Configuration** → **OperatorHub** page, click the **Sources** tab, where you can create, update, delete, disable, and enable individual sources. ## Installing the policy resources into the cluster {#oc-mirror-updating-cluster-manifests_installing-restricted-networks-nutanix-installer-provisioned} Mirroring the OpenShift Container Platform content using the oc-mirror OpenShift CLI (oc) plugin creates resources, which include `catalogSource-certified-operator-index.yaml` and `imageContentSourcePolicy.yaml`. - The `ImageContentSourcePolicy` resource associates the mirror registry with the source registry and redirects image pull requests from the online registries to the mirror registry. - The `CatalogSource` resource is used by Operator Lifecycle Manager (OLM) Classic to retrieve information about the available Operators in the mirror registry, which lets users discover and install Operators. > [!NOTE] > OLM v1 uses the `ClusterCatalog` resource to retrieve information about the available cluster extensions in the mirror registry. > > The oc-mirror plugin v1 does not generate `ClusterCatalog` resources automatically; you must manually create them. The oc-mirror plugin v2 does, however, generate `ClusterCatalog` resources automatically. > > For more information on creating and applying `ClusterCatalog` resources, see "Adding a catalog to a cluster" in "Extensions". After you install the cluster, you must install these resources into the cluster. **Prerequisites** - You have mirrored the image set to the registry mirror in the disconnected environment. - You have access to the cluster as a user with the `cluster-admin` role. **Procedure** 1. Log in to the OpenShift CLI as a user with the `cluster-admin` role. 2. Apply the YAML files from the results directory to the cluster: ```terminal $ oc apply -f ./oc-mirror-workspace/results-/ ``` **Verification** 1. Verify that the `ImageContentSourcePolicy` resources were successfully installed: ```terminal $ oc get imagecontentsourcepolicy ``` 2. Verify that the `CatalogSource` resources were successfully installed: ```terminal $ oc get catalogsource --all-namespaces ``` **Additional resources** {._additional-resources} - [Adding a catalog to a cluster in Extensions](/openshift-docs-markdown/extensions/catalogs/managing-catalogs#olmv1-adding-a-catalog-to-a-cluster_managing-catalogs) ## Configuring the default storage container {#registry-configuring-storage-nutanix_installing-restricted-networks-nutanix-installer-provisioned} After you install the cluster, you must install the Nutanix CSI Operator and configure the default storage container for the cluster. **Additional resources** {._additional-resources} - [Installing the CSI Operator](https://opendocs.nutanix.com/openshift/operators/csi/) - [Configuring registry storage](https://opendocs.nutanix.com/openshift/post-install/) ## Telemetry access for OpenShift Container Platform {#cluster-telemetry_installing-restricted-networks-nutanix-installer-provisioned} 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} - [OpenShift Container Platform installation and update processes](/openshift-docs-markdown/architecture/architecture-installation#architecture-installation) - [Configuring your firewall to grant required access](/openshift-docs-markdown/installing/install_config/configuring-firewall#configuring-firewall-module_configuring-firewall) - [Nutanix AOS Security Guide](https://portal.nutanix.com/page/documents/details?targetId=Nutanix-Security-Guide-v6_1:mul-security-ssl-certificate-pc-t.html) - [Configuring a custom PKI](/openshift-docs-markdown/networking/configuring_network_settings/configuring-a-custom-pki#configuring-a-custom-pki) - [*mirror registry for Red Hat OpenShift*](/openshift-docs-markdown/disconnected/installing-mirroring-creating-registry#installing-mirroring-creating-registry) - [oc-mirror OpenShift CLI (oc) plugin](/openshift-docs-markdown/disconnected/about-installing-oc-mirror-v2#about-installing-oc-mirror-v2) - [About remote health monitoring](/openshift-docs-markdown/support/remote_health_monitoring/about-remote-health-monitoring#about-remote-health-monitoring) - [Remote health reporting](/openshift-docs-markdown/support/remote_health_monitoring/remote-health-reporting#remote-health-reporting) - [Registering your disconnected cluster](/openshift-docs-markdown/support/remote_health_monitoring/remote-health-reporting#insights-operator-register-disconnected-cluster_remote-health-reporting) - [Customize your cluster](/openshift-docs-markdown/post_installation_configuration/cluster-tasks#available_cluster_customizations)