第 9 章 vSphere 的安装配置参数


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

9.1. vSphere 可用的安装配置参数

下表指定可设置为安装过程的一部分所需的、可选和特定于 vSphere 的安装配置参数。

注意

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

9.1.1. 所需的配置参数

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

表 9.1. 所需的参数
参数描述
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:

对于特定平台的配置取决于执行安装的环境: 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"
      }
   }
}

9.1.2. 网络配置参数

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

在为集群配置网络参数前,请考虑以下信息:

  • 如果使用 Red Hat OpenShift Networking OVN-Kubernetes 网络插件,则支持 IPv4 和 IPv6 地址系列。
  • 如果您在带有支持 IPv4 和非本地 IPv6 地址的网络的 OpenShift Container Platform 集群中部署了节点,请将集群配置为使用双栈网络。

    • 对于为双栈网络配置的集群,IPv4 和 IPv6 流量都必须使用与默认网关相同的网络接口。这样可确保在一个多个网络接口控制器(NIC)环境中,集群可以根据可用的网络接口检测要使用的 NIC。如需更多信息,请参阅关于 OVN-Kubernetes 网络插件中的"OVN-Kubernetes IPv6 和双栈限制"。
    • 为防止网络连接问题,请不要在支持双栈网络的主机上安装单堆栈 IPv4 集群。
注意

在 VMware vSphere 上,双栈网络可以指定 IPv4 或 IPv6 作为主要地址系列。

如果将集群配置为使用两个 IP 地址系列,请查看以下要求:

  • 两个 IP 系列都必须将相同的网络接口用于默认网关。
  • 两个 IP 系列都必须具有默认网关。
  • 您必须为所有网络配置参数指定 IPv4 和 IPv6 地址。例如,以下配置 IPv4 地址列在 IPv6 地址的前面。

    networking:
      clusterNetwork:
      - cidr: 10.128.0.0/14
        hostPrefix: 23
      - cidr: fd00:10:128::/56
        hostPrefix: 64
      serviceNetwork:
      - 172.30.0.0/16
      - fd00:172:16::/112
表 9.2. 网络参数
参数描述
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

CIDR 表示法中的 IP 网络块。

例如: 10.0.0.0/16

注意

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

9.1.3. 可选的配置参数

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

表 9.3. 可选参数
参数描述
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:
  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:
  name:

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

master

controlPlane:
  platform:

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

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

controlPlane:
  replicas:

要置备的 control plane 机器数量。

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

credentialsMode:

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

注意

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

MintPassthroughManual 或空字符串("")。

fips:

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

重要

要为集群启用 FIPS 模式,您必须从配置为以 FIPS 模式操作的 Red Hat Enterprise Linux (RHEL) 计算机运行安装程序。有关在 RHEL 中配置 FIPS 模式的更多信息,请参阅将 RHEL 切换到 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 路由。

内部或外部 .默认值为 External

在非云平台上不支持将此字段设置为 Internal

重要

如果将字段的值设为 Internal,集群将无法运行。如需更多信息,请参阅 BZ#1953035

sshKey:

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

注意

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

例如,sshKey: ssh-ed25519 AAAA..

9.1.4. 其他 VMware vSphere 配置参数

下表描述了其他 VMware vSphere 配置参数:

表 9.4. 其他 VMware vSphere 集群参数
参数描述
platform:
  vsphere:

描述托管集群的云平台中的帐户。您可以使用参数来自定义平台。如果您为机器池中的 compute 和 control plane 机器提供额外的配置设置,则不需要该参数。您只能为 OpenShift Container Platform 集群指定一个 vCenter 服务器。

vSphere 配置对象的字典

platform:
  vsphere:
    apiVIPs:

为 control plane API 访问配置的虚拟 IP (VIP) 地址。

注意

这个参数只适用于安装程序置备的基础架构,而无需配置外部负载均衡器。您不能在用户置备的基础架构中指定此参数。

多个 IP 地址

platform:
  vsphere:
    diskType:

可选:磁盘置备方法。如果没有设置,则默认值为 vSphere 默认存储策略。

有效值为 thinthickeagerZeroedThick

platform:
  vsphere:
    failureDomains:

