7.14. GCP 的安装配置参数

apiVersion:

install-config.yaml 内容的 API 版本。当前版本为 v1。安装程序可能还支持旧的 API 版本。

字符串

baseDomain:

云供应商的基域。基域用于创建到 OpenShift Container Platform 集群组件的路由。集群的完整 DNS 名称是 baseDomain 和 metadata.name 参数值的组合，其格式为 <metadata.name>.<baseDomain>。

完全限定域名或子域名，如 example.com。

metadata:

Kubernetes 资源 ObjectMeta，其中只消耗 name 参数。

对象

metadata:
  name:

集群的名称。集群的 DNS 记录是 {{.metadata.name}}.{{.baseDomain}} 的子域。

小写字母、连字符(-)和句点(.)字符串，如 dev。

platform:

对于特定平台的配置取决于执行安装的环境： aws, baremetal, azure, gcp, ibmcloud, nutanix, openstack, powervs, vsphere, 或 {}.有关 platform.<platform> 参数的更多信息，请参考下表中您的特定平台。

对象

pullSecret:

从 Red Hat OpenShift Cluster Manager 获取 pull secret，验证从 Quay.io 等服务中下载 OpenShift Container Platform 组件的容器镜像。

{
   "auths":{
      "cloud.openshift.com":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      },
      "quay.io":{
         "auth":"b3Blb=",
         "email":"you@example.com"
      }
   }
}

networking:

集群网络的配置。

对象

networking:
  networkType:

要安装的 Red Hat OpenShift Networking 网络插件。

OVNKubernetes。OVNKubernetes 是 Linux 网络和包含 Linux 和 Windows 服务器的混合网络的 CNI 插件。默认值为 OVNKubernetes。

networking:
  clusterNetwork:

pod 的 IP 地址块。

默认值为 10.128.0.0/14，主机前缀为 /23。

如果您指定了多个 IP 地址块，块不得重叠。

对象数组。例如：

networking:
  clusterNetwork:
  - cidr: 10.128.0.0/14
    hostPrefix: 23

networking:
  clusterNetwork:
    cidr:

使用 networking.clusterNetwork 时需要此项。IP 地址块。

IPv4 网络。

无类别域间路由(CIDR)表示法中的 IP 地址块。IPv4 块的前缀长度介于 0 到 32 之间 。

networking:
  clusterNetwork:
    hostPrefix:

分配给每个节点的子网前缀长度。例如，如果 hostPrefix 设为 23，则每个节点从 given cidr 中分配 a /23 子网。hostPrefix 值 23 提供 510（2^(32 - 23)- 2）pod IP 地址。

子网前缀。

默认值为 23。

networking:
  serviceNetwork:

服务的 IP 地址块。默认值为 172.30.0.0/16。

OVN-Kubernetes 网络插件只支持服务网络的一个 IP 地址块。

CIDR 格式具有 IP 地址块的数组。例如：

networking:
  serviceNetwork:
   - 172.30.0.0/16

networking:
  machineNetwork:

机器的 IP 地址块。

如果您指定了多个 IP 地址块，块不得重叠。

对象数组。例如：

networking:
  machineNetwork:
  - cidr: 10.0.0.0/16

networking:
  machineNetwork:
    cidr:

使用 networking.machineNetwork 时需要此项。IP 地址块。对于 libvirt 和 IBM Power® Virtual Server 以外的所有平台，默认值为 10.0.0.0/16。对于 libvirt，默认值 为 192.168.126.0/24。对于 IBM Power® Virtual Server，默认值为 192.168.0.0/24。

CIDR 表示法中的 IP 网络块。

例如： 10.0.0.0/16。

additionalTrustBundle:

添加到节点可信证书存储中的 PEM 编码 X.509 证书捆绑包。配置了代理时，也可以使用此信任捆绑包。

字符串

capabilities:

控制可选核心组件的安装。您可以通过禁用可选组件来减少 OpenShift Container Platform 集群的空间。如需更多信息，请参阅安装中的"集群功能"页面。

字符串数组

capabilities:
  baselineCapabilitySet:

选择要启用的一组初始可选功能。有效值为 None、v4.11、v4.12 和 vCurrent。默认值为 vCurrent。

