字符串
在 Google Cloud Platform (GCP) 上部署 OpenShift Container Platform 集群之前,您需要提供参数来定制您的集群和托管它的平台。创建 `install-config.yaml` 文件时,您可以通过命令行提供必需参数的值。然后,您可以修改 `install-config.yaml` 文件以进一步自定义您的集群。
下表指定了您可以在安装过程中设置的必需、可选和 GCP 特定的安装配置参数。
安装后,您不能修改 `install-config.yaml` 文件中的这些参数。 |
下表描述了必需的安装配置参数。
参数 | 描述 | 值 |
---|---|---|
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}}` 的子域名。 |
由小写字母、连字符 ( |
platform: |
用于执行安装的特定平台的配置:`aws`、`baremetal`、`azure`、`gcp`、`ibmcloud`、`nutanix`、`openstack`、`powervs`、`vsphere` 或 `{}`。有关 `platform.<platform>` 参数的更多信息,请参阅以下您特定平台的表格。 |
对象 |
pullSecret: |
从 Red Hat OpenShift 集群管理器获取 pull secret,以验证从 Quay.io 等服务下载 OpenShift Container Platform 组件的容器镜像。 |
|
您可以根据现有网络基础设施的要求自定义安装配置。例如,您可以扩展集群网络的 IP 地址块或提供与默认值不同的 IP 地址块。
仅支持 IPv4 地址。
参数 | 描述 | 值 | ||
---|---|---|---|---|
networking: |
集群网络的配置。 |
对象
|
||
networking: networkType: |
要安装的 Red Hat OpenShift 网络网络插件。 |
`OVNKubernetes`。`OVNKubernetes` 是适用于 Linux 网络和包含 Linux 和 Windows 服务器的混合网络的 CNI 插件。默认值为 `OVNKubernetes`。 |
||
networking: clusterNetwork: |
Pod 的 IP 地址块。 默认值为 `10.128.0.0/14`,主机前缀为 `/23`。 如果指定多个 IP 地址块,则这些块不能重叠。 |
对象的数组。例如
|
||
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`。 OVN-Kubernetes 网络插件仅支持服务网络的单个 IP 地址块。 |
包含一个 CIDR 格式 IP 地址块的数组。例如
|
||
networking: machineNetwork: |
机器的 IP 地址块。 如果指定多个 IP 地址块,则这些块不能重叠。 |
对象的数组。例如
|
||
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 证书捆绑包。当配置了代理时,也可以使用此信任捆绑包。 |
字符串 |
||||
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`。 |
字符串 |
||||
compute: hyperthreading: |
是否在计算机器上启用或禁用同时多线程处理或超线程。默认情况下,启用同时多线程处理以提高机器内核的性能。
|
`Enabled` 或 `Disabled` |
||||
compute: name: |
如果您使用 `compute`,则需要此参数。机器池的名称。 |
|
||||
compute: platform: |
如果您使用 `compute`,则需要此参数。使用此参数指定托管工作机器的云提供商。此参数值必须与 `controlPlane.platform` 参数值匹配。 |
`aws`、`azure`、`gcp`、`ibmcloud`、`nutanix`、`openstack`、`powervs`、`vsphere` 或 `{}` |
||||
compute: replicas: |
要供应的计算机器(也称为工作机器)的数量。 |
大于或等于 `2` 的正整数。默认值为 `3`。 |
||||
featureSet: |
为功能集启用集群。功能集是默认情况下未启用的 OpenShift Container Platform 功能的集合。有关在安装期间启用功能集的更多信息,请参阅“使用功能门启用功能”。 |
字符串。要启用的功能集的名称,例如 `TechPreviewNoUpgrade`。 |
||||
controlPlane: |
构成控制平面的机器的配置。 |
`MachinePool` 对象的数组。 |
||||
controlPlane: architecture: |
确定池中机器的指令集体系结构。目前,不支持具有不同体系结构的集群。所有池都必须指定相同的体系结构。有效值为 `amd64` 和 `arm64`。 |
字符串 |
||||
controlPlane: hyperthreading: |
是否在控制平面机器上启用或禁用同时多线程处理或超线程。默认情况下,启用同时多线程处理以提高机器内核的性能。
|
`Enabled` 或 `Disabled` |
||||
controlPlane: name: |
如果您使用 |
|
||||
controlPlane: platform: |
如果您使用 |
`aws`、`azure`、`gcp`、`ibmcloud`、`nutanix`、`openstack`、`powervs`、`vsphere` 或 `{}` |
||||
controlPlane: replicas: |
要预配的控制平面机器数量。 |
支持的值为 |
||||
credentialsMode: |
云凭据操作员 (CCO) 模式。如果未指定模式,CCO 将动态尝试确定所提供凭据的功能,在支持多种模式的平台上优先使用 mint 模式。
|
|
||||
fips: |
启用或禁用 FIPS 模式。默认为
|
|
||||
imageContentSources: |
发行版映像内容的来源和存储库。 |
对象数组。包含 |
||||
imageContentSources: source: |
如果您使用 |
字符串 |
||||
imageContentSources: mirrors: |
指定可能还包含相同映像的一个或多个存储库。 |
字符串数组 |
||||
publish: |
如何发布或公开集群的用户端点,例如 Kubernetes API、OpenShift 路由。 |
|
||||
sshKey: |
用于验证对集群机器访问权限的 SSH 密钥。
|
例如, |
+
如果您在 GCP 上安装到共享虚拟专用云 (VPC),则必须将 |
+
将此参数设置为 |
下表中描述了其他 GCP 配置参数
参数 | 描述 | 值 | ||
---|---|---|---|---|
controlPlane: platform: gcp: osImage: project: |
可选。默认情况下,安装程序会下载并安装用于引导控制平面机器的 Red Hat Enterprise Linux CoreOS (RHCOS) 映像。您可以通过指定安装程序要仅用于控制平面机器的自定义 RHCOS 映像的位置来覆盖默认行为。 |
字符串。映像所在 GCP 项目的名称。 |
||
controlPlane: platform: gcp: osImage: name: |
安装程序要用于引导控制平面机器的自定义 RHCOS 映像的名称。如果您使用 |
字符串。RHCOS 映像的名称。 |
||
compute: platform: gcp: osImage: project: |
可选。默认情况下,安装程序会下载并安装用于引导计算机器的 RHCOS 映像。您可以通过指定安装程序要仅用于计算机器的自定义 RHCOS 映像的位置来覆盖默认行为。 |
字符串。映像所在 GCP 项目的名称。 |
||
compute: platform: gcp: osImage: name: |
安装程序要用于引导计算机器的自定义 RHCOS 映像的名称。如果您使用 |
字符串。RHCOS 映像的名称。 |
||
compute: platform: gcp: serviceAccount: |
指定在安装过程中要使用的 GCP 服务帐户的电子邮件地址。此服务帐户将用于预配计算机器。 |
字符串。服务帐户的电子邮件地址。 |
||
platform: gcp: network: |
要部署集群的现有虚拟专用云 (VPC) 的名称。如果您要将集群部署到共享 VPC,则必须使用包含共享 VPC 的 GCP 项目的名称设置 |
字符串。 |
||
platform: gcp: networkProjectID: |
可选。包含要部署集群的共享 VPC 的 GCP 项目的名称。 |
字符串。 |
||
platform: gcp: projectID: |
安装程序安装集群的 GCP 项目的名称。 |
字符串。 |
||
platform: gcp: region: |
托管集群的 GCP 区域的名称。 |
任何有效的区域名称,例如 |
||
platform: gcp: controlPlaneSubnet: |
要部署控制平面机器的现有子网的名称。 |
子网名称。 |
||
platform: gcp: computeSubnet: |
要部署计算机器的现有子网的名称。 |
子网名称。 |
||
platform: gcp: defaultMachinePlatform: zones: |
安装程序创建机器的可用区。 |
|||
platform: gcp: defaultMachinePlatform: osDisk: diskSizeGB: |
磁盘大小(以 GB 为单位)。 |
16 GB 到 65536 GB 之间的任何大小。 |
||
platform: gcp: defaultMachinePlatform: osDisk: diskType: |
所有机器的默认磁盘类型。有效值为 |
|||
platform: gcp: defaultMachinePlatform: osImage: project: |
可选。默认情况下,安装程序会下载并安装用于引导控制平面和计算机器的 RHCOS 映像。您可以通过指定安装程序要同时用于这两种类型机器的自定义 RHCOS 映像的位置来覆盖默认行为。 |
字符串。映像所在 GCP 项目的名称。 |
||
platform: gcp: defaultMachinePlatform: osImage: name: |
安装程序要用于引导控制平面和计算机器的自定义 RHCOS 映像的名称。如果您使用 |
字符串。RHCOS 映像的名称。 |
||
platform: gcp: defaultMachinePlatform: tags: |
可选。要添加到控制平面和计算机器的其他网络标签。 |
一个或多个字符串,例如 |
||
platform: gcp: defaultMachinePlatform: type: |
控制平面和计算机器的GCP 机器类型。 |
例如 |
||
platform: gcp: defaultMachinePlatform: osDisk: encryptionKey: kmsKey: name: |
用于机器磁盘加密的客户管理加密密钥的名称。 |
加密密钥名称。 |
||
platform: gcp: defaultMachinePlatform: osDisk: encryptionKey: kmsKey: keyRing: |
KMS 密钥所属的密钥管理服务 (KMS) 密钥环的名称。 |
KMS 密钥环名称。 |
||
platform: gcp: defaultMachinePlatform: osDisk: encryptionKey: kmsKey: location: |
存在 KMS 密钥环的GCP 位置。 |
GCP 位置。 |
||
platform: gcp: defaultMachinePlatform: osDisk: encryptionKey: kmsKey: projectID: |
存在 KMS 密钥环的项目的 ID。如果未设置此值,则默认为 |
GCP 项目 ID。 |
||
platform: gcp: defaultMachinePlatform: osDisk: encryptionKey: kmsKeyServiceAccount: |
用于控制平面和计算机器加密请求的 GCP 服务帐号。如果不存在,则使用 Compute Engine 默认服务帐号。有关 GCP 服务帐号的更多信息,请参阅 Google 关于服务帐号的文档。 |
GCP 服务帐号邮箱,例如 |
||
platform: gcp: defaultMachinePlatform: secureBoot: |
是否为集群中的所有机器启用 Shielded VM 安全启动。Shielded VM 具有其他安全协议,例如安全启动、固件和完整性监控以及反 rootkit 保护。有关 Shielded VM 的更多信息,请参阅 Google 关于Shielded VM的文档。 |
|
||
platform: gcp: defaultMachinePlatform: confidentialCompute: |
是否为集群中的所有机器使用 Confidential VM。Confidential VM 可在处理过程中为数据提供加密。有关机密计算的更多信息,请参阅 Google 关于机密计算的文档。 |
|
||
platform: gcp: defaultMachinePlatform: onHostMaintenance: |
指定所有虚拟机在主机维护事件(例如软件或硬件更新)期间的行为。对于 Confidential VM,此参数必须设置为 |
|
||
controlPlane: platform: gcp: osDisk: encryptionKey: kmsKey: name: |
用于控制平面机器磁盘加密的客户管理加密密钥的名称。 |
加密密钥名称。 |
||
controlPlane: platform: gcp: osDisk: encryptionKey: kmsKey: keyRing: |
对于控制平面机器,KMS 密钥所属的 KMS 密钥环的名称。 |
KMS 密钥环名称。 |
||
controlPlane: platform: gcp: osDisk: encryptionKey: kmsKey: location: |
对于控制平面机器,密钥环所在的 GCP 位置。有关 KMS 位置的更多信息,请参阅 Google 关于Cloud KMS 位置的文档。 |
密钥环的 GCP 位置。 |
||
controlPlane: platform: gcp: osDisk: encryptionKey: kmsKey: projectID: |
对于控制平面机器,存在 KMS 密钥环的项目的 ID。如果未设置此值,则默认为虚拟机项目 ID。 |
GCP 项目 ID。 |
||
controlPlane: platform: gcp: osDisk: encryptionKey: kmsKeyServiceAccount: |
用于控制平面机器加密请求的 GCP 服务帐号。如果不存在,则使用 Compute Engine 默认服务帐号。有关 GCP 服务帐号的更多信息,请参阅 Google 关于服务帐号的文档。 |
GCP 服务帐号邮箱,例如 |
||
controlPlane: platform: gcp: osDisk: diskSizeGB: |
磁盘大小(以 GB 为单位)。此值适用于控制平面机器。 |
16 到 65536 之间的任何整数。 |
||
controlPlane: platform: gcp: osDisk: diskType: |
控制平面机器的GCP 磁盘类型。 |
有效值为 |
||
controlPlane: platform: gcp: tags: |
可选。要添加到控制平面机器的其他网络标签。如果设置此参数,则会覆盖控制平面机器的 |
一个或多个字符串,例如 |
||
controlPlane: platform: gcp: type: |
控制平面机器的GCP 机器类型。如果设置此参数,则会覆盖 |
例如 |
||
controlPlane: platform: gcp: zones: |
安装程序创建控制平面机器的可用区。 |
|||
controlPlane: platform: gcp: secureBoot: |
是否为控制平面机器启用 Shielded VM 安全启动。Shielded VM 具有其他安全协议,例如安全启动、固件和完整性监控以及反 rootkit 保护。有关 Shielded VM 的更多信息,请参阅 Google 关于Shielded VM的文档。 |
|
||
controlPlane: platform: gcp: confidentialCompute: |
是否为控制平面机器启用 Confidential VM。Confidential VM 可在数据处理过程中为数据提供加密。有关 Confidential VM 的更多信息,请参阅 Google 关于Confidential Computing的文档。 |
|
||
controlPlane: platform: gcp: onHostMaintenance: |
指定控制平面虚拟机在主机维护事件(例如软件或硬件更新)期间的行为。对于 Confidential VM,此参数必须设置为 |
|
||
controlPlane: platform: gcp: serviceAccount: |
指定在安装期间要使用的 GCP 服务帐号的电子邮件地址。此服务帐号将用于配置控制平面机器。
|
字符串。服务帐户的电子邮件地址。 |
||
compute: platform: gcp: osDisk: encryptionKey: kmsKey: name: |
用于计算机器磁盘加密的客户管理加密密钥的名称。 |
加密密钥名称。 |
||
compute: platform: gcp: osDisk: encryptionKey: kmsKey: keyRing: |
对于计算机器,KMS 密钥所属的 KMS 密钥环的名称。 |
KMS 密钥环名称。 |
||
compute: platform: gcp: osDisk: encryptionKey: kmsKey: location: |
对于计算机器,密钥环所在的 GCP 位置。有关 KMS 位置的更多信息,请参阅 Google 关于Cloud KMS 位置的文档。 |
密钥环的 GCP 位置。 |
||
compute: platform: gcp: osDisk: encryptionKey: kmsKey: projectID: |
对于计算机器,存在 KMS 密钥环的项目的 ID。如果未设置此值,则默认为虚拟机项目 ID。 |
GCP 项目 ID。 |
||
compute: platform: gcp: osDisk: encryptionKey: kmsKeyServiceAccount: |
用于计算机器加密请求的 GCP 服务帐号。如果未设置此值,则使用 Compute Engine 默认服务帐号。有关 GCP 服务帐号的更多信息,请参阅 Google 关于服务帐号的文档。 |
GCP 服务帐号邮箱,例如 |
||
compute: platform: gcp: osDisk: diskSizeGB: |
磁盘大小(以 GB 为单位)。此值适用于计算机器。 |
16 到 65536 之间的任何整数。 |
||
compute: platform: gcp: osDisk: diskType: |
计算机器的GCP 磁盘类型。 |
有效值为 |
||
compute: platform: gcp: tags: |
可选。要添加到计算机器的其他网络标签。如果设置此参数,则会覆盖计算机器的 |
一个或多个字符串,例如 |
||
compute: platform: gcp: type: |
计算机器的GCP 机器类型。如果设置此参数,则会覆盖 |
例如 |
||
compute: platform: gcp: zones: |
安装程序创建计算机器的可用区。 |
|||
compute: platform: gcp: secureBoot: |
是否为计算机器启用 Shielded VM 安全启动。Shielded VM 具有其他安全协议,例如安全启动、固件和完整性监控以及反 rootkit 保护。有关 Shielded VM 的更多信息,请参阅 Google 关于Shielded VM的文档。 |
|
||
compute: platform: gcp: confidentialCompute: |
是否为计算机器启用机密虚拟机 (Confidential VMs)。机密虚拟机在数据处理过程中提供加密保护。有关机密虚拟机的更多信息,请参阅 Google 的文档:保密计算。 |
|
||
compute: platform: gcp: onHostMaintenance: |
指定计算虚拟机在主机维护事件(例如软件或硬件更新)期间的行为。对于机密虚拟机,此参数必须设置为 |
|