Install OKD¶

Plan your installation¶

OKD supports 2 types of cluster install options:

• Installer-provisioned infrastructure (IPI)
• User-provisioned infrastructure (UPI)

IPI is a largely automated install process, where the installer is responsible for setting up the infrastructure, where UPI requires you to set up the base infrastructure. You can find further details in the documentation

OKD support installation on bare metal hardware, a number of virtualization platforms and a number of cloud platforms, so you need to decide where you want to install OKD and that your environment has sufficient resources for the cluster to operate. The documentation has more information to help you plan your installation.

If you want to install on a typical developer workstation, then Code-Ready Containers may be a better options, as that is a cut-down installation designed to run on limited compute and memory resources.

You can find examples of OKD installations, setup by OKD community members in the guides section.

Getting Started¶

To obtain the openshift installer and client, visit releases for stable versions or https://amd64.origin.releases.ci.openshift.org/ for nightlies.

You can verify the downloads using:

curl https://www.okd.io/vrutkovs.pub | gpg --import

    gpg: key 3D54B6723B20C69F: public key "Vadim Rutkovsky <vadim@vrutkovs.eu>" imported
    gpg: Total number processed: 1
    gpg:               imported: 1

gpg --verify sha256sum.txt.asc sha256sum.txt

gpg: Signature made Mon May 25 18:48:22 2020 CEST
gpg:                using RSA key DB861D01D4D1138A993ADC1A3D54B6723B20C69F
gpg: Good signature from "Vadim Rutkovsky <vadim@vrutkovs.eu>" [ultimate]
gpg:                 aka "Vadim Rutkovsky <vrutkovs@redhat.com>" [ultimate]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: DB86 1D01 D4D1 138A 993A  DC1A 3D54 B672 3B20 C69F

sha256sum -c sha256sum.txt

release.txt: OK
openshift-client-linux-4.4.0-0.okd-2020-05-23-055148-beta5.tar.gz: OK
openshift-client-mac-4.4.0-0.okd-2020-05-23-055148-beta5.tar.gz: OK
openshift-client-windows-4.4.0-0.okd-2020-05-23-055148-beta5.zip: OK
openshift-install-linux-4.4.0-0.okd-2020-05-23-055148-beta5.tar.gz: OK
openshift-install-mac-4.4.0-0.okd-2020-05-23-055148-beta5.tar.gz: OK

Please note that each nightly release is pruned after 72 hours. If the nightly that you installed was pruned, the cluster may be unable to pull necessary images and may show errors for various functionality (including updates).

Alternatively, if you have the openshift client oc already installed, you can use it to download and extract the openshift installer and client from our container image:

oc adm release extract --tools quay.io/openshift/okd:4.5.0-0.okd-2020-07-14-153706-ga

There are full instructions in the OKD documentation for each supported platform, but the main steps for an IPI install are:

1. extract the downloaded tarballs and copy the binaries into your PATH.
2. run the following from an empty directory:

   openshift-install create cluster
   

3. follow the prompts to create the install config
   • you will need to have cloud credentials set in your shell properly before installation.
   • you must have permission to configure the appropriate cloud resources from that account (such as VPCs, instances, and DNS records).
   • you must have already configured a public DNS zone on your chosen cloud before the install starts.
   • you will also be prompted for a pull-secret that will be made available to all of of your machines - for OKD4 you should either paste the pull-secret you use for your registry, or paste {"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}} to bypass the required value check (see bug #182).

Once the install completes successfully the console URL and an admin username and password will be printed. If your DNS records were correct, you should be able to log in to your new OKD4 cluster!

To undo the installation and delete any cloud resources created by the installer, run

openshift-install destroy cluster