使用 kubeadm 进行证书管理

kubeadm 生成的客户端证书有效期为 1 年。本页面介绍了如何使用 kubeadm 管理证书续订。它还涵盖了与 kubeadm 证书管理相关的其他任务。

Kubernetes 项目建议及时升级到最新的补丁版本，并确保你正在运行受支持的 Kubernetes 次要版本。遵循此建议有助于你保持安全。

准备工作

你应该熟悉 Kubernetes 中的 PKI 证书和要求。

你应该熟悉如何将配置文件传递给 kubeadm 命令。

本指南涵盖了 openssl 命令的使用（如果你选择这种方法，用于手动证书签名），但你可以使用你喜欢的工具。

此处的某些步骤使用 sudo 进行管理员访问。你可以使用任何等效工具。

使用自定义证书

默认情况下，kubeadm 会生成集群运行所需的所有证书。你可以通过提供自己的证书来覆盖此行为。

为此，你必须将它们放置在 --cert-dir 标志或 kubeadm 的 ClusterConfiguration 的 certificatesDir 字段指定的任何目录中。默认情况下，这是 /etc/kubernetes/pki。

如果在运行 kubeadm init 之前存在给定的证书和私钥对，kubeadm 不会覆盖它们。这意味着你可以，例如，将现有 CA 复制到 /etc/kubernetes/pki/ca.crt 和 /etc/kubernetes/pki/ca.key 中，kubeadm 将使用此 CA 签署其余证书。

选择加密算法

kubeadm 允许你选择用于创建公钥和私钥的加密算法。这可以通过使用 kubeadm 配置的 encryptionAlgorithm 字段来完成。

apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
encryptionAlgorithm: <ALGORITHM>

<ALGORITHM> 可以是 RSA-2048（默认）、RSA-3072、RSA-4096 或 ECDSA-P256 之一。

选择证书有效期

kubeadm 允许你选择 CA 和叶子证书的有效期。这可以通过使用 kubeadm 配置的 certificateValidityPeriod 和 caCertificateValidityPeriod 字段来完成。

apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
certificateValidityPeriod: 8760h # Default: 365 days × 24 hours = 1 year
caCertificateValidityPeriod: 87600h # Default: 365 days × 24 hours * 10 = 10 years

字段值遵循 Go 的 time.Duration 值接受的格式，支持的最长单位是 h（小时）。

外部 CA 模式

也可以只提供 ca.crt 文件而不提供 ca.key 文件（这仅适用于根 CA 文件，不适用于其他证书对）。如果所有其他证书和 kubeconfig 文件都已就位，kubeadm 会识别此情况并激活“外部 CA”模式。kubeadm 将在磁盘上没有 CA 密钥的情况下继续运行。

相反，使用 --controllers=csrsigner 独立运行 controller-manager 并指向 CA 证书和密钥。

在使用外部 CA 模式时，有多种方法可以准备组件凭据。

手动准备组件凭据

PKI 证书和要求包含有关如何手动准备 kubeadm 所需的所有组件凭据的信息。

本指南涵盖了 openssl 命令的使用（如果你选择这种方法，用于手动证书签名），但你可以使用你喜欢的工具。

通过签署 kubeadm 生成的 CSR 来准备凭据

kubeadm 可以生成 CSR 文件，你可以使用 openssl 和你的外部 CA 等工具手动签署这些文件。这些 CSR 文件将包含 kubeadm 部署的组件所需的所有凭据规范。

通过使用 kubeadm phases 自动准备组件凭据

或者，可以使用 kubeadm phase 命令来自动化此过程。

