- Installing a cluster on oVirt with customizations
- Prerequisites
- Requirements for the oVirt environment
- Verifying the requirements for the oVirt environment
- Preparing the network environment on oVirt
- Installing OKD on oVirt in insecure mode
- Generating an SSH private key and adding it to the agent
- Obtaining the installation program
- Creating the installation configuration file
- Deploying the cluster
- Installing the OpenShift CLI by downloading the binary
- Logging in to the cluster by using the CLI
- Verifying cluster status
- Accessing the OKD web console on oVirt
- Troubleshooting common issues with installing on oVirt
- Post-installation tasks
- Next steps
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:
Create an installation configuration file, the
install-config.yaml
file, by running the installation program and answering its prompts.Inspect and modify parameters in the
install-config.yaml
file.Make a working copy of the
install-config.yaml
file.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.
This installation program is available for Linux and macOS only. |
Prerequisites
Review details about the OKD installation and update processes.
If you use a firewall, configure it to allow the sites that your cluster requires access to.
Requirements for the oVirt environment
To install and run an OKD version 4.7 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.
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
Apply the principle of least privilege: Avoid using an administrator account with |
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.
These requirements are based on the default resources the installation program uses to create control plane and compute machines. These resources include vCPUs, memory, and storage. If you change these resources or increase the number of OKD machines, adjust these requirements accordingly. |
Procedure
Check that the oVirt version supports installation of OKD version 4.7.
In the oVirt Administration Portal, click the ? help icon in the upper-right corner and select About.
In the window that opens, make a note of the oVirt Software Version.
Confirm that the oVirt version is 4.4. For more information about supported version combinations, see Support Matrix for OKD on oVirt.
Inspect the data center, cluster, and storage.
In the oVirt Administration Portal, click Compute → Data Centers.
Confirm that the data center where you plan to install OKD is accessible.
Click the name of that data center.
In the data center details, on the Storage tab, confirm the storage domain where you plan to install OKD is Active.
Record the Domain Name for use later on.
Confirm Free Space has at least 230 GiB.
Confirm that the storage domain meets these etcd backend performance requirements, which you can measure by using the fio performance benchmarking tool.
In the data center details, click the Clusters tab.
Find the oVirt cluster where you plan to install OKD. Record the cluster name for use later on.
Inspect the oVirt host resources.
In the oVirt Administration Portal, click Compute > Clusters.
Click the cluster where you plan to install OKD.
In the cluster details, click the Hosts tab.
Inspect the hosts and confirm they have a combined total of at least 28 Logical CPU Cores available exclusively for the OKD cluster.
Record the number of available Logical CPU Cores for use later on.
Confirm that these CPU cores are distributed so that each of the seven virtual machines created during installation can have four cores.
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
Record the amount of Max free Memory for scheduling new virtual machines for use later on.
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 ocpadmin@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
Reserve two static IP addresses
On the network where you plan to install OKD, identify two static IP addresses that are outside the DHCP lease pool.
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
Reserve two static IP addresses following the standard practices for your network environment.
Record these IP addresses for future reference.
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.
Installing in insecure mode is not recommended, because it enables a potential attacker to perform a Man-in-the-Middle attack and capture sensitive credentials on the network. |
Procedure
Create a file named
~/.ovirt/ovirt-config.yaml
.Add the following content to
ovirt-config.yaml
:ovirt_url: \https://ovirt.example.com/ovirt-engine/api
ovirt_fqdn: ovirt.example.com
ovirt_pem_url: ""
ovirt_username: ocpadmin@internal
ovirt_password: super-secret-password
ovirt_insecure: true
Run the installer.
Generating an SSH private key and adding it to the agent
If you want to perform installation debugging or disaster recovery on your cluster, you must provide an SSH key to both your ssh-agent
and the installation program. You can use this key to access the bootstrap machine in a public cluster to troubleshoot installation issues.
In a production environment, you require disaster recovery and debugging. |
You can use this key to SSH into the master nodes as the user core
. When you deploy the cluster, the key is added to the core
user’s ~/.ssh/authorized_keys
list.
On clusters running Fedora CoreOS (FCOS), the SSH keys specified in the Ignition config files are written to the |
Procedure
If you do not have an SSH key that is configured for password-less authentication on your computer, 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_rsa
, of the new SSH key. If you have an existing key pair, ensure your public key is in the your~/.ssh
directory.Running this command generates an SSH key that does not require a password in the location that you specified.
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 theed25519
algorithm. Instead, create a key that uses thersa
orecdsa
algorithm.Start the
ssh-agent
process 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.
Add your SSH private key to the
ssh-agent
:$ ssh-add <path>/<file_name> (1)
Example output
Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
1 Specify the path and file name for your SSH private key, such as ~/.ssh/id_rsa
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 a local computer.
Prerequisites
- You have a computer that runs Linux or macOS, with 500 MB of local disk space
Procedure
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.
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
From the Pull Secret page on the Red Hat OpenShift Cluster Manager site, download your installation pull secret as a
.txt
file. 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 site 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 site:
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
Create the
install-config.yaml
file.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.Specify an empty directory. Some installation assets, like bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OKD version.
Respond to the installation program prompts.
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.For
Platform
, selectovirt
.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 ocpadmin@internal:pw123 \
https://ovirtlab.example.com/ovirt-engine/api
For
Is the oVirt CA trusted locally?
, enterYes
, because you have already set up a CA certificate. Otherwise, enterNo
.For
oVirt’s CA bundle
, if you enteredYes
for the preceding question, copy the certificate content from/etc/pki/ca-trust/source/anchors/ca.pem
and paste it here. Then, pressEnter
twice. Otherwise, if you enteredNo
for the preceding question, this question does not appear.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:ocpadmin@internal
For
oVirt engine password
, enter the oVirt admin password.For
oVirt cluster
, select the cluster for installing OKD.For
oVirt storage domain
, select the storage domain for installing OKD.For
oVirt network
, select a virtual network that has access to the oVirt Engine REST API.For
Internal API Virtual IP
, enter the static IP address you set aside for the cluster’s REST API.For
Ingress virtual IP
, enter the static IP address you reserved for the wildcard apps domain.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
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.For
Pull Secret
, copy the pull secret from thepull-secret.txt
file you downloaded earlier and paste it here. You can also get a copy of the same pull secret from the Pull Secret page on the Red Hat OpenShift Cluster Manager site.
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 theinstall-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——-
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 example is specific to installing OKD on oVirt.
This file is located in the <installation_directory>
you specified when you ran the following command.
$ ./openshift-install create install-config --dir=<installation_directory>
|
Example: This is the default install-config.yaml
file
apiVersion: v1
baseDomain: example.com
compute:
- architecture: amd64
hyperthreading: Enabled
name: worker
platform: {}
replicas: 3
controlPlane:
architecture: amd64
hyperthreading: Enabled
name: master
platform: {}
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
serviceNetwork:
- 172.30.0.0/16
platform:
ovirt:
api_vip: 10.46.8.230
ingress_vip: 192.168.1.5
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: A minimal install-config.yaml
file
apiVersion: v1
baseDomain: example.com
metadata:
name: test-cluster
platform:
ovirt:
api_vip: 10.46.8.230
ingress_vip: 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_vip: 10.46.8.230
ingress_vip: 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...
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.
After installation, you cannot modify these parameters in the |
The |
Required configuration parameters
Required installation configuration parameters are described in the following table:
Parameter | Description | Values |
---|---|---|
| The API version for the | String |
| The base domain of your cloud provider. The base domain is used to create routes to your OKD cluster components. The full DNS name for your cluster is a combination of the | A fully-qualified domain or subdomain name, such as |
| Kubernetes resource | Object |
| The name of the cluster. DNS records for the cluster are all subdomains of | String of lowercase letters, hyphens ( |
| The configuration for the specific platform upon which to perform the installation: | Object |
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.
Parameter | Description | Values | ||
---|---|---|---|---|
| The configuration for the cluster network. | Object
| ||
| The cluster network provider Container Network Interface (CNI) plug-in to install. | Either | ||
| The IP address blocks for pods. The default value is If you specify multiple IP address blocks, the blocks must not overlap. | An array of objects. For example:
| ||
| Required if you use An IPv4 network. | An IP address block in Classless Inter-Domain Routing (CIDR) notation. The prefix length for an IPv4 block is between | ||
| The subnet prefix length to assign to each individual node. For example, if | A subnet prefix. The default value is | ||
| The IP address block for services. The default value is The OpenShift SDN and OVN-Kubernetes network providers support only a single IP address block for the service network. | An array with an IP address block in CIDR format. For example:
| ||
| The IP address blocks for machines. If you specify multiple IP address blocks, the blocks must not overlap. | An array of objects. For example:
| ||
| Required if you use | An IP network block in CIDR notation. For example,
|
Optional configuration parameters
Optional installation configuration parameters are described in the following table:
Parameter | Description | Values | ||
---|---|---|---|---|
| A PEM-encoded X.509 certificate bundle that is added to the nodes’ trusted certificate store. This trust bundle may also be used when a proxy has been configured. | String | ||
| The configuration for the machines that comprise the compute nodes. | Array of | ||
| Determines the instruction set architecture of the machines in the pool. Currently, heteregeneous clusters are not supported, so all pools must specify the same architecture. Valid values are | String | ||
| Whether to enable or disable simultaneous multithreading, or
|
| ||
| Required if you use |
| ||
| Required if you use |
| ||
| The number of compute machines, which are also known as worker machines, to provision. | A positive integer greater than or equal to | ||
| The configuration for the machines that comprise the control plane. | Array of | ||
| Determines the instruction set architecture of the machines in the pool. Currently, heterogeneous clusters are not supported, so all pools must specify the same architecture. Valid values are | String | ||
| Whether to enable or disable simultaneous multithreading, or
|
| ||
| Required if you use |
| ||
| Required if you use |
| ||
| The number of control plane machines to provision. | The only supported value is | ||
| The Cloud Credential Operator (CCO) mode. If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported.
|
| ||
| Sources and repositories for the release-image content. | Array of objects. Includes a | ||
| Required if you use | String | ||
| Specify one or more repositories that may also contain the same images. | Array of strings | ||
| How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes. |
Setting this field to
| ||
| The SSH key or keys to authenticate access your cluster machines.
| One or more keys. For example:
|
Additional oVirt configuration parameters
Additional oVirt configuration parameters are described in the following table:
Parameter | Description | Values |
---|---|---|
| Required. The Cluster where the VMs will be created. | String. For example: |
| Required. The Storage Domain ID where the VM disks will be created. | String. For example: |
| Required. The network name where the VM nics will be created. | String. For example: |
| Required. The vNIC profile ID of the VM network interfaces. This can be inferred if the cluster network has a single profile. | String. For example: |
| Required. An IP address on the machine network that will be assigned to the API virtual IP (VIP). You can access the OpenShift API at this endpoint. | String. Example: |
| Required. An IP address on the machine network that will be assigned to the Ingress virtual IP (VIP). | String. Example: |
Additional oVirt parameters for machine pools
Additional oVirt configuration parameters for machine pools are described in the following table:
Parameter | Description | Values | ||
---|---|---|---|---|
| Optional. Defines the CPU of the VM. | Object | ||
| Required if you use | Integer | ||
| Required if you use | Integer | ||
| Optional. Memory of the VM in MiB. | Integer | ||
| Optional. An instance type UUID, such as | String of UUID | ||
| Optional. Defines the first and bootable disk of the VM. | String | ||
| Required if you use | Number | ||
| Optional. The VM workload type, such as
| String |
You can replace |
Deploying the cluster
You can install OKD on a compatible cloud platform.
You can run the |
Prerequisites
Open the
ovirt-imageio
port to the Engine from the machine running the installer. By default, the port is54322
.Obtain the OKD installation program and the pull secret for your cluster.
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
, orerror
instead ofinfo
.If the cloud provider account that you configured on your host does not have sufficient permissions to deploy the cluster, the installation process stops, and the missing permissions are displayed.
When the cluster deployment completes, directions for accessing your cluster, including a link to its web console and credentials for the
kubeadmin
user, display in your terminal.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
The cluster access and credential information also outputs to
<installation_directory>/.openshift_install.log
when an installation succeeds.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.You must not delete the installation program or the files that the installation program creates. Both are required to delete the cluster.
You have completed the steps required to install the cluster. The remaining steps show you how to verify the cluster and troubleshoot the installation. |
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 |
Installing the OpenShift CLI on Linux
You can install the OpenShift CLI (oc
) binary on Linux by using the following procedure.
Procedure
Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
Download
oc.tar.gz
.Unpack the archive:
$ tar xvzf <file>
Place the
oc
binary in a directory that is on yourPATH
.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
Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
Download
oc.zip
.Unzip the archive with a ZIP program.
Move the
oc
binary to a directory that is on yourPATH
.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
Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
Download
oc.tar.gz
.Unpack and unzip the archive.
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
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.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
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.View the control plane and compute machines created after a deployment:
$ oc get nodes
View your cluster’s version:
$ oc get clusterversion
View your Operators’ status:
$ oc get clusteroperator
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 into the OKD web console.
Procedure
Optional: In the oVirt Administration Portal, open Compute → Cluster.
Verify that the installation program creates the virtual machines.
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.
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 (also known as the master 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
If necessary, you can opt out of remote health reporting.