Installing a cluster on GCP in a restricted network with user-provisioned infrastructure

In OKD version 4.13, you can install a cluster on Google Cloud Platform (GCP) that uses infrastructure that you provide and an internal mirror of the installation release content.

The steps for performing a user-provided infrastructure install are outlined here. Several Deployment 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.

Prerequisites

• You reviewed details about the OKD installation and update processes.

• You read the documentation on selecting a cluster installation method and preparing it for users.

• You created a registry on your mirror host and obtained the imageContentSources data for your version of OKD.

  Because the installation media is on the mirror host, you can use that computer to complete all installation steps.

• If you use a firewall, you configured it to allow the sites that your cluster requires access to. While you might need to grant access to more sites, you must grant access to *.googleapis.com and accounts.google.com.

• 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-system namespace, you can manually create and maintain IAM credentials.

About installations in restricted networks

In OKD 4.13, you can perform an installation that does not require an active connection to the internet to obtain software components. Restricted network installations can be completed using installer-provisioned infrastructure or user-provisioned infrastructure, depending on the cloud platform to which you are installing the cluster.

If you choose to perform a restricted network installation on a cloud platform, you still require access to its cloud APIs. Some cloud functions, like Amazon Web Service’s Route 53 DNS and IAM services, require internet access. Depending on your network, you might require less internet access for an installation on bare metal hardware, Nutanix, or on VMware vSphere.

To complete a restricted network installation, you must create a registry that mirrors the contents of the OpenShift image registry and contains the installation media. You can create this registry on a mirror host, which can access both the internet and your closed network, or by using other methods that meet your restrictions.

Additional limits

Clusters in restricted networks have the following additional limitations and restrictions:

• The ClusterVersion status includes an Unable to retrieve available updates error.

• By default, you cannot use the contents of the Developer Catalog because you cannot access the required image stream tags.

Configuring your GCP project

Before you can install OKD, you must configure a Google Cloud Platform (GCP) project to host it.

Creating a GCP project

To install OKD, you must create a project in your Google Cloud Platform (GCP) account to host the cluster.

Procedure

• Create a project to host your OKD cluster. See Creating and Managing Projects in the GCP documentation.

  Your GCP 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.

Enabling API services in GCP

Your Google Cloud Platform (GCP) project requires access to several API services to complete OKD 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 GCP documentation.

  Table 1. Required API services

  API service	Console service name
  Compute Engine API	compute.googleapis.com
  Cloud Resource Manager API	cloudresourcemanager.googleapis.com
  Google DNS API	dns.googleapis.com
  IAM Service Account Credentials API	iamcredentials.googleapis.com
  Identity and Access Management (IAM) API	iam.googleapis.com
  Service Usage API	serviceusage.googleapis.com

  Table 2. Optional API services

  API service	Console service name
  Google Cloud APIs	cloudapis.googleapis.com
  Service Management API	servicemanagement.googleapis.com
  Google Cloud Storage JSON API	storage-api.googleapis.com
  Cloud Storage	storage-component.googleapis.com

Configuring DNS for GCP

To install OKD, the Google Cloud Platform (GCP) account you use must have a dedicated public hosted zone in the same project that you host the OKD cluster. 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

1. Identify your domain, or subdomain, and registrar. You can transfer an existing domain and registrar or obtain a new one through GCP or another source.

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

2. Create a public hosted zone for your domain or subdomain in your GCP project. See Creating public zones in the GCP documentation.

   Use an appropriate root domain, such as openshiftcorp.com, or subdomain, such as clusters.openshiftcorp.com.

3. Extract the new authoritative name servers from the hosted zone records. See Look up your Cloud DNS name servers in the GCP documentation.

   You typically have four name servers.

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

5. If you migrated your root domain to Google Cloud DNS, migrate your DNS records. See Migrating to Cloud DNS in the GCP documentation.

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

GCP account limits

The OKD cluster uses a number of Google Cloud Platform (GCP) components, but the default Quotas do not affect your ability to install a default OKD 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.

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 GCP 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 OKD cluster.

Creating a service account in GCP

OKD requires a Google Cloud Platform (GCP) 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.

Prerequisites

• You created a project to host your cluster.

Procedure

1. Create a service account in the project that you use to host your OKD cluster. See Creating a service account in the GCP documentation.

2. Grant the service account the appropriate permissions. You can either grant the individual permissions that follow or assign the Owner role to it. See Granting roles to a service account for specific resources.

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

3. You can create the service account key in JSON format, or attach the service account to a GCP virtual machine. See Creating service account keys and Creating and enabling service accounts for instances in the GCP documentation.

   You must have a service account key or a virtual machine with an attached service account to create the cluster.

   If you use a virtual machine with an attached service account to create your cluster, you must set credentialsMode: Manual in the install-config.yaml file before installation.

Required GCP roles

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

• IAM 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 passthrough credentials mode

• Compute Load Balancer Admin

• IAM Role Viewer

Required roles for user-provisioned GCP infrastructure

• Deployment Manager Editor

The roles are applied to the service accounts that the control plane and compute machines use:

Required GCP permissions for user-provisioned infrastructure

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

If your organization’s security policies require a more restrictive set of permissions, you can create custom roles with the necessary permissions. The following permissions are required for the user-provisioned infrastructure for creating and deleting the OKD cluster.

Required permissions for creating network resources

• compute.addresses.create

• compute.addresses.createInternal

• compute.addresses.delete

• compute.addresses.get

• compute.addresses.list

• compute.addresses.use

• compute.addresses.useInternal

• compute.firewalls.create

• compute.firewalls.delete

• compute.firewalls.get

• compute.firewalls.list

• compute.forwardingRules.create

• compute.forwardingRules.get

• compute.forwardingRules.list

• compute.forwardingRules.setLabels

• compute.networks.create

• compute.networks.get

• compute.networks.list

• compute.networks.updatePolicy

• compute.routers.create

• compute.routers.get

• compute.routers.list

• compute.routers.update

• compute.routes.list

• compute.subnetworks.create

• compute.subnetworks.get

• compute.subnetworks.list

• compute.subnetworks.use

• compute.subnetworks.useExternalIp

Required permissions for creating load balancer resources

• compute.regionBackendServices.create

• compute.regionBackendServices.get

• compute.regionBackendServices.list

• compute.regionBackendServices.update

• compute.regionBackendServices.use

• compute.targetPools.addInstance

• compute.targetPools.create

• compute.targetPools.get

• compute.targetPools.list

• compute.targetPools.removeInstance

• compute.targetPools.use

Required permissions for creating DNS resources

• dns.changes.create

• dns.changes.get

• dns.managedZones.create

• dns.managedZones.get

• dns.managedZones.list

• dns.networks.bindPrivateDNSZone

• dns.resourceRecordSets.create

• dns.resourceRecordSets.list

• dns.resourceRecordSets.update

Required permissions for creating Service Account resources

• iam.serviceAccountKeys.create