字符串

capabilities:
  additionalEnabledCapabilities:

将可选功能集合扩展到您在 baselineCapabilitySet 中指定的范围。您可以在此参数中指定多个功能。

字符串数组

cpuPartitioningMode:

启用工作负载分区，它会隔离 OpenShift Container Platform 服务、集群管理工作负载和基础架构 pod，以便在保留的一组 CPU 上运行。工作负载分区只能在安装过程中启用，且在安装后无法禁用。虽然此字段启用工作负载分区，但它不会将工作负载配置为使用特定的 CPU。如需更多信息，请参阅 Scalability and Performance 部分中的 Workload partitioning 页面。

None 或 AllNodes.None 是默认值。

compute:

组成计算节点的机器的配置。

MachinePool 对象的数组。

compute:
  architecture:

决定池中机器的指令集合架构。目前，不支持具有不同架构的集群。所有池都必须指定相同的架构。有效值为 amd64 和 arm64。

字符串

compute:
  hyperthreading:

是否在计算机器上启用或禁用并发多 线程或超线程。默认情况下，启用并发多线程以提高机器内核的性能。

enabled 或 Disabled

compute:
  name:

使用 compute 时需要此项。机器池的名称。

worker

compute:
  platform:

使用 compute 时需要此项。使用此参数指定托管 worker 机器的云供应商。此参数值必须与 controlPlane.platform 参数值匹配。

aws, azure, gcp, ibmcloud, nutanix, openstack, powervs, vsphere, 或 {}

compute:
  replicas:

要置备的计算机器数量，也称为 worker 机器。

大于或等于 2 的正整数。默认值为 3。

featureSet:

为功能集启用集群。功能集是 OpenShift Container Platform 功能的集合，默认情况下不启用。有关在安装过程中启用功能集的更多信息，请参阅"使用功能门启用功能"。

字符串.要启用的功能集的名称，如 TechPreviewNoUpgrade。

controlPlane:

组成 control plane 的机器的配置。

MachinePool 对象的数组。

controlPlane:
  architecture:

决定池中机器的指令集合架构。目前，不支持具有不同架构的集群。所有池都必须指定相同的架构。有效值为 amd64 和 arm64。

字符串

controlPlane:
  hyperthreading:

是否在 control plane 机器上启用或禁用并发多 线程或超线程。默认情况下，启用并发多线程以提高机器内核的性能。

enabled 或 Disabled

controlPlane:
  name:

使用 controlPlane 时需要此项。机器池的名称。

master

controlPlane:
  platform:

使用 controlPlane 时需要此项。使用此参数指定托管 control plane 机器的云供应商。此参数值必须与 compute.platform 参数值匹配。

aws, azure, gcp, ibmcloud, nutanix, openstack, powervs, vsphere, 或 {}

controlPlane:
  replicas:

要置备的 control plane 机器数量。

部署单节点 OpenShift 时支持的值为 3 或 1。

credentialsMode:

Cloud Credential Operator(CCO)模式。如果没有指定模式，CCO 会动态尝试决定提供的凭证的功能，在支持多个模式的平台上首选 mint 模式。

Mint、Passthrough、Manual 或空字符串("")。

fips:

启用或禁用 FIPS 模式。默认值为 false （禁用）。如果启用了 FIPS 模式，运行 OpenShift Container Platform 的 Red Hat Enterprise Linux CoreOS(RHCOS)机器会绕过默认的 Kubernetes 加密套件，并使用由 RHCOS 提供的加密模块。

false 或 true

imageContentSources:

release-image 内容的源和存储库。

对象数组。包括一个 source 以及可选的 mirrors，如本表的以下行所述。

imageContentSources:
  source:

使用 imageContentSources 时需要此项。指定用户在镜像拉取规格中引用的存储库。

字符串

imageContentSources:
  mirrors:

指定可能还包含同一镜像的一个或多个仓库。

字符串数组

publish:

如何发布或公开集群的面向用户的端点，如 Kubernetes API、OpenShift 路由。

内部或外部 .要部署无法从互联网访问的私有集群，请将 publish 设置为 Internal。默认值为 External。

sshKey:

