8.10. IBM Cloud 的安装配置参数

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。如果您要将集群部署到现有的 Virtual Private Cloud (VPC)，则 CIDR 必须包含在 platform.ibmcloud.controlPlaneSubnets and platform.ibmcloud.computeSubnets 中定义的子网。

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 （默认值）。

字符串

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 （默认值）。

字符串

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:
    ibmcloud:
      bootVolume:
        encryptionKey:

一个 IBM® Key Protect for IBM Cloud® (Key Protect) root 密钥，应只用于加密 control plane 机器的 root (boot) 卷。

root 密钥的 Cloud Resource Name (CRN)。

CRN 必须用引号 ("") 括起。

compute:
  platform:
    ibmcloud:
      bootVolume:
        encryptionKey:

一个 Key Protect root 密钥，应只用于加密计算机器的 root (boot) 卷。

root 密钥的 CRN。

CRN 必须用引号 ("") 括起。

platform:
  ibmcloud:
    defaultMachinePlatform:
      bootvolume:
        encryptionKey:

一个 Key Protect root 密钥，应用于加密所有集群机器的 root (boot) 卷。

当作为默认机器配置的一部分指定时，所有受管存储类都会使用此密钥更新。因此，安装后置备的数据卷也会使用此密钥加密。

root 密钥的 CRN。

CRN 必须用引号 ("") 括起。

platform:
  ibmcloud:
    resourceGroupName:

现有资源组的名称。默认情况下，安装程序置备的 VPC 和集群资源放置在此资源组中。如果没有指定，安装程序会为集群创建资源组。如果您要将集群部署到现有的 VPC 中，安装程序置备的集群资源将放置在此资源组中。如果没有指定，安装程序会为集群创建资源组。您置备的 VPC 资源必须存在于您使用 networkResourceGroupName 参数指定的资源组中。在这两种情况下，此资源组必须仅用于单个集群安装，因为集群组件假定资源组中所有资源的所有权 [¹]

字符串，如 existing_resource_group。

platform:
  ibmcloud:
    serviceEndpoints:
      - name:
        url:

服务端点名称和 URI 列表。

默认情况下，安装程序和集群组件使用公共服务端点访问所需的 IBM Cloud® 服务。

如果网络限制限制对公共服务端点的访问，您可以指定一个备用服务端点来覆盖默认行为。

您只能为每个服务指定一个备用服务端点：

有效服务端点名称和完全限定的 URI。

有效名称包括：

platform:
  ibmcloud:
    networkResourceGroupName:

现有资源组的名称。此资源包含集群要部署到的现有 VPC 和子网。当将集群部署到已置备的 VPC 时，需要此参数。

字符串，如 existing_network_resource_group。

platform:
  ibmcloud:
    dedicatedHosts:
      profile:

要创建的新专用主机。如果您为 platform.ibmcloud.dedicatedHosts.name 指定值，则不需要此参数。

有效的 IBM Cloud® 专用主机配置文件，如 cx2-host-152x304. [²]

platform:
  ibmcloud:
    dedicatedHosts:
      name:

存在一个现有的专用主机。如果您为 platform.ibmcloud.dedicatedHosts.profile 指定一个值，则不需要此参数。

字符串，如 my-dedicated-host-name。

platform:
  ibmcloud:
    type:

所有 IBM Cloud® 机器的实例类型。

有效的 IBM Cloud® 实例类型，如 bx2-8x32. [²]

platform:
  ibmcloud:
    vpcName:

要将集群部署到的现有 VPC 的名称。

字符串.

platform:
  ibmcloud:
    controlPlaneSubnets:

要将 control plane 机器部署到的 VPC 中现有子网的名称。为每个可用区指定一个子网。

字符串数组

platform:
  ibmcloud:
    computeSubnets:

要将计算机器部署到的 VPC 中现有子网的名称。为每个可用区指定一个子网。不支持子网 ID。

字符串数组