4.8.6. 创建安装配置文件

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、openstack、ovirt、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

要安装的集群网络供应商 Container Network Interface（CNI）插件。

OpenShiftSDN 或 OVNKubernetes。默认值为 OpenShiftSDN。

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，则每个节点从所给的 cidr 中分配一个 /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 以外的所有平台的默认值为 10.0.0.0/16。对于 libvirt，默认值为 192.168.126.0/24。

CIDR 表示法中的 IP 网络块。

例如： 10.0.0.0/16。

additionalTrustBundle

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

字符串

compute

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

MachinePool 对象的数组。详情请查看以下"Machine-pool"表。

compute.architecture

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

字符串

compute.hyperthreading

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

Enabled 或 Disabled

compute.name

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

worker

compute.platform

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

aws、azure、gcp、openstack、ovirt、vsphere 或 {}

compute.replicas

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

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

controlPlane

组成 control plane 的机器的配置。

MachinePool 对象的数组。详情请查看以下"Machine-pool"表。

controlPlane.architecture

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

字符串

controlPlane.hyperthreading

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

Enabled 或 Disabled

controlPlane.name

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

master

controlPlane.platform

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

aws、azure、gcp、openstack、ovirt、vsphere 或 {}

controlPlane.replicas

要置备的 control plane 机器数量。

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

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 路由。

Internal 或 External。把 publish 设置为 Internal 以部署一个私有集群，它不能被互联网访问。默认值为 External。

sshKey

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

一个或多个密钥。例如：

sshKey:
  <key1>
  <key2>
  <key3>

compute.platform.aws.amiID

用于为集群引导计算机器的 AWS AMI。对于需要自定义 RHCOS AMI 的区域来说，这是必需的。

属于集合 AWS 区域的任何已发布或自定义 RHCOS AMI。

compute.platform.aws.iamRole

一个已存在的 AWS IAM 角色应用到计算机器池实例配置集。您可以使用这些字段与命名方案匹配，并为您的 IAM 角色包含预定义的权限界限。如果未定义，安装程序会创建一个新的 IAM 角色。

有效 AWS IAM 角色的名称。

compute.platform.aws.rootVolume.iops

为根卷保留的每秒输入/输出操作 (IOPS) 数。

整数，如 4000。

compute.platform.aws.rootVolume.size

以 GiB 为单位的根卷大小。

整数，如 500。

compute.platform.aws.rootVolume.type

根卷的类型。

有效的 AWS EBS 卷类型，如 io1。

compute.platform.aws.rootVolume.kmsKeyARN

KMS 密钥的 Amazon 资源名称（密钥 ARN）。这是使用特定 KMS 密钥加密 worker 节点的操作系统卷。

有效的 密钥 ID 或密钥 ARN。

compute.platform.aws.type

计算机器的 EC2 实例类型。

有效的 AWS 实例类型，如 m4.2xlarge。请参阅以下机器表的实例类型。

compute.platform.aws.zones

安装程序在其中为计算机机器池创建机器的可用区。如果您提供自己的 VPC，则必须在那个可用域中提供一个子网。

有效 AWS 可用区的列表，如 us-east-1c，以 YAML 序列表示。

compute.aws.region

安装程序在其中创建计算资源的 AWS 区域。

任何有效的 AWS 区域，如 us-east-1。

controlPlane.platform.aws.amiID

用于为集群引导 control plane 机器的 AWS AMI。对于需要自定义 RHCOS AMI 的区域来说，这是必需的。

属于集合 AWS 区域的任何已发布或自定义 RHCOS AMI。

controlPlane.platform.aws.iamRole

应用到 control plane 机器池实例配置集的已存在的 AWS IAM 角色。您可以使用这些字段与命名方案匹配，并为您的 IAM 角色包含预定义的权限界限。如果未定义，安装程序会创建一个新的 IAM 角色。

有效 AWS IAM 角色的名称。

controlPlane.platform.aws.rootVolume.kmsKeyARN

KMS 密钥的 Amazon 资源名称（密钥 ARN）。这需要使用特定的 KMS 密钥加密 control plane 节点的操作系统卷。

有效的 密钥 ID 和密钥 ARN。

controlPlane.platform.aws.type

control plane 机器的 EC2 实例类型。

有效的 AWS 实例类型，如 m5.xlarge。请参阅以下机器表的实例类型。

controlPlane.platform.aws.zones

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

有效 AWS 可用区的列表，如 us-east-1c，以 YAML 序列表示。

controlPlane.aws.region

安装程序在其中创建 control plane 资源的 AWS 区域。

有效的 AWS 区域，如 us-east-1。

platform.aws.amiID

用于为集群引导所有机器的 AWS AMI。如果设置，AMI 必须属于与集群相同的区域。对于需要自定义 RHCOS AMI 的区域来说，这是必需的。

属于集合 AWS 区域的任何已发布或自定义 RHCOS AMI。

platform.aws.hostedZone

集群的现有 Route 53 私有托管区。您只能在提供自己的 VPC 时使用已存在的托管区。安装前，托管区必须已经与用户提供的 VPC 关联。另外，托管区的域必须是集群域或集群域的父域。如果未定义，安装程序会创建一个新的托管区。

字符串，如 Z3URY6TWQ91KVV。

platform.aws.serviceEndpoints.name

AWS 服务端点名称。只有在必须使用替代 AWS 端点（如 FIPS）时，才需要自定义端点。可以为 EC2、S3、IAM、Elastic Load Balancing、Tagging、Route 53 和 STS AWS 服务指定自定义 API 端点。

有效的 AWS 服务端点名称。

platform.aws.serviceEndpoints.url

AWS 服务端点 URL。URL 必须使用 https 协议，主机必须信任该证书。

有效的 AWS 服务端点 URL。

platform.aws.userTags

键与值的映射，安装程序将其作为标签添加到它所创建的所有资源。

任何有效的 YAML 映射，如 <key>: <value> 格式的键值对。如需有关 AWS 标签的更多信息，请参阅 AWS 文档中的标记您的 Amazon EC2 资源。

platform.aws.subnets

如果您提供 VPC，而不是让安装程序为您创建 VPC，请指定要使用的集群子网。子网必须是您指定的同一 machineNetwork[].cidr 范围的一部分。对于标准集群，为每个可用区指定一个公共和私有子网。对于私有集群，为每个可用区指定一个私有子网。

有效的子网 ID。