$ sudo subscription-manager register # If not done already
In OKD version 4.16, you can install a cluster on OpenStack that runs on user-provisioned infrastructure.
Using your own infrastructure allows you to integrate your cluster with existing infrastructure and modifications. The process requires more labor on your part than installer-provisioned installations, because you must create all OpenStack resources, like Nova servers, Neutron ports, and security groups. However, Red Hat provides Ansible playbooks to help you in the deployment process.
You reviewed details about the OKD installation and update processes.
You read the documentation on selecting a cluster installation method and preparing it for users.
You verified that OKD 4.16 is compatible with your OpenStack version by using the Supported platforms for OpenShift clusters section. You can also compare platform support across different versions by viewing the OKD on OpenStack support matrix.
You have an OpenStack account where you want to install OKD.
You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see Recommended practices for scaling the cluster.
On the machine from which you run the installation program, you have:
A single directory in which you can keep the files you create during the installation process
Python 3
To support an OKD installation, your OpenStack quota must meet the following requirements:
Resource | Value |
---|---|
Floating IP addresses |
3 |
Ports |
15 |
Routers |
1 |
Subnets |
1 |
RAM |
88 GB |
vCPUs |
22 |
Volume storage |
275 GB |
Instances |
7 |
Security groups |
3 |
Security group rules |
60 |
Server groups |
2 - plus 1 for each additional availability zone in each machine pool |
A cluster might function with fewer than recommended resources, but its performance is not guaranteed.
If OpenStack object storage (Swift) is available and operated by a user account with the |
By default, your security group and security group rule quotas might be low. If you encounter problems, run openstack quota set --secgroups 3 --secgroup-rules 60 <project> as an administrator to increase them.
|
An OKD deployment comprises control plane machines, compute machines, and a bootstrap machine.
By default, the OKD installation process creates three control plane machines.
Each machine requires:
An instance from the OpenStack quota
A port from the OpenStack quota
A flavor with at least 16 GB memory and 4 vCPUs
At least 100 GB storage space from the OpenStack quota
By default, the OKD installation process creates three compute machines.
Each machine requires:
An instance from the OpenStack quota
A port from the OpenStack quota
A flavor with at least 8 GB memory and 2 vCPUs
At least 100 GB storage space from the OpenStack quota
Compute machines host the applications that you run on OKD; aim to run as many as you can. |
During installation, a bootstrap machine is temporarily provisioned to stand up the control plane. After the production control plane is ready, the bootstrap machine is deprovisioned.
The bootstrap machine requires:
An instance from the OpenStack quota
A port from the OpenStack quota
A flavor with at least 16 GB memory and 4 vCPUs
At least 100 GB storage space from the OpenStack quota
The Ansible playbooks that simplify the installation process on user-provisioned infrastructure require several Python modules. On the machine where you will run the installer, add the modules' repositories and then download them.
These instructions assume that you are using Fedora 8. |
Python 3 is installed on your machine.
On a command line, add the repositories:
Register with Red Hat Subscription Manager:
$ sudo subscription-manager register # If not done already
Pull the latest subscription data:
$ sudo subscription-manager attach --pool=$YOUR_POOLID # If not done already
Disable the current repositories:
$ sudo subscription-manager repos --disable=* # If not done already
Add the required repositories:
$ sudo subscription-manager repos \
--enable=rhel-8-for-x86_64-baseos-rpms \
--enable=openstack-16-tools-for-rhel-8-x86_64-rpms \
--enable=ansible-2.9-for-rhel-8-x86_64-rpms \
--enable=rhel-8-for-x86_64-appstream-rpms
Install the modules:
$ sudo yum install python3-openstackclient ansible python3-openstacksdk python3-netaddr ansible-collections-openstack
Ensure that the python
command points to python3
:
$ sudo alternatives --set python /usr/bin/python3
Download Ansible playbooks that you can use to install OKD on your own OpenStack infrastructure.
The curl command-line tool is available on your machine.
To download the playbooks to your working directory, run the following script from a command line:
$ xargs -n 1 curl -O <<< '
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/bootstrap.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/common.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/compute-nodes.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/control-plane.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-bootstrap.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-compute-nodes.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-control-plane.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-network.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-security-groups.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/down-containers.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/inventory.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/network.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/security-groups.yaml
https://raw.githubusercontent.com/openshift/installer/release-4.16/upi/openstack/update-network-resources.yaml'
The playbooks are downloaded to your machine.
During the installation process, you can modify the playbooks to configure your deployment. Retain all playbooks for the life of your cluster. You must have the playbooks to remove your OKD cluster from OpenStack. |
You must match any edits you make in the |
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 500 MB of local disk space.
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
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 Container Catalog registry, such as image streams and Operators, are not available.
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.
The OKD installation program requires that a Fedora CoreOS (FCOS) image be present in the OpenStack cluster. Retrieve the latest FCOS image, then upload it using the OpenStack CLI.
The OpenStack CLI is installed.
Log in to the Red Hat Customer Portal’s Product Downloads page.
Under Version, select the most recent release of OKD 4.16 for Fedora 8.
The FCOS images might not change with every release of OKD. You must download images with the highest version that is less than or equal to the OKD version that you install. Use the image versions that match your OKD version if they are available. |
Download the Fedora CoreOS (FCOS) - OpenStack Image (QCOW).
Decompress the image.
You must decompress the OpenStack image before the cluster can use it. The name of the downloaded file might not contain a compression extension, like
|
From the image that you downloaded, create an image that is named rhcos
in your cluster by using the OpenStack CLI:
$ openstack image create --container-format=bare --disk-format=qcow2 --file rhcos-${RHCOS_VERSION}-openstack.qcow2 rhcos
Depending on your OpenStack environment, you might be able to upload the image in either .raw or .qcow2 formats. If you use Ceph, you must use the .raw format.
|
If the installation program finds multiple images with the same name, it chooses one of them at random. To avoid this behavior, create unique names for resources in OpenStack. |
After you upload the image to OpenStack, it is usable in the installation process.
The OKD installation process requires external network access. You must provide an external network value to it, or deployment fails. Before you begin the process, verify that a network with the external router type exists in OpenStack.
Using the OpenStack CLI, verify the name and ID of the 'External' network:
$ openstack network list --long -c ID -c Name -c "Router Type"
+--------------------------------------+----------------+-------------+
| ID | Name | Router Type |
+--------------------------------------+----------------+-------------+
| 148a8023-62a7-4672-b018-003462f8d7dc | public_network | External |
+--------------------------------------+----------------+-------------+
A network with an external router type appears in the network list. If at least one does not, see Creating a default floating IP network and Creating a default provider network.
If the Neutron trunk service plugin is enabled, a trunk port is created by default. For more information, see Neutron trunk port. |
At deployment, all OKD machines are created in a OpenStack-tenant network. Therefore, they are not accessible directly in most OpenStack deployments.
You can configure OKD API and application access by using floating IP addresses (FIPs) during installation. You can also complete an installation without configuring FIPs, but the installer will not configure a way to reach the API or applications externally.
Create floating IP (FIP) addresses for external access to the OKD API, cluster applications, and the bootstrap process.
Using the OpenStack CLI, create the API FIP:
$ openstack floating ip create --description "API <cluster_name>.<base_domain>" <external_network>
Using the OpenStack CLI, create the apps, or Ingress, FIP:
$ openstack floating ip create --description "Ingress <cluster_name>.<base_domain>" <external_network>
By using the OpenStack CLI, create the bootstrap FIP:
$ openstack floating ip create --description "bootstrap machine" <external_network>
Add records that follow these patterns to your DNS server for the API and Ingress FIPs:
api.<cluster_name>.<base_domain>. IN A <API_FIP>
*.apps.<cluster_name>.<base_domain>. IN A <apps_FIP>
If you do not control the DNS server, you can access the cluster by adding the cluster domain names such as the following to your
The cluster domain names in the |
Add the FIPs to the
inventory.yaml
file as the values of the following
variables:
os_api_fip
os_bootstrap_fip
os_ingress_fip
If you use these values, you must also enter an external network as the value of the
os_external_network
variable in the inventory.yaml
file.
You can make OKD resources available outside of the cluster by assigning a floating IP address and updating your firewall configuration. |
You can install OKD on OpenStack without providing floating IP addresses.
In the
inventory.yaml
file, do not define the following
variables:
os_api_fip
os_bootstrap_fip
os_ingress_fip
If you cannot provide an external network, you can also leave os_external_network
blank. If you do not provide a value for os_external_network
, a router is not created for you, and, without additional action, the installer will fail to retrieve an image from Glance. Later in the installation process, when you create network resources, you must configure external connectivity on your own.
If you run the installer
with the wait-for
command
from a system that cannot reach the cluster API due to a lack of floating IP addresses or name resolution, installation fails. To prevent installation failure in these cases, you can use a proxy network or run the installer from a system that is on the same network as your machines.
You can enable name resolution by creating DNS records for the API and Ingress ports. For example:
If you do not control the DNS server, you can add the record to your |
The OKD installation program relies on a file that is called clouds.yaml
. The file describes OpenStack configuration parameters, including the project name, log in information, and authorization service URLs.
Create the clouds.yaml
file:
If your OpenStack distribution includes the Horizon web UI, generate a clouds.yaml
file in it.
Remember to add a password to the |
If your OpenStack distribution does not include the Horizon web UI, or you do not want to use Horizon, create the file yourself. For detailed information about clouds.yaml
, see Config files in the OpenStack documentation.
clouds:
shiftstack:
auth:
auth_url: http://10.10.14.42:5000/v3
project_name: shiftstack
username: <username>
password: <password>
user_domain_name: Default
project_domain_name: Default
dev-env:
region_name: RegionOne
auth:
username: <username>
password: <password>
project_name: 'devonly'
auth_url: 'https://10.10.14.22:5001/v2.0'
If your OpenStack installation uses self-signed certificate authority (CA) certificates for endpoint authentication:
Copy the certificate authority file to your machine.
Add the cacerts
key to the clouds.yaml
file. The value must be an absolute, non-root-accessible path to the CA certificate:
clouds:
shiftstack:
...
cacert: "/etc/pki/ca-trust/source/anchors/ca.crt.pem"
After you run the installer with a custom CA certificate, you can update the certificate by editing the value of the
|
Place the clouds.yaml
file in one of the following locations:
The value of the OS_CLIENT_CONFIG_FILE
environment variable
The current directory
A Unix-specific user configuration directory, for example ~/.config/openstack/clouds.yaml
A Unix-specific site configuration directory, for example /etc/openstack/clouds.yaml
The installation program searches for clouds.yaml
in that order.
Create the network resources that an OKD on OpenStack installation on your own infrastructure requires. To save time, run supplied Ansible playbooks that generate security groups, networks, subnets, routers, and ports.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
For a dual stack cluster deployment, edit the inventory.yaml
file and uncomment the os_subnet6
attribute.
On a command line, create the network resources by running the following command:
$ ansible-playbook -i inventory.yaml network.yaml
The API and Ingress VIP fields will be overwritten in the |
The resources created by the |
You can customize the OKD cluster you install on OpenStack.
You have the OKD installation program and the pull secret for your cluster.
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 openstack as the platform to target.
Specify the OpenStack external network name to use for installing the cluster.
Specify the floating IP address to use for external access to the OpenShift API.
Specify a OpenStack flavor with at least 16 GB RAM to use for control plane nodes and 8 GB RAM for compute nodes.
Select the base domain to deploy the cluster to. All DNS records will be sub-domains of this base and will also include the cluster name.
Enter a name for your cluster. The name must be 14 or fewer characters long.
Modify the install-config.yaml
file. You can find more information about the available parameters in the "Installation configuration parameters" section.
Back up the install-config.yaml
file so that you can use
it to install multiple clusters.
The |
You now have the file install-config.yaml
in the directory that you specified.
Optionally, you can deploy a cluster on a OpenStack subnet of your choice. The subnet’s GUID is passed as the value of platform.openstack.machinesSubnet
in the install-config.yaml
file.
This subnet is used as the cluster’s primary subnet. By default, nodes and ports are created on it. You can create nodes and ports on a different OpenStack subnet by setting the value of the platform.openstack.machinesSubnet
property to the subnet’s UUID.
Before you run the OKD installer with a custom subnet, verify that your configuration meets the following requirements:
The subnet that is used by platform.openstack.machinesSubnet
has DHCP enabled.
The CIDR of platform.openstack.machinesSubnet
matches the CIDR of networking.machineNetwork
.
The installation program user has permission to create ports on this network, including ports with fixed IP addresses.
Clusters that use custom subnets have the following limitations:
If you plan to install a cluster that uses floating IP addresses, the platform.openstack.machinesSubnet
subnet must be attached to a router that is connected to the externalNetwork
network.
If the platform.openstack.machinesSubnet
value is set in the install-config.yaml
file, the installation program does not create a private network or subnet for your OpenStack machines.
You cannot use the platform.openstack.externalDNS
property at the same time as a custom subnet. To add DNS to a cluster that uses a custom subnet, configure DNS on the OpenStack network.
By default, the API VIP takes x.x.x.5 and the Ingress VIP takes x.x.x.7 from your network’s CIDR block. To override these default values,
set values for |
The CIDR ranges for networks are not adjustable after cluster installation. Red Hat does not provide direct guidance on determining the range during cluster installation because it requires careful consideration of the number of created pods per namespace. |
The following example install-config.yaml
files demonstrate all of the possible OpenStack customization options.
This sample file is provided for reference only. You must obtain your install-config.yaml file by using the installation program.
|
install-config.yaml
fileapiVersion: v1
baseDomain: example.com
controlPlane:
name: master
platform: {}
replicas: 3
compute:
- name: worker
platform:
openstack:
type: ml.large
replicas: 3
metadata:
name: example
networking:
clusterNetwork:
- cidr: 10.128.0.0/14
hostPrefix: 23
machineNetwork:
- cidr: 10.0.0.0/16
serviceNetwork:
- 172.30.0.0/16
networkType: OVNKubernetes
platform:
openstack:
cloud: mycloud
externalNetwork: external
computeFlavor: m1.xlarge
apiFloatingIP: 128.0.0.1
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
install-config.yaml
fileapiVersion: v1
baseDomain: example.com
controlPlane:
name: master
platform: {}
replicas: 3
compute:
- name: worker
platform:
openstack:
type: ml.large
replicas: 3
metadata:
name: example
networking:
clusterNetwork:
- cidr: 10.128.0.0/14
hostPrefix: 23
- cidr: fd01::/48
hostPrefix: 64
machineNetwork:
- cidr: 192.168.25.0/24
- cidr: fd2e:6f44:5dd8:c956::/64
serviceNetwork:
- 172.30.0.0/16
- fd02::/112
networkType: OVNKubernetes
platform:
openstack:
cloud: mycloud
externalNetwork: external
computeFlavor: m1.xlarge
apiVIPs:
- 192.168.25.10
- fd2e:6f44:5dd8:c956:f816:3eff:fec3:5955
ingressVIPs:
- 192.168.25.132
- fd2e:6f44:5dd8:c956:f816:3eff:fe40:aecb
controlPlanePort:
fixedIPs:
- subnet:
name: openshift-dual4
- subnet:
name: openshift-dual6
network:
name: openshift-dual
fips: false
pullSecret: '{"auths": ...}'
sshKey: ssh-ed25519 AAAA...
The IP range that the installation program uses by default might not match the Neutron subnet that you create when you install OKD. If necessary, update the CIDR value for new machines by editing the installation configuration file.
You have the install-config.yaml
file that was generated by the OKD installation program.
You have Python 3 installed.
On a command line, browse to the directory that contains the install-config.yaml
and inventory.yaml
files.
From that directory, either run a script to edit the install-config.yaml
file or update the file manually:
To set the value by using a script, run the following command:
$ python -c 'import yaml
path = "install-config.yaml"
data = yaml.safe_load(open(path))
inventory = yaml.safe_load(open("inventory.yaml"))["all"]["hosts"]["localhost"]
machine_net = [{"cidr": inventory["os_subnet_range"]}]
api_vips = [inventory["os_apiVIP"]]
ingress_vips = [inventory["os_ingressVIP"]]
ctrl_plane_port = {"network": {"name": inventory["os_network"]}, "fixedIPs": [{"subnet": {"name": inventory["os_subnet"]}}]}
if inventory.get("os_subnet6"): (1)
machine_net.append({"cidr": inventory["os_subnet6_range"]})
api_vips.append(inventory["os_apiVIP6"])
ingress_vips.append(inventory["os_ingressVIP6"])
data["networking"]["networkType"] = "OVNKubernetes"
data["networking"]["clusterNetwork"].append({"cidr": inventory["cluster_network6_cidr"], "hostPrefix": inventory["cluster_network6_prefix"]})
data["networking"]["serviceNetwork"].append(inventory["service_subnet6_range"])
ctrl_plane_port["fixedIPs"].append({"subnet": {"name": inventory["os_subnet6"]}})
data["networking"]["machineNetwork"] = machine_net
data["platform"]["openstack"]["apiVIPs"] = api_vips
data["platform"]["openstack"]["ingressVIPs"] = ingress_vips
data["platform"]["openstack"]["controlPlanePort"] = ctrl_plane_port
del data["platform"]["openstack"]["externalDNS"]
open(path, "w").write(yaml.dump(data, default_flow_style=False))'
1 | Applies to dual stack (IPv4/IPv6) environments. |
To proceed with an installation that uses your own infrastructure, set the number of compute machines in the installation configuration file to zero. Later, you create these machines manually.
You have the install-config.yaml
file that was generated by the OKD installation program.
On a command line, browse to the directory that contains install-config.yaml
.
From that directory, either run a script to edit the install-config.yaml
file or update the file manually:
To set the value by using a script, run:
$ python -c '
import yaml;
path = "install-config.yaml";
data = yaml.safe_load(open(path));
data["compute"][0]["replicas"] = 0;
open(path, "w").write(yaml.dump(data, default_flow_style=False))'
To set the value manually, open the file and set the value of compute.<first entry>.replicas
to 0
.
You can deploy your OKD clusters on OpenStack with a primary network interface on a provider network. Provider networks are commonly used to give projects direct access to a public network that can be used to reach the internet. You can also share provider networks among projects as part of the network creation process.
OpenStack provider networks map directly to an existing physical network in the data center. A OpenStack administrator must create them.
In the following example, OKD workloads are connected to a data center by using a provider network:
OKD clusters that are installed on provider networks do not require tenant networks or floating IP addresses. The installer does not create these resources during installation.
Example provider network types include flat (untagged) and VLAN (802.1Q tagged).
A cluster can support as many provider network connections as the network type allows. For example, VLAN networks typically support up to 4096 connections. |
You can learn more about provider and tenant networks in the OpenStack documentation.
Before you install an OKD cluster, your OpenStack deployment and provider network must meet a number of conditions:
The OpenStack networking service (Neutron) is enabled and accessible through the OpenStack networking API.
The OpenStack networking service has the port security and allowed address pairs extensions enabled.
The provider network can be shared with other tenants.
Use the |
The OpenStack project that you use to install the cluster must own the provider network, as well as an appropriate subnet.
To learn more about creating networks on OpenStack, read the provider networks documentation. |
If the cluster is owned by the admin
user, you must run the installer as that user to create ports on the network.
Provider networks must be owned by the OpenStack project that is used to create the cluster. If they are not, the OpenStack Compute service (Nova) cannot request a port from that network. |
Verify that the provider network can reach the OpenStack metadata service IP address, which is 169.254.169.254
by default.
Depending on your OpenStack SDN and networking service configuration, you might need to provide the route when you create the subnet. For example:
$ openstack subnet create --dhcp --host-route destination=169.254.169.254/32,gateway=192.0.2.2 ...
Optional: To secure the network, create role-based access control (RBAC) rules that limit network access to a single project.
You can deploy an OKD cluster that has its primary network interface on an OpenStack provider network.
Your OpenStack deployment is configured as described by "OpenStack provider network requirements for cluster installation".
In a text editor, open the install-config.yaml
file.
Set the value of the platform.openstack.apiVIPs
property to the IP address for the API VIP.
Set the value of the platform.openstack.ingressVIPs
property to the IP address for the Ingress VIP.
Set the value of the platform.openstack.machinesSubnet
property to the UUID of the provider network subnet.
Set the value of the networking.machineNetwork.cidr
property to the CIDR block of the provider network subnet.
The |
...
platform:
openstack:
apiVIPs: (1)
- 192.0.2.13
ingressVIPs: (1)
- 192.0.2.23
machinesSubnet: fa806b2f-ac49-4bce-b9db-124bc64209bf
# ...
networking:
machineNetwork:
- cidr: 192.0.2.0/24
1 | In OKD 4.12 and later, the apiVIP and ingressVIP configuration settings are deprecated. Instead, use a list format to enter values in the apiVIPs and ingressVIPs configuration settings. |
You cannot set the |
When you deploy the cluster, the installer uses the install-config.yaml
file to deploy the cluster on the provider network.
You can add additional networks, including provider networks, to the After you deploy your cluster, you can attach pods to additional networks. For more information, see Understanding multiple networks. |
Because you must modify some cluster definition files and manually start the cluster machines, you must generate the Kubernetes manifest and Ignition config files that the cluster needs to configure the machines.
The installation configuration file transforms into the Kubernetes manifests. The manifests wrap into the Ignition configuration files, which are later used to configure the cluster machines.
|
You obtained the OKD installation program.
You created the install-config.yaml
installation configuration file.
Change to the directory that contains the OKD installation program and generate the Kubernetes manifests for the cluster:
$ ./openshift-install create manifests --dir <installation_directory> (1)
1 | For <installation_directory> , specify the installation directory that
contains the install-config.yaml file you created. |
Remove the Kubernetes manifest files that define the control plane machines, compute machine sets, and control plane machine sets:
$ rm -f openshift/99_openshift-cluster-api_master-machines-*.yaml openshift/99_openshift-cluster-api_worker-machineset-*.yaml openshift/99_openshift-machine-api_master-control-plane-machine-set.yaml
Because you create and manage these resources yourself, you do not have to initialize them.
You can preserve the compute machine set files to create compute machines by using the machine API, but you must update references to them to match your environment.
Check that the mastersSchedulable
parameter in the <installation_directory>/manifests/cluster-scheduler-02-config.yml
Kubernetes manifest file is set to false
. This setting prevents pods from being scheduled on the control plane machines:
Open the <installation_directory>/manifests/cluster-scheduler-02-config.yml
file.
Locate the mastersSchedulable
parameter and ensure that it is set to false
.
Save and exit the file.
To create the Ignition configuration files, run the following command from the directory that contains the installation program:
$ ./openshift-install create ignition-configs --dir <installation_directory> (1)
1 | For <installation_directory> , specify the same installation directory. |
Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory. The kubeadmin-password
and kubeconfig
files are created in the ./<installation_directory>/auth
directory:
. ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign
Export the metadata file’s infraID
key as an environment variable:
$ export INFRA_ID=$(jq -r .infraID metadata.json)
Extract the infraID key from metadata.json and use it as a prefix for all of the OpenStack resources that you create. By doing so, you avoid name conflicts when making multiple deployments in the same project.
|
The OKD installation process relies on bootstrap machines that are created from a bootstrap Ignition configuration file.
Edit the file and upload it. Then, create a secondary bootstrap Ignition configuration file that OpenStack uses to download the primary file.
You have the bootstrap Ignition file that the installer program generates, bootstrap.ign
.
The infrastructure ID from the installer’s metadata file is set as an environment variable ($INFRA_ID
).
If the variable is not set, see Creating the Kubernetes manifest and Ignition config files.
You have an HTTP(S)-accessible way to store the bootstrap Ignition file.
The documented procedure uses the OpenStack image service (Glance), but you can also use the OpenStack storage service (Swift), Amazon S3, an internal HTTP server, or an ad hoc Nova server.
Run the following Python script. The script modifies the bootstrap Ignition file to set the hostname and, if available, CA certificate file when it runs:
import base64
import json
import os
with open('bootstrap.ign', 'r') as f:
ignition = json.load(f)
files = ignition['storage'].get('files', [])
infra_id = os.environ.get('INFRA_ID', 'openshift').encode()
hostname_b64 = base64.standard_b64encode(infra_id + b'-bootstrap\n').decode().strip()
files.append(
{
'path': '/etc/hostname',
'mode': 420,
'contents': {
'source': 'data:text/plain;charset=utf-8;base64,' + hostname_b64
}
})
ca_cert_path = os.environ.get('OS_CACERT', '')
if ca_cert_path:
with open(ca_cert_path, 'r') as f:
ca_cert = f.read().encode()
ca_cert_b64 = base64.standard_b64encode(ca_cert).decode().strip()
files.append(
{
'path': '/opt/openshift/tls/cloud-ca-cert.pem',
'mode': 420,
'contents': {
'source': 'data:text/plain;charset=utf-8;base64,' + ca_cert_b64
}
})
ignition['storage']['files'] = files;
with open('bootstrap.ign', 'w') as f:
json.dump(ignition, f)
Using the OpenStack CLI, create an image that uses the bootstrap Ignition file:
$ openstack image create --disk-format=raw --container-format=bare --file bootstrap.ign <image_name>
Get the image’s details:
$ openstack image show <image_name>
Make a note of the file
value; it follows the pattern v2/images/<image_ID>/file
.
Verify that the image you created is active. |
Retrieve the image service’s public address:
$ openstack catalog show image
Combine the public address with the image file
value and save the result as the storage location. The location follows the pattern <image_service_public_URL>/v2/images/<image_ID>/file
.
Generate an auth token and save the token ID:
$ openstack token issue -c id -f value
Insert the following content into a file called $INFRA_ID-bootstrap-ignition.json
and edit the placeholders to match your own values:
{
"ignition": {
"config": {
"merge": [{
"source": "<storage_url>", (1)
"httpHeaders": [{
"name": "X-Auth-Token", (2)
"value": "<token_ID>" (3)
}]
}]
},
"security": {
"tls": {
"certificateAuthorities": [{
"source": "data:text/plain;charset=utf-8;base64,<base64_encoded_certificate>" (4)
}]
}
},
"version": "3.2.0"
}
}
1 | Replace the value of ignition.config.merge.source with the bootstrap Ignition file storage URL. |
2 | Set name in httpHeaders to "X-Auth-Token" . |
3 | Set value in httpHeaders to your token’s ID. |
4 | If the bootstrap Ignition file server uses a self-signed certificate, include the base64-encoded certificate. |
Save the secondary Ignition config file.
The bootstrap Ignition data will be passed to OpenStack during installation.
The bootstrap Ignition file contains sensitive information, like clouds.yaml credentials. Ensure that you store it in a secure place, and delete it after you complete the installation process.
|
Installing OKD on OpenStack on your own infrastructure requires control plane Ignition config files. You must create multiple config files.
As with the bootstrap Ignition configuration, you must explicitly define a hostname for each control plane machine. |
The infrastructure ID from the installation program’s metadata file is set as an environment variable ($INFRA_ID
).
If the variable is not set, see "Creating the Kubernetes manifest and Ignition config files".
On a command line, run the following Python script:
$ for index in $(seq 0 2); do
MASTER_HOSTNAME="$INFRA_ID-master-$index\n"
python -c "import base64, json, sys;
ignition = json.load(sys.stdin);
storage = ignition.get('storage', {});
files = storage.get('files', []);
files.append({'path': '/etc/hostname', 'mode': 420, 'contents': {'source': 'data:text/plain;charset=utf-8;base64,' + base64.standard_b64encode(b'$MASTER_HOSTNAME').decode().strip(), 'verification': {}}, 'filesystem': 'root'});
storage['files'] = files;
ignition['storage'] = storage
json.dump(ignition, sys.stdout)" <master.ign >"$INFRA_ID-master-$index-ignition.json"
done
You now have three control plane Ignition files: <INFRA_ID>-master-0-ignition.json
, <INFRA_ID>-master-1-ignition.json
,
and <INFRA_ID>-master-2-ignition.json
.
Update the network resources that an OKD on OpenStack installation on your own infrastructure requires.
Python 3 is installed on your machine.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
Optional: Add an external network value to the inventory.yaml
playbook:
inventory.yaml
Ansible Playbook...
# The public network providing connectivity to the cluster. If not
# provided, the cluster external connectivity must be provided in another
# way.
# Required for os_api_fip, os_ingress_fip, os_bootstrap_fip.
os_external_network: 'external'
...
If you did not provide a value for |
Optional: Add external network and floating IP (FIP) address values to the inventory.yaml
playbook:
inventory.yaml
Ansible Playbook...
# OpenShift API floating IP address. If this value is non-empty, the
# corresponding floating IP will be attached to the Control Plane to
# serve the OpenShift API.
os_api_fip: '203.0.113.23'
# OpenShift Ingress floating IP address. If this value is non-empty, the
# corresponding floating IP will be attached to the worker nodes to serve
# the applications.
os_ingress_fip: '203.0.113.19'
# If this value is non-empty, the corresponding floating IP will be
# attached to the bootstrap machine. This is needed for collecting logs
# in case of install failure.
os_bootstrap_fip: '203.0.113.20'
If you do not define values for If you do not define a value for See "Enabling access to the environment" for more information. |
On a command line, create security groups by running the security-groups.yaml
playbook:
$ ansible-playbook -i inventory.yaml security-groups.yaml
On a command line, update the network resources by running the update-network-resources.yaml
playbook:
$ ansible-playbook -i inventory.yaml update-network-resources.yaml (1)
1 | This playbook will add tags to the network, subnets, ports, and router. It also attaches floating IP addresses to the API and Ingress ports and sets the security groups for those ports. |
Optional: If you want to control the default resolvers that Nova servers use, run the OpenStack CLI command:
$ openstack subnet set --dns-nameserver <server_1> --dns-nameserver <server_2> "$INFRA_ID-nodes"
Optional: You can use the inventory.yaml
file that you created to customize your installation. For example, you can deploy a cluster that uses bare metal machines.
If you want your cluster to use bare metal machines, modify the
inventory.yaml
file. Your cluster can have both control plane and compute machines running on bare metal, or just compute machines.
Be sure that your |
The OpenStack Bare Metal service (Ironic) is enabled and accessible via the OpenStack Compute API.
Bare metal is available as a OpenStack flavor.
If your cluster runs on an OpenStack version that is more than 16.1.6 and less than 16.2.4, bare metal workers do not function due to a known issue that causes the metadata service to be unavailable for services on OKD nodes.
The OpenStack network supports both VM and bare metal server attachment.
If you want to deploy the machines on a pre-existing network, a OpenStack subnet is provisioned.
If you want to deploy the machines on an installer-provisioned network, the OpenStack Bare Metal service (Ironic) is able to listen for and interact with Preboot eXecution Environment (PXE) boot machines that run on tenant networks.
You created an inventory.yaml
file as part of the OKD installation process.
In the inventory.yaml
file, edit the flavors for machines:
If you want to use bare-metal control plane machines, change the value of os_flavor_master
to a bare metal flavor.
Change the value of os_flavor_worker
to a bare metal flavor.
inventory.yaml
fileall:
hosts:
localhost:
ansible_connection: local
ansible_python_interpreter: "{{ansible_playbook_python}}"
# User-provided values
os_subnet_range: '10.0.0.0/16'
os_flavor_master: 'my-bare-metal-flavor' (1)
os_flavor_worker: 'my-bare-metal-flavor' (2)
os_image_rhcos: 'rhcos'
os_external_network: 'external'
...
1 | If you want to have bare-metal control plane machines, change this value to a bare metal flavor. |
2 | Change this value to a bare metal flavor to use for compute machines. |
Use the updated inventory.yaml
file to complete the installation process.
Machines that are created during deployment use the flavor that you
added to the file.
The installer may time out while waiting for bare metal machines to boot. If the installer times out, restart and then complete the deployment by using the
|
Create a bootstrap machine and give it the network access it needs to run on OpenStack. Red Hat provides an Ansible playbook that you run to simplify this process.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
The inventory.yaml
, common.yaml
, and bootstrap.yaml
Ansible playbooks are in a common directory.
The metadata.json
file that the installation program created is in the same directory as the Ansible playbooks.
On a command line, change the working directory to the location of the playbooks.
On a command line, run the bootstrap.yaml
playbook:
$ ansible-playbook -i inventory.yaml bootstrap.yaml
After the bootstrap server is active, view the logs to verify that the Ignition files were received:
$ openstack console log show "$INFRA_ID-bootstrap"
Create three control plane machines by using the Ignition config files that you generated. Red Hat provides an Ansible playbook that you run to simplify this process.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
The infrastructure ID from the installation program’s metadata file is set as an environment variable ($INFRA_ID
).
The inventory.yaml
, common.yaml
, and control-plane.yaml
Ansible playbooks are in a common directory.
You have the three Ignition files that were created in "Creating control plane Ignition config files".
On a command line, change the working directory to the location of the playbooks.
If the control plane Ignition config files are not already in your working directory, copy them into it.
On a command line, run the control-plane.yaml
playbook:
$ ansible-playbook -i inventory.yaml control-plane.yaml
Run the following command to monitor the bootstrapping process:
$ openshift-install wait-for bootstrap-complete
You will see messages that confirm that the control plane machines are running and have joined the cluster:
INFO API v1.29.4 up
INFO Waiting up to 30m0s for bootstrapping to complete...
...
INFO It is now safe to remove the bootstrap resources
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.
You deployed an OKD cluster.
You installed the oc
CLI.
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
system:admin
Delete the bootstrap resources that you no longer need.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
The inventory.yaml
, common.yaml
, and down-bootstrap.yaml
Ansible playbooks are in a common directory.
The control plane machines are running.
If you do not know the status of the machines, see "Verifying cluster status".
On a command line, change the working directory to the location of the playbooks.
On a command line, run the down-bootstrap.yaml
playbook:
$ ansible-playbook -i inventory.yaml down-bootstrap.yaml
The bootstrap port, server, and floating IP address are deleted.
If you did not disable the bootstrap Ignition file URL earlier, do so now. |
After standing up the control plane, create compute machines. Red Hat provides an Ansible playbook that you run to simplify this process.
You downloaded the modules in "Downloading playbook dependencies".
You downloaded the playbooks in "Downloading the installation playbooks".
The inventory.yaml
, common.yaml
, and compute-nodes.yaml
Ansible playbooks are in a common directory.
The metadata.json
file that the installation program created is in the same directory as the Ansible playbooks.
The control plane is active.
On a command line, change the working directory to the location of the playbooks.
On a command line, run the playbook:
$ ansible-playbook -i inventory.yaml compute-nodes.yaml
Approve the certificate signing requests for the machines.
When you add machines to a cluster, two pending certificate signing requests (CSRs) are generated for each machine that you added. You must confirm that these CSRs are approved or, if necessary, approve them yourself. The client requests must be approved first, followed by the server requests.
You added machines to your cluster.
Confirm that the cluster recognizes the machines:
$ oc get nodes
NAME STATUS ROLES AGE VERSION
master-0 Ready master 63m v1.29.4
master-1 Ready master 63m v1.29.4
master-2 Ready master 64m v1.29.4
The output lists all of the machines that you created.
The preceding output might not include the compute nodes, also known as worker nodes, until some CSRs are approved. |
Review the pending CSRs and ensure that you see the client requests with the Pending
or Approved
status for each machine that you added to the cluster:
$ oc get csr
NAME AGE REQUESTOR CONDITION
csr-8b2br 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending
csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending
...
In this example, two machines are joining the cluster. You might see more approved CSRs in the list.
If the CSRs were not approved, after all of the pending CSRs for the machines you added are in Pending
status, approve the CSRs for your cluster machines:
Because the CSRs rotate automatically, approve your CSRs within an hour of adding the machines to the cluster. If you do not approve them within an hour, the certificates will rotate, and more than two certificates will be present for each node. You must approve all of these certificates. After the client CSR is approved, the Kubelet creates a secondary CSR for the serving certificate, which requires manual approval. Then, subsequent serving certificate renewal requests are automatically approved by the |
For clusters running on platforms that are not machine API enabled, such as bare metal and other user-provisioned infrastructure, you must implement a method of automatically approving the kubelet serving certificate requests (CSRs). If a request is not approved, then the |
To approve them individually, run the following command for each valid CSR:
$ oc adm certificate approve <csr_name> (1)
1 | <csr_name> is the name of a CSR from the list of current CSRs. |
To approve all pending CSRs, run the following command:
$ oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs --no-run-if-empty oc adm certificate approve
Some Operators might not become available until some CSRs are approved. |
Now that your client requests are approved, you must review the server requests for each machine that you added to the cluster:
$ oc get csr
NAME AGE REQUESTOR CONDITION
csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending
csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending
...
If the remaining CSRs are not approved, and are in the Pending
status, approve the CSRs for your cluster machines:
To approve them individually, run the following command for each valid CSR:
$ oc adm certificate approve <csr_name> (1)
1 | <csr_name> is the name of a CSR from the list of current CSRs. |
To approve all pending CSRs, run the following command:
$ oc get csr -o go-template='{{range .items}}{{if not .status}}{{.metadata.name}}{{"\n"}}{{end}}{{end}}' | xargs oc adm certificate approve
After all client and server CSRs have been approved, the machines have the Ready
status. Verify this by running the following command:
$ oc get nodes
NAME STATUS ROLES AGE VERSION
master-0 Ready master 73m v1.29.4
master-1 Ready master 73m v1.29.4
master-2 Ready master 74m v1.29.4
worker-0 Ready worker 11m v1.29.4
worker-1 Ready worker 11m v1.29.4
It can take a few minutes after approval of the server CSRs for the machines to transition to the |
For more information on CSRs, see Certificate Signing Requests.
Verify that the OKD installation is complete.
You have the installation program (openshift-install
)
On a command line, enter:
$ openshift-install --log-level debug wait-for install-complete
The program outputs the console URL, as well as the administrator’s login information.
See About remote health monitoring for more information about the Telemetry service
If necessary, you can opt out of remote health reporting.
If you need to enable external access to node ports, configure ingress cluster traffic by using a node port.
If you did not configure OpenStack to accept application traffic over floating IP addresses, configure OpenStack access with floating IP addresses.