Installing a cluster on oVirt with customizations

You can customize and install an OKD cluster on oVirt, similar to the one shown in the following diagram.

The installation program uses installer-provisioned infrastructure to automate creating and deploying the cluster.

To install a customized cluster, you prepare the environment and perform the following steps:

1. Create an installation configuration file, the install-config.yaml file, by running the installation program and answering its prompts.

2. Inspect and modify parameters in the install-config.yaml file.

3. Make a working copy of the install-config.yaml file.

4. Run the installation program with a copy of the install-config.yaml file.

Then, the installation program creates the OKD cluster.

For an alternative to installing a customized cluster, see Installing a default cluster.

Prerequisites

• You reviewed details about the OKD installation and update processes.

• You have a supported combination of versions in the Support Matrix for OKD on oVirt.

• You read the documentation on selecting a cluster installation method and preparing it for users.

• If you use a firewall, you configured it to allow the sites that your cluster requires access to.

Requirements for the oVirt environment

To install and run an OKD version 4.13 cluster, the oVirt environment must meet the following requirements.

Not meeting these requirements can cause the installation or process to fail. Additionally, not meeting these requirements can cause the OKD cluster to fail days or weeks after installation.

The following requirements for CPU, memory, and storage resources are based on default values multiplied by the default number of virtual machines the installation program creates. These resources must be available in addition to what the oVirt environment uses for non-OKD operations.

By default, the installation program creates seven virtual machines during the installation process. First, it creates a bootstrap virtual machine to provide temporary services and a control plane while it creates the rest of the OKD cluster. When the installation program finishes creating the cluster, deleting the bootstrap machine frees up its resources.

If you increase the number of virtual machines in the oVirt environment, you must increase the resources accordingly.

Requirements

• The oVirt version is 4.4.

• The oVirt environment has one data center whose state is Up.

• The oVirt data center contains an oVirt cluster.

• The oVirt cluster has the following resources exclusively for the OKD cluster:

  • Minimum 28 vCPUs: four for each of the seven virtual machines created during installation.

  • 112 GiB RAM or more, including:

    • 16 GiB or more for the bootstrap machine, which provides the temporary control plane.

    • 16 GiB or more for each of the three control plane machines which provide the control plane.

    • 16 GiB or more for each of the three compute machines, which run the application workloads.

• The oVirt storage domain must meet these etcd backend performance requirements.

• For affinity group support:

  One physical machine per worker or control plane. Workers and control planes can be on the same physical machine. For example, if you have three workers and three control planes, you need three physical machines. If you have four workers and three control planes, you need four physical machines.

  • For hard anti-affinity (default): A minimum of three physical machines. For more than three worker nodes, one physical machine per worker or control plane. Workers and control planes can be on the same physical machine.

  • For custom affinity groups: Ensure that the resources are appropriate for the affinity group rules that you define.

• In production environments, each virtual machine must have 120 GiB or more. Therefore, the storage domain must provide 840 GiB or more for the default OKD cluster. In resource-constrained or non-production environments, each virtual machine must have 32 GiB or more, so the storage domain must have 230 GiB or more for the default OKD cluster.

• To download images from the Red Hat Ecosystem Catalog during installation and update procedures, the oVirt cluster must have access to an internet connection. The Telemetry service also needs an internet connection to simplify the subscription and entitlement process.

• The oVirt cluster must have a virtual network with access to the REST API on the oVirt Engine. Ensure that DHCP is enabled on this network, because the VMs that the installer creates obtain their IP address by using DHCP.

• A user account and group with the following least privileges for installing and managing an OKD cluster on the target oVirt cluster:

  • DiskOperator

  • DiskCreator

  • UserTemplateBasedVm

  • TemplateOwner

  • TemplateCreator

  • ClusterAdmin on the target cluster

Verifying the requirements for the oVirt environment

Verify that the oVirt environment meets the requirements to install and run an OKD cluster. Not meeting these requirements can cause failures.

Procedure

1. Check that the oVirt version supports installation of OKD version 4.13.

   1. In the oVirt Administration Portal, click the ? help icon in the upper-right corner and select About.

   2. In the window that opens, make a note of the oVirt Software Version.

   3. Confirm that the oVirt version is 4.4. For more information about supported version combinations, see Support Matrix for OKD on oVirt.