• iam.serviceAccountKeys.delete

• iam.serviceAccountKeys.get

• iam.serviceAccountKeys.list

• iam.serviceAccounts.actAs

• iam.serviceAccounts.create

• iam.serviceAccounts.delete

• iam.serviceAccounts.get

• iam.serviceAccounts.list

• resourcemanager.projects.get

• resourcemanager.projects.getIamPolicy

• resourcemanager.projects.setIamPolicy

Required permissions for creating compute resources

• compute.disks.create

• compute.disks.get

• compute.disks.list

• compute.instanceGroups.create

• compute.instanceGroups.delete

• compute.instanceGroups.get

• compute.instanceGroups.list

• compute.instanceGroups.update

• compute.instanceGroups.use

• compute.instances.create

• compute.instances.delete

• compute.instances.get

• compute.instances.list

• compute.instances.setLabels

• compute.instances.setMetadata

• compute.instances.setServiceAccount

• compute.instances.setTags

• compute.instances.use

• compute.machineTypes.get

• compute.machineTypes.list

Required for creating storage resources

• storage.buckets.create

• storage.buckets.delete

• storage.buckets.get

• storage.buckets.list

• storage.objects.create

• storage.objects.delete

• storage.objects.get

• storage.objects.list

Required permissions for creating health check resources

• compute.healthChecks.create

• compute.healthChecks.get

• compute.healthChecks.list

• compute.healthChecks.useReadOnly

• compute.httpHealthChecks.create

• compute.httpHealthChecks.get

• compute.httpHealthChecks.list

• compute.httpHealthChecks.useReadOnly

Required permissions to get GCP zone and region related information

• compute.globalOperations.get

• compute.regionOperations.get

• compute.regions.list

• compute.zoneOperations.get

• compute.zones.get

• compute.zones.list

Required permissions for checking services and quotas

• monitoring.timeSeries.list

• serviceusage.quotas.get

• serviceusage.services.list

Required IAM permissions for installation

• iam.roles.get

Required Images permissions for installation

• compute.images.create

• compute.images.delete

• compute.images.get

• compute.images.list

Optional permission for running gather bootstrap

• compute.instances.getSerialPortOutput

Required permissions for deleting network resources

• compute.addresses.delete

• compute.addresses.deleteInternal

• compute.addresses.list

• compute.firewalls.delete

• compute.firewalls.list

• compute.forwardingRules.delete

• compute.forwardingRules.list

• compute.networks.delete

• compute.networks.list

• compute.networks.updatePolicy

• compute.routers.delete

• compute.routers.list

• compute.routes.list

• compute.subnetworks.delete

• compute.subnetworks.list

Required permissions for deleting load balancer resources

• compute.regionBackendServices.delete

• compute.regionBackendServices.list

• compute.targetPools.delete

• compute.targetPools.list

Required permissions for deleting DNS resources

• dns.changes.create

• dns.managedZones.delete

• dns.managedZones.get

• dns.managedZones.list

• dns.resourceRecordSets.delete

• dns.resourceRecordSets.list

Required permissions for deleting Service Account resources

• iam.serviceAccounts.delete

• iam.serviceAccounts.get

• iam.serviceAccounts.list

• resourcemanager.projects.getIamPolicy

• resourcemanager.projects.setIamPolicy

Required permissions for deleting compute resources

• compute.disks.delete

• compute.disks.list

• compute.instanceGroups.delete

• compute.instanceGroups.list

• compute.instances.delete

• compute.instances.list

• compute.instances.stop

• compute.machineTypes.list

Required for deleting storage resources

• storage.buckets.delete

• storage.buckets.getIamPolicy

• storage.buckets.list

• storage.objects.delete

• storage.objects.list

Required permissions for deleting health check resources

• compute.healthChecks.delete

• compute.healthChecks.list

• compute.httpHealthChecks.delete

• compute.httpHealthChecks.list

Required Images permissions for deletion

• compute.images.delete

• compute.images.list

Required permissions to get Region related information

• compute.regions.get

Required Deployment Manager permissions

• deploymentmanager.deployments.create

• deploymentmanager.deployments.delete

• deploymentmanager.deployments.get

• deploymentmanager.deployments.list

• deploymentmanager.manifests.get

• deploymentmanager.operations.get

• deploymentmanager.resources.list

Supported GCP regions

You can deploy an OKD cluster to the following Google Cloud Platform (GCP) regions:

• 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-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)

Installing and configuring CLI tools for GCP

To install OKD on Google Cloud Platform (GCP) using user-provisioned infrastructure, you must install and configure the CLI tools for GCP.

Prerequisites

• You created a project to host your cluster.

• You created a service account and granted it the required permissions.

Procedure

1. Install the following binaries in $PATH:

   • gcloud

   • gsutil

   See Install the latest Cloud SDK version in the GCP documentation.

2. Authenticate using the gcloud tool with your configured service account.

   See Authorizing with a service account in the GCP documentation.

Requirements for a cluster with user-provisioned infrastructure

For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines.

This section describes the requirements for deploying OKD on user-provisioned infrastructure.

Required machines for cluster installation

The smallest OKD clusters require the following hosts:

The bootstrap and control plane machines must use Fedora CoreOS (FCOS) as the operating system. However, the compute machines can choose between Fedora CoreOS (FCOS), Fedora 8.6, Fedora 8.7, or Fedora 8.8.

See Red Hat Enterprise Linux technology capabilities and limits.

Minimum resource requirements for cluster installation

Each cluster machine must meet the following minimum requirements:

1. One vCPU is equivalent to one physical core when simultaneous multithreading (SMT), or hyperthreading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = vCPUs.

2. OKD 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.

3. As with all user-provisioned installations, if you choose to use Fedora 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 Fedora 7 compute machines is deprecated and has been removed in OKD 4.10 and later.

If an instance type for your platform meets the minimum requirements for cluster machines, it is supported to use in OKD.

Tested instance types for GCP

The following Google Cloud Platform instance types have been tested with OKD.

Machine series

• C2

• E2

• M1

• N1

• N2

• N2D

• Tau T2D

Using custom machine types

Using a custom machine type to install a OKD 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.

Creating the installation files for GCP

To install OKD on Google Cloud Platform (GCP) 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.

Optional: Creating a separate /var partition

It is recommended that disk partitioning for OKD be left to the installer. However, there are cases where you might want to create separate partitions in a part of the filesystem that you expect to grow.

OKD supports the addition of a single partition to attach storage to either the /var partition or a subdirectory of /var. For example:

• /var/lib/containers: Holds container-related content that can grow as more images and containers are added to a system.

• /var/lib/etcd: Holds data that you might want to keep separate for purposes such as performance optimization of etcd storage.

• /var: Holds data that you might want to keep separate for purposes such as auditing.

Storing the contents of a /var directory separately makes it easier to grow storage for those areas as needed and reinstall OKD at a later date and keep that data intact. With this method, you will not have to pull all your containers again, nor will you have to copy massive log files when you update systems.