• 转到要准备为带有外部 CA 的 kubeadm 控制平面节点的宿主机。
• 将外部 CA 文件 ca.crt 和 ca.key 复制到节点的 /etc/kubernetes/pki 中。
• 准备一个临时的 kubeadm 配置文件，命名为 config.yaml，可与 kubeadm init 一起使用。确保此文件包含证书中可能包含的任何相关的集群范围或宿主机特定信息，例如 ClusterConfiguration.controlPlaneEndpoint、ClusterConfiguration.certSANs 和 InitConfiguration.APIEndpoint。
• 在同一台宿主机上执行命令 kubeadm init phase kubeconfig all --config config.yaml 和 kubeadm init phase certs all --config config.yaml。这将在 /etc/kubernetes/ 及其 pki 子目录下生成所有必需的 kubeconfig 文件和证书。
• 检查生成的文件。删除 /etc/kubernetes/pki/ca.key，删除或移动到安全位置的文件 /etc/kubernetes/super-admin.conf。
• 在将调用 kubeadm join 的节点上，也要删除 /etc/kubernetes/kubelet.conf。此文件仅在将调用 kubeadm init 的第一个节点上需要。
• 请注意，某些文件，如 pki/sa.*、pki/front-proxy-ca.* 和 pki/etc/ca.* 在控制平面节点之间共享。你可以生成它们一次，然后手动分发到将调用 kubeadm join 的节点，或者你可以使用 kubeadm init 的 --upload-certs 功能和 kubeadm join 的 --certificate-key 来自动化此分发。

在所有节点上准备好凭据后，调用 kubeadm init 和 kubeadm join，使这些节点加入集群。kubeadm 将使用 /etc/kubernetes/ 及其 pki 子目录中现有的 kubeconfig 和证书文件。

证书过期和管理

你可以使用 check-expiration 子命令检查证书何时过期

kubeadm certs check-expiration

输出类似于：

CERTIFICATE                EXPIRES                  RESIDUAL TIME   CERTIFICATE AUTHORITY   EXTERNALLY MANAGED
admin.conf                 Dec 30, 2020 23:36 UTC   364d                                    no
apiserver                  Dec 30, 2020 23:36 UTC   364d            ca                      no
apiserver-etcd-client      Dec 30, 2020 23:36 UTC   364d            etcd-ca                 no
apiserver-kubelet-client   Dec 30, 2020 23:36 UTC   364d            ca                      no
controller-manager.conf    Dec 30, 2020 23:36 UTC   364d                                    no
etcd-healthcheck-client    Dec 30, 2020 23:36 UTC   364d            etcd-ca                 no
etcd-peer                  Dec 30, 2020 23:36 UTC   364d            etcd-ca                 no
etcd-server                Dec 30, 2020 23:36 UTC   364d            etcd-ca                 no
front-proxy-client         Dec 30, 2020 23:36 UTC   364d            front-proxy-ca          no
scheduler.conf             Dec 30, 2020 23:36 UTC   364d                                    no

CERTIFICATE AUTHORITY   EXPIRES                  RESIDUAL TIME   EXTERNALLY MANAGED
ca                      Dec 28, 2029 23:36 UTC   9y              no
etcd-ca                 Dec 28, 2029 23:36 UTC   9y              no
front-proxy-ca          Dec 28, 2029 23:36 UTC   9y              no

该命令显示 /etc/kubernetes/pki 文件夹中客户端证书以及 kubeadm 使用的 kubeconfig 文件（admin.conf、controller-manager.conf 和 scheduler.conf）中嵌入的客户端证书的到期/剩余时间。

此外，kubeadm 会告知用户证书是否由外部管理；在这种情况下，用户应手动/使用其他工具管理证书续订。

kubelet.conf 配置文件未包含在上述列表中，因为 kubeadm 配置 kubelet 以便通过 /var/lib/kubelet/pki 下的可旋转证书进行自动证书续订。要修复过期的 kubelet 客户端证书，请参阅Kubelet 客户端证书旋转失败。

client-certificate: /var/lib/kubelet/pki/kubelet-client-current.pem
client-key: /var/lib/kubelet/pki/kubelet-client-current.pem

自动证书续订

kubeadm 会在控制平面升级期间续订所有证书。

此功能旨在解决最简单的用例；如果你对证书续订没有特定要求，并且定期执行 Kubernetes 版本升级（每次升级之间间隔不到 1 年），kubeadm 将负责保持你的集群最新且相对安全。

如果你对证书续订有更复杂的要求，你可以通过向 kubeadm upgrade apply 或 kubeadm upgrade node 传递 --certificate-renewal=false 来选择退出默认行为。