建立地区和区域之间的关系。您可以使用 vCenter 对象(如 datastore 对象)定义故障域。故障域定义 OpenShift Container Platform 集群节点的 vCenter 位置。

故障域配置对象的数组。

platform:
  vsphere:
    failureDomains:
      name:

故障域的名称。

字符串

platform:
  vsphere:
    failureDomains:
      region:

如果为集群定义多个故障域,则必须将标签附加到每个 vCenter 数据中心。要定义区域,请使用 openshift-region 标签类别中的标签。对于单个 vSphere 数据中心环境,您不需要附加标签,但必须为参数输入一个字母数字值,如 datacenter

字符串

platform:
  vsphere:
    failureDomains:
      server:

指定 VMware vCenter 服务器的完全限定主机名或 IP 地址,以便客户端可以访问故障域资源。您必须将 server 器角色应用到 vSphere vCenter 服务器位置。

字符串

platform:
  vsphere:
    failureDomains:
      zone:

如果为集群定义多个故障域,则必须为每个 vCenter 集群附加标签。要定义一个区,请使用 openshift-zone 标签类别中的标签。对于单个 vSphere 数据中心环境,您不需要附加标签,但必须为参数输入一个字母数字值,如 cluster

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        computeCluster:

vSphere 计算集群的路径。

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        datacenter:

列出并定义 OpenShift Container Platform 虚拟机 (VM) 操作的数据中心。数据中心列表必须与 vcenters 字段中指定的数据中心列表匹配。

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        datastore:

指定为故障域存储虚拟机文件的 vSphere 数据存储的路径。您必须将 datastore 角色应用到 vSphere vCenter 数据存储位置。

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        folder:

可选:用户创建虚拟机的现有文件夹的绝对路径,例如 /<data_center_name>/vm/<folder_name>/<subfolder_name>。如果没有提供这个值,安装程序会在数据中心虚拟机文件夹中创建一个顶层文件夹,其名称为基础架构 ID。如果您为集群提供基础架构,且您不想使用默认的 StorageClass 对象(名为 thin),您可以从 install-config.yaml 文件中省略 folder 参数。

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        networks:

列出 vCenter 实例中包含您配置的虚拟 IP 地址和 DNS 记录的任何网络。

字符串

platform:
  vsphere:
    failureDomains:
      topology:
        resourcePool:

可选:安装程序创建虚拟机的现有资源池的绝对路径,例如 /<data_center_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>。如果没有指定值,安装程序会在 /<data_center_name>/host/<cluster_name>/Resources 下的集群的 root 中安装资源。

字符串

platform:
  vsphere:
    failureDomains:
      topology
        template:

指定预先存在的 Red Hat Enterprise Linux CoreOS (RHCOS) 镜像模板或虚拟机的绝对路径。安装程序可以使用镜像模板或虚拟机在 vSphere 主机上快速安装 RHCOS。考虑使用此参数作为在 vSphere 主机上上传 RHCOS 镜像的替代选择。此参数仅适用于安装程序置备的基础架构。

字符串

platform:
  vsphere:
    ingressVIPs:

为集群 Ingress 配置的虚拟 IP (VIP) 地址。

注意

这个参数只适用于安装程序置备的基础架构,而无需配置外部负载均衡器。您不能在用户置备的基础架构中指定此参数。

多个 IP 地址

platform:
  vsphere:
    vcenters:

配置连接详情,以便服务可以与 vCenter 服务器通信。目前,只支持单个 vCenter 服务器。

vCenter 配置对象的数组。

platform:
  vsphere:
    vcenters:
      datacenters:

列出并定义 OpenShift Container Platform 虚拟机 (VM) 操作的数据中心。数据中心列表必须与 failureDomains 字段中指定的数据中心列表匹配。

字符串

platform:
  vsphere:
    vcenters:
      password:

与 vSphere 用户关联的密码。

字符串

platform:
  vsphere:
    vcenters:
      port:

用于与 vCenter 服务器通信的端口号。

整数

platform:
  vsphere:
    vcenters:
      server:

vCenter 服务器的完全限定主机名(FQHN)或 IP 地址。

字符串

platform:
  vsphere:
    vcenters:
      user:

与 vSphere 用户关联的用户名。

