创建参考

本页介绍使用 ac adm alpha cluster create 创建业务集群时,所有 provider 共用的内容。每个 provider 的创建页面都链接到此处。

通用 install-config.yaml 字段

该文件包含四个部分:

  • cluster:名称、网络、密钥和加密。
  • provider.<name>:某个 provider 的基础设施。
  • controlPlane 和 computes:节点组。
  • credentialRef:基础设施凭证。

以下结构仅展示所有 provider 都会使用的字段,并非完整文件。要编写文件,请从对应 provider 的模板开始。模板会添加该 provider 的字段,例如控制平面端点、节点网络和磁盘,并对这些字段进行说明。

ac 会在未知或拼写错误的字段造成任何更改之前拒绝该字段,并在错误中指出字段路径。

与 global 集群的文件不同,此文件没有 global 部分,也没有 deployMode。ac 会拒绝这两者。

install-config.yaml (common structure)
cluster:
  clusterName: <cluster-name>
  sshKeys:
    - <ssh-public-key>
  # registrySecretRef:
  #   name: <registry-secret-name>
  #   namespace: cpaas-system
  # encryptionProviderConfig: <encryption-key>
  ntpServers: [] 
  network:
    podCIDR: 10.199.0.0/16
    serviceCIDR: 10.96.0.0/12
    kubeOVN:
      joinCIDR: 100.64.0.0/16

provider:
  <provider-name>: {} 

controlPlane:
  replicas: 3
  <provider-name>: {} 

computes:
  - name: worker
    replicas: 3
    <provider-name>: {}

credentialRef:
  name: <credential-secret-name>
  namespace: cpaas-system
#字段说明
cluster必填 · object不依赖 provider 的集群级设置。
1cluster.clusterName必填 · string长度不超过 63 个字符的 DNS-1123 子域名。不能为 global,且不能以 global- 开头。Cluster 对象和 provider 的集群对象会使用此名称。所有其他渲染后的对象名称前缀均为 <cluster-name>-。
2cluster.sshKeys必填 · []string每个节点上 boot 用户的 SSH 公钥。使用这些密钥登录节点。
3cluster.registrySecretRef可选 · object · 默认值:global 集群的 registry选择一个不同于 global 集群所用 registry 的 registry。此功能需要 platform v4.4.0 或更高版本。name:最多 63 个字符。namespace:cpaas-system,这是默认值,也是唯一接受的值。Secret 必须带有标签 capi.cpaas.io/provider=registry-credential。它必须包含 registry 键,该键的值为不带方案或 /v2/ 的地址。可选的 username 和 password 键必须同时设置。请参阅为业务集群选择镜像 registry。
4cluster.encryptionProviderConfig可选 · string · 默认值:自动生成16、24 或 32 字节 aescbc 密钥的 base64 编码,而不是配置文件。该密钥用于加密集群 API server 中静态存储的 Secrets。生成的密钥仅保存在 <install-dir>/manifests/ 中。请保留该目录,因为如果没有它再次进行渲染,会生成新的密钥。
5cluster.ntpServers可选 · []string · 默认值:[]节点的 NTP 服务器。这些服务器会写入 chronyd 配置,并优先于镜像中的源。列表为空时,使用镜像的时间配置。
cluster.network有条件必填 · object集群网络。VMware vSphere、Huawei DCS 和 Bare Metal 必须配置此项,因为这些环境需要 loadBalancer。在 Huawei Cloud Stack 上,不允许使用 loadBalancer,且三个 CIDR 均有默认值,因此可以省略此部分。除各行中的规则外,三个 CIDR 均不得与主机网络或同一 global 集群上其他集群的 CIDR 重叠。
6cluster.network.podCIDR可选 · string · 默认值:10.199.0.0/16Pod CIDR。不得与 Service CIDR 或 join CIDR 重叠。
7cluster.network.serviceCIDR可选 · string · 默认值:10.96.0.0/12Service CIDR。不得与 Pod CIDR 或 join CIDR 重叠。
8cluster.network.kubeOVN.joinCIDR可选 · string · 默认值:100.64.0.0/16Kube-OVN join CIDR。不得与 Pod CIDR 或 Service CIDR 重叠。
provider有条件必填 · objectprovider 设置,位于以 provider 名称命名的键下。VMware vSphere、Huawei DCS 和 Huawei Cloud Stack 必须配置此项。Bare Metal 不应配置此项,因为它会拒绝该字段。
9provider.<provider-name>有条件必填 · objectprovider 的基础设施:vsphere、dcs 或 hcs。请参阅对应 provider 的创建页面。Bare Metal 会拒绝此字段,因为 Bare Metal 业务集群没有 provider 部分。
controlPlane必填 · object控制平面节点组。
10controlPlane.replicas必填 · integer对于堆叠式 etcd,设置为 1,或设置为不小于 3 的奇数。单节点配置仅用于测试,且无法升级。
11controlPlane.<provider-name>有条件必填 · objectprovider 的节点组字段。computes[] 中也会出现相同字段。是否必填取决于 provider;请参阅其模板。
computes[]可选 · []object · 默认值:[]工作节点组,每个组对应一个条目。
12computes[].name必填 · string在各组中唯一的 DNS-1123 标签。control-plane 为保留值。
13computes[].replicas可选 · integer · 默认值:0组中的节点数。不得为负数。
14credentialRef有条件必填 · object包含基础设施凭证的 Secret。必须在运行 create 之前创建此 Secret。ac 不会渲染或删除此 Secret。在 VMware vSphere 上,provider 会在删除集群时一并删除该 Secret;请参阅删除集群。name:Secret 名称。namespace:cpaas-system,这是默认值,也是唯一接受的值。Huawei DCS、Huawei Cloud Stack 和 VMware vSphere 必须配置此项;这些 provider 的先决条件中列出了 Secret 的键。Bare Metal 会拒绝此字段。

computes 为可选项。不配置时,集群仅在其控制平面节点上运行。