手动证书续订

你可以随时使用 kubeadm certs renew 命令和适当的命令行选项手动续订证书。如果你运行的是具有复制控制平面的集群，则此命令需要在所有控制平面节点上执行。

此命令使用存储在 /etc/kubernetes/pki 中的 CA（或 front-proxy-CA）证书和密钥执行续订。

kubeadm certs renew 使用现有证书作为属性（通用名称、组织、主题备用名称）的权威来源，并且不依赖于 kubeadm-config ConfigMap。即便如此，Kubernetes 项目仍建议保持提供的证书和该 ConfigMap 中的相关值同步，以避免任何混淆风险。

运行命令后，你应该重新启动控制平面 Pod。这是必需的，因为目前并非所有组件和证书都支持动态证书重新加载。静态 Pod 由本地 kubelet 管理，而不是由 API 服务器管理，因此不能使用 kubectl 删除和重新启动它们。要重新启动静态 Pod，你可以暂时将其清单文件从 /etc/kubernetes/manifests/ 中删除，并等待 20 秒（参见 KubeletConfiguration 结构中的 fileCheckFrequency 值。如果 Pod 不再位于清单目录中，kubelet 将终止该 Pod。然后你可以将文件移回，在另一个 fileCheckFrequency 周期后，kubelet 将重新创建 Pod，并且该组件的证书续订可以完成。

kubeadm certs renew 可以续订任何特定证书，或者使用子命令 all，它可以续订所有证书。

# If you are running cluster with a replicated control plane, this command
# needs to be executed on all the control-plane nodes.
kubeadm certs renew all

复制管理员证书（可选）

使用 kubeadm 构建的集群通常会将 admin.conf 证书复制到 $HOME/.kube/config 中，如使用 kubeadm 创建集群中所述。在此类系统上，为了在续订 admin.conf 后更新 $HOME/.kube/config 的内容，你可以运行以下命令：

sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
sudo chown $(id -u):$(id -g) $HOME/.kube/config

使用 Kubernetes 证书 API 续订证书

本节提供了有关如何使用 Kubernetes 证书 API 执行手动证书续订的更多详细信息。

设置签名器

Kubernetes 证书颁发机构无法立即工作。你可以配置外部签名者，例如 cert-manager，或者你可以使用内置签名者。

内置签名者是 kube-controller-manager 的一部分。

要激活内置签名者，你必须传递 --cluster-signing-cert-file 和 --cluster-signing-key-file 标志。

如果你正在创建新集群，可以使用 kubeadm 配置文件。

apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
controllerManager:
  extraArgs:
  - name: "cluster-signing-cert-file"
    value: "/etc/kubernetes/pki/ca.crt"
  - name: "cluster-signing-key-file"
    value: "/etc/kubernetes/pki/ca.key"

创建证书签名请求 (CSR)

有关使用 Kubernetes API 创建 CSR 的信息，请参阅创建 CertificateSigningRequest。

使用外部 CA 续订证书

本节提供了有关如何使用外部 CA 执行手动证书续订的更多详细信息。

为了更好地与外部 CA 集成，kubeadm 还可以生成证书签名请求 (CSR)。CSR 表示向 CA 请求客户端签名证书。在 kubeadm 术语中，任何通常由磁盘 CA 签名的证书都可以作为 CSR 生成。然而，CA 不能作为 CSR 生成。

通过使用证书签名请求 (CSR) 续订

可以通过生成新的 CSR 并使用外部 CA 签署它们来续订证书。有关使用 kubeadm 生成的 CSR 的更多详细信息，请参阅签署 kubeadm 生成的证书签名请求 (CSR) 部分。

证书颁发机构 (CA) 轮换

Kubeadm 不支持开箱即用的 CA 证书轮换或替换。

有关手动轮换或替换 CA 的更多信息，请参见手动轮换 CA 证书。

启用已签名 kubelet 服务证书

默认情况下，kubeadm 部署的 kubelet 服务证书是自签名的。这意味着从外部服务（如 metrics-server）到 kubelet 的连接无法通过 TLS 保护。

