安装参考

本页面介绍每个 provider 共有的内容:安装目录、通用 install-config.yaml 字段,以及 manifests、create 和 destroy 命令。每个 provider 的安装和参数页面都会链接到此处。

安装目录

在本文档中,<install-dir> 是安装目录:bootstrap 节点上用于存放一个 global 安装的目录。您可以选择其路径,并使用 --dir <install-dir> 将其传递给 ac。

  • 在运行 ac 之前,创建该目录并在其中写入 install-config.yaml。ac 不会创建这两者。如果缺少其中任意一个,ac 将停止并报错。
  • 每个 global 安装使用单独的目录。在灾难恢复对中,两端各自在自己的 bootstrap 节点上拥有自己的目录。
  • 对该安装的每个 ac 命令使用同一个目录,包括再次运行 create 时。

您需要写入 install-config.yaml。ac 会将其他所有内容写入该目录。

<install-dir>/
  install-config.yaml       written by you; ac never changes it
  manifests/                the rendered cluster objects
  output/kubeconfig         kubeconfig of the global cluster; it is not renewed automatically
  logs/ac.log               log of every ac run in this directory
  logs/cpaas-installer.log  copy of the platform installer log
  • 保持文件私有(chmod 600 <install-dir>/install-config.yaml),因为其中包含密码。
  • 不要编辑 manifests/ 中的文件。
  • 安装完成后保留该目录。output/kubeconfig 和 logs/ 仅存在于该目录中。

通用 install-config.yaml 字段

该文件包含四个部分:

  • global:registry 和平台身份。
  • cluster:网络、密钥和加密。
  • provider.<name>:一个 provider 的基础设施。
  • 节点组 controlPlane 和 computes。

以下结构展示了每个 provider 使用的字段。这不是完整文件。请改为复制您的 provider 的模板。该模板会添加并描述该 provider 的字段,例如控制平面 endpoint、节点网络和节点磁盘。如果字段未知或拼写错误,ac 会在进行任何更改之前失败,并在错误中指出字段路径。

install-config.yaml (common structure)
global:
  registry:
    address: <host>:<port>
    username: <user>
    password: <password>
  platform:
    address: <platform-domain-or-ip>
    username: admin@cpaas.io
    password: <password>
    extraAddresses: [] 
    cert:
      certificateFile: <console-cert-file>
      privateKeyFile: <console-key-file>
      # pkcs12CertificateFile: <console-pkcs12-file>
      # pkcs12Password: <password>

cluster:
  sshKeys:
    - <ssh-public-key>
  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
  deployMode: normal
  <provider-name>: {} 

computes:
  - name: worker
    replicas: 3
    deployMode: normal
    <provider-name>: {}