字符串

9.1.5. 弃用的 VMware vSphere 配置参数

在 OpenShift Container Platform 4.13 中,以下 vSphere 配置参数已弃用。您可以继续使用这些参数,但安装程序不会在 install-config.yaml 文件中自动指定这些参数。

下表列出了每个已弃用的 vSphere 配置参数:

表 9.5. 弃用的 VMware vSphere 集群参数
参数描述
platform:
  vsphere:
    apiVIP:

为 control plane API 访问配置的虚拟 IP(VIP)地址。

注意

在 OpenShift Container Platform 4.12 及更新的版本中,apiVIP 配置设置已弃用。反之,使用 List 格式在 apiVIPs 配置设置中输入值。

IP 地址,如 128.0.0.1

platform:
  vsphere:
    cluster:

安装 OpenShift Container Platform 集群的 vCenter 集群。

字符串

platform:
  vsphere:
    datacenter:

定义 OpenShift Container Platform 虚拟机 (VM) 操作的数据中心。

字符串

platform:
  vsphere:
    defaultDatastore:

用于调配卷的默认数据存储名称。

字符串

platform:
  vsphere:
    folder:

可选:安装程序创建虚拟机的现有文件夹的绝对路径。如果没有提供这个值,安装程序会创建一个文件夹,它的名称为 datacenter 虚拟机文件夹中的基础架构 ID。

字符串,如 /<data_center_name>/vm/<folder_name>/<subfolder_name>

platform:
  vsphere:
    ingressVIP:

为集群 Ingress 配置的虚拟 IP (VIP) 地址。

注意

在 OpenShift Container Platform 4.12 及更新的版本中,ingressVIP 配置设置已弃用。反之,使用 List 格式在 ingressVIPs 配置设置中输入值。

IP 地址,如 128.0.0.1

platform:
  vsphere:
    network:

包含您配置的虚拟 IP 地址和 DNS 记录的 vCenter 实例中的网络。

字符串

platform:
  vsphere:
    password:

vCenter 用户名的密码。

字符串

platform:
  vsphere:
    resourcePool:

可选:安装程序创建虚拟机的现有资源池的绝对路径。如果没有指定值,安装程序会在 /<data_center_name>/host/<cluster_name>/Resources 下的集群的 root 中安装资源。

字符串,例如 /<data_center_name>/host/<cluster_name>/Resources/<resource_pool_name>/<optional_nested_resource_pool_name>

platform:
  vsphere:
    username:

用于连接 vCenter 实例的用户名。此用户必须至少具有 vSphere 中 静态或动态持久性卷置备 所需的角色和权限。

字符串

platform:
  vsphere:
    vCenter:

vCenter 服务器的完全限定主机名或 IP 地址。

字符串

9.1.6. 可选的 VMware vSphere 机器池配置参数

下表描述了可选的 VMware vSphere 机器池配置参数:

表 9.6. 可选的 VMware vSphere 机器池参数
参数描述
platform:
  vsphere:
    clusterOSImage:

安装程序从中下载 Red Hat Enterprise Linux CoreOS (RHCOS) 镜像的位置。在为此参数设置路径值前,请确保 OpenShift Container Platform 发行版本中的默认 RHCOS 引导镜像与 RHCOS 镜像模板或虚拟机版本匹配;否则,集群安装可能会失败。

HTTP 或 HTTPS URL,可选使用 SHA-256 校验和。例如: https://mirror.openshift.com/images/rhcos-<version>-vmware.<architecture>.ova

platform:
  vsphere:
    osDisk:
      diskSizeGB:

以 GB 为单位的磁盘大小。

整数

platform:
  vsphere:
    cpus:

用于分配虚拟机的虚拟处理器内核总数。platform.vsphere.cpus 的值必须是 platform.vsphere.coresPerSocket 值的倍数。

整数

platform:
  vsphere:
    coresPerSocket:

虚拟机中每个插槽的内核数。虚拟机上的虚拟套接字数量为 platform .vsphere.cpus/platform.vsphere.coresPerSocket。control plane 节点和 worker 节点的默认值为 42

整数

platform:
  vsphere:
    memoryMB:

以 MB 为单位的虚拟机内存大小。

整数

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.