要在新的 kubeadm 集群中配置 kubelet 以获取正确签名的服务证书，你必须向 kubeadm init 传递以下最小配置

apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
---
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
serverTLSBootstrap: true

如果你已经创建了集群，则必须通过以下方式进行调整

• 在 kube-system 命名空间中查找并编辑 kubelet-config-1.34 ConfigMap。在该 ConfigMap 中，kubelet 键的值是一个 KubeletConfiguration 文档。编辑 KubeletConfiguration 文档以设置 serverTLSBootstrap: true。
• 在每个节点上，在 /var/lib/kubelet/config.yaml 中添加 serverTLSBootstrap: true 字段，并使用 systemctl restart kubelet 重新启动 kubelet。

serverTLSBootstrap: true 字段将通过从 certificates.k8s.io API 请求 kubelet 服务证书来启用引导。一个已知的限制是，这些证书的 CSR（证书签名请求）无法由 kube-controller-manager 中的默认签名器自动批准 - kubernetes.io/kubelet-serving。这将需要用户或第三方控制器采取行动。

可以使用以下命令查看这些 CSR

kubectl get csr

NAME        AGE     SIGNERNAME                        REQUESTOR                      CONDITION
csr-9wvgt   112s    kubernetes.io/kubelet-serving     system:node:worker-1           Pending
csr-lz97v   1m58s   kubernetes.io/kubelet-serving     system:node:control-plane-1    Pending

要批准它们，你可以执行以下操作

kubectl certificate approve <CSR-name>

默认情况下，这些服务证书将在一年后过期。Kubeadm 将 KubeletConfiguration 字段 rotateCertificates 设置为 true，这意味着在接近过期时，将创建一组新的服务证书 CSR，并且必须批准才能完成轮换。要了解更多信息，请参见证书轮换。

如果你正在寻找自动批准这些 CSR 的解决方案，建议你联系你的云提供商，询问他们是否有通过带外机制验证节点身份的 CSR 签名器。

可以使用第三方自定义控制器

• kubelet-csr-approver

除非此类控制器不仅验证 CSR 中的通用名称，还验证请求的 IP 和域名，否则它不是一种安全机制。这将防止拥有 kubelet 客户端证书的恶意行为者创建请求任何 IP 或域名的服务证书的 CSR。

为其他用户生成 kubeconfig 文件

在集群创建期间，kubeadm init 会签署 super-admin.conf 中的证书，使其具有 Subject: O = system:masters, CN = kubernetes-super-admin。system:masters 是一个“破窗”超级用户组，它绕过授权层（例如 RBAC）。admin.conf 文件也由 kubeadm 在控制平面节点上创建，它包含一个证书，其 Subject: O = kubeadm:cluster-admins, CN = kubernetes-admin。kubeadm:cluster-admins 是一个逻辑上属于 kubeadm 的组。如果你的集群使用 RBAC（kubeadm 默认），则 kubeadm:cluster-admins 组绑定到 cluster-admin ClusterRole。

你可以使用 kubeadm kubeconfig user 命令为其他用户生成 kubeconfig 文件。该命令接受命令行标志和 kubeadm 配置选项的混合。生成的 kubeconfig 将写入标准输出，并且可以使用 kubeadm kubeconfig user ... > somefile.conf 管道传输到文件。

可与 --config 一起使用的示例配置文件

# example.yaml
apiVersion: kubeadm.k8s.io/v1beta4
kind: ClusterConfiguration
# Will be used as the target "cluster" in the kubeconfig
clusterName: "kubernetes"
# Will be used as the "server" (IP or DNS name) of this cluster in the kubeconfig
controlPlaneEndpoint: "some-dns-address:6443"
# The cluster CA key and certificate will be loaded from this local directory
certificatesDir: "/etc/kubernetes/pki"

确保这些设置与所需的目标集群设置匹配。要查看现有集群的设置，请使用

kubectl get cm kubeadm-config -n kube-system -o=jsonpath="{.data.ClusterConfiguration}"