Because /var must be in place before a fresh installation of Fedora CoreOS (FCOS), the following procedure sets up the separate /var partition by creating a machine config manifest that is inserted during the openshift-install preparation phases of an OKD installation.

Procedure

1. Create a directory to hold the OKD installation files:

   $ mkdir $HOME/clusterconfig

2. Run openshift-install to create a set of files in the manifest and openshift subdirectories. Answer the system questions as you are prompted:

   $ openshift-install create manifests --dir $HOME/clusterconfig

   Example output

   ? SSH Public Key ...
   INFO Credentials loaded from the "myprofile" profile in file "/home/myuser/.aws/credentials"
   INFO Consuming Install Config from target directory
   INFO Manifests created in: $HOME/clusterconfig/manifests and $HOME/clusterconfig/openshift

3. Optional: Confirm that the installation program created manifests in the clusterconfig/openshift directory:

   $ ls $HOME/clusterconfig/openshift/

   Example output

   99_kubeadmin-password-secret.yaml
   99_openshift-cluster-api_master-machines-0.yaml
   99_openshift-cluster-api_master-machines-1.yaml
   99_openshift-cluster-api_master-machines-2.yaml
   ...

4. Create a Butane config that configures the additional partition. For example, name the file $HOME/clusterconfig/98-var-partition.bu, change the disk device name to the name of the storage device on the worker systems, and set the storage size as appropriate. This example places the /var directory on a separate partition:

   variant: openshift
   version: 4.13.0
   metadata:
     labels:
       machineconfiguration.openshift.io/role: worker
     name: 98-var-partition
   storage:
     disks:
     - device: /dev/<device_name> (1)
       partitions:
       - label: var
         start_mib: <partition_start_offset> (2)
         size_mib: <partition_size> (3)
     filesystems:
       - device: /dev/disk/by-partlabel/var
         path: /var
         format: xfs
         mount_options: [defaults, prjquota] (4)
         with_mount_unit: true

   1	The storage device name of the disk that you want to partition.
   2	When adding a data partition to the boot disk, a minimum value of 25000 MiB (Mebibytes) is recommended. The root file system is automatically resized to fill all available space up to the specified offset. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of FCOS might overwrite the beginning of the data partition.
   3	The size of the data partition in mebibytes.
   4	The prjquota mount option must be enabled for filesystems used for container storage.

   When creating a separate /var partition, you cannot use different instance types for worker nodes, if the different instance types do not have the same device name.

5. Create a manifest from the Butane config and save it to the clusterconfig/openshift directory. For example, run the following command:

   $ butane $HOME/clusterconfig/98-var-partition.bu -o $HOME/clusterconfig/openshift/98-var-partition.yaml

6. Run openshift-install again to create Ignition configs from a set of files in the manifest and openshift subdirectories:

   $ openshift-install create ignition-configs --dir $HOME/clusterconfig
   $ ls $HOME/clusterconfig/
   auth  bootstrap.ign  master.ign  metadata.json  worker.ign

Now you can use the Ignition config files as input to the installation procedures to install Fedora CoreOS (FCOS) systems.

Creating the installation configuration file

You can customize the OKD cluster you install on Google Cloud Platform (GCP).

Prerequisites

• Obtain the OKD installation program and the pull secret for your cluster. For a restricted network installation, these files are on your mirror host.

• Have the imageContentSources values that were generated during mirror registry creation.

• Obtain the contents of the certificate for your mirror registry.

• Obtain service principal permissions at the subscription level.

Procedure

1. Create the install-config.yaml file.

   1. Change to the directory that contains the installation program and run the following command:

      $ ./openshift-install create install-config --dir <installation_directory> (1)

      1	For <installation_directory>, specify the directory name to store the files that the installation program creates.

      When specifying the directory:

      • Verify that the directory has the execute permission. This permission is required to run Terraform binaries under the installation directory.

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

   2. At the prompts, provide the configuration details for your cloud:

      1. Optional: Select an SSH key to use to access your cluster machines.

         For production OKD clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your ssh-agent process uses.

      2. Select gcp as the platform to target.

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

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

      5. Select the region to deploy the cluster to.

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

      7. Enter a descriptive name for your cluster.

      8. Paste the pull secret from the Red Hat OpenShift Cluster Manager. This field is optional.

1. Edit the install-config.yaml file to give the additional information that is required for an installation in a restricted network.

   1. Update the pullSecret value to contain the authentication information for your registry:

      pullSecret: '{"auths":{"<mirror_host_name>:5000": {"auth": "<credentials>","email": "you@example.com"}}}'

      For <mirror_host_name>, specify the registry domain name that you specified in the certificate for your mirror registry, and for <credentials>, specify the base64-encoded user name and password for your mirror registry.

   2. Add the additionalTrustBundle parameter and value.

      additionalTrustBundle: |
        -----BEGIN CERTIFICATE-----
        ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
        -----END CERTIFICATE-----

      The value must be the contents of the certificate file that you used for your mirror registry. The certificate file can be an existing, trusted certificate authority, or the self-signed certificate that you generated for the mirror registry.

   3. Define the network and subnets for the VPC to install the cluster in under the parent platform.gcp field:

      network: <existing_vpc>
      controlPlaneSubnet: <control_plane_subnet>
      computeSubnet: <compute_subnet>

      For platform.gcp.network, specify the name for the existing Google VPC. For platform.gcp.controlPlaneSubnet and platform.gcp.computeSubnet, specify the existing subnets to deploy the control plane machines and compute machines, respectively.

   4. Add the image content resources, which resemble the following YAML excerpt:

      imageContentSources:
      - mirrors:
        - <mirror_host_name>:5000/<repo_name>/release
        source: quay.io/openshift-release-dev/ocp-release
      - mirrors:
        - <mirror_host_name>:5000/<repo_name>/release
        source: registry.redhat.io/ocp/release

      For these values, use the imageContentSources that you recorded during mirror registry creation.

2. Make any other modifications to the install-config.yaml file that you require. You can find more information about the available parameters in the Installation configuration parameters section.

3. Back up the install-config.yaml file so that you can use it to install multiple clusters.

   The install-config.yaml file is consumed during the installation process. If you want to reuse the file, you must back it up now.

Enabling Shielded VMs

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.

Prerequisites

• You have created an install-config.yaml file.

Procedure

• Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add one of the following stanzas:

  1. To use shielded VMs for only control plane machines:

     controlPlane:
       platform:
         gcp:
            secureBoot: Enabled

  2. To use shielded VMs for only compute machines:

     compute:
     - platform:
         gcp:
            secureBoot: Enabled

  3. To use shielded VMs for all machines:

     platform:
       gcp:
         defaultMachinePlatform:
            secureBoot: Enabled

Enabling Confidential VMs

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.

Prerequisites

• You have created an install-config.yaml file.

Procedure