#字段描述
global.registry必需 · object安装的 image registry。
1global.registry.address必需 · string存放所有安装制品的外部 registry 的地址,该 registry 已在准备 Core Package 和 Registry中准备。将其写为 <host>[:<port>],不包含 scheme 或 /v2/。<host> 是域名或 IPv4 地址。如果 registry 使用 IPv6,请使用域名。
2global.registry.username可选 · string · 默认值:无(匿名访问)将其与 password 一起设置,或者同时删除二者以进行匿名访问。不要只设置其中一个。
3global.registry.password可选 · string · 默认值:无(匿名访问)username 的密码。
global.platform必需 · object用户访问平台的方式:访问地址、管理员、额外地址和证书。
4global.platform.address必需 · string平台访问地址:域名或 IP 地址,不包含 scheme 或端口。灾难恢复需要域名。
5global.platform.username可选 · string · 默认值:admin@cpaas.io平台管理员用户名,转换为小写。
6global.platform.password必需 · string长度为 8 到 32 个字符,且包含字母、数字以及来自 !#$%&()*+=?@^_~- 的符号。如果值以 YAML 特殊字符开头,例如 !、* 或 &,请将其引起来。
7global.platform.extraAddresses可选 · []string · 默认值:[]控制台的其他地址,不包含端口。ac 不会添加控制平面 VIP。要通过 VIP 打开控制台,请在此处列出该 VIP。对于灾难恢复,两端都必须设置此字段,并且每端列出自己的控制平面 VIP。
8global.platform.cert可选 · object · 默认值:自签名证书用户提供的平台访问地址证书;请参阅通用先决条件。设置 certificateFile 和 privateKeyFile(PEM),或设置 pkcs12CertificateFile 和 pkcs12Password(包含一个证书及其密钥的 bundle)。将文件放在 bootstrap 节点上,并通过绝对路径引用。包含 CA 链的 bundle 将被拒绝。证书涵盖 address(域名或 IP 地址)以及 extraAddresses 中的域名。证书使用 RSA 或 ECDSA 密钥。要使用自签名证书,请删除此字段。灾难恢复不允许使用自签名证书,并且两端需要使用相同的证书。
cluster必需 · object不依赖 provider 的集群级设置。
9cluster.sshKeys必需 · []string每个节点上 boot 用户的 SSH 公钥,用于登录节点。
10cluster.encryptionProviderConfig可选 · string · 默认值:生成用于加密静态 Secrets 的 16、24 或 32 字节 aescbc 密钥的 base64 编码。它不是配置文件。删除此字段即可生成密钥。对于灾难恢复,请生成一次,并在两端设置相同的值。
11cluster.ntpServers可选 · []string · 默认值:[]节点使用的 NTP servers。它们会写入 chronyd 配置,并优先于 image 的时间源。列表为空时,使用 image 的时间配置。
cluster.network有条件 · object集群网络。VMware vSphere、Huawei DCS 和 Bare Metal 必须设置,因为它们需要 loadBalancer。在 Huawei Cloud Stack 上不允许使用 loadBalancer,且三个 CIDR 有默认值,因此可以省略此部分。
12cluster.network.podCIDR可选 · string · 默认值:10.199.0.0/16Pod CIDR。不得与 Service CIDR 或 join CIDR 重叠。
13cluster.network.serviceCIDR可选 · string · 默认值:10.96.0.0/12Service CIDR。不得与 Pod CIDR 或 join CIDR 重叠。
14cluster.network.kubeOVN.joinCIDR可选 · string · 默认值:100.64.0.0/16Kube-OVN join CIDR。不得与 Pod CIDR 或 Service CIDR 重叠。
provider必需 · objectprovider 设置,位于以 provider 命名的键下。
15provider.<provider-name>必需 · objectprovider 的基础设施:vsphere、dcs、hcs 或 baremetal;请参阅 provider 的安装页面。
controlPlane必需 · object控制平面节点组。
16controlPlane.replicas必需 · integer1,或 3 个及以上的奇数个节点,因为 stacked etcd 有此要求。单节点仅用于测试,无法升级。
17controlPlane.deployMode可选 · string · 默认值:normalnormal 或 base。computes[] 中也存在此字段。base 会将该节点组专用于平台;请参阅平台节点组。
18controlPlane.<provider-name>有条件 · objectprovider 的节点组字段。computes[] 中也存在此字段。是否必需取决于 provider;请参阅该 provider 的模板。
computes[]可选 · []object · 默认值:[]工作节点组,每个组对应一个条目。
19computes[].name必需 · stringDNS-1123 标签,在各组之间必须唯一。control-plane 已被保留。
20computes[].replicas可选 · integer · 默认值:0组中的节点数量。不能为负数。

computes 是可选的。没有它时,平台仅运行在控制平面节点上。

平台节点组

deployMode: base 会为节点组添加标签和污点,使其仅运行平台。如果任何节点组使用 base,则整个​​平台会以 base 模式安装。此时,base 组总共必须至少有一个副本。

应用于 base 节点组
标签node-role.kubernetes.io/cpaas-system: "true"
工作节点组上的污点node-role.kubernetes.io/cpaas-system:NoSchedule
控制平面组上的污点node-role.kubernetes.io/control-plane:NoSchedule 和 node-role.kubernetes.io/cpaas-system:NoSchedule

渲染的清单

要渲染集群对象而不应用任何对象,请在 bootstrap 节点上运行以下命令:

<extract-dir>/res/<arch>/ac adm alpha global manifests \
  --dir <install-dir> --provider <baremetal|dcs|vsphere|hcs>

此步骤是可选的,因为 create 会以相同方式渲染对象。manifests 会运行不需要 bootstrap 集群的检查,并将对象写入 <install-dir>/manifests/。create 会运行其余检查。

