TCP
In OKD version Latest, you can install a cluster on bare metal infrastructure that you provision.
|
While you might be able to follow this procedure to deploy a cluster on virtualized or cloud environments, you must be aware of additional considerations for non-bare metal platforms. Review the information in the guidelines for deploying OKD on non-tested platforms before you attempt to install an OKD cluster in such an environment. |
Review details about the OKD installation and update processes.
If you use a firewall, you must configure it to allow the sites that your cluster requires access to.
|
Be sure to also review this site list if you are configuring a proxy. |
In OKD Latest, you require access to the internet to install and entitle your cluster. The Telemetry service, which runs by default to provide metrics about cluster health and the success of updates, also requires internet access. If your cluster is connected to the internet, Telemetry runs automatically, and your cluster is registered to the Red Hat OpenShift Cluster Manager. From there, you can allocate entitlements to your cluster.
You must have internet access to:
Access the Red Hat OpenShift Cluster Manager page to download the installation program and perform subscription management and entitlement. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster. If the Telemetry service cannot entitle your cluster, you must manually entitle it on the Cluster registration page.
Access Quay.io to obtain the packages that are required to install your cluster.
Obtain the packages that are required to perform cluster updates.
|
If your cluster cannot have direct internet access, you can perform a restricted network installation on some types of infrastructure that you provision. During that process, you download the content that is required and use it to populate a mirror registry with the packages that you need to install a cluster and generate the installation program. With some installation types, the environment that you install your cluster in will not require internet access. Before you update the cluster, you update the content of the mirror registry. |
For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.
The smallest OKD clusters require the following hosts:
One temporary bootstrap machine
Three control plane, or master, machines
At least two compute machines, which are also known as worker machines
|
The cluster requires the bootstrap machine to deploy the OKD cluster on the three control plane machines. You can remove the bootstrap machine after you install the cluster. |
|
To maintain high availability of your cluster, use separate physical hosts for these cluster machines. |
The bootstrap, control plane, and compute machines must use the Red Hat Enterprise Linux CoreOS (RHCOS) as the operating system.
Note that RHCOS is based on Red Hat Enterprise Linux 8 and inherits all of its hardware certifications and requirements. See Red Hat Enterprise Linux technology capabilities and limits.
All the Red Hat Enterprise Linux CoreOS (RHCOS) machines require network in initramfs during boot to fetch Ignition config files from the Machine Config Server.
During the initial boot, the machines require either a DHCP server
or that static IP addresses be set in order to establish a network
connection to download their Ignition config files.
Each cluster machine must meet the following minimum requirements:
| Machine | Operating System | vCPU | RAM | Storage |
|---|---|---|---|---|
Bootstrap |
RHCOS |
4 |
16 GB |
120 GB |
Control plane |
RHCOS |
4 |
16 GB |
120 GB |
Compute |
RHCOS or RHEL 7.6 |
2 |
8 GB |
120 GB |
Because your cluster has limited access to automatic machine management when you
use infrastructure that you provision, you must provide a mechanism for approving
cluster certificate signing requests (CSRs) after installation. The
kube-controller-manager only approves the kubelet client CSRs. The
machine-approver cannot guarantee the validity of a serving certificate
that is requested by using kubelet credentials because it cannot confirm that
the correct machine issued the request. You must determine and implement a
method of verifying the validity of the kubelet serving certificate requests
and approving them.
Before you deploy an OKD cluster that uses user-provisioned infrastructure, you must create the underlying infrastructure.
Review the OpenShift Container Platform 4.x Tested Integrations page before you create the supporting infrastructure for your cluster.
Configure DHCP or set static IP addresses on each node.
Provision the required load balancers.
Configure the ports for your machines.
Configure DNS.
Ensure network connectivity.
All the Red Hat Enterprise Linux CoreOS (RHCOS) machines require network in initramfs during boot
to fetch Ignition config from the Machine Config Server.
During the initial boot, the machines require either a DHCP server or that static IP addresses be set on each host in the cluster in order to establish a network connection, which allows them to download their Ignition config files.
It is recommended to use the DHCP server to manage the machines for the cluster long-term. Ensure that the DHCP server is configured to provide persistent IP addresses and host names to the cluster machines.
The Kubernetes API server must be able to resolve the node names of the cluster machines. If the API servers and worker nodes are in different zones, you can configure a default DNS search zone to allow the API server to resolve the node names. Another supported approach is to always refer to hosts by their fully-qualified domain names in both the node objects and all DNS requests.
You must configure the network connectivity between machines to allow cluster components to communicate. Each machine must be able to resolve the host names of all other machines in the cluster.
| Protocol | Port | Description |
|---|---|---|
TCP |
|
etcd server, peer, and metrics ports |
|
Kubernetes API |
|
|
Host level services, including the node exporter on ports |
|
|
The default ports that Kubernetes reserves |
|
|
openshift-sdn |
|
UDP |
|
VXLAN and GENEVE |
|
VXLAN and GENEVE |
|
|
Host level services, including the node exporter on ports |
|
|
Kubernetes NodePort |
The infrastructure that you provision for your cluster must meet the following network topology requirements.
|
OKD requires all nodes to have internet access to pull images for platform containers and provide telemetry data to Red Hat. |
Before you install OKD, you must provision two layer-4 load balancers. The API requires one load balancer and the default Ingress Controller needs the second load balancer to provide ingress to applications.
| Port | Machines | Internal | External | Description |
|---|---|---|---|---|
|
Bootstrap and control plane. You remove the bootstrap machine from the load balancer after the bootstrap machine initializes the cluster control plane. |
x |
x |
Kubernetes API server |
|
Bootstrap and control plane. You remove the bootstrap machine from the load balancer after the bootstrap machine initializes the cluster control plane. |
x |
Machine Config server |
|
|
The machines that run the Ingress router pods, compute, or worker, by default. |
x |
x |
HTTPS traffic |
|
The machines that run the Ingress router pods, compute, or worker by default. |
x |
x |
HTTP traffic |
|
A working configuration for the Ingress router is required for an OKD cluster. You must configure the Ingress router after the control plane initializes. |
The following DNS records are required for an OKD cluster that uses
user-provisioned infrastructure. In each record, <cluster_name> is the cluster
name and <base_domain> is the cluster base domain that you specify in the
install-config.yaml file. A complete DNS record takes the form: <component>.<cluster_name>.<base_domain>..
| Component | Record | Description | |
|---|---|---|---|
Kubernetes API |
|
This DNS A/AAAA or CNAME record must point to the load balancer for the control plane machines. This record must be resolvable by both clients external to the cluster and from all the nodes within the cluster. |
|
|
This DNS A/AAAA or CNAME record must point to the load balancer for the control plane machines. This record must be resolvable from all the nodes within the cluster.
|
||
Routes |
|
A wildcard DNS A/AAAA or CNAME record that points to the load balancer that targets the machines that run the Ingress router pods, which are the worker nodes by default. This record must be resolvable by both clients external to the cluster and from all the nodes within the cluster. |
|
etcd |
|
OKD requires DNS A/AAAA records for each etcd instance to point to the
control plane machines that host the instances. The etcd instances are
differentiated by |
|
|
For each control plane machine, OKD also requires a SRV DNS
record for etcd server on that machine with priority # _service._proto.name. TTL class SRV priority weight port target. _etcd-server-ssl._tcp.<cluster_name>.<base_domain>. 86400 IN SRV 0 10 2380 etcd-0.<cluster_name>.<base_domain> _etcd-server-ssl._tcp.<cluster_name>.<base_domain>. 86400 IN SRV 0 10 2380 etcd-1.<cluster_name>.<base_domain> _etcd-server-ssl._tcp.<cluster_name>.<base_domain>. 86400 IN SRV 0 10 2380 etcd-2.<cluster_name>.<base_domain> |
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 to the installation program.
|
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.
|
You must use a local key, not one that you configured with platform-specific approaches such as AWS key pairs. |
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 rsa -b 4096 -N '' \
-f <path>/<file_name> (1)
| 1 | Specify the path and file name, such as ~/.ssh/id_rsa, of the SSH key. |
Running this command generates an SSH key that does not require a password in the location that you specified.
Start the ssh-agent process as a background task:
$ eval "$(ssh-agent -s)" Agent pid 31874
Add your SSH private key to the ssh-agent:
$ ssh-add <path>/<file_name> (1) 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 |
When you install OKD, provide the SSH public key to the installation program. If you install a cluster on infrastructure that you provision, you must provide this key to your cluster’s machines.
Before you install OKD, download the installation file on a local computer.
You must install the cluster from a computer that uses Linux or macOS.
You need 500 MB of local disk space to download the installation program.
Access the Infrastructure Provider page on the Red Hat OpenShift Cluster Manager site. If you have a Red Hat account, log in with your credentials. If you do not, create an account.
Navigate to the page for your installation type, download the installation program for your operating system, and place the file in the directory where you will store the installation configuration files.
|
The installation program creates several files on the computer that you use to install your cluster. You must keep both the installation program and the files that the installation program creates after you finish installing the cluster. |
Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:
$ tar xvf <installation_program>.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.
You can install the CLI in order to interact with OKD using a command-line interface.
|
If you installed an earlier version of |
From the Infrastructure Provider page on the Red Hat OpenShift Cluster Manager site, navigate to the page for your installation type and click Download Command-line Tools.
Click the folder for your operating system and architecture and click the compressed file.
|
You can install |
Save the file to your file system.
Extract the compressed file.
Place it in a directory that is on your PATH.
After you install the CLI, it is available using the oc command:
$ oc <command>
For installations of OKD that use user-provisioned infrastructure, you must manually generate your installation configuration file.
Obtain the OKD installation program and the access token for your cluster.
Create an installation directory to store your required installation assets in:
$ mkdir <installation_directory>
|
You must create a 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. |
Customize the following install-config.yaml file template and save
it in the <installation_directory>.
|
You must name this configuration file |
Back up the install-config.yaml file so that you can use it to install
multiple clusters.
|
The |
install-config.yaml file for bare metalYou 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.
apiVersion: v1
baseDomain: example.com (1)
compute:
- hyperthreading: Enabled (2) (3)
name: worker
replicas: 0 (4)
controlPlane:
hyperthreading: Enabled (2) (3)
name: master (3)
replicas: 3 (5)
metadata:
name: test (6)
networking:
clusterNetwork:
- cidr: 10.128.0.0/14 (7)
hostPrefix: 23 (8)
networkType: OpenShiftSDN
serviceNetwork: (9)
- 172.30.0.0/16
platform:
none: {} (10)
fips: false (11)
pullSecret: '{"auths": ...}' (12)
sshKey: 'ssh-ed25519 AAAA...' (13)| 1 | The base domain of the cluster. All DNS records must be sub-domains of this base and include the cluster name. | ||
| 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 | You must set the value of the replicas parameter to 0. This parameter
controls the number of workers that the cluster creates and manages for you,
which are functions that the cluster does not perform when you
use user-provisioned infrastructure. You must manually deploy worker
machines for the cluster to use before you finish installing OKD. |
||
| 5 | The number of control plane machines that you add to the cluster. Because the cluster uses this values as the number of etcd endpoints in the cluster, the value must match the number of control plane machines that you deploy. | ||
| 6 | The cluster name that you specified in your DNS records. | ||
| 7 | A block of IP addresses from which Pod IP addresses are allocated. This block must not overlap with existing physical networks. These IP addresses are used for the Pod network, and if you need to access the Pods from an external network, configure load balancers and routers to manage the traffic. | ||
| 8 | The subnet prefix length to assign to each individual node. For example, if
hostPrefix is set to 23, then each node is assigned a /23 subnet out of
the given cidr, which allows for 510 (2^(32 - 23) - 2) pod IPs addresses. If
you are required to provide access to nodes from an external network, configure
load balancers and routers to manage the traffic. |
||
| 9 | The IP address pool to use for service IP addresses. You can enter only one IP address pool. If you need to access the services from an external network, configure load balancers and routers to manage the traffic. | ||
| 10 | You must set the platform to none. You cannot provide additional platform
configuration variables for bare metal infrastructure. |
||
| 11 | Whether to enable or disable FIPS mode. By default, FIPS mode is not enabled. If FIPS mode is enabled, the Red Hat Enterprise Linux CoreOS (RHCOS) machines that OKD runs on bypass the default Kubernetes cryptography suite and use the cryptography modules that are provided with RHCOS instead. | ||
| 12 | The pull secret that you obtained from the Pull Secret page on the Red Hat OpenShift Cluster Manager site. 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. | ||
| 13 | The public portion of the default SSH key for the core user in
Red Hat Enterprise Linux CoreOS (RHCOS).
|
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.
|
For bare metal installations, if you do not assign node IP addresses from the
range that is specified in the |
An existing install-config.yaml file.
Review the sites that your cluster requires access to and determine whether any need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. Add sites to the Proxy object’s spec.noProxy field to bypass the proxy if necessary.
|
The Proxy object’s |
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: http://<username>:<pswd>@<ip>:<port> (2)
noProxy: example.com (3)
additionalTrustBundle: | (4)
-----BEGIN CERTIFICATE-----
<MY_TRUSTED_CA_CERT>
-----END CERTIFICATE-----
...| 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. If
this field is not specified, then httpProxy is used for both HTTP and HTTPS
connections. The URL scheme must be http; https is currently not
supported. |
| 3 | A comma-separated list of destination domain names, domains, IP addresses, or
other network CIDRs to exclude proxying. Preface a domain with . to include
all subdomains of that domain. Use * to bypass proxy for all destinations. |
| 4 | If provided, the installation program generates a ConfigMap 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 ConfigMap that merges these contents
with the Red Hat Enterprise Linux CoreOS (RHCOS) trust bundle, and this ConfigMap is referenced in the Proxy
object’s trustedCA field. The additionalTrustBundle field is required unless
the proxy’s identity certificate is signed by an authority from the RHCOS trust
bundle. |
|
The installation program does not support the proxy |
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 Proxy object named |
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 make its machines.
|
The Ignition config files that the installation program generates contain certificates that expire after 24 hours. You must complete your cluster installation and keep the cluster running for 24 hours in a non-degraded state to ensure that the first certificate rotation has finished. |
Obtain the OKD installation program.
Create the install-config.yaml installation configuration file.
Generate the Kubernetes manifests for the cluster:
$ ./openshift-install create manifests --dir=<installation_directory> (1) WARNING There are no compute nodes specified. The cluster will not fully initialize without compute nodes. INFO Consuming "Install Config" from target directory
| 1 | For <installation_directory>, specify the installation directory that
contains the install-config.yaml file you created. |
Because you create your own compute machines later in the installation process, you can safely ignore this warning.
Modify the <installation_directory>/manifests/cluster-scheduler-02-config.yml Kubernetes manifest file to prevent 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 set its value to False.
Save and exit the file.
|
Currently, due to a Kubernetes limitation, router Pods running on control plane machines will not be reachable by the ingress load balancer. This step might not be required in a future minor version of OKD. |
Obtain the Ignition config files:
$ ./openshift-install create ignition-configs --dir=<installation_directory> (1)
| 1 | For <installation_directory>, specify the same installation directory. |
The following files are generated in the directory:
. ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign
Before you install a cluster on bare metal infrastructure that you provision, you must create RHCOS machines for it to use. Follow either the steps to use an ISO image or network PXE booting to create the machines.
Before you install a cluster on bare metal infrastructure that you provision, you must create RHCOS machines for it to use. You can use an ISO image to create the machines.
Obtain the Ignition config files for your cluster.
Have access to an HTTP server that you can access from your computer and that the machines that you create can access.
Upload the control plane, compute, and bootstrap Ignition config files that the installation program created to your HTTP server. Note the URLs of these files.
Obtain the RHCOS images that are required for your preferred method of installing operating system instances from the Product Downloads page on the Red Hat customer portal or the RHCOS image mirror page.
|
The RHCOS 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. |
You must download the ISO file and the RAW disk file. Those file names resemble the following examples:
ISO: rhcos-<version>-installer.<architecture>.iso
Compressed metal RAW: rhcos-<version>-metal.<architecture>.raw.gz
Upload either the RAW RHCOS image file to your HTTP server and note its URL.
Use the ISO to start the RHCOS installation. Use one of the following installation options:
Burn the ISO image to a disk and boot it directly.
Use ISO redirection via a LOM interface.
After the instance boots, press the TAB or E key to edit the kernel command line.
Add the parameters to the kernel command line:
coreos.inst=yes coreos.inst.install_dev=sda (1) coreos.inst.image_url=<bare_metal_image_URL> (2) coreos.inst.ignition_url=http://example.com/config.ign (3) ip=<dhcp or static IP address> (4) (5)
| 1 | Specify the block device of the system to install to. |
| 2 | Specify the URL of the RAW image that you uploaded to your server. |
| 3 | Specify the URL of the Ignition config file for this machine type. |
| 4 | Set ip=dhcp or set an individual static IP address (ip=) and DNS server (nameserver=) on each node.
For example, setting
ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none nameserver=4.4.4.41 sets:
|
| 5 | If you use multiple network interfaces or DNS servers, you can further customize the IP address configuration in the following ways:
|
Press Enter to complete the installation. After RHCOS installs, the system reboots. After the system reboots, it applies the Ignition config file that you specified.
Continue to create the machines for your cluster.
|
You must create the bootstrap and control plane machines at this time. Because some pods are deployed on compute machines by default, also create at least two compute machines before you install the cluster. |
Before you install a cluster on bare metal infrastructure that you provision, you must create RHCOS machines for it to use. You can use PXE or iPXE booting to create the machines.
Obtain the Ignition config files for your cluster.
Configure suitable PXE or iPXE infrastructure.
Have access to an HTTP server that you can access from your computer.
Upload the master, worker, and bootstrap Ignition config files that the installation program created to your HTTP server. Note the URLs of these files.
Obtain the RHCOS ISO image, compressed metal RAW image, kernel
and initramfs files from the
Product Downloads page on the Red
Hat customer portal or the
RHCOS image mirror
page.
|
The RHCOS 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. |
The file names contain the OKD version number. They resemble the following examples:
ISO: rhcos-<version>-installer.<architecture>.iso
Compressed metal RAW image: rhcos-<version>metal.<architecture>.raw.gz
kernel: rhcos-<version>-installer-kernel-<architecture>
initramfs: rhcos-<version>-installer-initramfs.<architecture>.img
Upload the compressed metal RAW image and the kernel and initramfs files
to your HTTP server.
Configure the network boot infrastructure so that the machines boot from their local disks after RHCOS is installed on them.
Configure PXE or iPXE installation for the RHCOS images.
Modify one of the following example menu entries for your environment and verify that the image and Ignition files are properly accessible:
For PXE:
DEFAULT pxeboot
TIMEOUT 20
PROMPT 0
LABEL pxeboot
KERNEL http://<HTTP_server>/rhcos-<version>-installer-kernel-<architecture> (1)
APPEND ip=dhcp rd.neednet=1 initrd=http://<HTTP_server>/rhcos-<version>-installer-initramfs.<architecture>.img console=tty0 console=ttyS0 coreos.inst=yes coreos.inst.install_dev=sda coreos.inst.image_url=http://<HTTP_server>/rhcos-<version>-metal.<architecture>.raw.gz coreos.inst.ignition_url=http://<HTTP_server>/bootstrap.ign (2) (3)
| 1 | Specify the location of the kernel file that you uploaded to your HTTP
server. |
| 2 | If you use multiple NICs, specify a single interface in the ip option.
For example, to use DHCP on a NIC that is named eno1, set ip=eno1:dhcp. |
| 3 | Specify locations of the RHCOS files that you uploaded to your
HTTP server. The initrd parameter value is the location of the initramfs file,
the coreos.inst.image_url parameter value is the location of the compressed
metal RAW image, and the coreos.inst.ignition_url parameter value is the
location of the bootstrap Ignition config file. |
For iPXE:
kernel http://<HTTP_server>/rhcos-<version>-installer-kernel-<architecture> ip=dhcp rd.neednet=1 initrd=http://<HTTP_server>/rhcos-<version>-installer-initramfs.<architecture>.img console=tty0 console=ttyS0 coreos.inst=yes coreos.inst.install_dev=sda coreos.inst.image_url=http://<HTTP_server>/rhcos-<version>-metal.<arhcitectutre>.raw.gz coreos.inst.ignition_url=http://<HTTP_server>/bootstrap.ign (1) (2) initrd http://<HTTP_server>/rhcos-<version>-installer-initramfs.<architecture>.img (3) boot
| 1 | Specify locations of the RHCOS files that you uploaded to your
HTTP server. The kernel parameter value is the location of the kernel file,
the initrd parameter value is the location of the initramfs file,
the coreos.inst.image_url parameter value is the location of the compressed
metal RAW image, and the coreos.inst.ignition_url parameter value is the
location of the bootstrap Ignition config file. |
| 2 | If you use multiple NICs, specify a single interface in the ip option.
For example, to use DHCP on a NIC that is named eno1, set ip=eno1:dhcp. |
| 3 | Specify the location of the initramfs file that you uploaded to your HTTP
server. |
Continue to create the machines for your cluster.
|
You must create the bootstrap and control plane machines at this time. Because some pods are deployed on compute machines by default, also create at least two compute machine before you install the cluster. |
To create the OKD cluster, you wait for the bootstrap process to complete on the machines that you provisioned by using the Ignition config files that you generated with the installation program.
Create the required infrastructure for the cluster.
You obtained the installation program and generated the Ignition config files for your cluster.
You used the Ignition config files to create RHCOS machines for your cluster.
Your machines have direct internet access.
Monitor the bootstrap process:
$ ./openshift-install --dir=<installation_directory> wait-for bootstrap-complete \ (1)
--log-level=info (2)
INFO Waiting up to 30m0s for the Kubernetes API at https://api.test.example.com:6443...
INFO API v1.14.6+c4799753c up
INFO Waiting up to 30m0s for the bootstrap-complete event...
| 1 | For <installation_directory>, specify the path to the directory that you
stored the installation files in. |
| 2 | To view different installation details, specify warn, debug, or
error instead of info. |
The command succeeds when the Kubernetes API server signals that it has been bootstrapped on the control plane machines.
After bootstrap process is complete, remove the bootstrap machine from the load balancer.
|
You must remove the bootstrap machine from the load balancer at this point. You can also remove or reformat the machine itself. |
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.
Deploy an OKD cluster.
Install 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
When you add machines to a cluster, two pending certificates signing request (CSRs) are generated for each machine that you added. You must confirm that these CSRs are approved or, if necessary, approve them yourself.
You added machines to your cluster.
Install the jq package.
Confirm that the cluster recognizes the machines:
$ oc get nodes NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.17.1 master-1 Ready master 63m v1.17.1 master-2 Ready master 64m v1.17.1 worker-0 NotReady worker 76s v1.17.1 worker-1 NotReady worker 70s v1.17.1
The output lists all of the machines that you created.
Review the pending certificate signing requests (CSRs) and ensure that the
you see a client and server request with 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 (1) csr-8vnps 15m system:serviceaccount:openshift-machine-config-operator:node-bootstrapper Pending csr-bfd72 5m26s system:node:ip-10-0-50-126.us-east-2.compute.internal Pending (2) csr-c57lv 5m26s system:node:ip-10-0-95-157.us-east-2.compute.internal Pending ...
| 1 | A client request CSR. |
| 2 | A server request CSR. |
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 you
approve the initial CSRs, the subsequent node client CSRs are automatically
approved by the cluster |
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. |
If all the CSRs are valid, approve them all by running the following command:
$ oc get csr -ojson | jq -r '.items[] | select(.status == {} ) | .metadata.name' | xargs oc adm certificate approve
After the control plane initializes, you must immediately configure some Operators so that they all become available.
Your control plane has initialized.
Watch the cluster components come online:
$ watch -n5 oc get clusteroperators NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.3.0 True False False 69s cloud-credential 4.3.0 True False False 12m cluster-autoscaler 4.3.0 True False False 11m console 4.3.0 True False False 46s dns 4.3.0 True False False 11m image-registry 4.3.0 True False False 5m26s ingress 4.3.0 True False False 5m36s kube-apiserver 4.3.0 True False False 8m53s kube-controller-manager 4.3.0 True False False 7m24s kube-scheduler 4.3.0 True False False 12m machine-api 4.3.0 True False False 12m machine-config 4.3.0 True False False 7m36s marketplace 4.3.0 True False False 7m54m monitoring 4.3.0 True False False 7h54s network 4.3.0 True False False 5m9s node-tuning 4.3.0 True False False 11m openshift-apiserver 4.3.0 True False False 11m openshift-controller-manager 4.3.0 True False False 5m943s openshift-samples 4.3.0 True False False 3m55s operator-lifecycle-manager 4.3.0 True False False 11m operator-lifecycle-manager-catalog 4.3.0 True False False 11m service-ca 4.3.0 True False False 11m service-catalog-apiserver 4.3.0 True False False 5m26s service-catalog-controller-manager 4.3.0 True False False 5m25s storage 4.3.0 True False False 5m30s
Configure the Operators that are not available.
On platforms that do not provide shareable object storage, the OpenShift Image
Registry Operator bootstraps itself as Removed. This allows
openshift-installer to complete installations on these platform types.
After installation, you must edit the Image Registry Operator configuration to
switch the ManagementState from Removed to Managed.
|
The Prometheus console provides an "Image Registry has been removed. |
The image-registry Operator is not initially available for platforms that do
not provide default storage. After installation, you must configure your
registry to use storage so the Registry Operator is made available.
Instructions for both configuring a PersistentVolume, which is required for production clusters, and for configuring an empty directory as the storage location, which is available for only non-production clusters, are shown.
As a cluster administrator, following installation you must configure your registry to use storage.
Cluster administrator permissions.
A cluster on bare metal.
Provision persistent storage for your cluster, such as Red Hat OpenShift Container Storage. To deploy a private image registry, your storage must provide ReadWriteMany access mode.
Must have "100Gi" capacity.
To configure your registry to use storage, change the spec.storage.pvc in
the configs.imageregistry/cluster resource.
Verify you do not have a registry Pod:
$ oc get pod -n openshift-image-registry
|
If the storage type is # cat /etc/exports /mnt/data *(rw,sync,no_wdelay,no_root_squash,insecure,fsid=0) sh-4.3# exportfs -rv exporting *:/mnt/data |
Check the registry configuration:
$ oc edit configs.imageregistry.operator.openshift.io
storage:
pvc:
claim:
Leave the claim field blank to allow the automatic creation of an
image-registry-storage PVC.
Check the clusteroperator status:
$ oc get clusteroperator image-registry
You must configure storage for the image registry Operator. For non-production clusters, you can set the image registry to an empty directory. If you do so, all images are lost if you restart the registry.
To set the image registry storage to an empty directory:
$ oc patch configs.imageregistry.operator.openshift.io cluster --type merge --patch '{"spec":{"storage":{"emptyDir":{}}}}'
|
Configure this option for only non-production clusters. |
If you run this command before the Image Registry Operator initializes its
components, the oc patch command fails with the following error:
Error from server (NotFound): configs.imageregistry.operator.openshift.io "cluster" not found
Wait a few minutes and run the command again.
After you complete the Operator configuration, you can finish installing the cluster on infrastructure that you provide.
Your control plane has initialized.
You have completed the initial Operator configuration.
Confirm that all the cluster components are online:
$ watch -n5 oc get clusteroperators NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.3.0 True False False 10m cloud-credential 4.3.0 True False False 22m cluster-autoscaler 4.3.0 True False False 21m console 4.3.0 True False False 10m dns 4.3.0 True False False 21m image-registry 4.3.0 True False False 16m ingress 4.3.0 True False False 16m kube-apiserver 4.3.0 True False False 19m kube-controller-manager 4.3.0 True False False 18m kube-scheduler 4.3.0 True False False 22m machine-api 4.3.0 True False False 22m machine-config 4.3.0 True False False 18m marketplace 4.3.0 True False False 18m monitoring 4.3.0 True False False 18m network 4.3.0 True False False 16m node-tuning 4.3.0 True False False 21m openshift-apiserver 4.3.0 True False False 21m openshift-controller-manager 4.3.0 True False False 17m openshift-samples 4.3.0 True False False 14m operator-lifecycle-manager 4.3.0 True False False 21m operator-lifecycle-manager-catalog 4.3.0 True False False 21m service-ca 4.3.0 True False False 21m service-catalog-apiserver 4.3.0 True False False 16m service-catalog-controller-manager 4.3.0 True False False 16m storage 4.3.0 True False False 16m
When all of the cluster Operators are AVAILABLE, you can complete the installation.
Monitor for cluster completion:
$ ./openshift-install --dir=<installation_directory> wait-for install-complete (1) INFO Waiting up to 30m0s for the cluster to initialize...
| 1 | For <installation_directory>, specify the path to the directory that you
stored the installation files in. |
The command succeeds when the Cluster Version Operator finishes deploying the OKD cluster from Kubernetes API server.
|
The Ignition config files that the installation program generates contain certificates that expire after 24 hours. You must keep the cluster running for 24 hours in a non-degraded state to ensure that the first certificate rotation has finished. |
Confirm that the Kubernetes API server is communicating with the Pods.
To view a list of all Pods, use the following command:
$ oc get pods --all-namespaces NAMESPACE NAME READY STATUS RESTARTS AGE openshift-apiserver-operator openshift-apiserver-operator-85cb746d55-zqhs8 1/1 Running 1 9m openshift-apiserver apiserver-67b9g 1/1 Running 0 3m openshift-apiserver apiserver-ljcmx 1/1 Running 0 1m openshift-apiserver apiserver-z25h4 1/1 Running 0 2m openshift-authentication-operator authentication-operator-69d5d8bf84-vh2n8 1/1 Running 0 5m ...
View the logs for a Pod that is listed in the output of the previous command by using the following command:
$ oc logs <pod_name> -n <namespace> (1)
| 1 | Specify the Pod name and namespace, as shown in the output of the previous command. |
If the Pod logs display, the Kubernetes API server can communicate with the cluster machines.
If necessary, you can opt out of remote health reporting.