升级 Cert-Manager

Rancher 适配 API 版本 cert-manager.io/v1 并且在 cert-manager v1.13.1 版本上进行了测试。

Rancher 使用 cert-manager 为 Rancher 高可用部署自动生成和续期 TLS 证书。从 2019 秋季开始，cert-manager 发生了以下的三个重要变更。如果你在此时间段前创建了 Rancher 高可用部署，请进行相关操作。

  1. 从 2019 年 11 月 1 日开始，Let’s Encrypt 已阻止低于 0.8.0 的 cert-manager 实例。
  2. Cert-manager 正在弃用和替换 certificate.spec.acme.solvers 字段。此更改暂时没有确切的截止日期。
  3. Cert-manager 正在弃用 v1alpha1 API 和替换它的 API 组。

为了帮助你应对这些变化，本文将：

  1. 提供升级 cert-manager 步骤的文档。
  2. 阐述 cert-manager API 的变更，并提供 cert-manager 官方文档的链接，助你实现数据迁移。

升级 Cert-Manager - 图1重要提示：

如果你要将 cert-manager 从早于 1.5 的版本升级到最新版本，请按照以下选项 C 中的步骤进行操作。请注意，你无需重新安装 Rancher 即可执行此升级。

升级 Cert-Manager

以下说明中使用的命名空间是由当前安装了 cert-manager 的命名空间决定的。如果它在 kube-system 中，在以下说明步骤中使用。你可以运行 kubectl get pods --all-namespaces 来验证，并检查 cert-manager-* pods 列在哪个命名空间中。不要更改运行 cert-manager 的命名空间，否则可能会出现错误。

要升级 cert-manager，请遵循步骤操作。

选项 A：联网升级 cert-manager

单击展开

  1. 备份现有资源：

    1. kubectl get -o yaml --all-namespaces \
    2. issuer,clusterissuer,certificates,certificaterequests > cert-manager-backup.yaml

    升级 Cert-Manager - 图2重要提示：

    如果你从低于 0.11.0 的版本升级，请将所有备份资源上的 apiVersion 从 certmanager.k8s.io/v1alpha1 升级到 cert-manager.io/v1alpha2。如果你需要在其他资源上使用 cert-manager 注释，请对其进行更新以反映新的 API 组。详情请参见附加注释变更。

  2. 卸载现有部署：

    1. helm uninstall cert-manager

    使用你安装的 vX.Y.Z 版本的链接删除 CustomResourceDefinition：

    1. kubectl delete -f https://github.com/cert-manager/cert-manager/releases/download/vX.Y.Z/cert-manager.crds.yaml

  3. 单独安装 CustomResourceDefinition 资源：

    1. kubectl apply --validate=false -f https://github.com/cert-manager/cert-manager/releases/download/vX.Y.Z/cert-manager.crds.yaml

    升级 Cert-Manager - 图3备注

    如果你运行的 Kubernetes 版本是 1.15 或更低版本，你需要在以上的 kubectl apply 命令中添加 --validate=false。否则你将看到 cert-manager CRD 资源中的 x-kubernetes-preserve-unknown-fields 字段校验错误提示。这是 kubectl 执行资源校验方式产生的良性错误。

  4. 根据需要为 cert-manager 创建命名空间：

    1. kubectl create namespace cert-manager

  5. 添加 Jetstack Helm 仓库：

    1. helm repo add jetstack https://charts.jetstack.io

  6. 更新 Helm Chart 仓库本地缓存：

    1. helm repo update

  7. 安装新版本的 cert-manager：

    1. helm install \
    2.   cert-manager jetstack/cert-manager \
    3.   --namespace cert-manager

  8. 恢复备份资源：

    1. kubectl apply -f cert-manager-backup.yaml

选项 B：在离线环境中升级 Cert-Manager

单击展开

先决条件

在执行升级之前，先将所需的容器镜像添加到私有镜像仓库中，并下载/渲染所需的 Kubernetes manifest 文件来准备离线环境。

  1. 参见准备私有镜像仓库指南，将升级所需的镜像推送到镜像仓库。

  2. 在可以连接互联网的系统中，将 cert-manager 仓库添加到 Helm：

    1. helm repo add jetstack https://charts.jetstack.io
    2. helm repo update

  3. 从 Helm Chart 仓库中获取最新可用的 cert-manager Chart：

    1. helm fetch jetstack/cert-manager

  4. 使用安装 Chart 的选项来渲染 cert-manager 模板。记住要设置 image.repository 选项，以从你的私有镜像仓库拉取镜像。此操作会创建一个包含 Kubernetes manifest 文件的 cert-manager 目录。

    Helm 3 命令如下：

    1. helm template cert-manager ./cert-manager-v0.12.0.tgz --output-dir . \
    2. --namespace cert-manager \
    3. --set image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-controller
    4. --set webhook.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-webhook
    5. --set cainjector.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-cainjector

    升级 Cert-Manager - 图4危险

    Helm v2 support is deprecated as of the Rancher v2.7 line and will be removed in Rancher v2.9.

    Helm 2 命令如下：

    1. helm template ./cert-manager-v0.12.0.tgz --output-dir . \
    2. --name cert-manager --namespace cert-manager \
    3. --set image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-controller
    4. --set webhook.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-webhook
    5. --set cainjector.image.repository=<REGISTRY.YOURDOMAIN.COM:PORT>/quay.io/jetstack/cert-manager-cainjector

  5. 下载新旧版 cert-manager 所需的 CRD 文件：

    1. curl -L -o cert-manager-crd.yaml https://raw.githubusercontent.com/cert-manager/cert-manager/release-0.12/deploy/manifests/00-crds.yaml
    2. curl -L -o cert-manager/cert-manager-crd-old.yaml https://raw.githubusercontent.com/cert-manager/cert-manager/release-X.Y/deploy/manifests/00-crds.yaml