当 manifests/ 已存在时,manifests 和 create 会询问是否重用它。按 Enter 键即可重用。更改 install-config.yaml 后,回答 n 以再次渲染清单。当标准输入不是终端时,请传递 --reuse-manifests=true 或 --reuse-manifests=false。

  • 重用会按磁盘上的原样应用文件,而不进行检查。更改后的基础设施凭证、加密密钥或 Bare Metal ServiceAccount 签名密钥不会生效。
  • 再次渲染会替换整个 manifests/ 目录。已应用的 Secret 不会发生更改。更改后的基础设施凭证或加密密钥仍不会生效。更改后的 Bare Metal ServiceAccount 签名密钥会使 create 因错误而停止。

create 命令

在 bootstrap 节点上运行 create:

<extract-dir>/res/<arch>/ac adm alpha global create \
  --dir <install-dir> --provider <baremetal|dcs|vsphere|hcs>
标志描述
--dir安装目录。请参阅安装目录。必需。
--providerbaremetal、dcs、vsphere 或 hcs。它必须与 install-config.yaml 中的 provider 部分匹配。必需。
--core-package已提取的 Core Package。仅当 ac 从其外部运行时需要。
--reuse-manifests是否重用现有的 manifests/ 目录或再次渲染。请参阅渲染的清单。
--timeout每个阶段的最大等待时间。每个阶段会单独计时。默认值为 2h。

create 不接受 --kubeconfig。

如果 create 因中断、错误或某个阶段超出 --timeout 而停止,请再次运行相同的命令。已完成的工作会被跳过。

  • 每个错误都会打印用于恢复安装的命令。将其中开头的 ac 替换为 <extract-dir>/res/<arch>/ac。
  • 镜像仓库检查失败时,错误还会打印一个带有 --reuse-manifests=false 的变体。更正 global.registry 后运行该变体。
  • bootstrap 集群启动后,请勿更改 global.registry;请参阅故障排除。

当 create 无错误返回时,安装即完成,并且 bootstrap 集群会被移除。关于需要保留的内容,请参阅安装目录。create 仅安装集群。要更改正在运行的集群,请参阅管理 Alauda OS 集群上的节点。

请勿删除 Cluster API 对象进行清理

在 global 集群上,请勿删除 Cluster API Cluster global、其 KubeadmControlPlane 或 provider 的基础设施对象。删除这些对象会销毁集群的机器。要移除集群,请使用 destroy。

destroy 命令

在能够通过 kubeconfig 访问 global 集群的计算机上运行 destroy,例如 <install-dir>/output/kubeconfig。在 bootstrap 节点上,以 <extract-dir>/res/<arch>/ac 身份运行 ac。

ac adm alpha global destroy --kubeconfig <install-dir>/output/kubeconfig          # lists what will be deleted, then asks you to type the cluster name
ac adm alpha global destroy --kubeconfig <install-dir>/output/kubeconfig --yes    # without a terminal

命令会删除和保留的内容取决于 provider;请参阅 provider 的“删除 global Cluster”页面。该命令不支持裸金属。以下内容适用于每个 provider:

  • 当目标不是使用 ac 安装的 global 集群时,destroy 会拒绝运行。如果平台仍管理任何其他集群(包括导入的集群和仅部分创建的集群),它也会拒绝运行。错误信息会列出这些集群。你无法跳过这两项检查。
  • 如果运行失败,或控制平面关闭后运行停止,请在同一台计算机上、以同一用户身份并使用同一 kubeconfig 再次运行相同的命令。destroy 会从你确认删除时保存的计划继续执行。该计划包含基础设施凭证。
  • 如果集群有响应,但使用 401、403 或不受信任的证书拒绝 kubeconfig,destroy 会停止运行且不会删除任何内容。该地址现在可能属于另一个集群。
  • 如果运行结束后仍有任何内容残留,错误信息会列出已保存的计划文件。完成清理后删除该文件。
  • 如果集群始终没有响应,则无法使用 ac 销毁它。请在基础设施侧清理此次失败的安装。
  • destroy 会保留 bootstrap 节点的现状。
  • ac adm alpha cluster destroy --cluster global 会被拒绝。该命令用于工作负载集群。