以下示例将生成一个 kubeconfig 文件，其中包含有效期为 24 小时的新用户 johndoe 的凭据，该用户属于 appdevs 组

kubeadm kubeconfig user --config example.yaml --org appdevs --client-name johndoe --validity-period 24h

以下示例将生成一个 kubeconfig 文件，其中包含有效期为 1 周的管理员凭据

kubeadm kubeconfig user --config example.yaml --client-name admin --validity-period 168h

签署 kubeadm 生成的证书签名请求 (CSR)

你可以使用 kubeadm certs generate-csr 创建证书签名请求。调用此命令将为常规证书生成 .csr / .key 文件对。对于嵌入在 kubeconfig 文件中的证书，该命令将生成 .csr / .conf 对，其中密钥已嵌入在 .conf 文件中。

CSR 文件包含 CA 签署证书所需的所有相关信息。kubeadm 为其所有证书和 CSR 使用定义明确的规范。

默认证书目录是 /etc/kubernetes/pki，而 kubeconfig 文件的默认目录是 /etc/kubernetes。这些默认值可以分别通过 --cert-dir 和 --kubeconfig-dir 标志覆盖。

要将自定义选项传递给 kubeadm certs generate-csr，请使用 --config 标志，它接受 kubeadm 配置文件，类似于 kubeadm init 等命令。任何规范，例如额外的 SAN 和自定义 IP 地址，都必须存储在同一配置文件中，并作为 --config 传递给所有相关的 kubeadm 命令。

准备 CA 和服务账户文件

在主控制平面节点（将执行 kubeadm init 的节点）上，调用以下命令：

sudo kubeadm init phase certs ca
sudo kubeadm init phase certs etcd-ca
sudo kubeadm init phase certs front-proxy-ca
sudo kubeadm init phase certs sa

这将用 kubeadm 控制平面节点所需的所有自签名 CA 文件（证书和密钥）和服务账户（公钥和私钥）填充 /etc/kubernetes/pki 和 /etc/kubernetes/pki/etcd 文件夹。

对于辅助控制平面节点 (kubeadm join --control-plane)，无需调用上述命令。根据你设置高可用性集群的方式，你可能需要手动从主控制平面节点复制相同的文件，或者使用 kubeadm init 的自动化 --upload-certs 功能。

生成 CSR

kubeadm certs generate-csr 命令为 kubeadm 管理的所有已知证书生成 CSR。命令完成后，你必须手动删除不需要的 .csr、.conf 或 .key 文件。

kubelet.conf 的注意事项

本节适用于控制平面节点和工作节点。

如果你已从控制平面节点删除了 ca.key 文件（外部 CA 模式），则此集群中的活动 kube-controller-manager 将无法签署 kubelet 客户端证书。如果你的设置中不存在用于签署这些证书的外部方法（例如外部签名器），你可以手动签署 kubelet.conf.csr，如本指南所述。

请注意，这还意味着自动kubelet 客户端证书轮换将被禁用。如果是这样，在证书到期前，你必须生成新的 kubelet.conf.csr，签署证书，将其嵌入 kubelet.conf 并重新启动 kubelet。

如果这不适用于你的设置，你可以跳过在辅助控制平面和工作节点（所有调用 kubeadm join ... 的节点）上处理 kubelet.conf.csr。这是因为活动的 kube-controller-manager 将负责签署新的 kubelet 客户端证书。

控制平面节点

在主（kubeadm init）和辅助（kubeadm join --control-plane）控制平面节点上执行以下命令以生成所有 CSR 文件

sudo kubeadm certs generate-csr

如果要使用外部 etcd，请遵循使用 kubeadm 的外部 etcd 指南，以了解 kubeadm 和 etcd 节点上需要哪些 CSR 文件。/etc/kubernetes/pki/etcd 下的其他 .csr 和 .key 文件可以删除。

根据kubelet.conf 的注意事项中的解释，保留或删除 kubelet.conf 和 kubelet.conf.csr 文件。

工作节点

根据kubelet.conf 的注意事项中的解释，可以选择调用

sudo kubeadm certs generate-csr