• Use a text editor to edit the install-config.yaml file prior to deploying your cluster and add one of the following stanzas:

  1. To use confidential VMs for only control plane machines:

     controlPlane:
       platform:
         gcp:
            confidentialCompute: Enabled (1)
            type: n2d-standard-8 (2)
            onHostMaintenance: Terminate (3)

     1	Enable confidential VMs.
     2	Specify a machine type that supports Confidential VMs. Confidential VMs require the N2D or C2D 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.

  2. To use confidential VMs for only compute machines:

     compute:
     - platform:
         gcp:
            confidentialCompute: Enabled
            type: n2d-standard-8
            onHostMaintenance: Terminate

  3. To use confidential VMs for all machines:

     platform:
       gcp:
         defaultMachinePlatform:
            confidentialCompute: Enabled
            type: n2d-standard-8
            onHostMaintenance: Terminate

Configuring the cluster-wide proxy during installation

Production environments can deny direct access to the internet and instead have an HTTP or HTTPS proxy available. You can configure a new OKD cluster to use a proxy by configuring the proxy settings in the install-config.yaml file.

Prerequisites

• You have an existing install-config.yaml file.

• You 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 Proxy object’s spec.noProxy field to bypass the proxy if necessary.

  The Proxy object status.noProxy field is populated with the values of the networking.machineNetwork[].cidr, networking.clusterNetwork[].cidr, and networking.serviceNetwork[] fields from your installation configuration. For installations on Amazon Web Services (AWS), Google Cloud Platform (GCP), Microsoft Azure, and OpenStack, the Proxy object status.noProxy field is also populated with the instance metadata endpoint (169.254.169.254).

Procedure

1. Edit your install-config.yaml file and add the proxy settings. For example:

   apiVersion: v1
   baseDomain: my.domain.com
   proxy:
     httpProxy: http://<username>:<pswd>@<ip>:<port> (1)
     httpsProxy: https://<username>:<pswd>@<ip>:<port> (2)
     noProxy: example.com (3)
   additionalTrustBundle: | (4)
       -----BEGIN CERTIFICATE-----
       <MY_TRUSTED_CA_CERT>
       -----END CERTIFICATE-----
   additionalTrustBundlePolicy: <policy_to_add_additionalTrustBundle> (5)

   1	A proxy URL to use for creating HTTP connections outside the cluster. The URL scheme must be http.
   2	A proxy URL to use for creating HTTPS connections outside the cluster.
   3	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.com matches x.y.com, but not y.com. Use * to bypass the proxy for all destinations.
   4	If provided, the installation program generates a config map that is named user-ca-bundle in the openshift-config namespace that contains one or more additional CA certificates that are required for proxying HTTPS connections. The Cluster Network Operator then creates a trusted-ca-bundle config map that merges these contents with the Fedora CoreOS (FCOS) trust bundle, and this config map is referenced in the trustedCA field of the Proxy object. The additionalTrustBundle field is required unless the proxy’s identity certificate is signed by an authority from the FCOS trust bundle.
   5	Optional: The policy to determine the configuration of the Proxy object to reference the user-ca-bundle config map in the trustedCA field. The allowed values are Proxyonly and Always. Use Proxyonly to reference the user-ca-bundle config map only when http/https proxy is configured. Use Always to always reference the user-ca-bundle config map. The default value is Proxyonly.

   The installation program does not support the proxy readinessEndpoints field.

   If the installer times out, restart and then complete the deployment by using the wait-for command of the installer. For example: $ ./openshift-install wait-for install-complete —log-level debug

2. Save the file and reference it when installing OKD.

The installation program creates a cluster-wide proxy that is named cluster that uses the proxy settings in the provided install-config.yaml file. If no proxy settings are provided, a cluster Proxy object is still created, but it will have a nil spec.

Creating the Kubernetes manifest and Ignition config files

Because you must modify some cluster definition files and manually start the cluster machines, you must generate the Kubernetes manifest and Ignition config files that the cluster needs to configure the machines.

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.

Prerequisites

• You obtained the OKD installation program. For a restricted network installation, these files are on your mirror host.

• You created the install-config.yaml installation configuration file.

Procedure

1. Change to the directory that contains the OKD installation program and generate the Kubernetes manifests for the cluster:

   $ ./openshift-install create manifests --dir <installation_directory> (1)

   1	For <installation_directory>, specify the installation directory that contains the install-config.yaml file you created.

2. Remove the Kubernetes manifest files that define the control plane machines:

   $ rm -f <installation_directory>/openshift/99_openshift-cluster-api_master-machines-*.yaml

   By removing these files, you prevent the cluster from automatically generating control plane machines.

3. 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.yaml

4. Optional: If you do not want the cluster to provision compute machines, remove the Kubernetes manifest files that define the worker machines:

   $ rm -f <installation_directory>/openshift/99_openshift-cluster-api_worker-machineset-*.yaml

   Because you create and manage the worker machines yourself, you do not need to initialize these machines.

5. Check that the mastersSchedulable parameter in the <installation_directory>/manifests/cluster-scheduler-02-config.yml Kubernetes manifest file is set to false. This setting prevents pods from being scheduled on the control plane machines:

   1. Open the <installation_directory>/manifests/cluster-scheduler-02-config.yml file.

   2. Locate the mastersSchedulable parameter and ensure that it is set to false.

   3. Save and exit the file.

6. Optional: If you do not want the Ingress Operator to create DNS records on your behalf, remove the privateZone and publicZone sections from the <installation_directory>/manifests/cluster-dns-02-config.yml DNS configuration file:

   apiVersion: config.openshift.io/v1
   kind: DNS
   metadata:
     creationTimestamp: null
     name: cluster
   spec:
     baseDomain: example.openshift.com
     privateZone: (1)
       id: mycluster-100419-private-zone
     publicZone: (1)
       id: example.openshift.com
   status: {}

   1	Remove this section completely.

   If you do so, you must add ingress DNS records manually in a later step.

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

   1	For <installation_directory>, specify the same installation directory.

   Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory. The kubeadmin-password and kubeconfig files are created in the ./<installation_directory>/auth directory:

   .
   ├── auth
   │   ├── kubeadmin-password
   │   └── kubeconfig
   ├── bootstrap.ign
   ├── master.ign
   ├── metadata.json
   └── worker.ign

Additional resources

• Optional: Adding the ingress DNS records

Exporting common variables

Extracting the infrastructure name

The Ignition config files contain a unique cluster identifier that you can use to uniquely identify your cluster in Google Cloud Platform (GCP). The infrastructure name is also used to locate the appropriate GCP resources during an OKD installation. The provided Deployment Manager templates contain references to this infrastructure name, so you must extract it.

Prerequisites

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

• You generated the Ignition config files for your cluster.

• You installed the jq package.

Procedure

• To extract and view the infrastructure name from the Ignition config file metadata, run the following command:

  $ jq -r .infraID <installation_directory>/metadata.json (1)

  1	For <installation_directory>, specify the path to the directory that you stored the installation files in.

  Example output

  openshift-vw9j6 (1)

  1	The output of this command is your cluster name and a random string.

