Chapter 3. Installing a cluster on Nutanix in a restricted network

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:

   $ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> 

   1

   1

   Specify 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 FIPS validated or Modules In Process cryptographic libraries on 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:

   $ cat <path>/<file_name>.pub

   For example, run the following to view the

   ~/.ssh/id_ed25519.pub

   public key:

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

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

      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

   :

   $ ssh-add <path>/<file_name> 

   1

   1

   Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519

   Example output

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

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:

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

   # update-ca-trust extract

Procedure

1. Change to the directory that contains the installation program and run the following command:

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

   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.

Procedure

1. Create the

   install-config.yaml

   file.

   1. Change to the directory that contains the installation program and run the following command:

      $ ./openshift-install create install-config --dir <installation_directory> 

      1

      1

      For <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 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.
      12. Paste the pull secret from the Red Hat OpenShift Cluster Manager.

2. In the

   install-config.yaml

   file, set the value of

   platform.nutanix.clusterOSImage

   to the image location or name. For example:

   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:

      pullSecret: '{"auths":{"<mirror_host_name>:5000": {"auth": "<credentials>","email": "you@example.com"}}}'

      For

      <mirror_host_name>

      , specify the registry domain name that you specified in the certificate for your mirror registry, and for

      <credentials>

      , specify the base64-encoded user name and password for your mirror registry.

   2. Add the

      additionalTrustBundle

      parameter and value.

      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:

      imageContentSources:
      - mirrors:
        - <mirror_host_name>:5000/<repo_name>/release
        source: quay.io/openshift-release-dev/ocp-release
      - mirrors:
        - <mirror_host_name>:5000/<repo_name>/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".

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.

Procedure

1. Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
2. Select the architecture from the Product Variant drop-down list.
3. Select the appropriate version from the Version drop-down list.
4. Click Download Now next to the OpenShift v4.12 Linux Client entry and save the file.

5. Unpack the archive:

   $ tar xvf <file>

6. Place the

   oc

   binary in a directory that is on your

   PATH

   .

   To check your

   PATH

   , execute the following command:

   $ echo $PATH

Procedure

1. Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
2. Select the appropriate version from the Version drop-down list.
3. Click Download Now next to the OpenShift v4.12 Windows Client entry and save the file.
4. Unzip the archive with a ZIP program.

5. 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:

   C:\> path

Procedure

1. Navigate to the OpenShift Container Platform downloads page on the Red Hat Customer Portal.
2. Select the appropriate version from the Version drop-down list.

3. Click Download Now next to the OpenShift v4.12 macOS Client entry and save the file.

   Note

   For macOS arm64, choose the OpenShift v4.12 macOS arm64 Client entry.

4. Unpack and unzip the archive.

5. Move the

   oc

   binary to a directory on your PATH.

   To check your

   PATH

   , open a terminal and execute the following command:

   $ echo $PATH

Procedure

1. Create a YAML file that contains the credentials data in the following format:

   Credentials data format

   credentials:
   - type: basic_auth 

   1

   
     data:
       prismCentral: 

   2

   
         username: <username_for_prism_central>
         password: <password_for_prism_central>
       prismElements: 

   3

   
       - name: <name_of_prism_element>
         username: <username_for_prism_element>
         password: <password_for_prism_element>

   1

   Specify the authentication type. Only basic authentication is supported.

   2

   Specify the Prism Central credentials.

   3

   Optional: Specify the Prism Element credentials.

2. Set a

   $RELEASE_IMAGE

   variable with the release image from your installation file by running the following command:

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

   $ oc adm release extract \
     --from=$RELEASE_IMAGE \
     --credentials-requests \
     --cloud=nutanix \
     --to=<path_to_directory_with_list_of_credentials_requests>/credrequests 

   1

   1

   Specify the path to the directory that contains the files for the component CredentialsRequests objects. If the specified directory does not exist, this command creates it.

   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. If your cluster uses cluster capabilities to disable one or more optional components, delete the

   CredentialsRequest

   custom resources for any disabled components.

   Example credrequests directory contents for OpenShift Container Platform 4.12 on Nutanix

   0000_30_machine-api-operator_00_credentials-request.yaml 

   1

   1

   The Machine API Operator CR is required.

5. Use the

   ccoctl

   tool to process all of the

   CredentialsRequest

   objects in the

   credrequests

   directory by running the following command:

   $ ccoctl nutanix create-shared-secrets \
   --credentials-requests-dir=<path_to_directory_with_list_of_credentials_requests>/credrequests \

   1

   
   --output-dir=<ccoctl_output_dir> \

   2

   
   --credentials-source-filepath=<path_to_credentials_file> 

   3

   1

   Specify the path to the directory that contains the files for the component CredentialsRequests objects.

   2

   Specify the directory that contains the files of the component credentials secrets, under the manifests directory. By default, the ccoctl tool creates objects in the directory in which the commands are run. To create the objects in a different directory, use the --output-dir flag.

   3

   Optional: Specify the directory that contains the credentials data YAML file. By default, ccoctl expects this file to be in <home_directory>/.nutanix/credentials. To specify a different directory, use the --credentials-source-filepath flag.

6. Edit the

   install-config.yaml

   configuration file so that the

   credentialsMode

   parameter is set to

   Manual

   .

   Example install-config.yaml configuration file

   apiVersion: v1
   baseDomain: cluster1.example.com
   credentialsMode: Manual 

   1

   
   ...

   1

   Add this line to set the credentialsMode parameter to Manual.

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

   $ openshift-install create manifests --dir <installation_directory> 

   1

   1

   Specify the path to the directory that contains the install-config.yaml file for your cluster.

8. Copy the generated credential files to the target manifests directory by running the following command:

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