$ ssh-keygen -t rsa -b 4096 -N '' \ -f <path>/<file_name> (1)
In OpenShift Container Platform version 4.2, you can install a cluster on Google Cloud Platform (GCP) that uses the default configuration options.
Review details about the OpenShift Container Platform installation and update processes.
Configure a GCP account to host the cluster.
If you use a firewall, you must configure it to allow the sites that your cluster requires access to.
In OpenShift Container Platform 4.2, 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 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.
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.
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
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
Running this command generates an SSH key that does not require a password in the location that you specified.
ssh-agent process as a background task:
$ eval "$(ssh-agent -s)" Agent pid 31874
Add your SSH private key to the
$ 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
When you install OpenShift Container Platform, provide the SSH public key to the installation program.
Before you install OpenShift Container Platform, 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
Pull Secret page on the Red Hat OpenShift Cluster Manager site, download your installation pull secret as a
.txt file or copy it to your
clipboard. 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 OpenShift Container Platform components.
You can install OpenShift Container Platform on a compatible cloud platform.
You can run the
Configure an account with the cloud platform that hosts your cluster.
Obtain the OpenShift Container Platform installation program and the pull secret for your cluster.
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:
gcloud cli default credentials
Run the installation program:
$ ./openshift-install create cluster --dir=<installation_directory> \ (1) --log-level=info (2)
|2||To view different installation details, specify
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 OpenShift Container Platform version.
Provide values at the prompts:
Optional: Select an SSH key to use to access your cluster machines.
For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery on, specify an SSH key that your
Select gcp as the platform to target.
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.
Select the project ID to provision the cluster in. The default value is specified by the service account that you configured.
Select the region to deploy the cluster to.
Select the base domain to deploy the cluster to. The base domain corresponds to the public DNS zone that you created for your cluster.
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.
Paste the pull secret that you obtained from the Pull Secret page on the Red Hat OpenShift Cluster Manager site.
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.
When the cluster deployment completes, directions for accessing your cluster,
including a link to its web console and credentials for the
display in your terminal.
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.
You must not delete the installation program or the files that the installation program creates. Both are required to delete the cluster.
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
If you included the
Service Account Key Admin role,
you can remove it.
You can install the CLI in order to interact with OpenShift Container Platform 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
After you install the CLI, it is available using the
$ oc <command>
You can log in to your cluster as a default system user by exporting the cluster
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 OpenShift Container Platform installation.
Deploy an OpenShift Container Platform cluster.
$ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)
Verify you can run
oc commands successfully using the exported configuration:
$ oc whoami system:admin