Exporting common variables for Deployment Manager templates

You must export a common set of variables that are used with the provided Deployment Manager templates used to assist in completing a user-provided infrastructure install on Google Cloud Platform (GCP).

Prerequisites

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

• Generate the Ignition config files for your cluster.

• Install the jq package.

Procedure

1. Export the following common variables to be used by the provided Deployment Manager templates:

   $ export BASE_DOMAIN='<base_domain>'
   $ export BASE_DOMAIN_ZONE_NAME='<base_domain_zone_name>'
   $ export NETWORK_CIDR='10.0.0.0/16'
   $ export MASTER_SUBNET_CIDR='10.0.0.0/17'
   $ export WORKER_SUBNET_CIDR='10.0.128.0/17'
   $ export KUBECONFIG=<installation_directory>/auth/kubeconfig (1)
   $ export CLUSTER_NAME=`jq -r .clusterName <installation_directory>/metadata.json`
   $ export INFRA_ID=`jq -r .infraID <installation_directory>/metadata.json`
   $ export PROJECT_NAME=`jq -r .gcp.projectID <installation_directory>/metadata.json`
   $ export REGION=`jq -r .gcp.region <installation_directory>/metadata.json`

   1	For <installation_directory>, specify the path to the directory that you stored the installation files in.

Creating a VPC in GCP

You must create a VPC in Google Cloud Platform (GCP) for your OKD cluster to use. You can customize the VPC to meet your requirements. One way to create the VPC is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

Procedure

1. Copy the template from the Deployment Manager template for the VPC section of this topic and save it as 01_vpc.py on your computer. This template describes the VPC that your cluster requires.

2. Create a 01_vpc.yaml resource definition file:

   $ cat <<EOF >01_vpc.yaml
   imports:
   - path: 01_vpc.py
   resources:
   - name: cluster-vpc
     type: 01_vpc.py
     properties:
       infra_id: '${INFRA_ID}' (1)
       region: '${REGION}' (2)
       master_subnet_cidr: '${MASTER_SUBNET_CIDR}' (3)
       worker_subnet_cidr: '${WORKER_SUBNET_CIDR}' (4)
   EOF

   1	infra_id is the INFRA_ID infrastructure name from the extraction step.
   2	region is the region to deploy the cluster into, for example us-central1.
   3	master_subnet_cidr is the CIDR for the master subnet, for example 10.0.0.0/17.
   4	worker_subnet_cidr is the CIDR for the worker subnet, for example 10.0.128.0/17.

3. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-vpc --config 01_vpc.yaml

Deployment Manager template for the VPC

You can use the following Deployment Manager template to deploy the VPC that you need for your OKD cluster:

01_vpc.py Deployment Manager template

def GenerateConfig(context):
    resources = [{
        'name': context.properties['infra_id'] + '-network',
        'type': 'compute.v1.network',
        'properties': {
            'region': context.properties['region'],
            'autoCreateSubnetworks': False
        }
    }, {
        'name': context.properties['infra_id'] + '-master-subnet',
        'type': 'compute.v1.subnetwork',
        'properties': {
            'region': context.properties['region'],
            'network': '$(ref.' + context.properties['infra_id'] + '-network.selfLink)',
            'ipCidrRange': context.properties['master_subnet_cidr']
        }
    }, {
        'name': context.properties['infra_id'] + '-worker-subnet',
        'type': 'compute.v1.subnetwork',
        'properties': {
            'region': context.properties['region'],
            'network': '$(ref.' + context.properties['infra_id'] + '-network.selfLink)',
            'ipCidrRange': context.properties['worker_subnet_cidr']
        }
    }, {
        'name': context.properties['infra_id'] + '-router',
        'type': 'compute.v1.router',
        'properties': {
            'region': context.properties['region'],
            'network': '$(ref.' + context.properties['infra_id'] + '-network.selfLink)',
            'nats': [{
                'name': context.properties['infra_id'] + '-nat-master',
                'natIpAllocateOption': 'AUTO_ONLY',
                'minPortsPerVm': 7168,
                'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS',
                'subnetworks': [{
                    'name': '$(ref.' + context.properties['infra_id'] + '-master-subnet.selfLink)',
                    'sourceIpRangesToNat': ['ALL_IP_RANGES']
                }]
            }, {
                'name': context.properties['infra_id'] + '-nat-worker',
                'natIpAllocateOption': 'AUTO_ONLY',
                'minPortsPerVm': 512,
                'sourceSubnetworkIpRangesToNat': 'LIST_OF_SUBNETWORKS',
                'subnetworks': [{
                    'name': '$(ref.' + context.properties['infra_id'] + '-worker-subnet.selfLink)',
                    'sourceIpRangesToNat': ['ALL_IP_RANGES']
                }]
            }]
        }
    }]
    return {'resources': resources}

Networking requirements for user-provisioned infrastructure

All the Fedora CoreOS (FCOS) machines require networking to be configured in initramfs during boot to fetch their Ignition config files.

Setting the cluster node hostnames through DHCP

On Fedora CoreOS (FCOS) 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.

Network connectivity requirements

You must configure the network connectivity between machines to allow OKD 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.

Creating load balancers in GCP

You must configure load balancers in Google Cloud Platform (GCP) for your OKD cluster to use. One way to create these components is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

• Create and configure a VPC and associated subnets in GCP.

Procedure

1. Copy the template from the Deployment Manager template for the internal load balancer section of this topic and save it as 02_lb_int.py on your computer. This template describes the internal load balancing objects that your cluster requires.

2. For an external cluster, also copy the template from the Deployment Manager template for the external load balancer section of this topic and save it as 02_lb_ext.py on your computer. This template describes the external load balancing objects that your cluster requires.

3. Export the variables that the deployment template uses:

   1. Export the cluster network location:

      $ export CLUSTER_NETWORK=(`gcloud compute networks describe ${INFRA_ID}-network --format json | jq -r .selfLink`)

   2. Export the control plane subnet location:

      $ export CONTROL_SUBNET=(`gcloud compute networks subnets describe ${INFRA_ID}-master-subnet --region=${REGION} --format json | jq -r .selfLink`)

   3. Export the three zones that the cluster uses:

      $ export ZONE_0=(`gcloud compute regions describe ${REGION} --format=json | jq -r .zones[0] | cut -d "/" -f9`)

      $ export ZONE_1=(`gcloud compute regions describe ${REGION} --format=json | jq -r .zones[1] | cut -d "/" -f9`)

      $ export ZONE_2=(`gcloud compute regions describe ${REGION} --format=json | jq -r .zones[2] | cut -d "/" -f9`)

