3.11. 安装配置参数

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。字符串长度必须为 14 个字符或更少。

platform

要执行安装的具体平台配置： alibabacloud、aws、baremetal、azure、gcp、ibmcloud、nutanix、openstack、ovirt、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 网络插件。

OpenShiftSDN 或 OVNKubernetes。OpenShiftSDN 是 all-Linux 网络的 CNI 插件。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。

OpenShift SDN 和 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 证书捆绑包。配置了代理时，也可以使用此信任捆绑包。

字符串

功能

控制可选核心组件的安装。您可以通过禁用可选组件来减少 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: 超线程：

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

enabled 或 Disabled

compute.name

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

worker

compute.platform

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

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

compute.replicas

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

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

featureSet

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

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

controlPlane

组成 control plane 的机器的配置。

MachinePool 对象的数组。

controlPlane.architecture

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

字符串

controlPlane: 超线程：

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

enabled 或 Disabled

controlPlane.name

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

master

controlPlane.platform

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

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

controlPlane.replicas

要置备的 control plane 机器数量。

唯一支持的值是 3，这是默认值。

credentialsMode

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

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

imageContentSources

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

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

imageContentSources.source

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

字符串

imageContentSources.mirrors

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

字符串数组

publish

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

内部或外部 .默认值为 External。

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

sshKey

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

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

compute.platform.openstack.rootVolume.size

对于计算机器，以 GB 为单位的根卷大小。如果没有设置这个值，机器将使用临时存储。

整数，如 30。

compute.platform.openstack.rootVolume.type

对于计算机器，根卷的类型。

字符串，如 performance。

controlPlane.platform.openstack.rootVolume.size

对于 control plane 机器，以 GB 为单位表示的根卷大小。如果没有设置这个值，机器将使用临时存储。

整数，如 30。

controlPlane.platform.openstack.rootVolume.type

对于 control plane 机器，根卷的类型。

字符串，如 performance。

platform.openstack.cloud

要使用的 RHOSP 云名称，来自于 clouds.yaml 文件中的云列表。

字符串，如 MyCloud。

platform.openstack.externalNetwork

用于安装的 RHOSP 外部网络名称。

字符串，如 external。

platform.openstack.computeFlavor

用于 control plane 和计算机器的 RHOSP 类别。

此属性已弃用。要将 flavor 用作所有机器池的默认值，请将其添加为 platform.openstack.defaultMachinePlatform 属性中的 type 键的值。您还可以分别为每个机器池设置 flavor 值。

字符串，如 m1.xlarge。

compute.platform.openstack.additionalNetworkIDs

与计算机器关联的其他网络。不为额外网络创建允许的地址对。

一个或多个 UUID 的列表作为字符串。例如： fa806b2f-ac49-4bce-b9db-124bc64209bf。

compute.platform.openstack.additionalSecurityGroupIDs

与计算机器关联的其他安全组。

一个或多个 UUID 的列表作为字符串。例如，7ee219f3-d2e9-48a1-96c2-e7429f1b0da7。

compute.platform.openstack.zones

RHOSP Compute(Nova)可用区(AZ)在其中安装机器。如果没有设置此参数，安装程序会依赖于配置了 RHOSP 管理员的 Nova 的默认设置。

在使用 Kuryr 的集群上，RHOSP Octavia 不支持可用区。负载均衡器，如果您使用 Amphora 供应商驱动程序，则依赖 Amphora 虚拟机的 OpenShift Container Platform 服务不会根据此属性的值创建。

字符串列表。例如： ["zone-1", "zone-2"]。

compute.platform.openstack.rootVolume.zones

对于计算机器，可在其上安装根卷的可用性区域。如果没有为此参数设置值，安装程序会选择默认的可用性区域。

字符串列表，如 ["zone-1", "zone-2"]。

compute.platform.openstack.serverGroupPolicy

要应用到包含池中的计算机器的组策略。您不能在创建后更改服务器组策略或关系。支持的选项包括 anti-affinity, soft-affinity, 和 soft-anti-affinity默认值为 soft-anti-affinity。

affinity 策略可防止迁移，因此会影响 RHOSP 升级。不支持 affinity 策略。

如果使用严格的 anti-affinity 策略，实例迁移过程中需要额外的 RHOSP 主机。

应用到机器池的服务器组策略。例如，soft-affinity。

controlPlane.platform.openstack.additionalNetworkIDs

与 control plane 机器关联的额外网络。不为额外网络创建允许的地址对。

附加到 control plane 机器的额外网络也会附加到 bootstrap 节点。

一个或多个 UUID 的列表作为字符串。例如： fa806b2f-ac49-4bce-b9db-124bc64209bf。

controlPlane.platform.openstack.additionalSecurityGroupIDs

与 control plane 机器关联的其他安全组。

一个或多个 UUID 的列表作为字符串。例如，7ee219f3-d2e9-48a1-96c2-e7429f1b0da7。

controlPlane.platform.openstack.zones

RHOSP Compute(Nova)可用区(AZ)在其中安装机器。如果没有设置此参数，安装程序会依赖于配置了 RHOSP 管理员的 Nova 的默认设置。

在使用 Kuryr 的集群上，RHOSP Octavia 不支持可用区。负载均衡器，如果您使用 Amphora 供应商驱动程序，则依赖 Amphora 虚拟机的 OpenShift Container Platform 服务不会根据此属性的值创建。

