Installing a cluster quickly on GCP

    • Review details about the OKD installation and update processes.

    • to host the cluster.

    • If you use a firewall, you must configure it to allow the sites that your cluster requires access to.

    • If you do not allow the system to manage identity and access management (IAM), then a cluster administrator can . Manual mode can also be used in environments where the cloud IAM APIs are not reachable.

    Generating an SSH private key and adding it to the agent

    If you want to perform installation debugging or disaster recovery on your cluster, you must provide an SSH key to both your and the installation program. You can use this key to access the bootstrap machine in a public cluster to troubleshoot installation issues.

    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 .

    On clusters running Fedora CoreOS (FCOS), the SSH keys specified in the Ignition config files are written to the /home/core/.ssh/authorized_keys.d/core file. However, the Machine Config Operator manages SSH keys in the /home/core/.ssh/authorized_keys file and configures sshd to ignore the /home/core/.ssh/authorized_keys.d/core file. As a result, newly provisioned OKD nodes are not accessible using SSH until the Machine Config Operator reconciles the machine configs with the authorized_keys file. After you can access the nodes using SSH, you can delete the /home/core/.ssh/authorized_keys.d/core file.

    Procedure

    1. 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:

      1Specify the path and file name, such as ~/.ssh/id_rsa, of the new SSH key. If you have an existing key pair, ensure your public key is in the your ~/.ssh directory.

      Running this command generates an SSH key that does not require a password in the location that you specified.

      If you plan to install an OKD cluster that uses FIPS Validated / Modules in Process cryptographic libraries on the x86_64 architecture, do not create a key that uses the ed25519 algorithm. Instead, create a key that uses the rsa or ecdsa algorithm.

    2. Start the ssh-agent process as a background task:

      1. $ eval "$(ssh-agent -s)"

      Example output

      1. Agent pid 31874

    3. Add your SSH private key to the ssh-agent:

      1. $ ssh-add <path>/<file_name> (1)

      Example output

      1. Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
      1Specify the path and file name for your SSH private key, such as ~/.ssh/id_rsa

    4. Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to the full path to your service account private key file.

      1. $ export GOOGLE_APPLICATION_CREDENTIALS="<your_service_account_file>"

    5. Verify that the credentials were applied.

    Next steps

    • When you install OKD, provide the SSH public key to the installation program.

    Before you install OKD, download the installation file on a local computer.

    Prerequisites

    • You have a computer that runs Linux or macOS, with 500 MB of local disk space

    Procedure

    1. 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.

    2. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:

      1. $ tar xvf openshift-install-linux.tar.gz

    3. From the page on the Red Hat OpenShift Cluster Manager site, download your installation pull secret as a .txt file. This pull secret allows you to authenticate with the services that are provided by the included authorities, including Quay.io, which serves the container images for OKD components.

      Using a pull secret from the Red Hat OpenShift Cluster Manager site is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use {"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}} as the pull secret when prompted during the installation.

      If you do not use the pull secret from the Red Hat OpenShift Cluster Manager site:

      • Red Hat Operators are not available.

      • Content from the Red Hat Container Catalog registry, such as image streams and Operators, are not available.

    Deploying the cluster

    You can install OKD on a compatible cloud platform.

    You can run the create cluster command of the installation program only once, during initial installation.

    Prerequisites

    • Obtain the OKD installation program and the pull secret for your cluster.

    Procedure

    1. Remove any existing GCP credentials that do not use the service account key for the GCP account that you configured for your cluster and that are stored in the following locations:

      • The GOOGLE_CREDENTIALS, GOOGLE_CLOUD_KEYFILE_JSON, or GCLOUD_KEYFILE_JSON environment variables

      • The ~/.gcp/osServiceAccount.json file

      • The gcloud cli default credentials

    2. Change to the directory that contains the installation program and initialize the cluster deployment:

      2.     --log-level=info (2)

      Specify an empty directory. Some installation assets, like bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier OKD version.

      Provide values at the prompts:

      1. 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 ssh-agent process uses.

      2. Select gcp as the platform to target.

      3. If you have not configured the service account key for your GCP account on your computer, you must obtain it from GCP and paste the contents of the file or enter the absolute path to the file.

      4. Select the project ID to provision the cluster in. The default value is specified by the service account that you configured.

      5. Select the region to deploy the cluster to.

      6. Select the base domain to deploy the cluster to. The base domain corresponds to the public DNS zone that you created for your cluster.

      7. Enter a descriptive name for your cluster. If you provide a name that is longer than 6 characters, only the first 6 characters will be used in the infrastructure ID that is generated from the cluster name.

      8. Paste the pull secret that you obtained from the Pull Secret page on the Red Hat OpenShift Cluster Manager site.

        • If you do not have a pull secret from the Red Hat OpenShift Cluster Manager site, you can paste the pull secret another private registry.

        • If you do not need the cluster to pull images from a private registry, you can paste {"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}} as the pull secret.

    1. <table><tbody><tr><td><i title="Note"></i></td><td><div><p>If the cloud provider account that you configured on your host does not have sufficient permissions to deploy the cluster, the installation process stops, and the missing permissions are displayed.</p></div></td></tr></tbody></table>
    3. When the cluster deployment completes, directions for accessing your cluster, including a link to its web console and credentials for the `kubeadmin` user, display in your terminal.
    5. Example output
    7. ```
    8. ...
    9. INFO Install complete!
    10. INFO To access the cluster as the system:admin user when using 'oc', run 'export KUBECONFIG=/home/myuser/install_dir/auth/kubeconfig'
    11. INFO Access the OpenShift web-console here: https://console-openshift-console.apps.mycluster.example.com
    12. INFO Login to the console with user: "kubeadmin", and password: "4vYBz-Ee6gm-ymBZj-Wt5AL"
    13. INFO Time elapsed: 36m22s
    14. ```
    17. <table><tbody><tr><td><i title="Important"></i></td><td><div><p>The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending <code>node-bootstrapper</code> certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for <em>Recovering from expired control plane certificates</em> for more information.</p></div></td></tr></tbody></table>
    19. <table><tbody><tr><td><i title="Important"></i></td><td><div><p>You must not delete the installation program or the files that the installation program creates. Both are required to delete the cluster.</p></div></td></tr></tbody></table>

    1. Optional: You can reduce the number of permissions for the service account that you used to install the cluster.

      • If you assigned the Owner role to your service account, you can remove that role and replace it with the Viewer role.

      • If you included the Service Account Key Admin role, you can remove it.

    You can install the OpenShift CLI (oc) in order to interact with OKD from a command-line interface. You can install on Linux, Windows, or macOS.

    If you installed an earlier version of oc, you cannot use it to complete all of the commands in OKD 4.6. Download and install the new version of oc.

    You can install the OpenShift CLI (oc) binary on Linux by using the following procedure.

    Procedure

    2. Download oc.tar.gz.

    3. Unpack the archive:

      1. $ tar xvzf <file>

    4. Place the oc binary in a directory that is on your PATH.

      To check your PATH, execute the following command:

      1. $ echo $PATH

    After you install the OpenShift CLI, it is available using the oc command:

    You can install the OpenShift CLI (oc) binary on Windows by using the following procedure.

    Procedure

    1. Navigate to and choose the folder for your operating system and architecture.

    2. Download oc.zip.

    3. Unzip the archive with a ZIP program.

    4. Move the oc binary to a directory that is on your PATH.

      To check your PATH, open the command prompt and execute the following command:

      1. C:\> path

    After you install the OpenShift CLI, it is available using the oc command:

    1. C:\> oc <command>

    You can install the OpenShift CLI (oc) binary on macOS by using the following procedure.

    Procedure

    1. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.

    2. Download oc.tar.gz.

    3. Unpack and unzip the archive.

    4. Move the oc binary to a directory on your PATH.

      To check your PATH, open a terminal and execute the following command:

      1. $ echo $PATH

    After you install the OpenShift CLI, it is available using the oc command:

    1. $ oc <command>

    Logging in to the cluster by using the CLI

    You can log in to your cluster as a default system user by exporting the cluster kubeconfig file. The kubeconfig file contains information about the cluster that is used by the CLI to connect a client to the correct cluster and API server. The file is specific to a cluster and is created during OKD installation.

    Prerequisites

    • You deployed an OKD cluster.

    • You installed the oc CLI.

    Procedure

    1. Export the kubeadmin credentials:

      1. $ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)
      1For <installation_directory>, specify the path to the directory that you stored the installation files in.

    2. Verify you can run oc commands successfully using the exported configuration:

      Example output

    Additional resources

    Additional resources

    • See for more information about the Telemetry service