4. Create a 02_infra.yaml resource definition file:

   $ cat <<EOF >02_infra.yaml
   imports:
   - path: 02_lb_ext.py
   - path: 02_lb_int.py (1)
   resources:
   - name: cluster-lb-ext (1)
     type: 02_lb_ext.py
     properties:
       infra_id: '${INFRA_ID}' (2)
       region: '${REGION}' (3)
   - name: cluster-lb-int
     type: 02_lb_int.py
     properties:
       cluster_network: '${CLUSTER_NETWORK}'
       control_subnet: '${CONTROL_SUBNET}' (4)
       infra_id: '${INFRA_ID}'
       region: '${REGION}'
       zones: (5)
       - '${ZONE_0}'
       - '${ZONE_1}'
       - '${ZONE_2}'
   EOF

   1	Required only when deploying an external cluster.
   2	infra_id is the INFRA_ID infrastructure name from the extraction step.
   3	region is the region to deploy the cluster into, for example us-central1.
   4	control_subnet is the URI to the control subnet.
   5	zones are the zones to deploy the control plane instances into, like us-east1-b, us-east1-c, and us-east1-d.

5. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-infra --config 02_infra.yaml

6. Export the cluster IP address:

   $ export CLUSTER_IP=(`gcloud compute addresses describe ${INFRA_ID}-cluster-ip --region=${REGION} --format json | jq -r .address`)

7. For an external cluster, also export the cluster public IP address:

   $ export CLUSTER_PUBLIC_IP=(`gcloud compute addresses describe ${INFRA_ID}-cluster-public-ip --region=${REGION} --format json | jq -r .address`)

Deployment Manager template for the external load balancer

You can use the following Deployment Manager template to deploy the external load balancer that you need for your OKD cluster:

02_lb_ext.py Deployment Manager template

def GenerateConfig(context):
    resources = [{
        'name': context.properties['infra_id'] + '-cluster-public-ip',
        'type': 'compute.v1.address',
        'properties': {
            'region': context.properties['region']
        }
    }, {
        # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver
        'name': context.properties['infra_id'] + '-api-http-health-check',
        'type': 'compute.v1.httpHealthCheck',
        'properties': {
            'port': 6080,
            'requestPath': '/readyz'
        }
    }, {
        'name': context.properties['infra_id'] + '-api-target-pool',
        'type': 'compute.v1.targetPool',
        'properties': {
            'region': context.properties['region'],
            'healthChecks': ['$(ref.' + context.properties['infra_id'] + '-api-http-health-check.selfLink)'],
            'instances': []
        }
    }, {
        'name': context.properties['infra_id'] + '-api-forwarding-rule',
        'type': 'compute.v1.forwardingRule',
        'properties': {
            'region': context.properties['region'],
            'IPAddress': '$(ref.' + context.properties['infra_id'] + '-cluster-public-ip.selfLink)',
            'target': '$(ref.' + context.properties['infra_id'] + '-api-target-pool.selfLink)',
            'portRange': '6443'
        }
    }]
    return {'resources': resources}

Deployment Manager template for the internal load balancer

You can use the following Deployment Manager template to deploy the internal load balancer that you need for your OKD cluster:

02_lb_int.py Deployment Manager template

def GenerateConfig(context):
    backends = []
    for zone in context.properties['zones']:
        backends.append({
            'group': '$(ref.' + context.properties['infra_id'] + '-master-' + zone + '-ig' + '.selfLink)'
        })
    resources = [{
        'name': context.properties['infra_id'] + '-cluster-ip',
        'type': 'compute.v1.address',
        'properties': {
            'addressType': 'INTERNAL',
            'region': context.properties['region'],
            'subnetwork': context.properties['control_subnet']
        }
    }, {
        # Refer to docs/dev/kube-apiserver-health-check.md on how to correctly setup health check probe for kube-apiserver
        'name': context.properties['infra_id'] + '-api-internal-health-check',
        'type': 'compute.v1.healthCheck',
        'properties': {
            'httpsHealthCheck': {
                'port': 6443,
                'requestPath': '/readyz'
            },
            'type': "HTTPS"
        }
    }, {
        'name': context.properties['infra_id'] + '-api-internal-backend-service',
        'type': 'compute.v1.regionBackendService',
        'properties': {
            'backends': backends,
            'healthChecks': ['$(ref.' + context.properties['infra_id'] + '-api-internal-health-check.selfLink)'],
            'loadBalancingScheme': 'INTERNAL',
            'region': context.properties['region'],
            'protocol': 'TCP',
            'timeoutSec': 120
        }
    }, {
        'name': context.properties['infra_id'] + '-api-internal-forwarding-rule',
        'type': 'compute.v1.forwardingRule',
        'properties': {
            'backendService': '$(ref.' + context.properties['infra_id'] + '-api-internal-backend-service.selfLink)',
            'IPAddress': '$(ref.' + context.properties['infra_id'] + '-cluster-ip.selfLink)',
            'loadBalancingScheme': 'INTERNAL',
            'ports': ['6443','22623'],
            'region': context.properties['region'],
            'subnetwork': context.properties['control_subnet']
        }
    }]
    for zone in context.properties['zones']:
        resources.append({
            'name': context.properties['infra_id'] + '-master-' + zone + '-ig',
            'type': 'compute.v1.instanceGroup',
            'properties': {
                'namedPorts': [
                    {
                        'name': 'ignition',
                        'port': 22623
                    }, {
                        'name': 'https',
                        'port': 6443
                    }
                ],
                'network': context.properties['cluster_network'],
                'zone': zone
            }
        })
    return {'resources': resources}

You will need this template in addition to the 02_lb_ext.py template when you create an external cluster.

Creating a private DNS zone in GCP

You must configure a private DNS zone in Google Cloud Platform (GCP) for your OKD cluster to use. One way to create this component is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

• Create and configure a VPC and associated subnets in GCP.

Procedure

1. Copy the template from the Deployment Manager template for the private DNS section of this topic and save it as 02_dns.py on your computer. This template describes the private DNS objects that your cluster requires.

2. Create a 02_dns.yaml resource definition file:

   $ cat <<EOF >02_dns.yaml
   imports:
   - path: 02_dns.py
   resources:
   - name: cluster-dns
     type: 02_dns.py
     properties:
       infra_id: '${INFRA_ID}' (1)
       cluster_domain: '${CLUSTER_NAME}.${BASE_DOMAIN}' (2)
       cluster_network: '${CLUSTER_NETWORK}' (3)
   EOF

   1	infra_id is the INFRA_ID infrastructure name from the extraction step.
   2	cluster_domain is the domain for the cluster, for example openshift.example.com.
   3	cluster_network is the selfLink URL to the cluster network.

3. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-dns --config 02_dns.yaml