2. Inspect the data center, cluster, and storage.

   1. In the oVirt Administration Portal, click Compute → Data Centers.

   2. Confirm that the data center where you plan to install OKD is accessible.

   3. Click the name of that data center.

   4. In the data center details, on the Storage tab, confirm the storage domain where you plan to install OKD is Active.

   5. Record the Domain Name for use later on.

   6. Confirm Free Space has at least 230 GiB.

   7. Confirm that the storage domain meets these etcd backend performance requirements, which you can measure by using the fio performance benchmarking tool.

   8. In the data center details, click the Clusters tab.

   9. Find the oVirt cluster where you plan to install OKD. Record the cluster name for use later on.

3. Inspect the oVirt host resources.

   1. In the oVirt Administration Portal, click Compute > Clusters.

   2. Click the cluster where you plan to install OKD.

   3. In the cluster details, click the Hosts tab.

   4. Inspect the hosts and confirm they have a combined total of at least 28 Logical CPU Cores available exclusively for the OKD cluster.

   5. Record the number of available Logical CPU Cores for use later on.

   6. Confirm that these CPU cores are distributed so that each of the seven virtual machines created during installation can have four cores.

   7. Confirm that, all together, the hosts have 112 GiB of Max free Memory for scheduling new virtual machines distributed to meet the requirements for each of the following OKD machines:

      • 16 GiB required for the bootstrap machine

      • 16 GiB required for each of the three control plane machines

      • 16 GiB for each of the three compute machines

   8. Record the amount of Max free Memory for scheduling new virtual machines for use later on.

4. Verify that the virtual network for installing OKD has access to the oVirt Engine’s REST API. From a virtual machine on this network, use curl to reach the oVirt Engine’s REST API:

   $ curl -k -u <username>@<profile>:<password> \ (1)
   https://<engine-fqdn>/ovirt-engine/api (2)

   1	For <username>, specify the user name of an oVirt account with privileges to create and manage an OKD cluster on oVirt. For <profile>, specify the login profile, which you can get by going to the oVirt Administration Portal login page and reviewing the Profile dropdown list. For <password>, specify the password for that user name.
   2	For <engine-fqdn>, specify the fully qualified domain name of the oVirt environment.

   For example:

   $ curl -k -u admin@internal:pw123 \
   https://ovirtlab.example.com/ovirt-engine/api

Preparing the network environment on oVirt

Configure two static IP addresses for the OKD cluster and create DNS entries using these addresses.

Procedure

1. Reserve two static IP addresses

   1. On the network where you plan to install OKD, identify two static IP addresses that are outside the DHCP lease pool.

   2. Connect to a host on this network and verify that each of the IP addresses is not in use. For example, use Address Resolution Protocol (ARP) to check that none of the IP addresses have entries:

      $ arp 10.35.1.19

      Example output

      10.35.1.19 (10.35.1.19) -- no entry

   3. Reserve two static IP addresses following the standard practices for your network environment.

   4. Record these IP addresses for future reference.

2. Create DNS entries for the OKD REST API and apps domain names using this format:

   api.<cluster-name>.<base-domain>   <ip-address> (1)
   *.apps.<cluster-name>.<base-domain>   <ip-address> (2)

   1	For <cluster-name>, <base-domain>, and <ip-address>, specify the cluster name, base domain, and static IP address of your OKD API.
   2	Specify the cluster name, base domain, and static IP address of your OKD apps for Ingress and the load balancer.

   For example:

   api.my-cluster.virtlab.example.com    10.35.1.19
   *.apps.my-cluster.virtlab.example.com    10.35.1.20

Installing OKD on oVirt in insecure mode

By default, the installer creates a CA certificate, prompts you for confirmation, and stores the certificate to use during installation. You do not need to create or install one manually.

Although it is not recommended, you can override this functionality and install OKD without verifying a certificate by installing OKD on oVirt in insecure mode.

Procedure

1. Create a file named ~/.ovirt/ovirt-config.yaml.

2. Add the following content to ovirt-config.yaml:

   ovirt_url: https://ovirt.example.com/ovirt-engine/api (1)
   ovirt_fqdn: ovirt.example.com (2)
   ovirt_pem_url: ""
   ovirt_username: admin@internal
   ovirt_password: super-secret-password (3)
   ovirt_insecure: true

   1	Specify the hostname or address of your oVirt engine.
   2	Specify the fully qualified domain name of your oVirt engine.
   3	Specify the admin password for your oVirt engine.

3. Run the installer.

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.

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.

   If you plan to install an OKD cluster that uses FIPS Validated / Modules in Process cryptographic libraries on the x86_64 architecture, 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.

   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

      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>)

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:

   $ 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 Container Catalog registry, such as image streams and Operators, are not available.

