Chapter 10. Installing a cluster into a shared VPC on Google Cloud using Infrastructure Manager templates
In OpenShift Container Platform version 4.22, you can install a cluster into a shared Virtual Private Cloud (VPC) on Google Cloud that uses infrastructure that you provide. In this context, a cluster installed into a shared VPC is a cluster that is configured to use a VPC from a project different from where the cluster is being deployed.
A shared VPC enables an organization to connect resources from multiple projects to a common VPC network. You can communicate within the organization securely and efficiently by using internal IPs from that network. For more information about shared VPC, see Shared VPC overview in the Google Cloud documentation.
The steps for performing a user-provided infrastructure installation into a shared VPC are outlined here. Several Infrastructure Manager templates are provided to assist in completing these steps or to help model your own. You are also free to create the required resources through other methods.
The steps for performing a user-provisioned infrastructure installation are provided as an example only. Installing a cluster with infrastructure you provide requires knowledge of the cloud provider and the installation process of OpenShift Container Platform. Several Infrastructure Manager templates are provided to assist in completing these steps or to help model your own. You are also free to create the required resources through other methods; the templates are just an example.
10.1. Prerequisites Copy linkLink copied to clipboard!
- You reviewed details about the OpenShift Container Platform installation and update processes.
- You read the documentation on selecting a cluster installation method and preparing it for users.
- If you use a firewall and plan to use the Telemetry service, you configured the firewall to allow the sites that your cluster requires access to.
-
If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the
kube-systemnamespace, you can manually create and maintain long-term credentials. If you want to provide your own private hosted zone, you must have created one in the service project with the DNS pattern
cluster-name.baseDomain., for exampletestCluster.example.com.. The private hosted zone must be bound to the VPC in the host project. For more information about cross-project binding, see Create a zone with cross-project binding (Google documentation). If you do not provide a private hosted zone, the installation program will provision one automatically.NoteBe sure to also review this site list if you are configuring a proxy.
10.2. Certificate signing requests management Copy linkLink copied to clipboard!
On user-provisioned infrastructure, you must provide a mechanism for approving cluster certificate signing requests (CSRs) after installation when your cluster has limited access to automatic machine management.
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.
10.3. Internet access for OpenShift Container Platform Copy linkLink copied to clipboard!
In OpenShift Container Platform 4.22, you require access to the internet to install your cluster.
You must have internet access to perform the following actions:
- Access OpenShift Cluster Manager to download the installation program and perform subscription management. If the cluster has internet access and you do not disable Telemetry, that service automatically entitles your cluster.
- 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 required content and use it to populate a mirror registry with the installation packages. 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.
10.4. Configuring the Google Cloud project that hosts your cluster Copy linkLink copied to clipboard!
Before you can install OpenShift Container Platform, you must configure a Google Cloud project to host it.
10.4.1. Creating a Google Cloud project Copy linkLink copied to clipboard!
To install OpenShift Container Platform, you must create a project in your Google Cloud account to host the cluster.
Procedure
Create a project to host your OpenShift Container Platform cluster. See Creating and Managing Projects in the Google Cloud documentation.
ImportantYour Google Cloud project must use the Premium Network Service Tier if you are using installer-provisioned infrastructure. The Standard Network Service Tier is not supported for clusters installed using the installation program. The installation program configures internal load balancing for the
api-int.<cluster_name>.<base_domain>URL; the Premium Tier is required for internal load balancing.
10.4.2. Enabling API services in Google Cloud Copy linkLink copied to clipboard!
Your Google Cloud project requires access to several API services to complete OpenShift Container Platform installation.
Prerequisites
- You created a project to host your cluster.
Procedure
Enable the following required API services in the project that hosts your cluster. You may also enable optional API services which are not required for installation. See Enabling services in the Google Cloud documentation.
Expand Table 10.1. Required API services API service Console service name Compute Engine API
compute.googleapis.comCloud Resource Manager API
cloudresourcemanager.googleapis.comCloud DNS API
dns.googleapis.comIAM Service Account Credentials API
iamcredentials.googleapis.comIdentity and Access Management (IAM) API
iam.googleapis.comService Usage API
serviceusage.googleapis.comExpand Table 10.2. Optional API services API service Console service name Cloud Deployment Manager V2 API
deploymentmanager.googleapis.comGoogle Cloud APIs
cloudapis.googleapis.comService Management API
servicemanagement.googleapis.comGoogle Cloud Storage JSON API
storage-api.googleapis.comCloud Storage
storage-component.googleapis.com
10.4.3. Google Cloud account limits Copy linkLink copied to clipboard!
The OpenShift Container Platform cluster uses a number of Google Cloud components, but the default Quotas do not affect your ability to install a default OpenShift Container Platform cluster.
A default cluster, which contains three compute and three control plane machines, uses the following resources. Note that some resources are required only during the bootstrap process and are removed after the cluster deploys.
| Service | Component | Location | Total resources required | Resources removed after bootstrap |
|---|---|---|---|---|
| Service account | IAM | Global | 6 | 1 |
| Firewall rules | Networking | Global | 11 | 1 |
| Forwarding rules | Compute | Global | 2 | 0 |
| Health checks | Compute | Global | 2 | 0 |
| Images | Compute | Global | 1 | 0 |
| Networks | Networking | Global | 1 | 0 |
| Routers | Networking | Global | 1 | 0 |
| Routes | Networking | Global | 2 | 0 |
| Subnetworks | Compute | Global | 2 | 0 |
| Target pools | Networking | Global | 2 | 0 |
If any of the quotas are insufficient during installation, the installation program displays an error that states both which quota was exceeded and the region.
Be sure to consider your actual cluster size, planned cluster growth, and any usage from other clusters that are associated with your account. The CPU, static IP addresses, and persistent disk SSD (storage) quotas are the ones that are most likely to be insufficient.
If you plan to deploy your cluster in one of the following regions, you will exceed the maximum storage quota and are likely to exceed the CPU quota limit:
-
asia-east2 -
asia-northeast2 -
asia-south1 -
australia-southeast1 -
europe-north1 -
europe-west2 -
europe-west3 -
europe-west6 -
northamerica-northeast1 -
southamerica-east1 -
us-west2
You can increase resource quotas from the Google Cloud console, but you might need to file a support ticket. Be sure to plan your cluster size early so that you can allow time to resolve the support ticket before you install your OpenShift Container Platform cluster.
10.4.4. Creating a service account in Google Cloud Copy linkLink copied to clipboard!
OpenShift Container Platform requires a Google Cloud service account that provides authentication and authorization to access data in the Google APIs. If you do not have an existing IAM service account that contains the required roles in your project, you must create one.
To reduce the scope of permissions granted to the main service account in your Google Cloud project while still being able to use the Google Cloud Container Storage Interface (CSI) Driver Operator, you can transfer the control of permissions from the project-wide service account to the control plane and compute node service accounts instead, thus reducing the scope of the permission. For more information, see Section Reducing permissions while using the Google Cloud CSI Driver Operator.
Prerequisites
- You created a project to host your cluster.
Procedure
- Create a service account in the project that you use to host your OpenShift Container Platform cluster. See Creating a service account in the Google Cloud documentation.
Grant the service account the appropriate permissions. You can either grant the individual permissions that follow or assign the
Ownerrole to it. See Granting roles to a service account for specific resources.NoteWhile making the service account an owner of the project is the easiest way to gain the required permissions, it means that service account has complete control over the project. You must determine if the risk that comes from offering that power is acceptable.
You can create the service account key in JSON format, or attach the service account to a Google Cloud virtual machine. See Creating service account keys and Creating and enabling service accounts for instances in the Google Cloud documentation.
NoteIf you use a virtual machine with an attached service account to create your cluster, you must set
credentialsMode: Manualin theinstall-config.yamlfile before installation.
10.4.4.1. Required Google Cloud roles Copy linkLink copied to clipboard!
When you attach the Owner role to the service account that you create, you grant that service account all permissions, including those that are required to install OpenShift Container Platform. If your organization’s security policies require a more restrictive set of permissions, you can create a service account with the following permissions. If you deploy your cluster into an existing virtual private cloud (VPC), the service account does not require certain networking permissions, which are noted in the following lists:
Required roles for the installation program
- Compute Admin
- Role Administrator
- Security Admin
- Service Account Admin
- Service Account Key Admin
- Service Account User
- Storage Admin
Required roles for creating network resources during installation
- DNS Administrator
Required roles for using the Cloud Credential Operator in passthrough mode
- Compute Load Balancer Admin
- Tag User
Required roles for user-provisioned Google Cloud infrastructure
- Cloud Infrastructure Manager Admin
The following roles are applied to the service accounts that the control plane and compute machines use:
| Account | Roles |
|---|---|
| Control Plane |
|
|
| |
|
| |
|
| |
|
| |
| Compute |
|
|
| |
|
|
10.4.5. Supported Google Cloud regions Copy linkLink copied to clipboard!
You can deploy an OpenShift Container Platform cluster to the following Google Cloud regions:
-
africa-south1(Johannesburg, South Africa) -
asia-east1(Changhua County, Taiwan) -
asia-east2(Hong Kong) -
asia-northeast1(Tokyo, Japan) -
asia-northeast2(Osaka, Japan) -
asia-northeast3(Seoul, South Korea) -
asia-south1(Mumbai, India) -
asia-south2(Delhi, India) -
asia-southeast1(Jurong West, Singapore) -
asia-southeast2(Jakarta, Indonesia) -
australia-southeast1(Sydney, Australia) -
australia-southeast2(Melbourne, Australia) -
europe-central2(Warsaw, Poland) -
europe-north1(Hamina, Finland) -
europe-southwest1(Madrid, Spain) -
europe-west1(St. Ghislain, Belgium) -
europe-west2(London, England, UK) -
europe-west3(Frankfurt, Germany) -
europe-west4(Eemshaven, Netherlands) -
europe-west6(Zürich, Switzerland) -
europe-west8(Milan, Italy) -
europe-west9(Paris, France) -
europe-west12(Turin, Italy) -
me-central1(Doha, Qatar, Middle East) -
me-central2(Dammam, Saudi Arabia, Middle East) -
me-west1(Tel Aviv, Israel) -
northamerica-northeast1(Montréal, Québec, Canada) -
northamerica-northeast2(Toronto, Ontario, Canada) -
southamerica-east1(São Paulo, Brazil) -
southamerica-west1(Santiago, Chile) -
us-central1(Council Bluffs, Iowa, USA) -
us-east1(Moncks Corner, South Carolina, USA) -
us-east4(Ashburn, Northern Virginia, USA) -
us-east5(Columbus, Ohio) -
us-south1(Dallas, Texas) -
us-west1(The Dalles, Oregon, USA) -
us-west2(Los Angeles, California, USA) -
us-west3(Salt Lake City, Utah, USA) -
us-west4(Las Vegas, Nevada, USA)
To determine which machine type instances are available by region and zone, see the Google documentation.
10.4.6. Installing and configuring CLI tools for Google Cloud Copy linkLink copied to clipboard!
To install OpenShift Container Platform on Google Cloud using user-provisioned infrastructure, you must install and configure the CLI tools for Google Cloud.
Prerequisites
- You created a project to host your cluster.
- You created a service account and granted it the required permissions.
Procedure
Install the following binaries in
$PATH:-
gcloud -
gsutil
See Install the latest Cloud SDK version in the Google Cloud documentation.
-
Authenticate using the
gcloudtool with your configured service account.See Authorizing with a service account in the Google Cloud documentation.
10.5. Requirements for a cluster with user-provisioned infrastructure Copy linkLink copied to clipboard!
For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.
This section describes the requirements for deploying OpenShift Container Platform on user-provisioned infrastructure.
10.5.1. Required machines for cluster installation Copy linkLink copied to clipboard!
You must specify the minimum required machines or hosts for your cluster so that your cluster remains stable if a node fails.
The smallest OpenShift Container Platform clusters require the following hosts:
For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.
| Hosts | Description |
|---|---|
| One temporary bootstrap machine | The cluster requires the bootstrap machine to deploy the OpenShift Container Platform cluster on the three control plane machines. You can remove the bootstrap machine after you install the cluster. |
| Three control plane machines | The control plane machines run the Kubernetes and OpenShift Container Platform services that form the control plane. |
| At least two compute machines, which are also known as worker machines. | The workloads requested by OpenShift Container Platform users run on the compute machines. |
To maintain high availability of your cluster, use separate physical hosts for these cluster machines.
The bootstrap and control plane machines must use Red Hat Enterprise Linux CoreOS (RHCOS) as the operating system. However, the compute machines can choose between Red Hat Enterprise Linux CoreOS (RHCOS), Red Hat Enterprise Linux (RHEL) 8.6 and later.
Note that RHCOS is based on Red Hat Enterprise Linux (RHEL) 9.8 and inherits all of its hardware certifications and requirements. See Red Hat Enterprise Linux technology capabilities and limits.
10.5.2. Minimum resource requirements for cluster installation Copy linkLink copied to clipboard!
Each created cluster must meet minimum requirements so that the cluster runs as expected.
| Machine | Operating System | vCPU [1] | Virtual RAM | Storage | Input/Output Per Second (IOPS)[2] |
|---|---|---|---|---|---|
| Bootstrap | RHCOS | 4 | 16 GB | 100 GB | 300 |
| Control plane | RHCOS | 4 | 16 GB | 100 GB | 300 |
| Compute | RHCOS | 2 | 8 GB | 100 GB | 300 |
- One vCPU is equivalent to one physical core when simultaneous multithreading (SMT), or Hyper-Threading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = vCPUs.
- OpenShift Container Platform and Kubernetes are sensitive to disk performance, and faster storage is recommended, particularly for etcd on the control plane nodes which require a 10 ms p99 fsync duration. Note that on many cloud platforms, storage size and IOPS scale together, so you might need to over-allocate storage volume to obtain sufficient performance.
- As with all user-provisioned installations, if you choose to use RHEL compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of RHEL 7 compute machines is deprecated and has been removed in OpenShift Container Platform 4.10 and later.
For OpenShift Container Platform version 4.22, RHCOS is based on RHEL version 9.8, which has the micro-architecture requirements. The following list contains the minimum instruction set architectures (ISA) that each architecture requires:
- x86-64 architecture requires x86-64-v2 ISA
- ARM64 architecture requires ARMv8.0-A ISA
- IBM Power architecture requires Power 9 ISA
- s390x architecture requires z14 ISA
For more information, see Architectures (RHEL documentation).
If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OpenShift Container Platform.
10.5.3. Tested instance types for Google Cloud Copy linkLink copied to clipboard!
The following Google Cloud instance types have been tested with OpenShift Container Platform.
Not all instance types are available in all regions and zones. For a detailed breakdown of which instance types are available in which zones, see regions and zones (Google documentation).
Some instance types require the use of Hyperdisk storage. If you use an instance type that requires Hyperdisk storage, all of the nodes in your cluster must support Hyperdisk storage, and you must change the default storage class to use Hyperdisk storage. For more information, see machine series support for Hyperdisk (Google documentation). For instructions on modifying storage classes, see the "GCE PersistentDisk (gcePD) object definition" section in the Dynamic Provisioning page in Storage.
Example 10.1. Machine series
-
A2 -
A3 -
C2 -
C2D -
C3 -
C3D -
C4 -
E2 -
M1 -
N1 -
N2 -
N2D -
N4 -
Tau T2D
10.5.4. Using custom machine types Copy linkLink copied to clipboard!
Using a custom machine type to install a OpenShift Container Platform cluster is supported.
Consider the following when using a custom machine type:
- Similar to predefined instance types, custom machine types must meet the minimum resource requirements for control plane and compute machines. For more information, see "Minimum resource requirements for cluster installation".
The name of the custom machine type must adhere to the following syntax:
custom-<number_of_cpus>-<amount_of_memory_in_mb>For example,
custom-6-20480.
10.6. Configuring the Google Cloud project that hosts your shared VPC network Copy linkLink copied to clipboard!
If you use a shared Virtual Private Cloud (VPC) to host your OpenShift Container Platform cluster in Google Cloud, you must configure the project that hosts it.
If you already have a project that hosts the shared VPC network, review this section to ensure that the project meets all of the requirements to install an OpenShift Container Platform cluster.
Procedure
- Create a project to host the shared VPC for your OpenShift Container Platform cluster. See Creating and Managing Projects in the Google Cloud documentation.
- Create a service account in the project that hosts your shared VPC. See Creating a service account in the Google Cloud documentation.
Grant the service account the appropriate permissions. You can either grant the individual permissions that follow or assign the
Ownerrole to it. See Granting roles to a service account for specific resources.NoteWhile making the service account an owner of the project is the easiest way to gain the required permissions, it means that service account has complete control over the project. You must determine if the risk that comes from offering that power is acceptable.
The service account for the project that hosts the shared VPC network requires the following roles:
- Compute Network User
- Compute Security Admin
- Cloud Infrastructure Manager Admin
- DNS Administrator
- Security Admin
- Network Management Admin
10.6.1. Configuring DNS for Google Cloud Copy linkLink copied to clipboard!
To install OpenShift Container Platform, the Google Cloud account you use must have a dedicated public hosted zone in the project that hosts the shared VPC that you install the cluster into. This zone must be authoritative for the domain. The DNS service provides cluster DNS resolution and name lookup for external connections to the cluster.
Procedure
Identify your domain, or subdomain, and registrar. You can transfer an existing domain and registrar or obtain a new one through Google Cloud or another source.
NoteIf you purchase a new domain, it can take time for the relevant DNS changes to propagate. For more information about purchasing domains through Google, see Google Domains.
Create a public hosted zone for your domain or subdomain in your Google Cloud project. See Creating public zones in the Google Cloud documentation.
Use an appropriate root domain, such as
openshiftcorp.com, or subdomain, such asclusters.openshiftcorp.com.Extract the new authoritative name servers from the hosted zone records. See Look up your Cloud DNS name servers in the Google Cloud documentation.
You typically have four name servers.
- Update the registrar records for the name servers that your domain uses. For example, if you registered your domain to Google Domains, see the following topic in the Google Domains Help: How to switch to custom name servers.
- If you migrated your root domain to Google Cloud DNS, migrate your DNS records. See Migrating to Cloud DNS in the Google Cloud documentation.
- If you use a subdomain, follow your company’s procedures to add its delegation records to the parent domain. This process might include a request to your company’s IT department or the division that controls the root domain and DNS services for your company.
10.7. Creating the installation files for Google Cloud Copy linkLink copied to clipboard!
To install OpenShift Container Platform on Google Cloud using user-provisioned infrastructure, you must generate the files that the installation program needs to deploy your cluster and modify them so that the cluster creates only the machines that it will use. You generate and customize the install-config.yaml file, Kubernetes manifests, and Ignition config files. You also have the option to first set up a separate var partition during the preparation phases of installation.
10.7.1. Manually creating the installation configuration file Copy linkLink copied to clipboard!
Installing the cluster requires that you manually create the installation configuration file.
Prerequisites
- You have an SSH public key on your local machine for use with the installation program. You can use the key for SSH authentication onto your cluster nodes for debugging and disaster recovery.
- You have obtained the OpenShift Container Platform installation program and the pull secret for your cluster.
Procedure
Create an installation directory to store your required installation assets in:
$ mkdir <installation_directory>ImportantYou must create a directory. Some installation assets, such as 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.
Customize the provided sample
install-config.yamlfile template and save the file in the<installation_directory>.NoteYou must name this configuration file
install-config.yaml.Back up the
install-config.yamlfile so that you can use it to install many clusters.ImportantBack up the
install-config.yamlfile now, because the installation process consumes the file in the next step.
10.7.2. Enabling Shielded VMs Copy linkLink copied to clipboard!
You can use Shielded VMs when installing your cluster. Shielded VMs have extra security features including secure boot, firmware and integrity monitoring, and rootkit detection. For more information, see Google’s documentation on Shielded VMs.
Shielded VMs are currently not supported on clusters with 64-bit ARM infrastructures.
Procedure
Use a text editor to edit the
install-config.yamlfile prior to deploying your cluster and add one of the following stanzas:To use shielded VMs for only control plane machines:
controlPlane: platform: gcp: secureBoot: EnabledTo use shielded VMs for only compute machines:
compute: - platform: gcp: secureBoot: EnabledTo use shielded VMs for all machines:
platform: gcp: defaultMachinePlatform: secureBoot: Enabled
10.7.3. Enabling Confidential VMs Copy linkLink copied to clipboard!
You can use Confidential VMs when installing your cluster. Confidential VMs encrypt data while it is being processed. For more information, see Google’s documentation on Confidential Computing. You can enable Confidential VMs and Shielded VMs at the same time, although they are not dependent on each other.
Confidential VMs are currently not supported on 64-bit ARM architectures.
Procedure
Use a text editor to edit the
install-config.yamlfile prior to deploying your cluster and add one of the following stanzas:To use confidential VMs for only control plane machines:
controlPlane: platform: gcp: confidentialCompute: AMDEncryptedVirtualizationNestedPaging1 type: n2d-standard-82 onHostMaintenance: Terminate3 - 1
- Enable confidential VMs with AMD Secure Encrypted Virtualization Secure Nested Paging (AMD SEV-SNP). For more information about available options, see "Additional Google Cloud configuration parameters".
- 2
- Specify a machine type that supports Confidential VMs. Confidential VMs require the N2D, C2D, C3D, or C3 series of machine types. For more information on supported machine types, see Supported operating systems and machine types.
- 3
- Specify the behavior of the VM during a host maintenance event, such as a hardware or software update. For a machine that uses Confidential VM, this value must be set to
Terminate, which stops the VM. Confidential VMs do not support live VM migration.
To use confidential VMs for only compute machines:
compute: - platform: gcp: confidentialCompute: AMDEncryptedVirtualizationNestedPaging type: n2d-standard-8 onHostMaintenance: TerminateTo use confidential VMs for all machines:
platform: gcp: defaultMachinePlatform: confidentialCompute: AMDEncryptedVirtualizationNestedPaging type: n2d-standard-8 onHostMaintenance: Terminate
10.7.5. Configuring the cluster-wide proxy during installation Copy linkLink copied to clipboard!
Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OpenShift Container Platform cluster to use a proxy by configuring the proxy settings in the install-config.yaml file.
Prerequisites
You have reviewed the sites that your cluster requires access to and determined whether any of them need to bypass the proxy. By default, all cluster egress traffic is proxied, including calls to hosting cloud provider APIs. You added sites to the
Proxyobject’sspec.noProxyfield to bypass the proxy if necessary.NoteThe
Proxyobjectstatus.noProxyfield is populated with the values of thenetworking.machineNetwork[].cidr,networking.clusterNetwork[].cidr, andnetworking.serviceNetwork[]fields from your installation configuration.For installations on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Red Hat OpenStack Platform (RHOSP), the
Proxyobjectstatus.noProxyfield is also populated with the instance metadata endpoint (169.254.169.254).
Procedure
Edit your
install-config.yamlfile and add the proxy settings. For example:apiVersion: v1 baseDomain: my.domain.com proxy: httpProxy: http://<username>:<pswd>@<ip>:<port> httpsProxy: https://<username>:<pswd>@<ip>:<port> noProxy: example.com additionalTrustBundle: | -----BEGIN CERTIFICATE----- <MY_TRUSTED_CA_CERT> -----END CERTIFICATE----- additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> # ...where:
proxy.httpProxy-
Specifies a proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be
http. proxy.httpsProxy- Specifies a proxy URL to use for creating HTTPS connections outside the cluster.
proxy.noProxy-
Specifies a comma-separated list of destination domain names, IP addresses, or other network CIDRs to exclude from proxying. Preface a domain with
.to match subdomains only. For example,.y.commatchesx.y.com, but noty.com. Use*to bypass the proxy for all destinations. additionalTrustBundle-
If provided, the installation program generates a config map that is named
user-ca-bundlein theopenshift-confignamespace to hold the additional CA certificates. If you provideadditionalTrustBundleand at least one proxy setting, theProxyobject is configured to reference theuser-ca-bundleconfig map in thetrustedCAfield. The Cluster Network Operator then creates atrusted-ca-bundleconfig map that merges the contents specified for thetrustedCAparameter with the RHCOS trust bundle. TheadditionalTrustBundlefield is required unless the proxy’s identity certificate is signed by an authority from the RHCOS trust bundle. additionalTrustBundlePolicySpecifies the policy that determines the configuration of the
Proxyobject to reference theuser-ca-bundleconfig map in thetrustedCAfield. The allowed values areProxyonlyandAlways. UseProxyonlyto reference theuser-ca-bundleconfig map only whenhttp/httpsproxy is configured. UseAlwaysto always reference theuser-ca-bundleconfig map. The default value isProxyonly. Optional parameter.NoteThe installation program does not support the proxy
readinessEndpointsfield.NoteIf the installation program times out, restart and then complete the deployment by using the
wait-forcommand of the installation program. For example:$ ./openshift-install wait-for install-complete --log-level debug
Save the file and reference it when installing OpenShift Container Platform.
The installation program creates a cluster-wide proxy that is named
clusterthat uses the proxy settings in the providedinstall-config.yamlfile. If no proxy settings are provided, aclusterProxyobject is still created, but it will have a nilspec.NoteOnly the
Proxyobject namedclusteris supported, and no additional proxies can be created.
10.7.6. Creating the Kubernetes manifest and Ignition config files Copy linkLink copied to clipboard!
To customize cluster definitions and manually start machines, generate the Kubernetes manifest and Ignition config files.
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.
-
The Ignition config files that the OpenShift Container Platform 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
node-bootstrappercertificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. - It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation.
Procedure
Change to the directory that contains the OpenShift Container Platform installation program and generate the Kubernetes manifests for the cluster:
$ ./openshift-install create manifests --dir <installation_directory>where
<installation_directory>-
Specifies the installation directory that contains the
install-config.yamlfile you created.
Remove the Kubernetes manifest files that define the control plane machines:
$ rm -f <installation_directory>/openshift/99_openshift-cluster-api_master-machines-*.yamlBy removing these files, you prevent the cluster from automatically generating control plane machines.
Remove the Kubernetes manifest files that define the control plane machine set:
$ rm -f <installation_directory>/openshift/99_openshift-machine-api_master-control-plane-machine-set.yamlRemove the Kubernetes manifest files that define the worker machines:
$ rm -f <installation_directory>/openshift/99_openshift-cluster-api_worker-machineset-*.yamlBecause you create and manage the worker machines yourself, you do not need to initialize these machines.
Check that the
mastersSchedulableparameter in the<installation_directory>/manifests/cluster-scheduler-02-config.ymlKubernetes manifest file is set tofalse. This setting prevents pods from being scheduled on the control plane machines:-
Open the
<installation_directory>/manifests/cluster-scheduler-02-config.ymlfile. -
Locate the
mastersSchedulableparameter and ensure that it is set tofalse. - Save and exit the file.
-
Open the
Remove the
privateZonesections from the<installation_directory>/manifests/cluster-dns-02-config.ymlDNS configuration file:apiVersion: config.openshift.io/v1 kind: DNS metadata: creationTimestamp: null name: cluster spec: baseDomain: example.openshift.com privateZone: id: mycluster-100419-private-zone status: {}spec.privateZone: Remove this section completely.Configure the cloud provider for your VPC.
-
Open the
<installation_directory>/manifests/cloud-provider-config.yamlfile. -
Add the
network-project-idparameter and set its value to the ID of project that hosts the shared VPC network. -
Add the
network-nameparameter and set its value to the name of the shared VPC network that hosts the OpenShift Container Platform cluster. Replace the value of the
subnetwork-nameparameter with the value of the shared VPC subnet that hosts your compute machines.The contents of the
<installation_directory>/manifests/cloud-provider-config.yamlresemble the following example:config: |+ [global] project-id = example-project regional = true multizone = true node-tags = opensh-ptzzx-master node-tags = opensh-ptzzx-worker node-instance-prefix = opensh-ptzzx external-instance-groups-prefix = opensh-ptzzx network-project-id = example-shared-vpc network-name = example-network subnetwork-name = example-worker-subnet
-
Open the
If you deploy a cluster that is not on a private network, open the
<installation_directory>/manifests/cluster-ingress-default-ingresscontroller.yamlfile and replace the value of thescopeparameter withExternal. The contents of the file resemble the following example:apiVersion: operator.openshift.io/v1 kind: IngressController metadata: creationTimestamp: null name: default namespace: openshift-ingress-operator spec: endpointPublishingStrategy: loadBalancer: scope: External type: LoadBalancerService status: availableReplicas: 0 domain: '' selector: ''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>where:
<installation_directory>Specifies the same installation directory.
Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory. The
kubeadmin-passwordandkubeconfigfiles are created in the./<installation_directory>/authdirectory:. ├── auth │ ├── kubeadmin-password │ └── kubeconfig ├── bootstrap.ign ├── master.ign ├── metadata.json └── worker.ign
10.8. Exporting common variables Copy linkLink copied to clipboard!
10.8.1. Extracting the infrastructure name Copy linkLink copied to clipboard!
The Ignition config files contain a unique cluster identifier that you can use to uniquely identify your cluster in Google Cloud. The infrastructure name is also used to locate the appropriate Google Cloud resources during an OpenShift Container Platform installation. The provided Infrastructure Manager templates contain references to this infrastructure name, so you must extract it.
Do not run the openshift-install create manifests command again after creating any Google Cloud resources. Running the command again generates a new cluster identifier, which will cause errors in existing resources. If you need to regenerate the manifests because you modified the install-config.yaml file, delete any Google Cloud resources you created and recreate them with the new cluster identifier.
Prerequisites
-
You installed the
jqpackage.
Procedure
To extract and view the infrastructure name from the Ignition config file metadata, run the following command:
$ jq -r .infraID <installation_directory>/metadata.jsonFor
<installation_directory>, specify the path to the directory that you stored the installation files in.Example output
$ openshift-vw9j6The output of this command is your cluster name and a random string.
10.8.2. Exporting common variables for Infrastructure Manager templates Copy linkLink copied to clipboard!
You must export a common set of variables that are used with the provided Infrastructure Manager templates used to assist in installing a cluster with user-provisioned infrastructure on Google Cloud.
Specific Infrastructure Manager templates can also require additional exported variables, which are detailed in their related procedures.
Procedure
Export the following common variables to be used by the provided Infrastructure Manager templates. For any command with
<installation_directory>, specify the path to the directory that you stored the installation files in.Export the
BASE_DOMAINvariable by running the following command:$ export BASE_DOMAIN='<base_domain>'<base_domain>- If you are installing a cluster into a shared VPC, specify the value for the host project.
Export the
BASE_DOMAIN_ZONE_NAMEvariable by running the following command:$ export BASE_DOMAIN_ZONE_NAME='<base_domain_zone_name>'<base_domain_zone_name>- Specifies the base domain zone name.
Export the
NETWORK_CIDRvariable by running the following command:$ export NETWORK_CIDR='<network_cidr>'<network_cidr>-
Specifies the network CIDR your cluster uses. For example,
10.0.0.0/16.
Export the
MASTER_SUBNET_CIDRvariable by running the following command:$ export MASTER_SUBNET_CIDR='<master_subnet_cidr>'<master_subnet_cidr>-
Specifies the network CIDR that your cluster’s control plane uses. For example,
10.0.0.0/17.
Export the
WORKER_SUBNET_CIDRvariable by running the following command:$ export WORKER_SUBNET_CIDR='<worker_subnet_cidr>'<worker_subnet_cidr>-
Specifies the network CIDR that your cluster’s compute machines use. For example,
10.0.128.0/17.
Export the
KUBECONFIGvariable by running the following command:$ export KUBECONFIG=<installation_directory>/auth/kubeconfigExport the
CLUSTER_NAMEvariable by running the following command:$ export CLUSTER_NAME=`jq -r .clusterName <installation_directory>/metadata.json`Export the
INFRA_IDvariable by running the following command:$ export INFRA_ID=`jq -r .infraID <installation_directory>/metadata.json`Export the
PROJECT_NAMEvariable by running the following command:$ export PROJECT_NAME=`jq -r .gcp.projectID <installation_directory>/metadata.json`If you are installing a cluster into a shared VPC, export the
HOST_PROJECTvariable by running the following command:$ export HOST_PROJECT=<host_project_name><host_project_name>specifies the name of the host project that contains the shared VPC.If you are installing a cluster into a shared VPC, export the
HOST_PROJECT_ACCOUNTvariable by running the following command:$ export HOST_PROJECT_ACCOUNT=<host_project_account><host_project_account>specifies the name of an account that can access the host project that contains the shared VPC.Export the
REGIONvariable by running the following command:$ export REGION=`jq -r .gcp.region <installation_directory>/metadata.json`Export the
ZONE_0variable by running the following command:$ export ZONE_0=$(gcloud compute regions describe ${REGION} --format=json | jq -r '.zones[0]' | cut -d "/" -f9)Export the
ZONE_1variable by running the following command:$ export ZONE_1=$(gcloud compute regions describe ${REGION} --format=json | jq -r '.zones[1]' | cut -d "/" -f9)Export the
ZONE_2variable by running the following command:$ export ZONE_2=$(gcloud compute regions describe ${REGION} --format=json | jq -r '.zones[2]' | cut -d "/" -f9)Export the
SERVICE_ACCOUNT_EMAILvariable by running the following command:$ export SERVICE_ACCOUNT_EMAIL="<service_account_email>"<service_account_email>- Specifies the email address of the service account you used for the installation.
Export the
INSTALL_SERVICE_ACCOUNTvariable by running the following command:$ export INSTALL_SERVICE_ACCOUNT="projects/${PROJECT_NAME}/serviceAccounts/${SERVICE_ACCOUNT_EMAIL}"Export the
CLUSTER_DOMAINvariable by running the following command:$ export CLUSTER_DOMAIN="${CLUSTER_NAME}.${BASE_DOMAIN}"
10.9. Networking requirements for user-provisioned infrastructure Copy linkLink copied to clipboard!
You must configure networking for all the Red Hat Enterprise Linux CoreOS (RHCOS) machines in initramfs during boot, so that they can fetch their Ignition config files.
10.9.1. Setting the cluster node hostnames through DHCP Copy linkLink copied to clipboard!
On Red Hat Enterprise Linux CoreOS (RHCOS) machines, the hostname is set through NetworkManager. By default, the machines obtain their hostname through DHCP. If the hostname is not provided by DHCP, set statically through kernel arguments, or another method, it is obtained through a reverse DNS lookup. Reverse DNS lookup occurs after the network has been initialized on a node and can take time to resolve. Other system services can start prior to this and detect the hostname as localhost or similar. You can avoid this by using DHCP to provide the hostname for each cluster node.
Additionally, setting the hostnames through DHCP can bypass any manual DNS record name configuration errors in environments that have a DNS split-horizon implementation.
10.9.2. Network connectivity requirements Copy linkLink copied to clipboard!
You must configure the network connectivity between machines to allow OpenShift Container Platform cluster components to communicate. Each machine must be able to resolve the hostnames of all other machines in the cluster.
This section provides details about the ports that are required.
In connected OpenShift Container Platform environments, all nodes are required to have internet access to pull images for platform containers and provide telemetry data to Red Hat.
| Protocol | Port | Description |
|---|---|---|
| ICMP | N/A | Network reachability tests |
| TCP |
| Metrics |
|
|
Host level services, including the node exporter on ports | |
|
| The default ports that Kubernetes reserves | |
|
| The port handles traffic from the Machine Config Server and directs the traffic to the control plane machines. | |
| UDP |
| Geneve |
|
|
Host level services, including the node exporter on ports | |
|
| IPsec IKE packets | |
|
| IPsec NAT-T packets | |
|
|
Network Time Protocol (NTP) on UDP port | |
| TCP/UDP |
| |
| Kubernetes node port | ESP | N/A |
| Protocol | Port | Description |
|---|---|---|
| TCP |
| Kubernetes API |
| Protocol | Port | Description |
|---|---|---|
| TCP |
| etcd server and peer ports |
10.10. Creating load balancers in Google Cloud Copy linkLink copied to clipboard!
You must configure load balancers in Google Cloud for your OpenShift Container Platform cluster to use. One way to create these components is to modify the provided Infrastructure Manager template.
If you do not use the provided template to create your Google Cloud infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
Prerequisites
- You have defined the variables in the Exporting common variables section.
- If you are not installing a cluster into a shared VPC, you have defined the variables in the Creating a VPC in Google Cloud section.
Procedure
If you are installing a cluster into a shared VPC, set environment variables for the cluster network and control plane subnet.
Determine the shared VPC network name by running the following command:
$ gcloud compute networks listSet the
CLUSTER_NETWORKvariable by running the following command:$ export CLUSTER_NETWORK=$(gcloud compute networks describe <network_name> --format json | jq -r .selfLink)<network_name>specifies the name of the network you determined.List the available network subnets by running the following command:
$ gcloud compute networks subnets list --network=<network_name><network_name>specifies the name of the network you determined.Select a subnet from the list, and set the
CONTROL_SUBNETvariable by running the following command:$ export CONTROL_SUBNET=<control_subnet><control_subnet>specifies the name of the subnet you selected from the list of subnets.
Copy the template from the Infrastructure Manager template for the internal load balancer section of this topic and save it as
02_lb_int.tfin a directory called02_lb_inton your computer. This template describes the internal load balancing objects that your cluster requires.Create an internal load balancer by running the following command:
$ gcloud infra-manager deployments apply <internal_lb_deployment_name> \ --location=${REGION} \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},cluster_network=${CLUSTER_NETWORK},control_subnet=${CONTROL_SUBNET},zone_0=${ZONE_0},zone_1=${ZONE_1},zone_2=${ZONE_2} \ --project=${PROJECT_NAME} \ --local-source=./02_lb_int \ --service-account=${INSTALL_SERVICE_ACCOUNT}<internal_lb_deployment_name>specifies the name of the internal load balancer deployment you create.Export the
CLUSTER_IPvariable by running the following command:$ export CLUSTER_IP=$(gcloud compute addresses describe ${INFRA_ID}-cluster-ip --region=${REGION} --format json | jq -r .address)
Optional: For a public or externally available cluster, copy the template from the Infrastructure Manager template for the external load balancer section of this topic and save it as
02_lb_ext.tfin a directory called02_lb_exton your computer. This template describes the external load balancing objects that your cluster requires.Create an external load balancer by running the following command:
$ gcloud infra-manager deployments apply <external_lb_deployment_name> \ --location=${REGION} \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION} \ --project=${PROJECT_NAME} \ --local-source=./02_lb_ext \ --service-account=${INSTALL_SERVICE_ACCOUNT}<external_lb_deployment_name>specifies the name of the external load balancer deployment you create.Export the
CLUSTER_PUBLIC_IPvariable by running the following command:$ export CLUSTER_PUBLIC_IP=$(gcloud compute addresses describe ${INFRA_ID}-cluster-public-ip --region=${REGION} --format json | jq -r .address)
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.10.1. Infrastructure Manager template for the external load balancer Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the external load balancer that you need for your OpenShift Container Platform cluster:
Example 10.2. 02_lb_ext.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
resource "google_compute_address" "cluster_public_ip" {
provider = google-beta
name = "${var.infra_id}-cluster-public-ip"
region = "${var.region}"
}
resource "google_compute_http_health_check" "api_http_health_check" {
provider = google-beta
name = "${var.infra_id}-api-http-health-check"
port = 6080
request_path = "/readyz"
}
resource "google_compute_target_pool" "api_target_pool" {
provider = google-beta
name = "${var.infra_id}-api-target-pool"
region = "${var.region}"
health_checks = [
google_compute_http_health_check.api_http_health_check.id
]
}
resource "google_compute_forwarding_rule" "api_forwarding_rule" {
provider = google-beta
name = "${var.infra_id}-api-forwarding-rule"
ip_address = google_compute_address.cluster_public_ip.address
port_range = "6443"
region = "${var.region}"
target = google_compute_target_pool.api_target_pool.id
}
10.10.2. Infrastructure Manager template for the internal load balancer Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the internal load balancer that you need for your OpenShift Container Platform cluster:
Example 10.3. 02_lb_int.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
variable "control_subnet" {
type = string
description = "Subnet for the control plane instances."
}
variable "cluster_network" {
type = string
description = "Full link to the cluster network."
}
# Terraform handles lists but the infra-manager --input-values only
# supports scalar types.
# If you require more or less zones, you must manually add them below
# as a single variable for each. You must add the zones to the
# locals `zones` list below.
variable "zone_0" {
type = string
description = "Zone 1 for the instance types."
}
variable "zone_1" {
type = string
description = "Zone 2 for the instance types."
}
variable "zone_2" {
type = string
description = "Zone 3 for the instance types."
}
locals {
zones = ["${var.zone_0}", "${var.zone_1}", "${var.zone_2}"]
}
resource "google_compute_address" "cluster_ip" {
provider = google-beta
name = "${var.infra_id}-cluster-ip"
address_type = "INTERNAL"
region = "${var.region}"
subnetwork = "${var.control_subnet}"
}
resource "google_compute_health_check" "api_internal_health_check" {
provider = google-beta
name = "${var.infra_id}-api-internal-health-check"
https_health_check {
port = 6443
}
}
resource "google_compute_region_backend_service" "api_internal" {
provider = google-beta
name = "${var.infra_id}-api-internal"
timeout_sec = 120
protocol = "TCP"
region = "${var.region}"
load_balancing_scheme = "INTERNAL"
health_checks = [
google_compute_health_check.api_internal_health_check.id
]
dynamic "backend" {
for_each = google_compute_instance_group.master_ig
content {
balancing_mode = "CONNECTION"
group = backend.value.self_link
}
}
}
resource "google_compute_forwarding_rule" "api_internal_forwarding_rule" {
provider = google-beta
name = "${var.infra_id}-api-internal-forwarding-rule"
ip_address = google_compute_address.cluster_ip.address
backend_service = google_compute_region_backend_service.api_internal.id
load_balancing_scheme = "INTERNAL"
ports = [
"6443",
"22623"
]
region = "${var.region}"
subnetwork = "${var.control_subnet}"
}
resource "google_compute_instance_group" "master_ig" {
provider = google-beta
for_each = toset(local.zones)
name = "${var.infra_id}-master-${each.key}-ig"
network = "${var.cluster_network}"
zone = "${each.key}"
named_port {
name = "ignition"
port = 22623
}
named_port {
name = "https"
port = 6443
}
}
10.11. Creating a private DNS zone in Google Cloud Copy linkLink copied to clipboard!
You must configure a private DNS zone in Google Cloud for your OpenShift Container Platform cluster to use. One way to create this component is to modify the provided Infrastructure Manager template.
If you do not use the provided template to create your Google Cloud infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
Prerequisites
- Ensure you defined the variables in the Exporting common variables and Creating load balancers in Google Cloud sections.
Procedure
-
Copy the template from the Infrastructure Manager template for the private DNS section of this topic and save it as
02_dns.tfin a folder called02_dnson your computer. This template describes the private DNS objects that your cluster requires. If you are installing a cluster into a shared VPC, and the host project already has a private DNS zone, skip this step. Create the DNS zone by running the following command:
$ gcloud infra-manager deployments apply <dns_zone_deployment_name> \ --location=${REGION} \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},cluster_domain=${CLUSTER_DOMAIN},cluster_network=${CLUSTER_NETWORK} \ --project=${PROJECT_NAME} \ --local-source=./02_dns \ --service-account=${INSTALL_SERVICE_ACCOUNT}<dns_zone_deployment_name>specifies the name of the DNS zone deployment you create.The templates do not create DNS entries due to limitations of Infrastructure Manager, so you must create them manually:
Add the internal DNS entries by running the following commands:
$ if [ -f transaction.yaml ]; then rm transaction.yaml; fi$ gcloud dns record-sets transaction start --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}$ gcloud dns record-sets transaction add ${CLUSTER_IP} --name api.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}$ gcloud dns record-sets transaction add ${CLUSTER_IP} --name api-int.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}$ gcloud dns record-sets transaction execute --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}For an external cluster, also add the external DNS entries by running the following commands:
$ if [ -f transaction.yaml ]; then rm transaction.yaml; fi$ gcloud --account=${HOST_PROJECT_ACCOUNT} --project=${HOST_PROJECT} dns record-sets transaction start --zone ${BASE_DOMAIN_ZONE_NAME}$ gcloud --account=${HOST_PROJECT_ACCOUNT} --project=${HOST_PROJECT} dns record-sets transaction add ${CLUSTER_PUBLIC_IP} --name api.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${BASE_DOMAIN_ZONE_NAME}$ gcloud --account=${HOST_PROJECT_ACCOUNT} --project=${HOST_PROJECT} dns record-sets transaction execute --zone ${BASE_DOMAIN_ZONE_NAME}
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.11.1. Infrastructure Manager template for the private DNS Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the private DNS that you need for your OpenShift Container Platform cluster:
Example 10.4. 02_dns.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
variable "cluster_domain" {
type = string
description = "ClusterName.BaseDomain"
}
variable "cluster_network" {
type = string
description = "Full link to the cluster network."
}
resource "google_dns_managed_zone" "private_zone" {
provider = google-beta
name = "${var.infra_id}-private-zone"
dns_name = "${var.cluster_domain}."
description = "OpenShift Installer UPI create private DNS zone."
visibility = "private"
private_visibility_config {
networks {
network_url = "${var.cluster_network}"
}
}
force_destroy = false
}
10.12. Creating firewall rules and IAM roles in Google Cloud Copy linkLink copied to clipboard!
You must create firewall rules and IAM roles in Google Cloud for your OpenShift Container Platform cluster to use. One way to create these components is to modify the provided Infrastructure Manager template. If you are installing a cluster into a shared VPC and the host project already has the necessary firewall rules and IAM roles, you can skip creating these resources.
If you do not use the provided Infrastructure Manager template to create your Google Cloud infrastructure, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
Prerequisites
- Ensure you defined the variables in the Exporting common variables and Creating load balancers in Google Cloud sections.
Procedure
-
Copy the template from the Infrastructure Manager template for firewall rules and IAM roles section of this topic and save it as
03_security.tfin a folder called03_securityon your computer. This template describes the security groups that your cluster requires. Create the firewall rules and IAM roles by running the following command:
$ gcloud infra-manager deployments apply <security_deployment_name> \ --location=${REGION} \ --project=${PROJECT_NAME} \ --local-source=./03_security \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},cluster_network=${CLUSTER_NETWORK},network_cidr=${NETWORK_CIDR} \ --service-account=${INSTALL_SERVICE_ACCOUNT}<security_deployment_name>specifies the name of the deployment of firewall rules and IAM roles.Configure service account variables based on the roles you created by running the following commands:
$ export MASTER_SERVICE_ACCOUNT=$(gcloud iam service-accounts list --filter "email~^${INFRA_ID}-m@${PROJECT_NAME}." --format json | jq -r '.[0].email')$ export WORKER_SERVICE_ACCOUNT=$(gcloud iam service-accounts list --filter "email~^${INFRA_ID}-w@${PROJECT_NAME}." --format json | jq -r '.[0].email')
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.12.1. Infrastructure Manager template for firewall rules and IAM roles Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the firewall rules and IAM roles that you need for your OpenShift Container Platform cluster:
Example 10.5. 03_security.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
variable "cluster_network" {
type = string
description = "Full link to the cluster network."
}
variable "network_cidr" {
type = string
description = "CIDR for network of the cluster."
}
variable "allowed_external_cidr" {
type = string
description = "Allowed external CIDR for firewall rule."
default = "0.0.0.0/0"
}
resource "google_compute_firewall" "bootstrap_in_ssh" {
provider = google-beta
name = "${var.infra_id}-bootstrap-in-ssh"
source_ranges = [
"${var.allowed_external_cidr}"
]
target_tags = [
"${var.infra_id}-bootstrap"
]
network = "${var.cluster_network}"
allow {
protocol = "tcp"
ports = ["22"]
}
}
resource "google_compute_firewall" "api" {
provider = google-beta
name = "${var.infra_id}-api"
source_ranges = [
"${var.allowed_external_cidr}"
]
target_tags = [
"${var.infra_id}-master"
]
network = "${var.cluster_network}"
allow {
protocol = "tcp"
ports = ["6443"]
}
}
resource "google_compute_firewall" "health_checks" {
provider = google-beta
name = "${var.infra_id}-health-checks"
source_ranges = [
"35.191.0.0/16",
"130.211.0.0/22",
"209.85.152.0/22",
"209.85.204.0/22"
]
target_tags = [
"${var.infra_id}-master"
]
network = "${var.cluster_network}"
allow {
protocol = "tcp"
ports = ["6080", "6443", "22624"]
}
}
resource "google_compute_firewall" "etcd" {
provider = google-beta
name = "${var.infra_id}-etcd"
source_tags = [
"${var.infra_id}-master"
]
target_tags = [
"${var.infra_id}-master"
]
network = "${var.cluster_network}"
allow {
protocol = "tcp"
ports = ["2379-2380"]
}
}
resource "google_compute_firewall" "control_plane" {
provider = google-beta
name = "${var.infra_id}-control-plane"
source_tags = [
"${var.infra_id}-master",
"${var.infra_id}-worker"
]
target_tags = [
"${var.infra_id}-master"
]
network = "${var.cluster_network}"
allow {
protocol = "tcp"
ports = ["10257"]
}
allow {
protocol = "tcp"
ports = ["10259"]
}
allow {
protocol = "tcp"
ports = ["22623"]
}
}
resource "google_compute_firewall" "internal_network" {
provider = google-beta
name = "${var.infra_id}-internal-network"
source_ranges = [
"${var.network_cidr}"
]
target_tags = [
"${var.infra_id}-master",
"${var.infra_id}-worker"
]
network = "${var.cluster_network}"
allow {
protocol = "icmp"
}
allow {
protocol = "tcp"
ports = ["22"]
}
}
resource "google_compute_firewall" "internal_cluster" {
provider = google-beta
name = "${var.infra_id}-internal-cluster"
source_tags = [
"${var.infra_id}-master",
"${var.infra_id}-worker"
]
target_tags = [
"${var.infra_id}-master",
"${var.infra_id}-worker"
]
network = "${var.cluster_network}"
allow {
protocol = "udp"
ports = ["4789", "6081"]
}
allow {
protocol = "udp"
ports = ["500", "4500"]
}
allow {
protocol = "esp"
}
allow {
protocol = "tcp"
ports = ["9000-9999"]
}
allow {
protocol = "udp"
ports = ["9000-9999"]
}
allow {
protocol = "tcp"
ports = ["10250"]
}
allow {
protocol = "tcp"
ports = ["30000-32767"]
}
allow {
protocol = "udp"
ports = ["30000-32767"]
}
}
resource "google_service_account" "master_node_sa" {
provider = google-beta
account_id = "${var.infra_id}-m"
display_name = "${var.infra_id}-master-node"
}
resource "google_service_account" "worker_node_sa" {
provider = google-beta
account_id = "${var.infra_id}-w"
display_name = "${var.infra_id}-worker-node"
}
10.14. Creating the RHCOS cluster image for the Google Cloud infrastructure Copy linkLink copied to clipboard!
You must use a valid Red Hat Enterprise Linux CoreOS (RHCOS) image for Google Cloud for your OpenShift Container Platform nodes.
Prerequisites
-
You have downloaded the
openshift-installbinary.
Procedure
Obtain the image name by running the following command:
$ source_image=$(openshift-install coreos print-stream-json | jq -r '.architectures.x86_64.images.gcp.name')Obtain the project name by running the following command:
$ source_project=$(openshift-install coreos print-stream-json | jq -r '.architectures.x86_64.images.gcp.project')Create the image by running the following command:
$ gcloud compute images create "${INFRA_ID}-rhcos-image" \ --source-image="${source_image}" --source-image-project="${source_project}"
10.15. Creating the bootstrap machine in Google Cloud Copy linkLink copied to clipboard!
You must create the bootstrap machine in Google Cloud to use during OpenShift Container Platform cluster initialization. One way to create this machine is to modify the provided Infrastructure Manager template.
If you do not use the provided Infrastructure Manager template to create your bootstrap machine, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
If you need to redeploy the bootstrap machine for any reason, delete the existing bootstrap VM first. If you redeploy the bootstrap machine without deleting the existing VM, Infrastructure Manager will update the metadata and appear to succeed, but the Ignition file will not be executed again. This will result in the VM still being based on the old Ignition data.
Prerequisites
- Ensure you defined the variables in the Exporting common variables and Creating load balancers in Google Cloud sections.
Procedure
Copy the template from the Infrastructure Manager template for the bootstrap machine section of this topic and save it as
04_bootstrap.tfin a folder called04_bootstrapon your computer. This template describes the bootstrap machine that your cluster requires.You can edit the
04_bootstrap.tffile to add additional tags to the bootstrap machine, by modifying the existingtagsstanza as follows:resource "google_compute_instance" "bootstrap" { # ... tags = [ "${var.infra_id}-master", "${var.infra_id}-bootstrap", "custom-tag-example" ] # ... }
Export the location of the Red Hat Enterprise Linux CoreOS (RHCOS) image that the installation program requires by running the following command:
$ export CLUSTER_IMAGE=(`gcloud compute images describe ${INFRA_ID}-rhcos-image --format json | jq -r .selfLink`)Create a bucket by running the following command:
$ gcloud storage buckets create "gs://${INFRA_ID}-bootstrap-ignition"Upload the
bootstrap.ignfile by running the following command:$ gcloud storage cp bootstrap.ign "gs://${INFRA_ID}-bootstrap-ignition/"Create a signed URL for the bootstrap instance and export the URL from the output as a variable by running the following command:
$ export BOOTSTRAP_IGN="$(gcloud storage sign-url --duration=2h --private-key-file=service-account-key.json "gs://${INFRA_ID}-bootstrap-ignition/bootstrap.ign" | grep "^signed_url:" | awk '{print $2}')"Create the bootstrap deployment by running the following command:
$ gcloud infra-manager deployments apply <bootstrap_deployment_name> \ --location=${REGION} \ --project=${PROJECT_NAME} \ --local-source=./04_bootstrap \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},zone=${ZONE_0},cluster_network=${CLUSTER_NETWORK},subnet=${CONTROL_SUBNET},image=${CLUSTER_IMAGE},bootstrap_ign="${BOOTSTRAP_IGN}",is_public_cluster=<public_cluster_status> \ --service-account=${INSTALL_SERVICE_ACCOUNT}where:
<bootstrap_deployment_name>- Specifies the name of the bootstrap deployment.
<public_cluster_status>-
Specifies whether the cluster is public or private. If it is a public cluster, specify
true. If it is a private cluster, specifyfalse.
The templates do not manage load balancer membership due to limitations of Infrastructure Manager, so you must add the bootstrap machine manually.
Add the bootstrap instance to the internal load balancer instance group by running the following command:
$ gcloud compute instance-groups unmanaged add-instances \ ${INFRA_ID}-bootstrap-ig --zone=${ZONE_0} --instances=${INFRA_ID}-bootstrapAdd the bootstrap instance group to the internal load balancer backend service by running the following command:
$ gcloud compute backend-services add-backend \ ${INFRA_ID}-api-internal --region=${REGION} --instance-group=${INFRA_ID}-bootstrap-ig --instance-group-zone=${ZONE_0}
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.15.1. Infrastructure Manager template for the bootstrap machine Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the bootstrap machine that you need for your OpenShift Container Platform cluster:
Example 10.6. 04_bootstrap.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
variable "zone" {
type = string
description = "Zone inside of the region where the bootstrap node is created."
}
variable "cluster_network" {
type = string
description = "Full link to the cluster network."
}
variable "subnet" {
type = string
description = "Control plane subnet."
}
variable "image" {
type = string
description = "Cluster Image."
}
variable "machine_type" {
type = string
description = "Machine type for the bootstrap machine."
default = "n1-standard-4"
}
variable "root_volume_size" {
type = string
description = "Size in GB for the root volume."
default = "128"
}
variable "bootstrap_ign" {
type = string
description = "Bootstrap ignition data."
}
variable "is_public_cluster" {
type = bool
default = true
description = "Whether the publish policy is the default External"
}
resource "google_compute_address" "bootstrap_public_ip" {
provider = google-beta
count = var.is_public_cluster ? 1 : 0
name = "${var.infra_id}-bootstrap-public-ip"
region = "${var.region}"
}
resource "google_compute_instance" "bootstrap" {
provider = google-beta
name = "${var.infra_id}-bootstrap"
zone = "${var.zone}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-master",
"${var.infra_id}-bootstrap"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.root_volume_size}"
image = "${var.image}"
}
}
network_interface {
subnetwork = "${var.subnet}"
# Dynamic block to conditionally create access_config
dynamic "access_config" {
for_each = var.is_public_cluster ? [1] : []
content {
nat_ip = google_compute_address.bootstrap_public_ip[0].address
}
}
}
metadata = {
user-data = "{\"ignition\":{\"config\":{\"replace\":{\"source\":\"${var.bootstrap_ign}\"}},\"version\":\"3.2.0\"}}"
}
}
resource "google_compute_instance_group" "bootstrap_ig" {
provider = google-beta
name = "${var.infra_id}-bootstrap-ig"
network = "${var.cluster_network}"
zone = "${var.zone}"
named_port {
name = "ignition"
port = 22623
}
named_port {
name = "https"
port = 6443
}
}
10.16. Creating the control plane machines in Google Cloud Copy linkLink copied to clipboard!
You must create the control plane machines in Google Cloud for your cluster to use. One way to create these machines is to modify the provided Infrastructure Manager template.
If you do not use the provided template to create your control plane machines, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
Prerequisites
- You defined the variables in the Exporting common variables, Creating load balancers in Google Cloud, Creating IAM roles in Google Cloud, and Creating the bootstrap machine in Google Cloud sections.
- You created the bootstrap machine.
- You created the Ignition configuration files.
Procedure
Copy the template from the Infrastructure Manager template for control plane machines section of this topic and save it as
05_control_plane.tfin a folder called05_control_planeon your computer. This template describes the control plane machines that your cluster requires.You can edit the
05_control_plane.tffile to add additional tags to the control plane machines, by modifying the existingtagsstanza. The following example adds a custom tag to the first control plane machine, which is namedmaster_0:resource "google_compute_instance" "master_0" { # ... tags = [ "${var.infra_id}-master", "custom_tag_example" ] # ... }
Copy the
master.ignfile from your installation directory into the05_control_planefolder by running the following command:$ cp <installation_directory>/master.ign 05_control_plane/master.ign<installation_directory>specifies the directory where you created the Ignition configuration files.Create the control plane deployment by running the following command:
$ gcloud infra-manager deployments apply <control_plane_deployment> \ --location=${REGION} \ --project=${PROJECT_NAME} \ --local-source=./05_control_plane \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},zone_0=${ZONE_0},zone_1=${ZONE_1},zone_2=${ZONE_2},subnet=${CONTROL_SUBNET},image=${CLUSTER_IMAGE},service_account_email=${MASTER_SERVICE_ACCOUNT} \ --service-account=${INSTALL_SERVICE_ACCOUNT}<control_plane_deployment>specifies the name of the control plane deployment.Delete the temporary ignition file from the
05_control_planefolder by running the following command:$ rm 05_control_plane/master.ignThe templates do not manage load balancer membership due to limitations of Infrastructure Manager, so you must add the control plane machines manually.
Add the first control plane machine to an internal load balancer instance group by running the following command:
$ gcloud compute instance-groups unmanaged add-instances ${INFRA_ID}-master-${ZONE_0}-ig --zone=${ZONE_0} --instances=${INFRA_ID}-master-0Add the second control plane machine to an internal load balancer instance group by running the following command:
$ gcloud compute instance-groups unmanaged add-instances ${INFRA_ID}-master-${ZONE_1}-ig --zone=${ZONE_1} --instances=${INFRA_ID}-master-1Add the third control plane machine to an internal load balancer instance group by running the following command:
$ gcloud compute instance-groups unmanaged add-instances ${INFRA_ID}-master-${ZONE_2}-ig --zone=${ZONE_2} --instances=${INFRA_ID}-master-2
For an external cluster, you must also add the control plane machines to external load balancer target pools.
Add the first control plane machine to an external load balancer pool by running the following command:
$ gcloud compute target-pools add-instances ${INFRA_ID}-api-target-pool --instances-zone="${ZONE_0}" --instances=${INFRA_ID}-master-0Add the second control plane machine to an external load balancer pool by running the following command:
$ gcloud compute target-pools add-instances ${INFRA_ID}-api-target-pool --instances-zone="${ZONE_1}" --instances=${INFRA_ID}-master-1Add the third control plane machine to an external load balancer pool by running the following command:
$ gcloud compute target-pools add-instances ${INFRA_ID}-api-target-pool --instances-zone="${ZONE_2}" --instances=${INFRA_ID}-master-2
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.16.1. Infrastructure Manager template for control plane machines Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the control plane machines that you need for your OpenShift Container Platform cluster:
Example 10.7. 05_control_plane.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
google-beta = {
source = "hashicorp/google-beta",
version = ">= 4.0.0"
}
local = {
source = "hashicorp/local",
version = ">= 2.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
# Terraform handles lists but the infra-manager --input-values only
# supports scalar types.
# If you require more or less zones, you must manually add them below
# as a single variable for each. You must add the zones to the
# locals `zones` list below.
variable "zone_0" {
type = string
description = "Zone 1 for the instance types."
}
variable "zone_1" {
type = string
description = "Zone 2 for the instance types."
}
variable "zone_2" {
type = string
description = "Zone 3 for the instance types."
}
variable "subnet" {
type = string
description = "Control plane subnet."
}
variable "image" {
type = string
description = "Cluster Image."
}
variable "machine_type" {
type = string
description = "Machine type for the control plane machine."
default = "n1-standard-4"
}
variable "disk_size" {
type = string
description = "Size in GB for the root volume."
default = "128"
}
variable "disk_type" {
type = string
description = "Type of storage disk for the vm."
default = "pd-ssd"
}
variable "service_account_email" {
type = string
description = "Email for the service account attached to the control planes."
}
data "local_file" "ignition_file" {
filename = "${path.module}/master.ign"
}
resource "google_compute_instance" "master_0" {
provider = google-beta
name = "${var.infra_id}-master-0"
zone = "${var.zone_0}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-master"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.disk_size}"
image = "${var.image}"
type = "${var.disk_type}"
}
}
network_interface {
subnetwork = "${var.subnet}"
}
metadata = {
user-data = data.local_file.ignition_file.content
}
service_account {
email = "${var.service_account_email}"
scopes = ["https://www.googleapis.com/auth/cloud-platform"]
}
}
resource "google_compute_instance" "master_1" {
provider = google-beta
name = "${var.infra_id}-master-1"
zone = "${var.zone_1}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-master"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.disk_size}"
image = "${var.image}"
type = "${var.disk_type}"
}
}
network_interface {
subnetwork = "${var.subnet}"
}
metadata = {
user-data = data.local_file.ignition_file.content
}
service_account {
email = "${var.service_account_email}"
scopes = ["https://www.googleapis.com/auth/cloud-platform"]
}
}
resource "google_compute_instance" "master_2" {
provider = google-beta
name = "${var.infra_id}-master-2"
zone = "${var.zone_2}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-master"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.disk_size}"
image = "${var.image}"
type = "${var.disk_type}"
}
}
network_interface {
subnetwork = "${var.subnet}"
}
metadata = {
user-data = data.local_file.ignition_file.content
}
service_account {
email = "${var.service_account_email}"
scopes = ["https://www.googleapis.com/auth/cloud-platform"]
}
}
10.17. Creating additional worker machines in Google Cloud Copy linkLink copied to clipboard!
You can create worker machines in Google Cloud for your cluster by using the Infrastructure Manager template. You can adjust the number of machines by modifying the number of google_compute_instance resources in the provided template.
If you do not use the provided Infrastructure Manager template to create your compute machines, you must review the provided information and manually create the infrastructure. If your cluster does not initialize correctly, you might have to contact Red Hat support with your installation logs.
If you are installing a three-node cluster, skip this step. A three-node cluster consists of three control plane machines, which also act as compute machines.
Prerequisites
- Ensure you defined the variables in the Exporting common variables, Creating load balancers in Google Cloud, and Creating the bootstrap machine in Google Cloud sections.
- Create the bootstrap machine.
- Create the control plane machines.
Procedure
Copy the template from the Infrastructure Manager template for worker machines section of this topic and save it as
06_worker.tfin a folder called06_workeron your computer. This template describes the worker machines that your cluster requires.You can edit the
06_worker.tffile to add additional tags to the compute machines, by modifying the existingtagsstanza as follows:resource "google_compute_instance" "worker_0" { # ... tags = [ "${var.infra_id}-worker-0", "custom-tag-example" ] # ... }
Copy the
worker.ignfile from your installation directory into the06_workerfolder by running the following command:$ cp <installation_directory>/worker.ign 06_worker/worker.ign<installation_directory>specifies the directory where you created the Ignition configuration files.Create the deployment by running the following command:
$ gcloud infra-manager deployments apply <worker_deployment_name> \ --location=${REGION} \ --project=${PROJECT_NAME} \ --local-source=./06_worker \ --input-values=infra_id=${INFRA_ID},project=${PROJECT_NAME},region=${REGION},zone_0=${ZONE_0},zone_1=${ZONE_1},subnet=${COMPUTE_SUBNET},image=${CLUSTER_IMAGE},service_account_email=${WORKER_SERVICE_ACCOUNT} \ --service-account=${INSTALL_SERVICE_ACCOUNT}<worker_deployment_name>specifies the name of the deployment.Remove the
worker.ignfile by running the following command:$ rm 06_worker/worker.ign
Verification
Verify the deployment is active by running the following command:
$ gcloud infra-manager deployments describe <deployment_name> --format='value(state)'Replace
<deployment_name>with the name of the deployment you created.Example output
ACTIVE
10.17.1. Infrastructure Manager template for worker machines Copy linkLink copied to clipboard!
You can use the following Infrastructure Manager template to deploy the worker machines that you need for your OpenShift Container Platform cluster:
Example 10.8. 06_worker.tf Infrastructure Manager template
terraform {
# Infra manager supports specific Terraform versions; ensure compatibility
required_version = ">=1.2.3"
required_providers {
google = {
source = "hashicorp/google"
version = ">= 4.0.0"
}
}
}
provider "google-beta" {
project = "${var.project}"
region = "${var.region}"
}
variable "infra_id" {
type = string
description = "OpenShift Installer Infrastructure ID"
}
variable "project" {
type = string
description = "Project ID"
}
variable "region" {
type = string
description = "GCP Region where the resources will be created."
default = "us-central1"
}
# Terraform handles lists but the infra-manager --input-values only
# supports scalar types.
# If you require more or less zones, you must manually add them below
# as a single variable for each. You must add the zones to the
# locals `zones` list below.
variable "zone_0" {
type = string
description = "Zone 1 for the instance types."
}
variable "zone_1" {
type = string
description = "Zone 2 for the instance types."
}
variable "subnet" {
type = string
description = "Compute subnet."
}
variable "image" {
type = string
description = "Cluster Image."
}
variable "machine_type" {
type = string
description = "Machine type for the compute machine."
default = "n1-standard-4"
}
variable "disk_size" {
type = string
description = "Size in GB for the root volume."
default = "128"
}
variable "disk_type" {
type = string
description = "Type of storage disk for the vm."
default = "pd-ssd"
}
variable "service_account_email" {
type = string
description = "Email for the service account attached to the compute nodes."
}
data "local_file" "ignition_file" {
filename = "${path.module}/worker.ign"
}
resource "google_compute_instance" "worker_0" {
provider = google-beta
name = "${var.infra_id}-worker-0"
zone = "${var.zone_0}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-worker"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.disk_size}"
image = "${var.image}"
type = "${var.disk_type}"
}
}
network_interface {
subnetwork = "${var.subnet}"
}
metadata = {
user-data = data.local_file.ignition_file.content
}
service_account {
email = "${var.service_account_email}"
scopes = ["https://www.googleapis.com/auth/cloud-platform"]
}
}
resource "google_compute_instance" "worker_1" {
provider = google-beta
name = "${var.infra_id}-worker-1"
zone = "${var.zone_1}"
machine_type = "${var.machine_type}"
tags = [
"${var.infra_id}-worker"
]
boot_disk {
auto_delete = true
initialize_params {
size = "${var.disk_size}"
image = "${var.image}"
type = "${var.disk_type}"
}
}
network_interface {
subnetwork = "${var.subnet}"
}
metadata = {
user-data = data.local_file.ignition_file.content
}
service_account {
email = "${var.service_account_email}"
scopes = ["https://www.googleapis.com/auth/cloud-platform"]
}
}
10.18. Removing bootstrap resources in Google Cloud Copy linkLink copied to clipboard!
After you create all of the required infrastructure in Google Cloud, wait for the bootstrap process to complete on the machines that you provisioned by using the Ignition config files. The installation program created the Ignition config files.
Prerequisites
- Ensure you defined the variables in the Exporting common variables and Creating load balancers in Google Cloud sections.
- Create the bootstrap machine.
- Create the control plane machines.
Procedure
Change to the directory that includes the installation program and run the following command:
$ ./openshift-install wait-for bootstrap-complete --dir <installation_directory> \1 --log-level info2 If the command exits without a
FATALwarning, your production control plane has initialized.To remove the bootstrap instance group from the backend services' backends, run the following commands:
$ gcloud compute backend-services remove-backend ${INFRA_ID}-api-internal --region=${REGION} --instance-group=${INFRA_ID}-bootstrap-ig --instance-group-zone=${ZONE_0}$ ingress_backendservice=$(gcloud compute backend-services list --filter="backends.group~${INFRA_ID}" --format='value(name)' | grep -v "${INFRA_ID}")If
ingress_backendserviceis not empty, run the followingdescribecommand for the bootstrap group:$ gcloud compute backend-services describe ${ingress_backendservice} --region=${REGION}If the
describecommand displays that the bootstrap group is one of its backends, run the followingremove-backendcommand to remove the bootstrap group from the backends:$ gcloud compute backend-services remove-backend ${ingress_backendservice} --region=${REGION} --instance-group=${INFRA_ID}-bootstrap-ig --instance-group-zone=${ZONE_0}To remove the bucket and the deployment, run the following commands:
$ gcloud storage rm "gs://${INFRA_ID}-bootstrap-ignition/bootstrap.ign"$ gcloud storage rm --recursive "gs://${INFRA_ID}-bootstrap-ignition/"$ gcloud infra-manager deployments delete <bootstrap_deployment_name> \ --project=${PROJECT_NAME} --location=${REGION} --quietSpecify the name of the bootstrap deployment you created for
<bootstrap_deployment_name>.
10.19. Installing the OpenShift CLI on Linux Copy linkLink copied to clipboard!
To manage your cluster and deploy applications from the command line, install the OpenShift CLI (oc) binary on Linux.
If you installed an earlier version of oc, you cannot use it to complete all of the commands in OpenShift Container Platform.
Download and install the new version of oc.
Procedure
- Navigate to the Download OpenShift Container Platform page on the Red Hat Customer Portal.
- Select the architecture from the Product Variant list.
- Select the appropriate version from the Version list.
- Click Download Now next to the OpenShift v4.22 Linux Clients entry and save the file.
Unpack the archive:
$ tar xvf <file>Place the
ocbinary in a directory that is on yourPATH.To check your
PATH, execute the following command:$ echo $PATH
Verification
After you install the OpenShift CLI, it is available using the
occommand:$ oc <command>
10.20. Installing the OpenShift CLI on Windows Copy linkLink copied to clipboard!
To manage your cluster and deploy applications from the command line, install OpenShift CLI (oc) binary on Windows.
If you installed an earlier version of oc, you cannot use it to complete all of the commands in OpenShift Container Platform.
Download and install the new version of oc.
Procedure
- Navigate to the Download OpenShift Container Platform page on the Red Hat Customer Portal.
- Select the appropriate version from the Version list.
- Click Download Now next to the OpenShift v4.22 Windows Client entry and save the file.
- Extract the archive with a ZIP program.
Move the
ocbinary to a directory that is on yourPATHvariable.To check your
PATHvariable, open the command prompt and execute the following command:C:\> path
Verification
After you install the OpenShift CLI, it is available using the
occommand:C:\> oc <command>
10.21. Installing the OpenShift CLI on macOS Copy linkLink copied to clipboard!
To manage your cluster and deploy applications from the command line, install the OpenShift CLI (oc) binary on macOS.
If you installed an earlier version of oc, you cannot use it to complete all of the commands in OpenShift Container Platform.
Download and install the new version of oc.
Procedure
- Navigate to the Download OpenShift Container Platform page on the Red Hat Customer Portal.
- Select the architecture from the Product Variant list.
- Select the appropriate version from the Version list.
Click Download Now next to the OpenShift v4.22 macOS Clients entry and save the file.
NoteFor macOS arm64, choose the OpenShift v4.22 macOS arm64 Client entry.
- Unpack and unzip the archive.
Move the
ocbinary to a directory on yourPATHvariable.To check your
PATHvariable, open a terminal and execute the following command:$ echo $PATH
Verification
Verify your installation by using an
occommand:$ oc <command>
10.22. Logging in to the cluster by using the CLI Copy linkLink copied to clipboard!
To log in to your cluster as the default system user, export the kubeconfig file. This configuration enables the CLI to authenticate and connect to the specific API server created during OpenShift Container Platform installation.
The kubeconfig file is specific to a cluster and is created during OpenShift Container Platform installation.
Prerequisites
-
You installed the OpenShift CLI (
oc). - Ensure the bootstrap process completed successfully.
Procedure
Export the
kubeadmincredentials by running the following command:$ export KUBECONFIG=<installation_directory>/auth/kubeconfigwhere:
<installation_directory>- Specifies the path to the directory that stores the installation files.
Verify you can run
occommands successfully using the exported configuration by running the following command:$ oc whoamiExample output
system:admin
Next steps
- "Customize your cluster"
- "Remote health reporting"
10.23. Approving the certificate signing requests for your machines Copy linkLink copied to clipboard!
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.
Prerequisites
- You added machines to your cluster.
Procedure
Confirm that the cluster recognizes the machines:
$ oc get nodesExample output
NAME STATUS ROLES AGE VERSION master-0 Ready master 63m v1.35.4 master-1 Ready master 63m v1.35.4 master-2 Ready master 64m v1.35.4The output lists all of the machines that you created.
NoteThe 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
PendingorApprovedstatus for each machine that you added to the cluster:$ oc get csrExample output
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
Pendingstatus, approve the CSRs for your cluster machines:NoteYou must 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
machine-approverif the Kubelet requests a new certificate with identical parameters.NoteFor 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
oc exec,oc rsh, andoc logscommands cannot succeed, because a serving certificate is required when the API server connects to the kubelet. Any operation that contacts the Kubelet endpoint requires this certificate approval to be in place. The method must watch for new CSRs, confirm that the CSR was submitted by thenode-bootstrapperservice account in thesystem:nodeorsystem:admingroups, and confirm the identity of the node.To approve them individually, run the following command for each valid CSR:
$ oc adm certificate approve <csr_name>where:
<csr_name>- Specifies 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 approveNoteSome Operators might not become available until some CSRs are approved. Each node submits two CSRs, so you may need to run the command to approve CSRs multiple times.
Now that your client requests are approved, you must review the server requests for each machine that you added to the cluster:
$ oc get csrExample output
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
Pendingstatus, 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>where:
<csr_name>- Specifies 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
Readystatus. Verify this by running the following command:$ oc get nodesExample output
NAME STATUS ROLES AGE VERSION master-0 Ready master 73m v1.35.4 master-1 Ready master 73m v1.35.4 master-2 Ready master 74m v1.35.4 worker-0 Ready worker 11m v1.35.4 worker-1 Ready worker 11m v1.35.4NoteIt can take a few minutes after approval of the server CSRs for the machines to transition to the
Readystatus.
10.24. Adding the ingress DNS records Copy linkLink copied to clipboard!
DNS zone configuration is removed when creating Kubernetes manifests and generating Ignition configs. You must manually create DNS records that point at the ingress load balancer. You can create either a wildcard *.apps.{baseDomain}. or specific records. You can use A, CNAME, and other records per your requirements.
Prerequisites
- Ensure you defined the variables in the Exporting common variables section.
- Remove the DNS Zone configuration when creating Kubernetes manifests and generating Ignition configs.
- Ensure the bootstrap process completed successfully.
Procedure
Wait for the Ingress router to create a load balancer and populate the
EXTERNAL-IPfield:$ oc -n openshift-ingress get service router-defaultExample output
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE router-default LoadBalancer 172.30.18.154 35.233.157.184 80:32288/TCP,443:31215/TCP 98Add the A record to your zones:
To use A records:
Export the variable for the router IP address:
$ export ROUTER_IP=`oc -n openshift-ingress get service router-default --no-headers | awk '{print $4}'`Add the A record to the private zones:
+
$ if [ -f transaction.yaml ]; then rm transaction.yaml; fi
+
$ gcloud dns record-sets transaction start --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
+
$ gcloud dns record-sets transaction add ${ROUTER_IP} --name \*.apps.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 300 --type A --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
+
$ gcloud dns record-sets transaction execute --zone ${INFRA_ID}-private-zone --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
For an external cluster, also add the A record to the public zones:
+
$ if [ -f transaction.yaml ]; then rm transaction.yaml; fi
+
$ gcloud dns record-sets transaction start --zone ${BASE_DOMAIN_ZONE_NAME} --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
+
$ gcloud dns record-sets transaction add ${ROUTER_IP} --name \*.apps.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 300 --type A --zone ${BASE_DOMAIN_ZONE_NAME} --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
+
$ gcloud dns record-sets transaction execute --zone ${BASE_DOMAIN_ZONE_NAME} --project ${HOST_PROJECT} --account ${HOST_PROJECT_ACCOUNT}
To add explicit domains instead of using a wildcard, create entries for each of the cluster’s current routes:
$ oc get --all-namespaces -o jsonpath='{range .items[*]}{range .status.ingress[*]}{.host}{"\n"}{end}{end}' routesExample output
oauth-openshift.apps.your.cluster.domain.example.com console-openshift-console.apps.your.cluster.domain.example.com downloads-openshift-console.apps.your.cluster.domain.example.com alertmanager-main-openshift-monitoring.apps.your.cluster.domain.example.com prometheus-k8s-openshift-monitoring.apps.your.cluster.domain.example.com
10.25. Adding ingress firewall rules Copy linkLink copied to clipboard!
The cluster requires several firewall rules. If you do not use a shared VPC, these rules are created by the Ingress Controller via the Google Cloud cloud provider. When you use a shared VPC, you can either create cluster-wide firewall rules for all services now or create each rule based on events, when the cluster requests access. By creating each rule when the cluster requests access, you know exactly which firewall rules are required. By creating cluster-wide firewall rules, you can apply the same rule set across multiple clusters.
If you choose to create each rule based on events, you must create firewall rules after you provision the cluster and during the life of the cluster when the console notifies you that rules are missing. Events that are similar to the following event are displayed, and you must add the firewall rules that are required:
$ oc get events -n openshift-ingress --field-selector="reason=LoadBalancerManualChange"
Example output
Firewall change required by security admin: `gcloud compute firewall-rules create k8s-fw-a26e631036a3f46cba28f8df67266d55 --network example-network --description "{\"kubernetes.io/service-name\":\"openshift-ingress/router-default\", \"kubernetes.io/service-ip\":\"35.237.236.234\"}\" --allow tcp:443,tcp:80 --source-ranges 0.0.0.0/0 --target-tags exampl-fqzq7-master,exampl-fqzq7-worker --project example-project`
If you encounter issues when creating these rule-based events, you can configure the cluster-wide firewall rules while your cluster is running.
10.26. Completing a Google Cloud installation on user-provisioned infrastructure Copy linkLink copied to clipboard!
After you start the OpenShift Container Platform installation on Google Cloud user-provisioned infrastructure, you can monitor the cluster events until the cluster is ready.
Prerequisites
- Ensure the bootstrap process completed successfully.
Procedure
Complete the cluster installation:
$ ./openshift-install --dir <installation_directory> wait-for install-complete1 Example output
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.
Important-
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
node-bootstrappercertificate signing requests (CSRs) to recover kubelet certificates. See the documentation for Recovering from expired control plane certificates for more information. - It is recommended that you use Ignition config files within 12 hours after they are generated because the 24-hour certificate rotates from 16 to 22 hours after the cluster is installed. By using the Ignition config files within 12 hours, you can avoid installation failure if the certificate update runs during installation.
Observe the running state of your cluster.
Run the following command to view the current cluster version and status:
$ oc get clusterversionExample output
NAME VERSION AVAILABLE PROGRESSING SINCE STATUS version False True 24m Working towards 4.5.4: 99% completeRun the following command to view the Operators managed on the control plane by the Cluster Version Operator (CVO):
$ oc get clusteroperatorsExample output
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE authentication 4.5.4 True False False 7m56s cloud-credential 4.5.4 True False False 31m cluster-autoscaler 4.5.4 True False False 16m console 4.5.4 True False False 10m csi-snapshot-controller 4.5.4 True False False 16m dns 4.5.4 True False False 22m etcd 4.5.4 False False False 25s image-registry 4.5.4 True False False 16m ingress 4.5.4 True False False 16m insights 4.5.4 True False False 17m kube-apiserver 4.5.4 True False False 19m kube-controller-manager 4.5.4 True False False 20m kube-scheduler 4.5.4 True False False 20m kube-storage-version-migrator 4.5.4 True False False 16m machine-api 4.5.4 True False False 22m machine-config 4.5.4 True False False 22m marketplace 4.5.4 True False False 16m monitoring 4.5.4 True False False 10m network 4.5.4 True False False 23m node-tuning 4.5.4 True False False 23m openshift-apiserver 4.5.4 True False False 17m openshift-controller-manager 4.5.4 True False False 15m openshift-samples 4.5.4 True False False 16m operator-lifecycle-manager 4.5.4 True False False 22m operator-lifecycle-manager-catalog 4.5.4 True False False 22m operator-lifecycle-manager-packageserver 4.5.4 True False False 18m service-ca 4.5.4 True False False 23m service-catalog-apiserver 4.5.4 True False False 23m service-catalog-controller-manager 4.5.4 True False False 23m storage 4.5.4 True False False 17mRun the following command to view your cluster pods:
$ oc get pods --all-namespacesExample output
NAMESPACE NAME READY STATUS RESTARTS AGE kube-system etcd-member-ip-10-0-3-111.us-east-2.compute.internal 1/1 Running 0 35m kube-system etcd-member-ip-10-0-3-239.us-east-2.compute.internal 1/1 Running 0 37m kube-system etcd-member-ip-10-0-3-24.us-east-2.compute.internal 1/1 Running 0 35m openshift-apiserver-operator openshift-apiserver-operator-6d6674f4f4-h7t2t 1/1 Running 1 37m openshift-apiserver apiserver-fm48r 1/1 Running 0 30m openshift-apiserver apiserver-fxkvv 1/1 Running 0 29m openshift-apiserver apiserver-q85nm 1/1 Running 0 29m ... openshift-service-ca-operator openshift-service-ca-operator-66ff6dc6cd-9r257 1/1 Running 0 37m openshift-service-ca apiservice-cabundle-injector-695b6bcbc-cl5hm 1/1 Running 0 35m openshift-service-ca configmap-cabundle-injector-8498544d7-25qn6 1/1 Running 0 35m openshift-service-ca service-serving-cert-signer-6445fc9c6-wqdqn 1/1 Running 0 35m openshift-service-catalog-apiserver-operator openshift-service-catalog-apiserver-operator-549f44668b-b5q2w 1/1 Running 0 32m openshift-service-catalog-controller-manager-operator openshift-service-catalog-controller-manager-operator-b78cr2lnm 1/1 Running 0 31mWhen the current cluster version is
AVAILABLE, the installation is complete.
10.27. Telemetry access for OpenShift Container Platform Copy linkLink copied to clipboard!
To provide metrics about cluster health and the success of updates, the Telemetry service requires internet access. When connected, this service runs automatically by default and registers your cluster to OpenShift Cluster Manager.
After you confirm that your OpenShift Cluster Manager inventory is correct, either maintained automatically by Telemetry or manually by using OpenShift Cluster Manager,use subscription watch to track your OpenShift Container Platform subscriptions at the account or multi-cluster level. For more information about subscription watch, see "Data Gathered and Used by Red Hat’s subscription services" in the Additional resources section.
10.28. Next steps Copy linkLink copied to clipboard!
- Customize your cluster.
- If necessary, you can Remote health reporting.