4. The templates do not create DNS entries due to limitations of Deployment Manager, so you must create them manually:

   1. Add the internal DNS entries:

      $ if [ -f transaction.yaml ]; then rm transaction.yaml; fi
      $ gcloud dns record-sets transaction start --zone ${INFRA_ID}-private-zone
      $ gcloud dns record-sets transaction add ${CLUSTER_IP} --name api.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${INFRA_ID}-private-zone
      $ gcloud dns record-sets transaction add ${CLUSTER_IP} --name api-int.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${INFRA_ID}-private-zone
      $ gcloud dns record-sets transaction execute --zone ${INFRA_ID}-private-zone

   2. For an external cluster, also add the external DNS entries:

      $ if [ -f transaction.yaml ]; then rm transaction.yaml; fi
      $ gcloud dns record-sets transaction start --zone ${BASE_DOMAIN_ZONE_NAME}
      $ gcloud dns record-sets transaction add ${CLUSTER_PUBLIC_IP} --name api.${CLUSTER_NAME}.${BASE_DOMAIN}. --ttl 60 --type A --zone ${BASE_DOMAIN_ZONE_NAME}
      $ gcloud dns record-sets transaction execute --zone ${BASE_DOMAIN_ZONE_NAME}

Deployment Manager template for the private DNS

You can use the following Deployment Manager template to deploy the private DNS that you need for your OKD cluster:

02_dns.py Deployment Manager template

def GenerateConfig(context):
    resources = [{
        'name': context.properties['infra_id'] + '-private-zone',
        'type': 'dns.v1.managedZone',
        'properties': {
            'description': '',
            'dnsName': context.properties['cluster_domain'] + '.',
            'visibility': 'private',
            'privateVisibilityConfig': {
                'networks': [{
                    'networkUrl': context.properties['cluster_network']
                }]
            }
        }
    }]
    return {'resources': resources}

Creating firewall rules in GCP

You must create firewall rules in Google Cloud Platform (GCP) for your OKD cluster to use. One way to create these components is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

• Create and configure a VPC and associated subnets in GCP.

Procedure

1. Copy the template from the Deployment Manager template for firewall rules section of this topic and save it as 03_firewall.py on your computer. This template describes the security groups that your cluster requires.

2. Create a 03_firewall.yaml resource definition file:

   $ cat <<EOF >03_firewall.yaml
   imports:
   - path: 03_firewall.py
   resources:
   - name: cluster-firewall
     type: 03_firewall.py
     properties:
       allowed_external_cidr: '0.0.0.0/0' (1)
       infra_id: '${INFRA_ID}' (2)
       cluster_network: '${CLUSTER_NETWORK}' (3)
       network_cidr: '${NETWORK_CIDR}' (4)
   EOF

   1	allowed_external_cidr is the CIDR range that can access the cluster API and SSH to the bootstrap host. For an internal cluster, set this value to ${NETWORK_CIDR}.
   2	infra_id is the INFRA_ID infrastructure name from the extraction step.
   3	cluster_network is the selfLink URL to the cluster network.
   4	network_cidr is the CIDR of the VPC network, for example 10.0.0.0/16.

3. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-firewall --config 03_firewall.yaml

Deployment Manager template for firewall rules

You can use the following Deployment Manager template to deploy the firewall rues that you need for your OKD cluster:

03_firewall.py Deployment Manager template

def GenerateConfig(context):
    resources = [{
        'name': context.properties['infra_id'] + '-bootstrap-in-ssh',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'tcp',
                'ports': ['22']
            }],
            'sourceRanges': [context.properties['allowed_external_cidr']],
            'targetTags': [context.properties['infra_id'] + '-bootstrap']
        }
    }, {
        'name': context.properties['infra_id'] + '-api',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'tcp',
                'ports': ['6443']
            }],
            'sourceRanges': [context.properties['allowed_external_cidr']],
            'targetTags': [context.properties['infra_id'] + '-master']
        }
    }, {
        'name': context.properties['infra_id'] + '-health-checks',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'tcp',
                'ports': ['6080', '6443', '22624']
            }],
            'sourceRanges': ['35.191.0.0/16', '130.211.0.0/22', '209.85.152.0/22', '209.85.204.0/22'],
            'targetTags': [context.properties['infra_id'] + '-master']
        }
    }, {
        'name': context.properties['infra_id'] + '-etcd',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'tcp',
                'ports': ['2379-2380']
            }],
            'sourceTags': [context.properties['infra_id'] + '-master'],
            'targetTags': [context.properties['infra_id'] + '-master']
        }
    }, {
        'name': context.properties['infra_id'] + '-control-plane',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'tcp',
                'ports': ['10257']
            },{
                'IPProtocol': 'tcp',
                'ports': ['10259']
            },{
                'IPProtocol': 'tcp',
                'ports': ['22623']
            }],
            'sourceTags': [
                context.properties['infra_id'] + '-master',
                context.properties['infra_id'] + '-worker'
            ],
            'targetTags': [context.properties['infra_id'] + '-master']
        }
    }, {
        'name': context.properties['infra_id'] + '-internal-network',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'icmp'
            },{
                'IPProtocol': 'tcp',
                'ports': ['22']
            }],
            'sourceRanges': [context.properties['network_cidr']],
            'targetTags': [
                context.properties['infra_id'] + '-master',
                context.properties['infra_id'] + '-worker'
            ]
        }
    }, {
        'name': context.properties['infra_id'] + '-internal-cluster',
        'type': 'compute.v1.firewall',
        'properties': {
            'network': context.properties['cluster_network'],
            'allowed': [{
                'IPProtocol': 'udp',
                'ports': ['4789', '6081']
            },{
                'IPProtocol': 'udp',
                'ports': ['500', '4500']
            },{
                'IPProtocol': 'esp',
            },{
                'IPProtocol': 'tcp',
                'ports': ['9000-9999']
            },{
                'IPProtocol': 'udp',
                'ports': ['9000-9999']
            },{
                'IPProtocol': 'tcp',
                'ports': ['10250']
            },{
                'IPProtocol': 'tcp',
                'ports': ['30000-32767']
            },{
                'IPProtocol': 'udp',
                'ports': ['30000-32767']
            }],
            'sourceTags': [
                context.properties['infra_id'] + '-master',
                context.properties['infra_id'] + '-worker'
            ],
            'targetTags': [
                context.properties['infra_id'] + '-master',
                context.properties['infra_id'] + '-worker'
            ]
        }
    }]
    return {'resources': resources}

Creating IAM roles in GCP

You must create IAM roles in Google Cloud Platform (GCP) for your OKD cluster to use. One way to create these components is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

• Create and configure a VPC and associated subnets in GCP.

Procedure

1. Copy the template from the Deployment Manager template for IAM roles section of this topic and save it as 03_iam.py on your computer. This template describes the IAM roles that your cluster requires.

2. Create a 03_iam.yaml resource definition file:

   $ cat <<EOF >03_iam.yaml
   imports:
   - path: 03_iam.py
   resources:
   - name: cluster-iam
     type: 03_iam.py
     properties:
       infra_id: '${INFRA_ID}' (1)
   EOF

   1	infra_id is the INFRA_ID infrastructure name from the extraction step.

3. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-iam --config 03_iam.yaml

