Installing a cluster on Nutanix

In OKD version 4, you can choose one of the following options to install a cluster on your Nutanix instance:

Using installer-provisioned infrastructure: Use the procedures in the following sections to use installer-provisioned infrastructure. Installer-provisioned infrastructure is ideal for installing in connected or disconnected network environments. The installer-provisioned infrastructure includes an installation program that provisions the underlying infrastructure for the cluster.

Using the Assisted Installer: The Assisted Installer hosted at console.redhat.com. The Assisted Installer cannot be used in disconnected environments. The Assisted Installer does not provision the underlying infrastructure for the cluster, so you must provision the infrastructure before the running the Assisted Installer. Installing with the Assisted Installer also provides integration with Nutanix, enabling autoscaling. See Installing an on-premise cluster using the Assisted Installer for additional details.

Using user-provisioned infrastructure: Complete the relevant steps outlined in the Installing a cluster on any platform documentation.

Prerequisites

  • You have reviewed details about the OKD 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 OKD requires. This includes the use of Telemetry.

  • If your Nutanix environment is using the default self-signed SSL 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.

    Use 2048-bit certificates. The installation fails if you use 4096-bit certificates with Prism Central 2022.x.

Internet access for Prism Central

Prism Central requires internet access to obtain the Fedora CoreOS (FCOS) image that is required to install the cluster. The FCOS image for Nutanix is available at rhcos.mirror.openshift.com.

Generating a key pair for cluster node SSH access

During an OKD installation, you can provide an SSH public key to the installation program. The key is passed to the Fedora CoreOS (FCOS) 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.

After the key is passed to the nodes, you can use the key pair to SSH in to the FCOS 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.

Do not skip this procedure in production environments, where disaster recovery and debugging is required.

You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs.

On clusters running Fedora CoreOS (FCOS), the SSH keys specified in the Ignition config files are written to the /home/core/.ssh/authorized_keys.d/core file. However, the Machine Config Operator manages SSH keys in the /home/core/.ssh/authorized_keys file and configures sshd to ignore the /home/core/.ssh/authorized_keys.d/core file. As a result, newly provisioned OKD nodes are not accessible using SSH until the Machine Config Operator reconciles the machine configs with the authorized_keys file. After you can access the nodes using SSH, you can delete the /home/core/.ssh/authorized_keys.d/core file.

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:

    1. $ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> (1)
    1Specify 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.

    If you plan to install an OKD cluster that uses the Fedora 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:

    1. $ cat <path>/<file_name>.pub

    For example, run the following to view the ~/.ssh/id_ed25519.pub public key:

    1. $ 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.

    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:

      1. $ eval "$(ssh-agent -s)"

      Example output

      1. Agent pid 31874

      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:

    1. $ ssh-add <path>/<file_name> (1)
    1Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519

    Example output

    1. Identity added: /home/<you>/<path>/<file_name> (<computer_name>)

Next steps

  • When you install OKD, provide the SSH public key to the installation program.

Obtaining the installation program

Before you install OKD, download the installation file on the host you are using for installation.

Prerequisites

  • You have a computer that runs Linux or macOS, with 500 MB of local disk space.

