Red Hat SummitCe contenu n'est pas disponible dans la langue sélectionnée.
Chapter 13. Installation configuration parameters for Google Cloud
Before you deploy an OpenShift Container Platform cluster on Google Cloud, you provide parameters to customize your cluster and the platform that hosts it. When you create the install-config.yaml file, you provide values for the required parameters through the command line. You can then modify the install-config.yaml file to customize your cluster further.
13.1. Available installation configuration parameters for Google Cloud
The following tables specify the required, optional, and Google Cloud-specific installation configuration parameters that you can set as part of the installation process.
After installation, you cannot change these parameters in the install-config.yaml file.
13.1.1. Required configuration parameters
Required installation configuration parameters are described in the following table:
| Parameter | Description |
|---|---|
apiVersion: |
The API version for the Value: String |
baseDomain: |
The base domain of your cloud provider. The base domain is used to create routes to your OpenShift Container Platform cluster components. The full DNS name for your cluster is a combination of the
Value: A fully-qualified domain or subdomain name, such as |
metadata: |
Kubernetes resource Value: Object |
metadata: name: |
The name of the cluster. DNS records for the cluster are all subdomains of
Value: String of lowercase letters, hyphens ( |
platform: |
The configuration for the specific platform upon which to perform the installation: Value: Object |
pullSecret: | Get a pull secret from Red Hat OpenShift Cluster Manager to authenticate downloading container images for OpenShift Container Platform components from services such as Quay.io. Value: |
13.1.2. Network configuration parameters
You can customize your installation configuration based on the requirements of your existing network infrastructure. For example, you can expand the IP address block for the cluster network or configure different IP address blocks than the defaults.
Only IPv4 addresses are supported.
| Parameter | Description |
|---|---|
networking: | The configuration for the cluster network. Value: Object Note
You cannot change parameters specified by the |
networking: networkType: | The Red Hat OpenShift Networking network plugin to install.
Value: |
networking: clusterNetwork: | The IP address blocks for pods.
The default value is If you specify multiple IP address blocks, the blocks must not overlap. Value: An array of objects. For example: networking:
clusterNetwork:
- cidr: 10.128.0.0/14
hostPrefix: 23
|
networking:
clusterNetwork:
cidr:
|
Required if you use An IPv4 network.
Value: An IP address block in Classless Inter-Domain Routing (CIDR) notation. The prefix length for an IPv4 block is between |
networking:
clusterNetwork:
hostPrefix:
|
The subnet prefix length to assign to each individual node. For example, if Value: A subnet prefix.
The default value is |
networking: serviceNetwork: |
The IP address block for services. The default value is The OVN-Kubernetes network plugins supports only a single IP address block for the service network. Value: An array with an IP address block in CIDR format. For example: networking: serviceNetwork: - 172.30.0.0/16 |
networking: machineNetwork: | The IP address blocks for machines. If you specify multiple IP address blocks, the blocks must not overlap. Value: An array of objects. For example: networking: machineNetwork: - cidr: 10.0.0.0/16 |
networking:
machineNetwork:
cidr:
|
Required if you use Value: An IP network block in CIDR notation.
For example, Note
Set the |
networking:
ovnKubernetesConfig:
ipv4:
internalJoinSubnet:
|
Configures the IPv4 join subnet that is used internally by
Value: An IP network block in CIDR notation. The default value is |
13.1.3. Optional configuration parameters
Optional installation configuration parameters are described in the following table:
| Parameter | Description |
|---|---|
additionalTrustBundle: | A PEM-encoded X.509 certificate bundle that is added to the nodes' trusted certificate store. This trust bundle might also be used when a proxy has been configured. Value: String |
capabilities: | Controls the installation of optional core cluster components. You can reduce the footprint of your OpenShift Container Platform cluster by disabling optional components. For more information, see the "Cluster capabilities" page in Installing. Value: String array |
capabilities: baselineCapabilitySet: |
Selects an initial set of optional capabilities to enable. Valid values are Value: String |
capabilities: additionalEnabledCapabilities: |
Extends the set of optional capabilities beyond what you specify in Value: String array |
cpuPartitioningMode: | Enables workload partitioning, which isolates OpenShift Container Platform services, cluster management workloads, and infrastructure pods to run on a reserved set of CPUs. You can only enable workload partitioning during installation. You cannot disable it after installation. While this field enables workload partitioning, it does not configure workloads to use specific CPUs. For more information, see the Workload partitioning page in the Scalability and Performance section.
Value: |
compute: | The configuration for the machines that comprise the compute nodes.
Value: Array of |
compute: architecture: |
Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are Value: String |
compute: hyperthreading: |
Whether to enable or disable simultaneous multithreading, or Important If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
Value: |
compute: name: |
Required if you use
Value: |
compute: platform: |
Required if you use
Value: |
compute: replicas: | The number of compute machines, which are also known as worker machines, to provision.
Value: A positive integer greater than or equal to |
featureSet: | Enables the cluster for a feature set. A feature set is a collection of OpenShift Container Platform features that are not enabled by default. For more information about enabling a feature set during installation, see "Enabling features using feature gates".
Value: String. The name of the feature set to enable, such as |
controlPlane: | The configuration for the machines that form the control plane.
Value: Array of |
controlPlane: architecture: |
Determines the instruction set architecture of the machines in the pool. Currently, clusters with varied architectures are not supported. All pools must specify the same architecture. Valid values are Value: String |
controlPlane: hyperthreading: |
Whether to enable or disable simultaneous multithreading, or Important If you disable simultaneous multithreading, ensure that your capacity planning accounts for the dramatically decreased machine performance.
Value: |
controlPlane: name: |
Required if you use
Value: |
controlPlane: platform: |
Required if you use
Value: |
controlPlane: replicas: | The number of control plane machines to provision.
Value: Supported values are |
arbiter:
name: arbiter
|
The OpenShift Container Platform cluster requires a name for arbiter nodes. For example, |
arbiter:
replicas: 1
|
The |
credentialsMode: | The Cloud Credential Operator (CCO) mode. If no mode is specified, the CCO dynamically tries to determine the capabilities of the provided credentials, with a preference for mint mode on the platforms where multiple modes are supported. Note Not all CCO modes are supported for all cloud providers. For more information about CCO modes, see the "Managing cloud provider credentials" entry in the Authentication and authorization content.
Value: |
fips: |
Enable or disable FIPS mode. The default is Important To enable FIPS mode for your cluster, you must run the installation program from a Red Hat Enterprise Linux (RHEL) computer configured to operate in FIPS mode. For more information about configuring FIPS mode on RHEL, see Switching RHEL to FIPS mode. When running Red Hat Enterprise Linux (RHEL) or Red Hat Enterprise Linux CoreOS (RHCOS) booted in FIPS mode, OpenShift Container Platform core components use the RHEL cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. Important If you are using Azure File storage, you cannot enable FIPS mode.
Value: |
imageContentSources: | Sources and repositories for the release-image content.
Value: Array of objects. Includes a |
imageContentSources: source: |
Required if you use Value: String |
imageContentSources: mirrors: | Specify one or more repositories that might also contain the same images. Value: Array of strings |
publish: | How to publish or expose the user-facing endpoints of your cluster, such as the Kubernetes API, OpenShift routes.
Value: |
sshKey: | The SSH key to authenticate access to your cluster machines. Note
For production OpenShift Container Platform clusters on which you want to perform installation debugging or disaster recovery, specify an SSH key that your
Value: For example, |
If you are installing on Google Cloud into a shared virtual private cloud (VPC), credentialsMode must be set to Passthrough or Manual.
Setting this parameter to Manual enables alternatives to storing administrator-level secrets in the kube-system project, which require additional configuration steps. For more information, see "Alternatives to storing administrator-level secrets in the kube-system project".
13.1.4. Additional Google Cloud configuration parameters
Additional Google Cloud configuration parameters are described in the following table:
| Parameter | Description |
|---|---|
controlPlane:
platform:
gcp:
osImage:
project:
| Optional. By default, the installation program downloads and installs the Red Hat Enterprise Linux CoreOS (RHCOS) image that is used to boot control plane machines. You can override the default behavior by specifying the location of a custom RHCOS image that the installation program is to use for control plane machines only. Control plane machines do not contribute to licensing costs when using the default image. But, if you apply a Google Cloud Marketplace image for a control plane machine, usage costs do apply. Value: String. The name of Google Cloud project where the image is located. |
controlPlane:
platform:
gcp:
osImage:
name:
|
The name of the custom RHCOS image that the installation program is to use to boot control plane machines. If you use Value: String. The name of the RHCOS image. |
compute:
platform:
gcp:
osImage:
project:
| Optional. By default, the installation program downloads and installs the RHCOS image that is used to boot compute machines. You can override the default behavior by specifying the location of a custom RHCOS image that the installation program is to use for compute machines only. Value: String. The name of Google Cloud project where the image is located. |
compute:
platform:
gcp:
osImage:
name:
|
The name of the custom RHCOS image that the installation program is to use to boot compute machines. If you use Value: String. The name of the RHCOS image. |
compute:
platform:
gcp:
serviceAccount:
| Specifies the email address of a Google Cloud service account to be used during installations. This service account is used to provision compute machines. Value: String. The email address of the service account. |
platform:
gcp:
network:
|
The name of the existing Virtual Private Cloud (VPC) where you want to deploy your cluster. If you want to deploy your cluster into a shared VPC, you must set Value: String. |
platform:
gcp:
networkProjectID:
| Optional. The name of the Google Cloud project that contains the shared VPC where you want to deploy your cluster. Value: String. |
platform:
gcp:
projectID:
| The name of the Google Cloud project where the installation program installs the cluster. Value: String. |
platform:
gcp:
dns:
privateZone:
name:
|
The name of the private DNS zone. This parameter is only used during shared VPC installations. You can use a private DNS zone in a service project that is distinct from the projects specified by the Value: String. |
platform:
gcp:
dns:
privateZone:
projectID:
|
The ID of the project that contains the private zone from the Value: String. |
platform:
gcp:
userProvisionedDNS:
|
Enables user-provisioned DNS instead of the default cluster-provisioned DNS solution. If you use this feature, you must provide your own DNS solution that includes records for
Value: |
platform:
gcp:
region:
| The name of the Google Cloud region that hosts your cluster.
Value: Any valid region name, such as |
platform:
gcp:
controlPlaneSubnet:
| The name of the existing subnet where you want to deploy your control plane machines. Value: The subnet name. |
platform:
gcp:
computeSubnet:
| The name of the existing subnet where you want to deploy your compute machines. Value: The subnet name. |
platform:
gcp:
defaultMachinePlatform:
zones:
| The availability zones where the installation program creates machines.
Value: A list of valid Google Cloud availability zones, such as Important When running your cluster on Google Cloud 64-bit ARM infrastructures, ensure that you use a zone where Ampere Altra Arm CPU’s are available. You can find which zones are compatible with 64-bit ARM processors in the "Google Cloud availability zones" link. |
platform:
gcp:
defaultMachinePlatform:
osDisk:
diskSizeGB:
| The size of the disk in gigabytes (GB). Value: Any size between 16 GB and 65536 GB. |
platform:
gcp:
defaultMachinePlatform:
osDisk:
diskType:
|
Value: The default disk type for all machines. Valid values are |
platform:
gcp:
defaultMachinePlatform:
osImage:
project:
| Optional. By default, the installation program downloads and installs the RHCOS image that is used to boot control plane and compute machines. You can override the default behavior by specifying the location of a custom RHCOS image that the installation program is to use for both types of machines. Value: String. The name of Google Cloud project where the image is located. |
platform:
gcp:
defaultMachinePlatform:
osImage:
name:
|
The name of the custom RHCOS image that the installation program is to use to boot control plane and compute machines. If you use Value: String. The name of the RHCOS image. |
platform:
gcp:
defaultMachinePlatform:
tags:
| Optional. Additional network tags to add to the control plane and compute machines.
Value: One or more strings, for example |
platform:
gcp:
defaultMachinePlatform:
type:
| The Google Cloud machine type for control plane and compute machines.
Value: The Google Cloud machine type, for example |
|
| The name of the customer managed encryption key to be used for machine disk encryption. Value: The encryption key name. |
|
| The name of the Key Management Service (KMS) key ring to which the KMS key belongs. Value: The KMS key ring name. |
|
| The Google Cloud location in which the KMS key ring exists. Value: The Google Cloud location. |
|
|
The ID of the project in which the KMS key ring exists. This value defaults to the value of the Value: The Google Cloud project ID. |
|
| The Google Cloud service account used for the encryption request for control plane and compute machines. If absent, the Compute Engine default service account is used. For more information about Google Cloud service accounts, see Google’s documentation on service accounts.
Value: The Google Cloud service account email, for example |
platform:
gcp:
defaultMachinePlatform:
secureBoot:
| Whether to enable Shielded VM secure boot for all machines in the cluster. Shielded VMs have additional security protocols such as secure boot, firmware and integrity monitoring, and rootkit protection. For more information on Shielded VMs, see Google’s documentation on Shielded VMs.
Value: |
platform:
gcp:
defaultMachinePlatform:
confidentialCompute:
| Whether to use Confidential VMs for all machines in the cluster. Confidential VMs provide encryption for data during processing. For more information on Confidential computing, see Google’s documentation about Confidential Computing. Supported values are:
If you specify any value other than Value: String. |
platform:
gcp:
defaultMachinePlatform:
onHostMaintenance:
|
Specifies the behavior of all VMs during a host maintenance event, such as a software or hardware update. For Confidential VMs, this parameter must be set to
Value: |
|
| The name of the customer managed encryption key to be used for control plane machine disk encryption. Value: The encryption key name. |
|
| For control plane machines, the name of the KMS key ring to which the KMS key belongs. Value: The KMS key ring name. |
|
| For control plane machines, the Google Cloud location in which the key ring exists. For more information about KMS locations, see Google’s documentation on Cloud KMS locations. Value: The Google Cloud location for the key ring. |
|
| For control plane machines, the ID of the project in which the KMS key ring exists. This value defaults to the VM project ID if not set. Value: The Google Cloud project ID. |
|
| The Google Cloud service account used for the encryption request for control plane machines. If absent, the Compute Engine default service account is used. For more information about Google Cloud service accounts, see Google’s documentation on service accounts.
Value: The Google Cloud service account email, for example |
controlPlane:
platform:
gcp:
osDisk:
diskSizeGB:
| The size of the disk in gigabytes (GB). This value applies to control plane machines. Value: Any integer between 16 and 65536. |
controlPlane:
platform:
gcp:
osDisk:
diskType:
| The Google Cloud disk type for control plane machines.
Value: Valid values are |
controlPlane:
platform:
gcp:
tags:
|
Optional. Additional network tags to add to the control plane machines. If set, this parameter overrides the
Value: One or more strings, for example |
controlPlane:
platform:
gcp:
type:
|
The Google Cloud machine type for control plane machines. If set, this parameter overrides the
Value: The Google Cloud machine type, for example |
controlPlane:
platform:
gcp:
zones:
| The availability zones where the installation program creates control plane machines.
Value: A list of valid Google Cloud availability zones, such as Important When running your cluster on Google Cloud 64-bit ARM infrastructures, ensure that you use a zone where Ampere Altra Arm CPU’s are available. You can find which zones are compatible with 64-bit ARM processors in the "Google Cloud availability zones" link. |
controlPlane:
platform:
gcp:
secureBoot:
| Whether to enable Shielded VM secure boot for control plane machines. Shielded VMs have additional security protocols such as secure boot, firmware and integrity monitoring, and rootkit protection. For more information on Shielded VMs, see Google’s documentation on Shielded VMs.
Value: |
controlPlane:
platform:
gcp:
confidentialCompute:
| Whether to use Confidential VMs for control plane machines. Confidential VMs provide encryption for data during processing. For more information on Confidential computing, see Google’s documentation about Confidential Computing. Supported values are:
If you specify any value other than Value: String. |
controlPlane:
platform:
gcp:
onHostMaintenance:
|
Specifies the behavior of control plane VMs during a host maintenance event, such as a software or hardware update. For Confidential VMs, this parameter must be set to
Value: |
controlPlane:
platform:
gcp:
serviceAccount:
| Specifies the email address of a Google Cloud service account to be used during installations. This service account is used to provision control plane machines. Important
In the case of shared VPC installations, when the service account is not provided, the installation program service account must have the Value: String. The email address of the service account. |
|
| The name of the customer managed encryption key to be used for compute machine disk encryption. Value: The encryption key name. |
|
| For compute machines, the name of the KMS key ring to which the KMS key belongs. Value: The KMS key ring name. |
|
| For compute machines, the Google Cloud location in which the key ring exists. For more information about KMS locations, see Google’s documentation on Cloud KMS locations. Value: The Google Cloud location for the key ring. |
|
| For compute machines, the ID of the project in which the KMS key ring exists. This value defaults to the VM project ID if not set. Value: The Google Cloud project ID. |
|
| The Google Cloud service account used for the encryption request for compute machines. If this value is not set, the Compute Engine default service account is used. For more information about Google Cloud service accounts, see Google’s documentation on service accounts.
Value: The Google Cloud service account email, for example |
compute:
platform:
gcp:
osDisk:
diskSizeGB:
| The size of the disk in gigabytes (GB). This value applies to compute machines. Value: Any integer between 16 and 65536. |
compute:
platform:
gcp:
osDisk:
diskType:
| The Google Cloud disk type for compute machines.
Value: Valid values are |
compute:
platform:
gcp:
tags:
|
Optional. Additional network tags to add to the compute machines. If set, this parameter overrides the
Value: One or more strings, for example |
compute:
platform:
gcp:
type:
|
The Google Cloud machine type for compute machines. If set, this parameter overrides the
Value: The Google Cloud machine type, for example |
compute:
platform:
gcp:
zones:
| The availability zones where the installation program creates compute machines.
Value: A list of valid Google Cloud availability zones, such as Important When running your cluster on Google Cloud 64-bit ARM infrastructures, ensure that you use a zone where Ampere Altra Arm CPU’s are available. You can find which zones are compatible with 64-bit ARM processors in the "Google Cloud availability zones" link. |
compute:
platform:
gcp:
secureBoot:
| Whether to enable Shielded VM secure boot for compute machines. Shielded VMs have additional security protocols such as secure boot, firmware and integrity monitoring, and rootkit protection. For more information on Shielded VMs, see Google’s documentation on Shielded VMs.
Value: |
compute:
platform:
gcp:
confidentialCompute:
| Whether to use Confidential VMs for compute machines. Confidential VMs provide encryption for data during processing. For more information on Confidential computing, see Google’s documentation on Confidential computing. Supported values are:
If you specify any value other than Value: String. |
compute:
platform:
gcp:
onHostMaintenance:
|
Specifies the behavior of compute VMs during a host maintenance event, such as a software or hardware update. For Confidential VMs, this parameter must be set to
Value: |
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}