安装 cert-manager

  1. 备份现有资源：

    1. kubectl get -o yaml --all-namespaces \
    2. issuer,clusterissuer,certificates,certificaterequests > cert-manager-backup.yaml

    升级 Cert-Manager - 图5重要提示：

    如果你从低于 0.11.0 的版本升级，请将所有备份资源上的 apiVersion 从 certmanager.k8s.io/v1alpha1 升级到 cert-manager.io/v1alpha2。如果你需要在其他资源上使用 cert-manager 注释，请对其进行更新以反映新的 API 组。详情请参见附加注释变更。

  2. 删除现有的 cert-manager 安装包：

    1. kubectl -n cert-manager \
    2. delete deployment,sa,clusterrole,clusterrolebinding \
    3. -l 'app=cert-manager' -l 'chart=cert-manager-v0.5.2'

    使用你安装的 vX.Y 版本的链接删除 CustomResourceDefinition：

    1. kubectl delete -f cert-manager/cert-manager-crd-old.yaml

  3. 单独安装 CustomResourceDefinition 资源：

    1. kubectl apply -f cert-manager/cert-manager-crd.yaml

    升级 Cert-Manager - 图6重要提示：

    如果你运行的 Kubernetes 版本是 1.15 或更低版本，你需要在以上的 kubectl apply 命令中添加 --validate=false。否则你将看到 cert-manager CRD 资源中的 x-kubernetes-preserve-unknown-fields 字段校验错误提示。这是 kubectl 执行资源校验方式产生的良性错误。

  4. 为 cert-manager 创建命名空间：

    1. kubectl create namespace cert-manager

  5. 安装 cert-manager

    1. kubectl -n cert-manager apply -R -f ./cert-manager

  6. 恢复备份资源：

    1. kubectl apply -f cert-manager-backup.yaml

选项 C：升级 1.5 及以下版本的 cert-manager

单击展开

以前，要升级旧版本的 cert-manager，我们建议卸载并重新安装 Rancher。使用以下方法，你可以升级 cert-manager 而无需执行此额外步骤，从而更好地保护你的生产环境：

  1. 按照安装指南安装 cmctl（cert-manager CLI 工具）。

  2. 确保所有以已弃用的 API 版本存储在 etcd 中的 cert-manager 自定义资源都迁移到 v1：

    1. cmctl upgrade migrate-api-version

    有关详细信息，请参阅 API 版本迁移文档。另请参阅将 1.5 升级到 1.6 和将 1.6 升级到到 1.7。

  3. 正常使用 helm upgrade 将 cert-manager 升级到 1.7.1。如果需要，你可以直接从版本 1.5 转到 1.7。

  4. 按照 Helm 教程更新发布清单的 API 版本。Chart 发布名称为 release_name=rancher，发布命名空​​间为 release_namespace=cattle-system。

  5. 在解码后的文件中，搜索 cert-manager.io/v1beta1 并将其替换为 cert-manager.io/v1。

  6. 使用 helm upgrade 正常升级 Rancher。

验证部署

安装完 cert-manager 后，你可以通过检查 kube-system 命名空间中正在运行的 Pod 来验证它是否已正确部署：

  1. kubectl get pods --namespace cert-manager
  3. NAME                                       READY   STATUS    RESTARTS   AGE
  4. cert-manager-5c6866597-zw7kh               1/1     Running   0          2m
  5. cert-manager-cainjector-577f6d9fd7-tr77l   1/1     Running   0          2m
  6. cert-manager-webhook-787858fcdb-nlzsq      1/1     Running   0          2m

Cert-Manager API 变更和数据迁移

Rancher 现在支持 cert-manager 1.6.2 和 1.7.1。推荐使用 v1.7.x，因为 v 1.6.x 将在 2022 年 3 月 30 日结束生命周期。详情请参见 cert-manager 文档。有关将 cert-manager 从 1.5 升级到 1.6 的说明，请参见上游的 cert-manager 文档。有关将 cert-manager 从 1.6 升级到 1.7 的说明，请参见上游的 cert-manager 文档。

Cert-manager 已经弃用 certificate.spec.acme.solvers 字段，而且会在未来的版本中放弃对该字段的支持。

根据 cert-manager 文档，v0.8 引入了配置 ACME 证书资源的新格式。具体来说，就是移动了 challenge solver 字段。v0.9 新旧格式均支持。请知悉，之后发布的新 cert-manager 版本会放弃对旧格式的支持。Cert-Manager 文档建议你在更新后，将 ACME 颁发者和证书资源更新到新格式。

如需了解变更细节以及迁移说明，请参见将 Cert-Manager 从 v0.7 升级到 v0.8。

v0.11 版本标志着删除先前 Cert-Manager 版本中使用的 v1alpha1 API，以及将 API 组从 certmanager.k8s.io 更改到 cert-manager.io。

此外，我们已不再支持 v0.8 版本中已弃用的旧配置格式。换言之，在升级到 v0.11 之前，你必须先为 ACME 发行者使用新的 solver 样式配置格式作为过渡。详情请参见升级到 v0.8。

如需了解变更细节以及迁移说明，请参见将 Cert-Manager 从 v0.10 升级到 v0.11。

如需获得更多信息，请参见 Cert-Manager 升级。