Creating the installation configuration file

You can customize the OKD cluster you install on oVirt.

Prerequisites

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

• Obtain service principal permissions at the subscription level.

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 OKD version.

   2. Respond to the installation program prompts.

      1. For SSH Public Key, select a password-less public key, such as ~/.ssh/id_rsa.pub. This key authenticates connections with the new OKD cluster.

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

      2. For Platform, select ovirt.

      3. For Enter oVirt’s API endpoint URL, enter the URL of the oVirt API using this format:

         https://<engine-fqdn>/ovirt-engine/api (1)

         1	For <engine-fqdn>, specify the fully qualified domain name of the oVirt environment.

         For example:

         $ curl -k -u admin@internal:pw123 \
         https://ovirtlab.example.com/ovirt-engine/api

      4. For Is the oVirt CA trusted locally?, enter Yes, because you have already set up a CA certificate. Otherwise, enter No.

      5. For oVirt’s CA bundle, if you entered Yes for the preceding question, copy the certificate content from /etc/pki/ca-trust/source/anchors/ca.pem and paste it here. Then, press Enter twice. Otherwise, if you entered No for the preceding question, this question does not appear.

      6. For oVirt engine username, enter the user name and profile of the oVirt administrator using this format:

         <username>@<profile> (1)

         1	For <username>, specify the user name of an oVirt administrator. For <profile>, specify the login profile, which you can get by going to the oVirt Administration Portal login page and reviewing the Profile dropdown list. Together, the user name and profile should look similar to this example:

         admin@internal

      7. For oVirt engine password, enter the oVirt admin password.

      8. For oVirt cluster, select the cluster for installing OKD.

      9. For oVirt storage domain, select the storage domain for installing OKD.

      10. For oVirt network, select a virtual network that has access to the oVirt Engine REST API.

      11. For Internal API Virtual IP, enter the static IP address you set aside for the cluster’s REST API.

      12. For Ingress virtual IP, enter the static IP address you reserved for the wildcard apps domain.

      13. For Base Domain, enter the base domain of the OKD cluster. If this cluster is exposed to the outside world, this must be a valid domain recognized by DNS infrastructure. For example, enter: virtlab.example.com

      14. For Cluster Name, enter the name of the cluster. For example, my-cluster. Use cluster name from the externally registered/resolvable DNS entries you created for the OKD REST API and apps domain names. The installation program also gives this name to the cluster in the oVirt environment.

      15. For Pull Secret, copy the pull secret from the pull-secret.txt file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the Red Hat OpenShift Cluster Manager.

1. Modify the install-config.yaml file. You can find more information about the available parameters in the “Installation configuration parameters” section.

   If you have any intermediate CA certificates on the Engine, verify that the certificates appear in the ovirt-config.yaml file and the install-config.yaml file. If they do not appear, add them as follows: In the ~/.ovirt/ovirt-config.yaml file: [ovirt_ca_bundle]: | ——-BEGIN CERTIFICATE——- <MY_TRUSTED_CA> ——-END CERTIFICATE——- ——-BEGIN CERTIFICATE——- <INTERMEDIATE_CA> ——-END CERTIFICATE——- In the install-config.yaml file: [additionalTrustBundle]: | ——-BEGIN CERTIFICATE——- <MY_TRUSTED_CA> ——-END CERTIFICATE——- ——-BEGIN CERTIFICATE——- <INTERMEDIATE_CA> ——-END CERTIFICATE——-

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.

Example install-config.yaml files for oVirt

You can customize the OKD cluster the installation program creates by changing the parameters and parameter values in the install-config.yaml file.

The following examples are specific to installing OKD on oVirt.

install-config.yaml is located in <installation_directory>, which you specified when you ran the following command.

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

Example default install-config.yaml file

apiVersion: v1
baseDomain: example.com
compute:
- architecture: amd64
  hyperthreading: Enabled
  name: worker
  platform:
    ovirt:
      sparse: false (1)
      format: raw   (2)
  replicas: 3
controlPlane:
  architecture: amd64
  hyperthreading: Enabled
  name: master
  platform:
      ovirt:
        sparse: false (1)
        format: raw   (2)
  replicas: 3
metadata:
  creationTimestamp: null
  name: my-cluster
networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23
  machineNetwork:
  - cidr: 10.0.0.0/16
  networkType: OVNKubernetes (3)
  serviceNetwork:
  - 172.30.0.0/16
platform:
  ovirt:
    api_vips:
      - 10.0.0.10
    ingress_vips:
      - 10.0.0.11
    ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
    ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
    ovirt_network_name: ovirtmgmt
    vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