并只保留 kubelet.conf 和 kubelet.conf.csr 文件。或者完全跳过工作节点步骤。

签署所有证书的 CSR

对所有具有 CSR 文件的节点重复此步骤。

将以下脚本写入 /etc/kubernetes 目录，导航到该目录并执行脚本。该脚本将为 /etc/kubernetes 树中存在的所有 CSR 文件生成证书。

#!/bin/bash

# Set certificate expiration time in days
DAYS=365

# Process all CSR files except those for front-proxy and etcd
find ./ -name "*.csr" | grep -v "pki/etcd" | grep -v "front-proxy" | while read -r FILE;
do
    echo "* Processing ${FILE} ..."
    FILE=${FILE%.*} # Trim the extension
    if [ -f "./pki/ca.srl" ]; then
        SERIAL_FLAG="-CAserial ./pki/ca.srl"
    else
        SERIAL_FLAG="-CAcreateserial"
    fi
    openssl x509 -req -days "${DAYS}" -CA ./pki/ca.crt -CAkey ./pki/ca.key ${SERIAL_FLAG} \
        -in "${FILE}.csr" -out "${FILE}.crt"
    sleep 2
done

# Process all etcd CSRs
find ./pki/etcd -name "*.csr" | while read -r FILE;
do
    echo "* Processing ${FILE} ..."
    FILE=${FILE%.*} # Trim the extension
    if [ -f "./pki/etcd/ca.srl" ]; then
        SERIAL_FLAG=-CAserial ./pki/etcd/ca.srl
    else
        SERIAL_FLAG=-CAcreateserial
    fi
    openssl x509 -req -days "${DAYS}" -CA ./pki/etcd/ca.crt -CAkey ./pki/etcd/ca.key ${SERIAL_FLAG} \
        -in "${FILE}.csr" -out "${FILE}.crt"
done

# Process front-proxy CSRs
echo "* Processing ./pki/front-proxy-client.csr ..."
openssl x509 -req -days "${DAYS}" -CA ./pki/front-proxy-ca.crt -CAkey ./pki/front-proxy-ca.key -CAcreateserial \
    -in ./pki/front-proxy-client.csr -out ./pki/front-proxy-client.crt

将证书嵌入 kubeconfig 文件

对所有具有 CSR 文件的节点重复此步骤。

将以下脚本写入 /etc/kubernetes 目录，导航到该目录并执行脚本。该脚本将从上一步的 CSR 中获取为 kubeconfig 文件签名的 .crt 文件，并将其嵌入到 kubeconfig 文件中。

#!/bin/bash

CLUSTER=kubernetes
find ./ -name "*.conf" | while read -r FILE;
do
    echo "* Processing ${FILE} ..."
    KUBECONFIG="${FILE}" kubectl config set-cluster "${CLUSTER}" --certificate-authority ./pki/ca.crt --embed-certs
    USER=$(KUBECONFIG="${FILE}" kubectl config view -o jsonpath='{.users[0].name}')
    KUBECONFIG="${FILE}" kubectl config set-credentials "${USER}" --client-certificate "${FILE}.crt" --embed-certs
done

执行清理

在所有具有 CSR 文件的节点上执行此步骤。

将以下脚本写入 /etc/kubernetes 目录，导航到该目录并执行脚本。

#!/bin/bash

# Cleanup CSR files
rm -f ./*.csr ./pki/*.csr ./pki/etcd/*.csr # Clean all CSR files

# Cleanup CRT files that were already embedded in kubeconfig files
rm -f ./*.crt

（可选）将 .srl 文件移动到下一个要处理的节点。

（可选）如果使用外部 CA，请删除 /etc/kubernetes/pki/ca.key 文件，如外部 CA 节点部分所述。

kubeadm 节点初始化

一旦 CSR 文件已签名并且所需证书已位于要用作节点的宿主机上，你就可以使用 kubeadm init 和 kubeadm join 命令从这些节点创建 Kubernetes 集群。在 init 和 join 期间，kubeadm 会使用宿主机本地文件系统上 /etc/kubernetes 树中找到的现有证书、加密密钥和 kubeconfig 文件。