$ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> (1)
In OKD version 4.15, 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.
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. |
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
.
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 |
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 the Fedora cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the |
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
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 |
If the ssh-agent
process is not already running for your local user, start it as a background task:
$ eval "$(ssh-agent -s)"
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)
1 | Specify the path and file name for your SSH private key, such as ~/.ssh/id_ed25519 |
Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
When you install OKD, provide the SSH public key to the installation program.
Before you install OKD, download the installation file on the host you are using for installation.
You have a computer that runs Linux or macOS, with at least 1.2 GB of local disk space.
Download the installation program from https://github.com/openshift/okd/releases.
|
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
Download your installation pull secret from 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 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 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.
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.
From the Prism Central web console, download the Nutanix root CA certificates.
Extract the compressed file that contains the Nutanix root CA certificates.
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
Update your system trust. For example, on a Fedora operating system, run the following command:
# update-ca-trust extract
You can customize the OKD cluster you install on Nutanix.
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".
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. |
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.
At the prompts, provide the configuration details for your cloud:
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 |
Select nutanix as the platform to target.
Enter the Prism Central domain name or IP address.
Enter the port that is used to log into Prism Central.
Enter the credentials that are used to log into Prism Central.
The installation program connects to Prism Central.
Select the Prism Element that will manage the OKD cluster.
Select the network subnet to use.
Enter the virtual IP address that you configured for control plane API access.
Enter the virtual IP address that you configured for cluster ingress.
Enter the base domain. This base domain must be the same one that you configured in the DNS records.
Enter a descriptive name for your cluster.
The cluster name you enter must match the cluster name you specified when configuring the DNS records.
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 |
Back up the install-config.yaml
file so that you can use
it to install multiple clusters.
The |
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 |
apiVersion: v1
baseDomain: example.com (1)
compute: (2)
- hyperthreading: Enabled (3)
name: worker
replicas: 3
platform:
nutanix: (4)
cpus: 2
coresPerSocket: 2
memoryMiB: 8196
osDisk:
diskSizeGiB: 120
categories: (5)
- key: <category_key_name>
value: <category_value>
controlPlane: (2)
hyperthreading: Enabled (3)
name: master
replicas: 3
platform:
nutanix: (4)
cpus: 4
coresPerSocket: 2
memoryMiB: 16384
osDisk:
diskSizeGiB: 120
categories: (5)
- key: <category_key_name>
value: <category_value>
metadata:
creationTimestamp: null
name: test-cluster (1)
networking:
clusterNetwork:
- cidr: 10.128.0.0/14
hostPrefix: 23
machineNetwork:
- cidr: 10.0.0.0/16
networkType: OVNKubernetes (6)
serviceNetwork:
- 172.30.0.0/16
platform:
nutanix:
apiVIPs:
- 10.40.142.7 (1)
defaultMachinePlatform:
bootType: Legacy
categories: (5)
- key: <category_key_name>
value: <category_value>
project: (7)
type: name
name: <project_name>
ingressVIPs:
- 10.40.142.8 (1)
prismCentral:
endpoint:
address: your.prismcentral.domainname (1)
port: 9440 (1)
password: <password> (1)
username: <username> (1)
prismElements:
- endpoint:
address: your.prismelement.domainname
port: 9440
uuid: 0005b0f1-8f43-a0f2-02b7-3cecef193712
subnetUUIDs:
- c7938dc6-7659-453e-a688-e26020c68e43
clusterOSImage: http://example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2 (8)
credentialsMode: Manual
publish: External
pullSecret: '{"auths": ...}' (1)
sshKey: ssh-ed25519 AAAA... (9)
1 | Required. The installation program prompts you for this value. | ||
2 | The 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. |
||
3 | Whether to enable or disable simultaneous multithreading, or hyperthreading . By default, simultaneous multithreading is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to Disabled . If you disable simultaneous multithreading in some cluster machines, you must disable it in all cluster machines.
|
||
4 | Optional: Provide additional configuration for the machine pool parameters for the compute and control plane machines. | ||
5 | Optional: Provide one or more pairs of a prism category key and a prism category value. These category key-value pairs must exist in Prism Central. You can provide separate categories to compute machines, control plane machines, or all machines. | ||
6 | TThe cluster network plugin to install. The default value OVNKubernetes is the only supported value. |
||
7 | Optional: 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. | ||
8 | Optional: You can provide the sshKey value that you use to access the machines in your cluster.
|
Failure domains improve the fault tolerance of an OKD cluster by distributing control plane and compute machines across multiple Nutanix Prism Elements (clusters).
It is recommended that you configure three failure domains to ensure high-availability. |
You have an installation configuration file (install-config.yaml
).
Edit the install-config.yaml
file and add the following stanza to configure the first failure domain:
apiVersion: v1
baseDomain: example.com
compute:
# ...
platform:
nutanix:
failureDomains:
- name: <failure_domain_name>
prismElement:
name: <prism_element_name>
uuid: <prism_element_uuid>
subnetUUIDs:
- <network_uuid>
# ...
where:
<failure_domain_name>
Specifies a unique name for the failure domain. The name is limited to 64 or fewer characters, which can include lower-case letters, digits, and a dash (-
). The dash cannot be in the leading or ending position of the name.
<prism_element_name>
Optional. Specifies the name of the Prism Element.
<prism_element_uuid
>Specifies the UUID of the Prism Element.
<network_uuid
>Specifies the UUID of the Prism Element subnet object. The subnet’s IP address prefix (CIDR) should contain the virtual IP addresses that the OKD cluster uses. Only one subnet per failure domain (Prism Element) in an OKD cluster is supported.
As required, configure additional failure domains.
To distribute control plane and compute machines across the failure domains, do one of the following:
If compute and control plane machines can share the same set of failure domains, add the failure domain names under the cluster’s default machine configuration.
apiVersion: v1
baseDomain: example.com
compute:
# ...
platform:
nutanix:
defaultMachinePlatform:
failureDomains:
- failure-domain-1
- failure-domain-2
- failure-domain-3
# ...
If compute and control plane machines must use different failure domains, add the failure domain names under the respective machine pools.
apiVersion: v1
baseDomain: example.com
compute:
# ...
controlPlane:
platform:
nutanix:
failureDomains:
- failure-domain-1
- failure-domain-2
- failure-domain-3
# ...
compute:
platform:
nutanix:
failureDomains:
- failure-domain-1
- failure-domain-2
# ...
Save the file.
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.
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 For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and OpenStack, the |
Edit your install-config.yaml
file and add the proxy settings. For example:
apiVersion: v1
baseDomain: my.domain.com
proxy:
httpProxy: http://<username>:<pswd>@<ip>:<port> (1)
httpsProxy: https://<username>:<pswd>@<ip>:<port> (2)
noProxy: example.com (3)
additionalTrustBundle: | (4)
-----BEGIN CERTIFICATE-----
<MY_TRUSTED_CA_CERT>
-----END CERTIFICATE-----
additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> (5)
1 | A proxy URL to use for creating HTTP connections outside the cluster. The
URL scheme must be http . |
2 | A proxy URL to use for creating HTTPS connections outside the cluster. |
3 | A comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with . to match subdomains only. For example, .y.com matches x.y.com , but not y.com . Use * to bypass the proxy for all destinations. |
4 | If provided, the installation program generates a config map that is named user-ca-bundle in
the openshift-config namespace that contains one or more additional CA
certificates that are required for proxying HTTPS connections. The Cluster Network
Operator then creates a trusted-ca-bundle config map that merges these contents
with the Fedora CoreOS (FCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless
the proxy’s identity certificate is signed by an authority from the FCOS trust
bundle. |
5 | Optional: 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 |
If the installer times out, restart and then complete the deployment by using the
|
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 |
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 |
You can install the OpenShift CLI (oc
) binary on Linux by using the following 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 xvf <file>
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>
You can install the OpenShift CLI (oc
) binary on Windows by using the following 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 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>
You can install the OpenShift CLI (oc
) binary on macOS by using the following 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
Verify your installation by using an oc
command:
$ oc <command>
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.
You have configured the ccoctl
binary.
You have an install-config.yaml
file.
Create a YAML file that contains the credentials data in the following 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. |
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}')
Extract the list of CredentialsRequest
custom resources (CRs) from the OKD release image by running the following command:
$ oc adm release extract \
--from=$RELEASE_IMAGE \
--credentials-requests \
--included \(1)
--install-config=<path_to_directory_with_installation_configuration>/install-config.yaml \(2)
--to=<path_to_directory_for_credentials_requests> (3)
1 | The --included parameter includes only the manifests that your specific cluster configuration requires. |
2 | Specify the location of the install-config.yaml file. |
3 | Specify the path to the directory where you want to store the CredentialsRequest objects. If the specified directory does not exist, this command creates it. |
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
Use the ccoctl
tool to process all CredentialsRequest
objects by running the following command:
$ ccoctl nutanix create-shared-secrets \
--credentials-requests-dir=<path_to_credentials_requests_directory> \(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 | Optional: 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. |
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 . |
Edit the install-config.yaml
configuration file so that the credentialsMode
parameter is set to Manual
.
install-config.yaml
configuration fileapiVersion: v1
baseDomain: cluster1.example.com
credentialsMode: Manual (1)
...
1 | Add this line to set the credentialsMode parameter to Manual . |
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. |
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
Ensure that the appropriate secrets exist in the manifests
directory.
$ ls ./<installation_directory>/manifests
cluster-config.yaml
cluster-dns-02-config.yml
cluster-infrastructure-02-config.yml
cluster-ingress-02-config.yml
cluster-network-01-crd.yml
cluster-network-02-config.yml
cluster-proxy-01-config.yaml
cluster-scheduler-02-config.yml
cvo-overrides.yaml
kube-cloud-config.yaml
kube-system-configmap-root-ca.yaml
machine-config-server-tls-secret.yaml
openshift-config-secret-pull-secret.yaml
openshift-cloud-controller-manager-nutanix-credentials-credentials.yaml
openshift-machine-api-nutanix-credentials-credentials.yaml
Installations on Nutanix require additional configmap
and Secret
resources to integrate with the Nutanix Cloud Controller Manager (CCM).
You have created a manifests
directory within your installation directory.
Navigate to the manifests
directory:
$ cd <path_to_installation_directory>/manifests
Create the cloud-conf
configmap
file with the name openshift-cloud-controller-manager-cloud-config.yaml
and add the following information:
apiVersion: v1
kind: configmap
metadata:
name: cloud-conf
namespace: openshift-cloud-controller-manager
data:
cloud.conf: "{
\"prismCentral\": {
\"address\": \"<prism_central_FQDN/IP>\", (1)
\"port\": 9440,
\"credentialRef\": {
\"kind\": \"Secret\",
\"name\": \"nutanix-credentials\",
\"namespace\": \"openshift-cloud-controller-manager\"
}
},
\"topologyDiscovery\": {
\"type\": \"Prism\",
\"topologyCategories\": null
},
\"enableCustomLabeling\": true
}"
1 | Specify the Prism Central FQDN/IP. |
Verify that the file cluster-infrastructure-02-config.yml
exists and has the following information:
spec:
cloudConfig:
key: config
name: cloud-provider-config
You can install OKD on a compatible cloud platform.
You can run the |
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.
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 . |
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. |
...
INFO Install complete!
INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'
INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com
INFO Login to the console with user: "kubeadmin", and password: "password"
INFO Time elapsed: 36m22s
|
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.