publish: External
pullSecret: '{"auths": ...}'
sshKey: ssh-ed12345 AAAA...

Example minimal install-config.yaml file

apiVersion: v1
baseDomain: example.com
metadata:
  name: test-cluster
platform:
  ovirt:
    api_vips:
      - 10.46.8.230
    ingress_vips:
      - 10.46.8.232
    ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
    ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
    ovirt_network_name: ovirtmgmt
    vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
pullSecret: '{"auths": ...}'
sshKey: ssh-ed12345 AAAA...

Example Custom machine pools in an install-config.yaml file

apiVersion: v1
baseDomain: example.com
controlPlane:
  name: master
  platform:
    ovirt:
      cpu:
        cores: 4
        sockets: 2
      memoryMB: 65536
      osDisk:
        sizeGB: 100
      vmType: server
  replicas: 3
compute:
- name: worker
  platform:
    ovirt:
      cpu:
        cores: 4
        sockets: 4
      memoryMB: 65536
      osDisk:
        sizeGB: 200
      vmType: server
  replicas: 5
metadata:
  name: test-cluster
platform:
  ovirt:
    api_vips:
      - 10.46.8.230
    ingress_vips:
      - 10.46.8.232
    ovirt_cluster_id: 68833f9f-e89c-4891-b768-e2ba0815b76b
    ovirt_storage_domain_id: ed7b0f4e-0e96-492a-8fff-279213ee1468
    ovirt_network_name: ovirtmgmt
    vnicProfileID: 3fa86930-0be5-4052-b667-b79f0a729692
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...

Example non-enforcing affinity group

It is recommended to add a non-enforcing affinity group to distribute the control plane and workers, if possible, to use as much of the cluster as possible.

platform:
  ovirt:
    affinityGroups:
    - description: AffinityGroup to place each compute machine on a separate host
      enforcing: true
      name: compute
      priority: 3
    - description: AffinityGroup to place each control plane machine on a separate host
      enforcing: true
      name: controlplane
      priority: 5
    - description: AffinityGroup to place worker nodes and control plane nodes on separate hosts
      enforcing: false
      name: openshift
      priority: 5
compute:
- architecture: amd64
  hyperthreading: Enabled
  name: worker
  platform:
    ovirt:
      affinityGroupsNames:
      - compute
      - openshift
  replicas: 3
controlPlane:
  architecture: amd64
  hyperthreading: Enabled
  name: master
  platform:
    ovirt:
      affinityGroupsNames:
      - controlplane
      - openshift
  replicas: 3

Example removing all affinity groups for a non-production lab setup

For non-production lab setups, you must remove all affinity groups to concentrate the OKD cluster on the few hosts you have.

platform:
  ovirt:
    affinityGroups: []
compute:
- architecture: amd64
  hyperthreading: Enabled
  name: worker
  platform:
    ovirt:
      affinityGroupsNames: []
  replicas: 3
controlPlane:
  architecture: amd64
  hyperthreading: Enabled
  name: master
  platform:
    ovirt:
      affinityGroupsNames: []
  replicas: 3

Installation configuration parameters

Before you deploy an OKD cluster, you provide parameter values to describe your account on the cloud platform that hosts your cluster and optionally customize your cluster’s platform. When you create the install-config.yaml installation configuration file, you provide values for the required parameters through the command line. If you customize your cluster, you can modify the install-config.yaml file to provide more details about the platform.

Required configuration parameters

Required installation configuration parameters are described in the following table:

Network configuration parameters

You can customize your installation configuration based on the requirements of your existing network infrastructure. For example, you can expand the IP address block for the cluster network or provide different IP address blocks than the defaults.

Only IPv4 addresses are supported.

networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23

networking:
  serviceNetwork:
   - 172.30.0.0/16

networking:
  machineNetwork:
  - cidr: 10.0.0.0/16

Optional configuration parameters

Optional installation configuration parameters are described in the following table:

sshKey:
  <key1>
  <key2>
  <key3>

Additional oVirt configuration parameters

Additional oVirt configuration parameters are described in the following table:

Additional oVirt parameters for machine pools

Additional oVirt configuration parameters for machine pools are described in the following table:

<machine-pool>:
  platform:
    ovirt:
      affinityGroupNames:
        - compute
        - clusterWideNonEnforcing

<machine-pool>:
  platform:
    ovirt:
      affinityGroupNames: []

Deploying the cluster

You can install OKD on a compatible cloud platform.