字符串列表。例如： ["zone-1", "zone-2"]。

controlPlane.platform.openstack.rootVolume.zones

对于 control plane 机器，安装根卷的可用区。如果没有设置这个值，安装程序会选择默认可用区。

字符串列表，如 ["zone-1", "zone-2"]。

controlPlane.platform.openstack.serverGroupPolicy

要应用到池中包含 control plane 机器的组的服务器组策略。您不能在创建后更改服务器组策略或关系。支持的选项包括 anti-affinity, soft-affinity, 和 soft-anti-affinity默认值为 soft-anti-affinity。

affinity关联性 策略会阻止迁移，因此会影响 RHOSP 升级。不支持 affinity 策略。

如果使用严格的 anti-affinity 策略，实例迁移过程中需要额外的 RHOSP 主机。

应用到机器池的服务器组策略。例如，soft-affinity。

platform.openstack.clusterOSImage

安装程序从中下载 RHCOS 镜像的位置。

您必须设置此参数才能在受限网络中执行安装。

HTTP 或 HTTPS URL，可选使用 SHA-256 校验和。

例如： http://mirror.example.com/images/rhcos-43.81.201912131630.0-openstack.x86_64.qcow2.gz?sha256=ffebbd68e8a1f2a245ca19522c16c86f67f9ac8e4e0c1f0a812b068b16f7265d。该值也可以是现有 Glance 镜像的名称，如 my-rhcos。

platform.openstack.clusterOSImageProperties

在 Glance 中添加至安装程序上传的 ClusterOSImage 的属性。如果将 platform.openstack.clusterOSImage 设置为现有的 Glance 镜像，则此属性将被忽略。

您可以使用此属性超过每个节点 26 个 PV 的 RHOSP 的默认持久性卷(PV)限值。要超过这个限制，请将 virtio- scsi_model 属性值设置为 virtio-scsi， 并将 hw_disk_bus 值设置为 scsi。

您还可以使用此属性通过包含值为 yes 的 hw_qemu_guest_agent 属性来启用 QEMU 客户机代理。

键值字符串对列表。例如 ，["hw_scsi_model": "virtio-scsi", "hw_disk_bus": "scsi"]。

platform.openstack.defaultMachinePlatform

默认机器池平台配置。

{
   "type": "ml.large",
   "rootVolume": {
      "size": 30,
      "type": "performance"
   }
}

platform.openstack.ingressFloatingIP

与 Ingress 端口关联的现有浮动 IP 地址。要使用此属性，还必须定义 platform.openstack.externalNetwork 属性。

IP 地址，如 128.0.0.1。

platform.openstack.apiFloatingIP

与 API 负载均衡器关联的现有浮动 IP 地址。要使用此属性，还必须定义 platform.openstack.externalNetwork 属性。

IP 地址，如 128.0.0.1。

platform.openstack.externalDNS

集群实例用于 DNS 解析的外部 DNS 服务器的 IP 地址。

IP 地址列表作为字符串。例如 ，["8.8.8.8", "192.168.1.12"]。

platform.openstack.loadbalancer

是否使用默认的内部负载均衡器。如果值设为 UserManaged，则此默认负载均衡器被禁用，以便您可以部署使用外部用户管理的负载均衡器的集群。如果没有设置该参数，或者值为 OpenShiftManagedDefault，集群将使用默认负载均衡器。

UserManaged 或 OpenShiftManagedDefault.

platform.openstack.machinesSubnet

集群节点使用的 RHOSP 子网的 UUID。在这个子网上创建节点和虚拟 IP(VIP)端口。

networking.machineNetwork 中的第一个项必须与 machine Subnet 的值匹配。

如果部署到自定义子网中，则无法将外部 DNS 服务器指定到 OpenShift Container Platform 安装程序。相反，将 DNS 添加到 RHOSP 中的子网中。

作为字符串的 UUID。例如： fa806b2f-ac49-4bce-b9db-124bc64209bf。

platform.openstack.failuredomains.computeAvailabilityZone

服务器的可用区。如果没有指定，则使用集群默认。

可用区的名称。例如，nova-1。

platform.openstack.failuredomains.storageAvailabilityZone

root 卷的可用区。如果没有指定，则使用集群默认。

可用区的名称。例如，cinder-1。

platform.openstack.failuredomains.portTargets

portTarget 对象列表，各自定义附加到故障域中机器的网络连接。

portTarget 对象列表。

platform.openstack.failuredomains.portTargets.portTarget.id

单个端口目标的 ID。要将该端口目标选为机器的第一个网络，请将此参数的值设置为 control-plane。如果此参数具有不同的值，它将被忽略。

control-plane 或任意字符串。

platform.openstack.failuredomains.portTargets.portTarget.network

必需。附加到故障域中机器的网络的名称或 ID。

包含名称或 UUID 的 network 对象。例如：

network:
  id: 8db6a48e-375b-4caa-b20b-5b9a7218bfe6

或：

network:
  name: my-network-1

platform.openstack.failuredomains.portTargets.portTarget.fixedIPs

要分配固定 IP 地址的子网。这些子网必须与端口位于同一个网络中。

subnet 对象列表。