用于验证对集群机器的访问的 SSH 密钥。

例如，sshKey: ssh-ed25519 AAAA..。

controlPlane:
  platform:
    gcp:
      osImage:
        project:

可选。默认情况下，安装程序会下载并安装用于引导 control plane 机器的 Red Hat Enterprise Linux CoreOS (RHCOS)镜像。您可以通过指定安装程序仅用于 control plane 机器的自定义 RHCOS 镜像的位置来覆盖默认行为。

字符串.镜像所在 GCP 项目的名称。

controlPlane:
  platform:
    gcp:
      osImage:
        name:

安装程序用来引导 control plane 机器的自定义 RHCOS 镜像的名称。如果使用 controlPlane.platform.gcp.osImage.project，则需要此字段。

字符串.RHCOS 镜像的名称。

compute:
  platform:
    gcp:
      osImage:
        project:

可选。默认情况下，安装程序会下载并安装用于引导计算机器的 RHCOS 镜像。您可以通过指定安装程序仅用于计算机器的自定义 RHCOS 镜像的位置来覆盖默认行为。

字符串.镜像所在 GCP 项目的名称。

compute:
  platform:
    gcp:
      osImage:
        name:

安装程序用来引导计算机器的自定义 RHCOS 镜像的名称。如果使用 compute.platform.gcp.osImage.project，则需要此字段。

字符串.RHCOS 镜像的名称。

platform:
  gcp:
    network:

要部署集群的现有 Virtual Private Cloud (VPC) 的名称。如果要将集群部署到共享 VPC 中，则必须使用包含共享 VPC 的 GCP 项目的名称设置 platform.gcp.networkProjectID。

字符串.

platform:
  gcp:
    networkProjectID:

可选。包含要部署集群的共享 VPC 的 GCP 项目的名称。

字符串.

platform:
  gcp:
    projectID:

安装程序安装集群的 GCP 项目的名称。

字符串.

platform:
  gcp:
    region:

托管集群的 GCP 区域的名称。

任何有效的区域名称，如 us-central1。

platform:
  gcp:
    controlPlaneSubnet:

要部署 control plane 机器的现有子网的名称。

子网名称。

platform:
  gcp:
    computeSubnet:

要部署计算机器的现有子网的名称。

子网名称。

platform:
  gcp:
    defaultMachinePlatform:
      zones:

安装程序在其中创建机器的可用区。

有效 GCP 可用区 列表，如 us-central1-a，在一个 YAML 序列 中。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        diskSizeGB:

以 GB(GB)为单位的磁盘大小。

16 GB 到 65536 GB 之间的任何大小。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        diskType:

GCP 磁盘类型。

所有机器的默认磁盘类型。control plane 节点必须使用 pd-ssd 磁盘类型。Compute 节点可以使用 pd-ssd、pd-balanced 或 pd-standard 磁盘类型。

platform:
  gcp:
    defaultMachinePlatform:
      osImage:
        project:

可选。默认情况下，安装程序会下载并安装用于引导 control plane 和计算机器的 RHCOS 镜像。您可以通过为安装程序为两种类型的机器指定自定义 RHCOS 镜像的位置来覆盖默认行为。

字符串.镜像所在 GCP 项目的名称。

platform:
  gcp:
    defaultMachinePlatform:
      osImage:
        name:

安装程序用来引导 control plane 和计算机器的自定义 RHCOS 镜像的名称。如果使用 platform.gcp.defaultMachinePlatform.osImage.project，则需要此字段。

字符串.RHCOS 镜像的名称。

platform:
  gcp:
    defaultMachinePlatform:
      tags:

可选。要添加到 control plane 和计算机器的额外网络标签。

一个或多个字符串，如 network-tag1。

platform:
  gcp:
    defaultMachinePlatform:
      type:

control plane 和计算机器的 GCP 机器类型。

GCP 机器类型，如 n1-standard-4。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        encryptionKey:
          kmsKey:
            name:

用于机器磁盘加密的客户管理的加密密钥名称。

加密密钥名称。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        encryptionKey:
          kmsKey:
            keyRing:

KMS 密钥所属的密钥管理服务 (KMS) 密钥环的名称。