Prerequisites

• Open the ovirt-imageio port to the Engine from the machine running the installer. By default, the port is 54322.

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

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

  $ ./openshift-install create cluster --dir <installation_directory> \ (1)
      --log-level=info (2)

  1	For <installation_directory>, specify the location of your customized ./install-config.yaml file.
  2	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 <installation_directory>/.openshift_install.log.

Example output

...
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: "4vYBz-Ee6gm-ymBZj-Wt5AL"
INFO Time elapsed: 36m22s

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.

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:

   $ tar xvf <file>

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

   To check your PATH, execute the following command:

   $ echo $PATH

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

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

   C:\> path

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

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:

   $ echo $PATH

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

$ oc <command>

Logging in to the cluster by using the CLI

You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OKD installation.

Prerequisites

• You deployed an OKD cluster.

• You installed the oc CLI.

Procedure

1. Export the kubeadmin credentials:

   $ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)

   1	For <installation_directory>, specify the path to the directory that you stored the installation files in.

2. Verify you can run oc commands successfully using the exported configuration:

   $ oc whoami

   Example output

   system:admin

To learn more, see Getting started with the OpenShift CLI.

Verifying cluster status

You can verify your OKD cluster’s status during or after installation.

Procedure

1. In the cluster environment, export the administrator’s kubeconfig file:

   $ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)

   1	For <installation_directory>, specify the path to the directory that you stored the installation files in.

   The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server.

2. View the control plane and compute machines created after a deployment:

   $ oc get nodes

3. View your cluster’s version:

   $ oc get clusterversion

4. View your Operators’ status:

   $ oc get clusteroperator

5. View all running pods in the cluster:

   $ oc get pods -A

Troubleshooting

If the installation fails, the installation program times out and displays an error message. To learn more, see Troubleshooting installation issues.

Accessing the OKD web console on oVirt

After the OKD cluster initializes, you can log in to the OKD web console.

Procedure

1. Optional: In the oVirt Administration Portal, open Compute → Cluster.

2. Verify that the installation program creates the virtual machines.

3. Return to the command line where the installation program is running. When the installation program finishes, it displays the user name and temporary password for logging into the OKD web console.

4. In a browser, open the URL of the OKD web console. The URL uses this format:

   console-openshift-console.apps.<clustername>.<basedomain> (1)

   1	For <clustername>.<basedomain>, specify the cluster name and base domain.

   For example:

   console-openshift-console.apps.my-cluster.virtlab.example.com

Additional resources

• See About remote health monitoring for more information about the Telemetry service

Troubleshooting common issues with installing on oVirt

Here are some common issues you might encounter, along with proposed causes and solutions.

CPU load increases and nodes go into a Not Ready state

• Symptom: CPU load increases significantly and nodes start going into a Not Ready state.

• Cause: The storage domain latency might be too high, especially for control plane nodes.

• Solution:

  Make the nodes ready again by restarting the kubelet service:

  $ systemctl restart kubelet

  Inspect the OKD metrics service, which automatically gathers and reports on some valuable data such as the etcd disk sync duration. If the cluster is operational, use this data to help determine whether storage latency or throughput is the root issue. If so, consider using a storage resource that has lower latency and higher throughput.

  To get raw metrics, enter the following command as kubeadmin or user with cluster-admin privileges:

  $ oc get --insecure-skip-tls-verify --server=https://localhost:<port> --raw=/metrics

  To learn more, see Exploring Application Endpoints for the purposes of Debugging with OpenShift 4.x

Trouble connecting the OKD cluster API

• Symptom: The installation program completes but the OKD cluster API is not available. The bootstrap virtual machine remains up after the bootstrap process is complete. When you enter the following command, the response will time out.

  $ oc login -u kubeadmin -p *** <apiurl>

• Cause: The bootstrap VM was not deleted by the installation program and has not released the cluster’s API IP address.

• Solution: Use the wait-for subcommand to be notified when the bootstrap process is complete:

  $ ./openshift-install wait-for bootstrap-complete

  When the bootstrap process is complete, delete the bootstrap virtual machine:

  $ ./openshift-install destroy bootstrap

Post-installation tasks

After the OKD cluster initializes, you can perform the following tasks.

• Optional: After deployment, add or replace SSH keys using the Machine Config Operator (MCO) in OKD.

• Optional: Remove the kubeadmin user. Instead, use the authentication provider to create a user with cluster-admin privileges.

Next steps

• Customize your cluster.

• If necessary, you can opt out of remote health reporting.