Procedure

  1. Download installer from https://github.com/openshift/okd/releases

    The installation program creates several files on the computer that you use to install your cluster. You must keep the installation program and the files that the installation program creates after you finish installing the cluster. Both files are required to delete the cluster.

    Deleting the files created by the installation program does not remove your cluster, even if the cluster failed during installation. To remove your cluster, complete the OKD uninstallation procedures for your specific cloud provider.

  2. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:

    1. $ tar -xvf openshift-install-linux.tar.gz

  3. Download your installation pull secret from the Red Hat OpenShift Cluster Manager. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OKD components.

    Using a pull secret from the Red Hat OpenShift Cluster Manager is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use {"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}} as the pull secret when prompted during the installation.

    If you do not use the pull secret from the Red Hat OpenShift Cluster Manager:

    • Red Hat Operators are not available.

    • The Telemetry and Insights operators do not send data to Red Hat.

    • Content from the Red Hat Ecosystem Catalog Container images registry, such as image streams and Operators, are not available.

Adding Nutanix root CA certificates to your system trust

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 OKD 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:

    1. # 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:

    1. # update-ca-trust extract

Creating the installation configuration file

You can customize the OKD cluster you install on Nutanix.

Prerequisites

  • You have the OKD installation program and the pull secret for your cluster.

  • 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:

      1. $ ./openshift-install create install-config --dir <installation_directory> (1)
      1For <installation_directory>, 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 OKD version.

        Always delete the ~/.powervs directory to avoid reusing a stale configuration. Run the following command:

        1. $ rm -rf ~/.powervs

    2. At the prompts, provide the configuration details for your cloud:

      1. Optional: Select an SSH key to use to access your cluster machines.

        For production OKD 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 OKD 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.

  1. 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”.

    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 Nutanix”.

  2. Back up the install-config.yaml file so that you can use it to install multiple clusters.

    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

Sample customized install-config.yaml file for Nutanix

You can customize the install-config.yaml file to specify more details about your OKD cluster’s platform or modify the values of the required parameters.

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.

  1. apiVersion: v1
  2. baseDomain: example.com (1)
  3. compute: (2)
  4. - hyperthreading: Enabled (3)
  5.   name: worker
  6.   replicas: 3
  7.   platform:
  8.     nutanix: (4)
  9.       cpus: 2
  10.       coresPerSocket: 2
  11.       memoryMiB: 8196
  12.       osDisk:
  13.         diskSizeGiB: 120
  14.       categories: (5)
  15.       - key: <category_key_name>
  16.         value: <category_value>
  17. controlPlane: (2)
  18.   hyperthreading: Enabled (3)
  19.   name: master
  20.   replicas: 3
  21.   platform:
  22.     nutanix: (4)
  23.       cpus: 4
  24.       coresPerSocket: 2
  25.       memoryMiB: 16384
  26.       osDisk:
  27.         diskSizeGiB: 120
  28.       categories: (5)
  29.       - key: <category_key_name>
  30.         value: <category_value>
  31. metadata:
  32.   creationTimestamp: null
  33.   name: test-cluster (1)
  34. networking:
  35.   clusterNetwork:
  36.     - cidr: 10.128.0.0/14
  37.       hostPrefix: 23
  38.   machineNetwork:
  39.     - cidr: 10.0.0.0/16
  40.   networkType: OVNKubernetes (6)
  41.   serviceNetwork:
  42.     - 172.30.0.0/16
  43. platform:
  44.   nutanix:
  45.     apiVIPs:
  46.       - 10.40.142.7 (1)
  47.     defaultMachinePlatform:
  48.       bootType: Legacy
  49.       categories: (5)
  50.       - key: <category_key_name>
  51.         value: <category_value>
  52.       project: (7)
  53.         type: name
  54.         name: <project_name>
  55.     ingressVIPs:
  56.       - 10.40.142.8 (1)
  57.     prismCentral:
  58.       endpoint:
  59.         address: your.prismcentral.domainname (1)
  60.         port: 9440 (1)
  61.       password: <password> (1)
  62.       username: <username> (1)
  63.     prismElements:
  64.     - endpoint:
  65.         address: your.prismelement.domainname
  66.         port: 9440
  67.       uuid: 0005b0f1-8f43-a0f2-02b7-3cecef193712
  68.     subnetUUIDs:
  69.     - c7938dc6-7659-453e-a688-e26020c68e43
  70.     clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 (8)
  71. credentialsMode: Manual
  72. publish: External
  73. pullSecret: '{"auths": ...}' (1)
  74. sshKey: ssh-ed25519 AAAA... (9)
1Required. The installation program prompts you for this value.
2The controlPlane section is a single mapping, but the compute section is a sequence of mappings. To meet the requirements of the different data structures, the first line of the compute section must begin with a hyphen, -, and the first line of the controlPlane section must not. Although both sections currently define a single machine pool, it is possible that future versions of OKD will support defining multiple compute pools during installation. Only one control plane pool is used.
3Whether 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.

If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.

4Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines.
5Optional: 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.
6The cluster network plugin to install. The supported values are OVNKubernetes and OpenShiftSDN. The default value is OVNKubernetes.
7Optional: By default, the installation program downloads and installs the Fedora CoreOS (FCOS) image. If Prism Central does not have internet access, you can override the default behavior by hosting the FCOS image on any HTTP server and pointing the installation program to the image.
8Optional: You can provide the sshKey value that you use to access the machines in your cluster.

For production OKD clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses.

Configuring the cluster-wide proxy during installation

Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OKD 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 reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the Proxy object’s spec.noProxy field to bypass the proxy if necessary.

    The Proxy object status.noProxy field is populated with 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 Platform (GCP), Microsoft Azure, and OpenStack, the Proxy object status.noProxy field is also populated with the instance metadata endpoint (169.254.169.254).

Procedure

  1. Edit your install-config.yaml file and add the proxy settings. For example:

    1. apiVersion: v1
    2. baseDomain: my.domain.com
    3. proxy:
    4.   httpProxy: http://<username>:<pswd>@<ip>:<port> (1)
    5.   httpsProxy: https://<username>:<pswd>@<ip>:<port> (2)
    6.   noProxy: example.com (3)
    7. additionalTrustBundle: | (4)
    8.     -----BEGIN CERTIFICATE-----
    9.     <MY_TRUSTED_CA_CERT>
    10.     -----END CERTIFICATE-----
    11. additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> (5)
    1A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http.
    2A proxy URL to use for creating HTTPS connections outside the cluster.
    3A 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.
    4If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace to hold the additional CA certificates. If you provide additionalTrustBundle and at least one proxy setting, the Proxy object is configured to reference 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 FCOS trust bundle. The additionalTrustBundle field is required unless the proxy’s identity certificate is signed by an authority from the FCOS trust bundle.
    5Optional: The policy to determine 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 http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly.

    The installation program does not support the proxy readinessEndpoints field.

    If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example:

    1. $ ./openshift-install wait-for install-complete —log-level debug

  2. Save the file and reference it when installing OKD.

The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec.

Only the Proxy object named cluster is supported, and no additional proxies can be created.

Installing the OpenShift CLI by downloading the binary

You can install the OpenShift CLI (oc) to interact with OKD from a command-line interface. You can install oc on Linux, Windows, or macOS.

If you installed an earlier version of oc, you cannot use it to complete all of the commands in OKD 4. Download and install the new version of oc.

Installing the OpenShift CLI on Linux

You can install the OpenShift CLI (oc) binary on Linux by using the following procedure.

Procedure

  1. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.

  2. Download oc.tar.gz.

  3. Unpack the archive:

    1. $ tar xvf <file>

  4. Place the oc binary in a directory that is on your PATH.

    To check your PATH, execute the following command:

    1. $ echo $PATH

Verification

  • After you install the OpenShift CLI, it is available using the oc command:

    1. $ oc <command>

Installing the OpenShift CLI on Windows

You can install the OpenShift CLI (oc) binary on Windows by using the following procedure.

Procedure

  1. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.

  2. Download oc.zip.

  3. Unzip the archive with a ZIP program.

  4. Move the oc binary to a directory that is on your PATH.

    To check your PATH, open the command prompt and execute the following command:

    1. C:\> path

Verification

  • After you install the OpenShift CLI, it is available using the oc command:

    1. C:\> oc <command>

Installing the OpenShift CLI on macOS

You can install the OpenShift CLI (oc) binary on macOS by using the following procedure.

Procedure

  1. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.

  2. Download oc.tar.gz.

  3. Unpack and unzip the archive.

  4. Move the oc binary to a directory on your PATH.

    To check your PATH, open a terminal and execute the following command:

    1. $ echo $PATH

Verification

  • After you install the OpenShift CLI, it is available using the oc command:

    1. $ oc <command>

Configuring IAM for Nutanix

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:

    Credentials data format

    1. credentials:
    2. - type: basic_auth (1)
    3.   data:
    4.     prismCentral: (2)
    5.       username: <username_for_prism_central>
    6.       password: <password_for_prism_central>
    7.     prismElements: (3)
    8.     - name: <name_of_prism_element>
    9.       username: <username_for_prism_element>
    10.       password: <password_for_prism_element>
    1Specify the authentication type. Only basic authentication is supported.
    2Specify the Prism Central credentials.
    3Optional: Specify the Prism Element credentials.

  2. Set a $RELEASE_IMAGE variable with the release image from your installation file by running the following command:

    1. $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}')

  3. Extract the list of CredentialsRequest custom resources (CRs) from the OKD release image by running the following command:

    1. $ oc adm release extract \
    2.   --from=$RELEASE_IMAGE \
    3.   --credentials-requests \
    4.   --included \(1)
    5.   --install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \(2)
    6.   --to=<path_to_directory_for_credentials_requests> (3)
    1The —included parameter includes only the manifests that your specific cluster configuration requires.
    2Specify the location of the install-config.yaml file.
    3Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it.

    Sample CredentialsRequest object

    1.   apiVersion: cloudcredential.openshift.io/v1
    2.   kind: CredentialsRequest
    3.   metadata:
    4.     annotations:
    5.       include.release.openshift.io/self-managed-high-availability: "true"
    6.     labels:
    7.       controller-tools.k8s.io: "1.0"
    8.     name: openshift-machine-api-nutanix
    9.     namespace: openshift-cloud-credential-operator
    10.   spec:
    11.     providerSpec:
    12.       apiVersion: cloudcredential.openshift.io/v1
    13.       kind: NutanixProviderSpec
    14.     secretRef:
    15.       name: nutanix-credentials
    16.       namespace: openshift-machine-api

  4. Use the ccoctl tool to process all CredentialsRequest objects by running the following command:

    1. $ ccoctl nutanix create-shared-secrets \
    2.   --credentials-requests-dir=<path_to_credentials_requests_directory> \(1)
    3.   --output-dir=<ccoctl_output_dir> \(2)
    4.   --credentials-source-filepath=<path_to_credentials_file> (3)
    1Specify the path to the directory that contains the files for the component CredentialsRequests objects.
    2Optional: Specify 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.
    3Optional: Specify the directory that contains the credentials data YAML file. By default, ccoctl expects this file to be in <home_directory>/.nutanix/credentials.

  5. Edit the install-config.yaml configuration file so that the credentialsMode parameter is set to Manual.

    Example install-config.yaml configuration file

    1. apiVersion: v1
    2. baseDomain: cluster1.example.com
    3. credentialsMode: Manual (1)
    4. ...
    1Add this line to set the credentialsMode parameter to Manual.

  6. Create the installation manifests by running the following command:

    1. $ openshift-install create manifests --dir <installation_directory> (1)
    1Specify 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:

    1. $ cp <ccoctl_output_dir>/manifests/*credentials.yaml ./<installation_directory>/manifests

Verification

  • Ensure that the appropriate secrets exist in the manifests directory.

    1. $ ls ./<installation_directory>/manifests

    Example output

    1. cluster-config.yaml
    2. cluster-dns-02-config.yml
    3. cluster-infrastructure-02-config.yml
    4. cluster-ingress-02-config.yml
    5. cluster-network-01-crd.yml
    6. cluster-network-02-config.yml
    7. cluster-proxy-01-config.yaml
    8. cluster-scheduler-02-config.yml
    9. cvo-overrides.yaml
    10. kube-cloud-config.yaml
    11. kube-system-configmap-root-ca.yaml
    12. machine-config-server-tls-secret.yaml
    13. openshift-config-secret-pull-secret.yaml
    14. openshift-cloud-controller-manager-nutanix-credentials-credentials.yaml
    15. openshift-machine-api-nutanix-credentials-credentials.yaml

Adding config map and secret resources required for Nutanix CCM

Installations on Nutanix require additional ConfigMap and Secret resources to integrate with the Nutanix Cloud Controller Manager (CCM).

Prerequisites

  • You have created a manifests directory within your installation directory.

Procedure

  1. Navigate to the manifests directory:

    1. $ cd <path_to_installation_directory>/manifests

  2. Create a file with the name openshift-cloud-controller-manager-nutanix-credentials-credentials.yaml and add the following information:

    1. apiVersion: v1
    2. kind: Secret
    3. metadata:
    4.   name: nutanix-credentials
    5.   namespace: openshift-cloud-controller-manager
    6. type: Opaque
    7. stringData:
    8.   credentials: "[{
    9.     \"type\":\"basic_auth\",
    10.     \"data\":{
    11.           \"prismCentral\":{
    12.             \"username\":\"<username_for_prism_central>\", (1)
    13.             \"password\":\"<password_for_prism_central>\"}, (2)
    14.             \"prismElements\":null
    15.           }
    16.     }]"
    1Specify the Prism Central username.
    2Specify the Prism Central password.

  3. Create the cloud-conf ConfigMap file with the name openshift-cloud-controller-manager-cloud-config.yaml and add the following information:

    1. apiVersion: v1
    2. kind: ConfigMap
    3. metadata:
    4.   name: cloud-conf
    5.   namespace: openshift-cloud-controller-manager
    6. data:
    7.   cloud.conf: "{
    8.       \"prismCentral\": {
    9.           \"address\": \"<prism_central_FQDN/IP>\", (1)
    10.           \"port\": 9440,
    11.             \"credentialRef\": {
    12.                 \"kind\": \"Secret\",
    13.                 \"name\": \"nutanix-credentials\",
    14.                 \"namespace\": \"openshift-cloud-controller-manager\"
    15.             }
    16.        },
    17.        \"topologyDiscovery\": {
    18.            \"type\": \"Prism\",
    19.            \"topologyCategories\": null
    20.        },
    21.        \"enableCustomLabeling\": true
    22.      }"
    1Specify the Prism Central FQDN/IP.

  4. Verify that the file cluster-infrastructure-02-config.yml exists and has the following information:

    1. spec:
    2.   cloudConfig:
    3.     key: config
    4.     name: cloud-provider-config

Deploying the cluster

You can install OKD on a compatible cloud platform.

You can run the create cluster command of the installation program only once, during initial installation.

Prerequisites

  • You have the OKD 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

  • Change to the directory that contains the installation program and initialize the cluster deployment:

    1. $ ./openshift-install create cluster --dir <installation_directory> \ (1)
    2.     --log-level=info (2)
    1For <installation_directory>, specify the location of your customized ./install-config.yaml file.
    2To 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 <installation_directory>/.openshift_install.log.

Do not delete the installation program or the files that the installation program creates. Both are required to delete the cluster.

Example output

  1. ...
  2. INFO Install complete!
  3. INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'
  4. INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com
  5. INFO Login to the console with user: "kubeadmin", and password: "password"
  6. INFO Time elapsed: 36m22s

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

Configuring the default storage container

After you install the cluster, you must install the Nutanix CSI Operator and configure the default storage container for the cluster.

For more information, see the Nutanix documentation for installing the CSI Operator and configuring registry storage.

Additional resources

Next steps