8.10. IBM Cloud 的安装配置参数


在 IBM Cloud® 上部署 OpenShift Container Platform 集群前,您可以提供参数来自定义集群以及托管它的平台。在创建 install-config.yaml 文件时,您可以通过命令行为所需参数提供值。然后,您可以修改 install-config.yaml 文件以进一步自定义集群。

8.10.1. IBM Cloud 可用的安装配置参数

下表指定您可以在安装过程中设置所需的、可选和 IBM Cloud 特定安装配置参数。

注意

安装后,您无法在 install-config.yaml 文件中修改这些参数。

8.10.1.1. 所需的配置参数

下表描述了所需的安装配置参数:

表 8.15. 所需的参数
参数描述
apiVersion:

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

字符串

baseDomain:

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

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

metadata:

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

对象

metadata:
  name:

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

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

platform:

要执行安装的具体平台配置:alibabacloud, aws, baremetal, azure, gcp, ibmcloud, nutanix, openstack, powervs, vsphere, or {}。有关 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"
      }
   }
}

8.10.1.2. 网络配置参数

您可以根据现有网络基础架构的要求自定义安装配置。例如,您可以扩展集群网络的 IP 地址块,或者提供不同于默认值的不同 IP 地址块。

仅支持 IPv4 地址。

注意

Red Hat OpenShift Data Foundation 灾难恢复解决方案不支持 Globalnet。对于区域灾难恢复场景,请确保为每个集群中的集群和服务网络使用非重叠的专用 IP 地址。

表 8.16. 网络参数
参数描述
networking:

集群网络的配置。

对象

注意

您无法在安装后修改 网络 对象指定的参数。

networking:
  networkType:

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

OVNKubernetesOVNKubernetes 是 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 子网。hostPrefix23 提供 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

注意

networking.machineNetwork 设置为与首选 NIC 所在的 CIDR 匹配。

8.10.1.3. 可选的配置参数

下表描述了可选的安装配置参数:

表 8.17. 可选参数
参数描述
additionalTrustBundle:

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

字符串

capabilities:

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

字符串数组

capabilities:
  baselineCapabilitySet:

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

字符串

capabilities:
  additionalEnabledCapabilities:

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

字符串数组

cpuPartitioningMode:

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

NoneAllNodes.None 是默认值。

compute:

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

MachinePool 对象的数组。

compute:
  architecture:

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

字符串

compute:
  hyperthreading:

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

重要

如果您禁用并发多线程,请确保您的容量规划考虑机器性能显著降低的情况。

enabledDisabled

compute:
  name:

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

worker

compute:
  platform:

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

alibabacloud, 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 机器上启用或禁用并发多 线程或超线程。默认情况下,启用并发多线程以提高机器内核的性能。

重要

如果您禁用并发多线程,请确保您的容量规划考虑机器性能显著降低的情况。

enabledDisabled

controlPlane:
  name:

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

master

controlPlane:
  platform:

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

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

controlPlane:
  replicas:

要置备的 control plane 机器数量。

部署单节点 OpenShift 时支持的值为 31

credentialsMode:

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

MintPassthroughManual 或空字符串("")。[1]

fips:

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

重要

要为集群启用 FIPS 模式,您必须从配置为以 FIPS 模式操作的 Red Hat Enterprise Linux (RHEL) 计算机运行安装程序。有关在 RHEL 中配置 FIPS 模式的更多信息,请参阅在 FIPS 模式中安装该系统。当以 FIPS 模式运行 Red Hat Enterprise Linux (RHEL) 或 Red Hat Enterprise Linux CoreOS (RHCOS)时,OpenShift Container Platform 核心组件使用 RHEL 加密库,在 x86_64、ppc64le 和 s390x 架构上提交到 NIST FIPS 140-2/140-3 Validation。

注意

如果使用 Azure File 存储,则无法启用 FIPS 模式。

falsetrue

imageContentSources:

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

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

imageContentSources:
  source:

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

字符串

imageContentSources:
  mirrors:

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

字符串数组

publish:

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

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

sshKey:

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

注意

对于您要在其上执行安装调试或灾难恢复的生产环境 OpenShift Container Platform 集群,请指定 ssh-agent 进程使用的 SSH 密钥。

例如,sshKey: ssh-ed25519 AAAA..

  1. 不是所有 CCO 模式都支持所有云供应商。有关 CCO 模式的更多信息,请参阅身份验证和授权内容中的"管理云供应商凭证"条目。

8.10.1.4. 其他 IBM Cloud 配置参数

下表描述了其他 IBM Cloud® 配置参数:

表 8.18. 其他 IBM Cloud (R)参数
参数描述
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 参数指定的资源组中。在这两种情况下,此资源组必须仅用于单个集群安装,因为集群组件假定资源组中所有资源的所有权 [1]

字符串,如 existing_resource_group

platform:
  ibmcloud:
    serviceEndpoints:
      - name:
        url:

服务端点名称和 URI 列表。

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

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

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

  • 云对象存储
  • DNS 服务
  • 全局搜索
  • 全局标记
  • 身份服务
  • 密钥保护
  • 资源控制器
  • 资源管理器
  • VPC

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

有效名称包括:

  • COS
  • DNSServices
  • GlobalServices
  • GlobalTagging
  • IAM
  • KeyProtect
  • ResourceController
  • ResourceManager
  • VPC
platform:
  ibmcloud:
    networkResourceGroupName:

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

字符串,如 existing_network_resource_group

platform:
  ibmcloud:
    dedicatedHosts:
      profile:

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

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

platform:
  ibmcloud:
    dedicatedHosts:
      name:

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

字符串,如 my-dedicated-host-name

platform:
  ibmcloud:
    type:

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

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

platform:
  ibmcloud:
    vpcName:

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

字符串.

platform:
  ibmcloud:
    controlPlaneSubnets:

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

字符串数组

platform:
  ibmcloud:
    computeSubnets:

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

字符串数组

  1. 不论您定义现有资源组还是安装程序创建了资源组,都决定在卸载资源组时如何对待资源组。如果您定义了资源组,安装程序会删除所有安装程序置备的资源,但只保留资源组;如果资源组是作为安装的一部分创建,安装程序将删除所有安装程序置备的资源和资源组。
  2. 要确定哪个配置集最符合您的需要,请参阅 IBM® 文档中的实例配置集
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.