4. Export the variable for the master service account:

   $ export MASTER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter "email~^${INFRA_ID}-m@${PROJECT_NAME}." --format json | jq -r '.[0].email'`)

5. Export the variable for the worker service account:

   $ export WORKER_SERVICE_ACCOUNT=(`gcloud iam service-accounts list --filter "email~^${INFRA_ID}-w@${PROJECT_NAME}." --format json | jq -r '.[0].email'`)

6. Export the variable for the subnet that hosts the compute machines:

   $ export COMPUTE_SUBNET=(`gcloud compute networks subnets describe ${INFRA_ID}-worker-subnet --region=${REGION} --format json | jq -r .selfLink`)

7. The templates do not create the policy bindings due to limitations of Deployment Manager, so you must create them manually:

   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${MASTER_SERVICE_ACCOUNT}" --role "roles/compute.instanceAdmin"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${MASTER_SERVICE_ACCOUNT}" --role "roles/compute.networkAdmin"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${MASTER_SERVICE_ACCOUNT}" --role "roles/compute.securityAdmin"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${MASTER_SERVICE_ACCOUNT}" --role "roles/iam.serviceAccountUser"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${MASTER_SERVICE_ACCOUNT}" --role "roles/storage.admin"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${WORKER_SERVICE_ACCOUNT}" --role "roles/compute.viewer"
   $ gcloud projects add-iam-policy-binding ${PROJECT_NAME} --member "serviceAccount:${WORKER_SERVICE_ACCOUNT}" --role "roles/storage.admin"

8. Create a service account key and store it locally for later use:

   $ gcloud iam service-accounts keys create service-account-key.json --iam-account=${MASTER_SERVICE_ACCOUNT}

Deployment Manager template for IAM roles

You can use the following Deployment Manager template to deploy the IAM roles that you need for your OKD cluster:

03_iam.py Deployment Manager template

def GenerateConfig(context):
    resources = [{
        'name': context.properties['infra_id'] + '-master-node-sa',
        'type': 'iam.v1.serviceAccount',
        'properties': {
            'accountId': context.properties['infra_id'] + '-m',
            'displayName': context.properties['infra_id'] + '-master-node'
        }
    }, {
        'name': context.properties['infra_id'] + '-worker-node-sa',
        'type': 'iam.v1.serviceAccount',
        'properties': {
            'accountId': context.properties['infra_id'] + '-w',
            'displayName': context.properties['infra_id'] + '-worker-node'
        }
    }]
    return {'resources': resources}

Creating the FCOS cluster image for the GCP infrastructure

You must use a valid Fedora CoreOS (FCOS) image for Google Cloud Platform (GCP) for your OKD nodes.

Procedure

1. Obtain the FCOS image from the FCOS Downloads page

2. Create the Google storage bucket:

   $ gsutil mb gs://<bucket_name>

3. Upload the FCOS image to the Google storage bucket:

   $ gsutil cp <downloaded_image_file_path>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz  gs://<bucket_name>

4. Export the uploaded FCOS image location as a variable:

   $ export IMAGE_SOURCE=gs://<bucket_name>/rhcos-<version>-x86_64-gcp.x86_64.tar.gz

5. Create the cluster image:

   $ gcloud compute images create "${INFRA_ID}-rhcos-image" \
       --source-uri="${IMAGE_SOURCE}"

Creating the bootstrap machine in GCP

You must create the bootstrap machine in Google Cloud Platform (GCP) to use during OKD cluster initialization. One way to create this machine is to modify the provided Deployment Manager template.

Prerequisites

• Configure a GCP account.

• Generate the Ignition config files for your cluster.

• Create and configure a VPC and associated subnets in GCP.

• Create and configure networking and load balancers in GCP.

• Create control plane and compute roles.

• Ensure pyOpenSSL is installed.

Procedure

1. Copy the template from the Deployment Manager template for the bootstrap machine section of this topic and save it as 04_bootstrap.py on your computer. This template describes the bootstrap machine that your cluster requires.

2. Export the location of the Fedora CoreOS (FCOS) image that the installation program requires:

   $ export CLUSTER_IMAGE=(`gcloud compute images describe ${INFRA_ID}-rhcos-image --format json | jq -r .selfLink`)

3. Create a bucket and upload the bootstrap.ign file:

   $ gsutil mb gs://${INFRA_ID}-bootstrap-ignition
   $ gsutil cp <installation_directory>/bootstrap.ign gs://${INFRA_ID}-bootstrap-ignition/

4. Create a signed URL for the bootstrap instance to use to access the Ignition config. Export the URL from the output as a variable:

   $ export BOOTSTRAP_IGN=`gsutil signurl -d 1h service-account-key.json gs://${INFRA_ID}-bootstrap-ignition/bootstrap.ign | grep "^gs:" | awk '{print $5}'`

5. Create a 04_bootstrap.yaml resource definition file:

   $ cat <<EOF >04_bootstrap.yaml
   imports:
   - path: 04_bootstrap.py
   resources:
   - name: cluster-bootstrap
     type: 04_bootstrap.py
     properties:
       infra_id: '${INFRA_ID}' (1)
       region: '${REGION}' (2)
       zone: '${ZONE_0}' (3)
       cluster_network: '${CLUSTER_NETWORK}' (4)
       control_subnet: '${CONTROL_SUBNET}' (5)
       image: '${CLUSTER_IMAGE}' (6)
       machine_type: 'n1-standard-4' (7)
       root_volume_size: '128' (8)
       bootstrap_ign: '${BOOTSTRAP_IGN}' (9)
   EOF

   1	infra_id is the INFRA_ID infrastructure name from the extraction step.
   2	region is the region to deploy the cluster into, for example us-central1.
   3	zone is the zone to deploy the bootstrap instance into, for example us-central1-b.
   4	cluster_network is the selfLink URL to the cluster network.
   5	control_subnet is the selfLink URL to the control subnet.
   6	image is the selfLink URL to the FCOS image.
   7	machine_type is the machine type of the instance, for example n1-standard-4.
   8	root_volume_size is the boot disk size for the bootstrap machine.
   9	bootstrap_ign is the URL output when creating a signed URL.

6. Create the deployment by using the gcloud CLI:

   $ gcloud deployment-manager deployments create ${INFRA_ID}-bootstrap --config 04_bootstrap.yaml

7. The templates do not manage load balancer membership due to limitations of Deployment Manager, so you must add the bootstrap machine manually.

   1. Add the bootstrap instance to the internal load balancer instance group:

      $ gcloud compute instance-groups unmanaged add-instances \
          ${INFRA_ID}-bootstrap-instance-group --zone=${ZONE_0} --instances=${INFRA_ID}-bootstrap

   2. Add the bootstrap instance group to the internal load balancer backend service:

      $ gcloud compute backend-services add-backend \
          ${INFRA_ID}-api-internal-backend-service --region=${REGION} --instance-group=${INFRA_ID}-bootstrap-instance-group --instance-group-zone=${ZONE_0}