字符串
在使用基于代理的安装程序部署 OpenShift Container Platform 集群之前,您需要提供参数来自定义集群及其所在的平台。创建install-config.yaml
和agent-config.yaml
文件时,必须为必需的参数提供值,并且可以使用可选参数进一步自定义集群。
下表指定了您可以在基于代理的安装过程中设置的必需和可选安装配置参数。
这些值在install-config.yaml
文件中指定。
这些设置仅用于安装,安装后无法修改。 |
下表描述了必需的安装配置参数
参数 | 描述 | 值 |
---|---|---|
apiVersion: |
|
字符串 |
baseDomain: |
云提供商的基本域名。基本域名用于创建到 OpenShift Container Platform 集群组件的路由。集群的完整 DNS 名称是 |
完全限定的域名或子域名,例如 |
metadata: |
Kubernetes 资源 `ObjectMeta`,仅使用其中的 `name` 参数。 |
对象 |
metadata: name: |
集群名称。集群的 DNS 记录都是 `{{.metadata.name}}.{{.baseDomain}}` 的子域名。如果您没有通过 `install-config.yaml` 或 `agent-config.yaml` 文件提供 `metadata.name`,例如仅使用 ZTP 清单时,集群名称将设置为 `agent-cluster`。 |
由小写字母、连字符 ( |
platform: |
用于执行安装的特定平台的配置:`baremetal`、`external`、`none` 或 `vsphere`。 |
对象 |
pullSecret: |
获取 Red Hat OpenShift 集群管理器中的 pull 密钥,以验证从 Quay.io 等服务下载 OpenShift Container Platform 组件的容器镜像。 |
|
您可以根据现有网络基础设施的要求自定义安装配置。例如,您可以扩展集群网络的 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 集群。
如果您将集群配置为使用两个 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
参数 | 描述 | 值 | ||
---|---|---|---|---|
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: |
如果您使用 `networking.clusterNetwork`,则需要此参数。一个 IP 地址块。 如果您使用 OVN-Kubernetes 网络插件,则可以指定 IPv4 和 IPv6 网络。 |
采用无类别域间路由 (CIDR) 表示法的 IP 地址块。IPv4 块的前缀长度介于 `0` 和 `32` 之间。IPv6 块的前缀长度介于 `0` 和 `128` 之间。例如,`10.128.0.0/14` 或 `fd01::/48`。 |
||
networking: clusterNetwork: hostPrefix: |
要分配给每个节点的子网前缀长度。例如,如果 `hostPrefix` 设置为 `23`,则每个节点都将从给定的 `cidr` 中分配一个 `/23` 子网。`hostPrefix` 值为 `23` 提供 510 (2^(32 - 23) - 2) 个 Pod IP 地址。 |
子网前缀。 对于 IPv4 网络,默认值为 `23`。对于 IPv6 网络,默认值为 `64`。默认值也是 IPv6 的最小值。 |
||
networking: serviceNetwork: |
服务的 IP 地址块。默认值为 `172.30.0.0/16`。 OVN-Kubernetes 网络插件仅支持服务网络的单个 IP 地址块。 如果您使用 OVN-Kubernetes 网络插件,则可以为 IPv4 和 IPv6 地址族指定 IP 地址块。 |
包含 CIDR 格式 IP 地址块的数组。例如
|
||
networking: machineNetwork: |
机器的 IP 地址块。 如果您指定多个 IP 地址块,则这些块不能重叠。 |
对象的数组。例如
|
||
networking: machineNetwork: cidr: |
如果您使用 `networking.machineNetwork`,则需要此参数。一个 IP 地址块。对于 libvirt 和 IBM Power® 虚拟服务器以外的所有平台,默认值为 `10.0.0.0/16`。对于 libvirt,默认值为 `192.168.126.0/24`。对于 IBM Power® 虚拟服务器,默认值为 `192.168.0.0/24`。 |
采用 CIDR 表示法的 IP 网络块。 例如,`10.0.0.0/16` 或 `fd00::/48`。
|
下表描述了可选安装配置参数
参数 | 描述 | 值 | ||||
---|---|---|---|---|---|---|
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。有关更多信息,请参见《可扩展性和性能》部分中的《工作负载分区》页面。 |
`None` 或 `AllNodes`。`None` 是默认值。 |
||||
compute: |
构成计算节点的机器的配置。 |
`MachinePool` 对象的数组。 |
||||
compute: architecture: |
确定池中机器的指令集体系结构。目前,不支持具有不同体系结构的集群。所有池都必须指定相同的体系结构。有效值为 `amd64`、`arm64`、`ppc64le` 和 `s390x`。 |
字符串 |
||||
compute: hyperthreading: |
是否启用或禁用计算机器上的同时多线程处理,或
|
|
||||
compute: name: |
如果您使用 |
|
||||
compute: platform: |
如果您使用 |
|
||||
compute: replicas: |
要供应的计算机器(也称为工作机器)的数量。 |
大于或等于 |
||||
featureSet: |
为功能集启用集群。功能集是默认情况下未启用的OpenShift Container Platform功能的集合。有关在安装期间启用功能集的更多信息,请参见“使用功能网关启用功能”。 |
字符串。要启用的功能集的名称,例如 |
||||
controlPlane: |
构成控制平面的机器的配置。 |
`MachinePool` 对象的数组。 |
||||
controlPlane: architecture: |
确定池中机器的指令集体系结构。目前,不支持具有不同体系结构的集群。所有池都必须指定相同的体系结构。有效值为 `amd64`、`arm64`、`ppc64le` 和 `s390x`。 |
字符串 |
||||
controlPlane: hyperthreading: |
是否启用或禁用控制平面机器上的同时多线程处理,或
|
|
||||
controlPlane: name: |
如果您使用 |
|
||||
controlPlane: platform: |
如果您使用 |
|
||||
controlPlane: replicas: |
要供应的控制平面机器的数量。 |
支持的值为 |
||||
credentialsMode: |
云凭据操作员 (CCO) 模式。如果未指定模式,CCO 将动态尝试确定提供的凭据的功能,并在支持多种模式的平台上优先使用 mint 模式。
|
|
||||
fips: |
启用或禁用 FIPS 模式。默认为
|
|
||||
imageContentSources: |
发行版映像内容的来源和存储库。 |
对象的数组。包括一个 |
||||
imageContentSources: source: |
如果您使用 |
字符串 |
||||
imageContentSources: mirrors: |
指定可能还包含相同镜像的一个或多个存储库。 |
字符串数组 |
||||
publish: |
如何发布或公开集群面向用户的端点,例如 Kubernetes API、OpenShift 路由。 |
|||||
sshKey: |
用于验证对集群机器访问权限的 SSH 密钥。
|
例如, |
下表描述了基于代理的安装程序的其他裸机安装配置参数
这些字段在集群初始配置期间未使用,但一旦集群安装完成即可使用。在安装时配置这些字段无需将其设置为第 2 天操作。 |
参数 | 描述 | 值 |
---|---|---|
platform: baremetal: clusterProvisioningIP: |
集群内运行配置服务的 IP 地址。默认为配置子网的第三个 IP 地址。例如, |
IPv4 或 IPv6 地址。 |
platform: baremetal: provisioningNetwork: |
|
|
platform: baremetal: provisioningMACAddress: |
集群内运行配置服务的 MAC 地址。 |
MAC 地址。 |
platform: baremetal: provisioningNetworkCIDR: |
用于配置的网络的 CIDR。当不使用配置网络上的默认地址范围时,此选项是必需的。 |
有效的 CIDR,例如 |
platform: baremetal: provisioningNetworkInterface: |
连接到配置网络的节点上的网络接口的名称。使用 |
字符串。 |
platform: baremetal: provisioningDHCPRange: |
定义配置网络上节点的 IP 范围,例如 |
IP 地址范围。 |
platform: baremetal: hosts: |
裸机主机的配置。 |
主机配置对象的数组。 |
platform: baremetal: hosts: name: |
主机的名称。 |
字符串。 |
platform: baremetal: hosts: bootMACAddress: |
用于配置主机的 NIC 的 MAC 地址。 |
MAC 地址。 |
platform: baremetal: hosts: bmc: |
用于连接到基板管理控制器 (BMC) 的主机的配置。 |
BMC 配置对象的字典。 |
platform: baremetal: hosts: bmc: username: |
BMC 的用户名。 |
字符串。 |
platform: baremetal: hosts: bmc: password: |
BMC 的密码。 |
字符串。 |
platform: baremetal: hosts: bmc: address: |
用于与主机 BMC 控制器通信的 URL。地址配置设置指定协议。例如, |
URL。 |
platform: baremetal: hosts: bmc: disableCertificateVerification: |
|
布尔值。 |
下表描述了其他 VMware vSphere 配置参数
参数 | 描述 | 值 | ||
---|---|---|---|---|
platform: vsphere: |
描述托管您的集群的云平台上的您的帐户。您可以使用此参数来自定义平台。如果您在机器池中为计算和控制平面机器提供了其他配置设置,则不需要此参数。 |
vSphere 配置对象的字典 |
||
platform: vsphere: failureDomains: |
建立区域和区域之间的关系。您可以使用 vCenter 对象(例如 |
故障域配置对象的数组。 |
||
platform: vsphere: failureDomains: name: |
故障域的名称。 |
字符串 |
||
platform: vsphere: failureDomains: region: |
如果您为集群定义多个故障域,则必须将标签附加到每个 vCenter 数据中心。要定义区域,请使用 |
字符串 |
||
platform: vsphere: failureDomains: server: |
指定 VMware vCenter 服务器的完全限定主机名或 IP 地址,以便客户端可以访问故障域资源。您必须将 |
字符串 |
||
platform: vsphere: failureDomains: zone: |
如果您为集群定义多个故障域,则必须将标签附加到每个 vCenter 集群。要定义区域,请使用 |
字符串 |
||
platform: vsphere: failureDomains: topology: computeCluster: |
vSphere 计算集群的路径。 |
字符串 |
||
platform: vsphere: failureDomains: topology: datacenter: |
列出并定义 OpenShift Container Platform 虚拟机 (VM) 运行的数据中心。数据中心列表必须与 |
字符串 |
||
platform: vsphere: failureDomains: topology: datastore: |
保存虚拟机文件、模板和 ISO 映像的 vSphere 数据存储的路径。
|
字符串 |
||
platform: vsphere: failureDomains: topology: folder: |
可选:用户创建虚拟机的现有文件夹的绝对路径,例如 |
字符串 |
||
platform: vsphere: failureDomains: topology: networks: |
列出 vCenter 实例中包含您已配置的虚拟 IP 地址和 DNS 记录的任何网络。 |
字符串 |
||
platform: vsphere: failureDomains: topology: resourcePool: |
可选:安装程序创建虚拟机的现有资源池的绝对路径,例如 |
字符串 |
||
platform: vsphere: failureDomains: topology template: |
指定预先存在的 Red Hat Enterprise Linux CoreOS (RHCOS) 映像模板或虚拟机的绝对路径。安装程序可以使用映像模板或虚拟机在 vSphere 主机上快速安装 RHCOS。考虑使用此参数作为在 vSphere 主机上上传 RHCOS 映像的替代方法。此参数仅可用于安装程序配置的基础架构。 |
字符串 |
||
platform: vsphere: vcenters: |
配置连接详细信息,以便服务可以与 vCenter 服务器通信。 |
vCenter 配置对象的数组。 |
||
platform: vsphere: vcenters: datacenters: |
列出并定义 OpenShift Container Platform 虚拟机 (VM) 运行的数据中心。数据中心列表必须与 |
字符串 |
||
platform: vsphere: vcenters: password: |
与 vSphere 用户关联的密码。 |
字符串 |
||
platform: vsphere: vcenters: port: |
用于与 vCenter 服务器通信的端口号。 |
整数 |
||
platform: vsphere: vcenters: server: |
vCenter 服务器的完全限定主机名 (FQHN) 或 IP 地址。 |
字符串 |
||
platform: vsphere: vcenters: user: |
与 vSphere 用户关联的用户名。 |
字符串 |
在 OpenShift Container Platform 4.13 中,以下 vSphere 配置参数已弃用。您可以继续使用这些参数,但安装程序不会自动在install-config.yaml
文件中指定这些参数。
下表列出了每个已弃用的 vSphere 配置参数
参数 | 描述 | 值 |
---|---|---|
platform: vsphere: cluster: |
安装 OpenShift Container Platform 集群的 vCenter 集群。 |
字符串 |
platform: vsphere: datacenter: |
定义 OpenShift Container Platform 虚拟机 (VM) 运行的数据中心。 |
字符串 |
platform: vsphere: defaultDatastore: |
用于配置卷的默认数据存储的名称。 |
字符串 |
platform: vsphere: folder: |
可选:安装程序创建虚拟机的现有文件夹的绝对路径。如果您不提供此值,安装程序将在数据中心虚拟机文件夹中创建一个以基础架构 ID 命名的文件夹。 |
字符串,例如 |
platform: vsphere: password: |
vCenter 用户名的密码。 |
字符串 |
platform: vsphere: resourcePool: |
可选:安装程序创建虚拟机的现有资源池的绝对路径。如果您未指定值,安装程序将在集群根目录下的 |
字符串,例如 |
platform: vsphere: username: |
用于连接到 vCenter 实例的用户名。此用户必须至少具有在 vSphere 中进行静态或动态持久卷配置所需的权限和特权。 |
字符串 |
platform: vsphere: vCenter: |
vCenter 服务器的完全限定主机名或 IP 地址。 |
字符串 |
下表指定您可以作为基于 Agent 的安装过程的一部分设置的必需和可选 Agent 配置参数。
这些值在agent-config.yaml
文件中指定。
这些设置仅用于安装,安装后无法修改。 |
下表描述了必需的 Agent 配置参数
参数 | 描述 | 值 |
---|---|---|
apiVersion: |
|
字符串 |
metadata: |
Kubernetes 资源 `ObjectMeta`,仅使用其中的 `name` 参数。 |
对象 |
metadata: name: |
集群的名称。集群的 DNS 记录都是 |
小写字母和连字符 ( |
下表描述了可选的 Agent 配置参数
参数 | 描述 | 值 |
---|---|---|
rendezvousIP: |
执行引导过程以及运行 |
IPv4 或 IPv6 地址。 |
bootArtifactsBaseURL: |
使用基于 Agent 的安装程序生成 iPXE 脚本时,用于将预引导执行环境 (PXE) 资源上传到的服务器的 URL。有关更多信息,请参见“为 OpenShift Container Platform 准备 PXE 资源”。 |
字符串。 |
additionalNTPSources: |
要添加到所有集群主机的网络时间协议 (NTP) 源列表,这些源将添加到通过其他方式配置的任何 NTP 源。 |
主机名或IP地址列表。 |
hosts: |
主机配置。一个可选的主机列表。定义的主机数量不得超过 |
一个主机配置对象数组。 |
hosts: hostname: |
主机名。覆盖从动态主机配置协议 (DHCP) 或反向 DNS 查找获得的主机名。每个主机必须通过这些方法之一提供唯一的主机名,尽管通过此参数配置主机名是可选的。 |
字符串。 |
hosts: interfaces: |
提供主机接口的名称和MAC地址映射表。如果 |
一个主机配置对象数组。 |
hosts: interfaces: name: |
主机上接口的名称。 |
字符串。 |
hosts: interfaces: macAddress: |
主机上接口的MAC地址。 |
MAC地址,例如: |
hosts: role: |
定义主机是 |
|
hosts: rootDeviceHints: |
启用将Red Hat Enterprise Linux CoreOS (RHCOS)镜像置备到特定设备。安装程序按发现设备的顺序检查设备,并将发现的值与提示值进行比较。它使用第一个与提示值匹配的已发现设备。这是在安装期间写入操作系统的设备。 |
键值对字典。有关更多信息,请参阅“OpenShift 安装环境设置”页面中的“根设备提示”部分。 |
hosts: rootDeviceHints: deviceName: |
为RHCOS镜像置备设备的名称。 |
字符串。 |
hosts: networkConfig: |
主机网络定义。此配置必须与nmstate 文档中定义的主机网络管理API匹配。 |
主机网络配置对象的字典。 |