KMS 密钥环名称。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        encryptionKey:
          kmsKey:
            location:

KMS 密钥环存在的 GCP 位置。

GCP 位置。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        encryptionKey:
          kmsKey:
            projectID:

存在 KMS 密钥环的项目 ID。如果没有设置，则默认值为 platform.gcp.projectID 参数的值。

GCP 项目 ID。

platform:
  gcp:
    defaultMachinePlatform:
      osDisk:
        encryptionKey:
          kmsKeyServiceAccount:

用于 control plane 和计算机器加密请求的 GCP 服务帐户。如果没有，则使用 Compute Engine 默认服务帐户。如需有关 GCP 服务帐户的更多信息，请参阅 Google 文档中的服务帐户。

GCP 服务帐户电子邮件，如 <service_account_name>@<project_id>.iam.gserviceaccount.com。

platform:
  gcp:
    defaultMachinePlatform:
      secureBoot:

是否为集群中的所有机器启用 Shielded VM 安全引导。Shielded 虚拟机具有额外的安全协议，如安全引导、固件和完整性监控和 rootkit 保护。有关 Shielded 虚拟机的更多信息，请参阅 Google 文档中有关 Shielded 虚拟机 的文档。

Enabled 或 Disabled。默认值为 Disabled。

platform:
  gcp:
    defaultMachinePlatform:
      confidentialCompute:

是否对集群中的所有机器使用机密虚拟机。机密虚拟机在处理过程中为数据提供加密。有关机密计算的更多信息，请参阅 Google 文档中有关机密计算的内容。

Enabled 或 Disabled。默认值为 Disabled。

platform:
  gcp:
    defaultMachinePlatform:
      onHostMaintenance:

指定主机维护事件期间所有虚拟机的行为，如软件或硬件更新。对于机密虚拟机，此参数必须设置为 Terminate。机密虚拟机不支持实时迁移。

Terminate 或 Migrate.默认值为 Migrate。

controlPlane:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            name:

用于 control plane 机器磁盘加密的客户管理的加密密钥名称。

加密密钥名称。

controlPlane:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            keyRing:

对于 control plane 机器，KMS 密钥环的名称。

KMS 密钥环名称。

controlPlane:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            location:

对于 control plane 机器，存在密钥环的 GCP 位置。有关 KMS 位置的更多信息，请参阅 Google 文档中的Cloud KMS 位置。

密钥环的 GCP 位置。

controlPlane:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            projectID:

对于 control plane 机器，存在 KMS 密钥环的项目 ID。如果没有设置，则默认值是 VM 项目 ID。

GCP 项目 ID。

controlPlane:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKeyServiceAccount:

用于 control plane 机器的加密请求的 GCP 服务帐户。如果没有，则使用 Compute Engine 默认服务帐户。如需有关 GCP 服务帐户的更多信息，请参阅 Google 文档中的服务帐户。

GCP 服务帐户电子邮件，如 <service_account_name>@<project_id>.iam.gserviceaccount.com。

controlPlane:
  platform:
    gcp:
      osDisk:
        diskSizeGB:

以 GB(GB)为单位的磁盘大小。这个值适用于 control plane 机器。

16 到 65536 之间的任何整数。

controlPlane:
  platform:
    gcp:
      osDisk:
        diskType:

control plane 机器的 GCP 磁盘类型。

control plane 机器必须使用 pd-ssd 磁盘类型，这是默认设置。

controlPlane:
  platform:
    gcp:
      tags:

可选。要添加到 control plane 机器的额外网络标签。如果设置，此参数会覆盖 control plane 机器的 platform.gcp.defaultMachinePlatform.tags 参数。

一个或多个字符串，如 control-plane-tag1。

controlPlane:
  platform:
    gcp:
      type:

control plane 机器的 GCP 机器类型。如果设置，此参数会覆盖 platform.gcp.defaultMachinePlatform.type 参数。

GCP 机器类型，如 n1-standard-4。

controlPlane:
  platform:
    gcp:
      zones:

安装程序在其中创建 control plane 机器的可用区。

有效 GCP 可用区 列表，如 us-central1-a，在一个 YAML 序列 中。

controlPlane:
  platform:
    gcp:
      secureBoot:

是否为 control plane 机器启用 Shielded VM 安全引导。Shielded 虚拟机具有额外的安全协议，如安全引导、固件和完整性监控和 rootkit 保护。有关 Shielded 虚拟机的更多信息，请参阅 Google 文档中有关 Shielded 虚拟机 的文档。

Enabled 或 Disabled。默认值为 Disabled。

controlPlane:
  platform:
    gcp:
      confidentialCompute:

是否为 control plane 机器启用机密虚拟机。机密虚拟机在处理数据时为数据提供加密。有关机密虚拟机的更多信息，请参阅 Google 文档中有关机密计算的内容。

Enabled 或 Disabled。默认值为 Disabled。

controlPlane:
  platform:
    gcp:
      onHostMaintenance:

指定在主机维护事件期间 control plane 虚拟机的行为，如软件或硬件更新。对于机密虚拟机，此参数必须设置为 Terminate。机密虚拟机不支持实时迁移。

Terminate 或 Migrate.默认值为 Migrate。

compute:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            name:

用于计算机器磁盘加密的客户管理的加密密钥名称。

加密密钥名称。

compute:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            keyRing:

对于计算机器，KMS 密钥环的名称。

KMS 密钥环名称。

compute:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            location:

对于计算机器，存在密钥环的 GCP 位置。有关 KMS 位置的更多信息，请参阅 Google 文档中的Cloud KMS 位置。

密钥环的 GCP 位置。

compute:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKey:
            projectID:

对于计算机器，存在 KMS 密钥环的项目 ID。如果没有设置，则默认值是 VM 项目 ID。

GCP 项目 ID。

compute:
  platform:
    gcp:
      osDisk:
        encryptionKey:
          kmsKeyServiceAccount:

用于计算机器加密请求的 GCP 服务帐户。如果没有设置这个值，则使用 Compute Engine 默认服务帐户。如需有关 GCP 服务帐户的更多信息，请参阅 Google 文档中的服务帐户。

GCP 服务帐户电子邮件，如 <service_account_name>@<project_id>.iam.gserviceaccount.com。

compute:
  platform:
    gcp:
      osDisk:
        diskSizeGB:

以 GB(GB)为单位的磁盘大小。这个值适用于计算机器。

16 到 65536 之间的任何整数。

compute:
  platform:
    gcp:
      osDisk:
        diskType:

计算机器的 GCP 磁盘类型。

pd-ssd、pd-standard 或 pd-balanced。默认为 pd-ssd。

compute:
  platform:
    gcp:
      tags:

可选。要添加到计算机器的额外网络标签。如果设置，此参数会覆盖计算机器的 platform.gcp.defaultMachinePlatform.tags 参数。

一个或多个字符串，如 compute-network-tag1。

compute:
  platform:
    gcp:
      type:

计算机器的 GCP 机器类型。如果设置，此参数会覆盖 platform.gcp.defaultMachinePlatform.type 参数。

GCP 机器类型，如 n1-standard-4。

compute:
  platform:
    gcp:
      zones:

安装程序在其中创建计算机器的可用区。

有效 GCP 可用区 列表，如 us-central1-a，在一个 YAML 序列 中。

compute:
  platform:
    gcp:
      secureBoot:

是否为计算机器启用 Shielded VM 安全引导。Shielded 虚拟机具有额外的安全协议，如安全引导、固件和完整性监控和 rootkit 保护。有关 Shielded 虚拟机的更多信息，请参阅 Google 文档中有关 Shielded 虚拟机 的文档。

Enabled 或 Disabled。默认值为 Disabled。

compute:
  platform:
    gcp:
      confidentialCompute:

是否为计算机器启用机密虚拟机。机密虚拟机在处理数据时为数据提供加密。有关机密虚拟机的更多信息，请参阅 Google 文档中有关机密计算的内容。

Enabled 或 Disabled。默认值为 Disabled。

compute:
  platform:
    gcp:
      onHostMaintenance:

指定在主机维护事件期间计算虚拟机的行为，如软件或硬件更新。对于机密虚拟机，此参数必须设置为 Terminate。机密虚拟机不支持实时迁移。

Terminate 或 Migrate.默认值为 Migrate。