使用 kubeadm 进行证书管理

特性状态: Kubernetes v1.15 [稳定]

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

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

开始之前

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

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

本指南涵盖了 openssl 命令的使用(如果您选择这种方法,则用于手动证书签名),但您可以使用您喜欢的工具。

本文档中的某些步骤使用 sudo 以获取管理员权限。您可以使用任何等效的工具。

使用自定义证书

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

为此,您必须将它们放置在由 --cert-dir 标志或 kubeadm 的 ClusterConfigurationcertificatesDir 字段指定的任何目录中。默认情况下,此目录为 /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-3072RSA-4096ECDSA-P256

选择证书有效期

kubeadm 允许您选择 CA 和叶证书的有效期。可以通过使用 kubeadm 配置的 certificateValidityPeriodcaCertificateValidityPeriod 字段来完成此操作

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 阶段自动准备组件凭据

或者,可以使用 kubeadm 阶段命令自动执行此过程。

  • 转到您想要准备为 kubeadm 控制平面节点的宿主机,该节点使用外部 CA。
  • 将外部 CA 文件 ca.crtca.key 复制到节点上的 /etc/kubernetes/pki 中。
  • 准备一个临时 kubeadm 配置文件,名为 config.yaml,可与 kubeadm init 一起使用。确保此文件包含任何相关的集群范围或主机特定信息,这些信息可以包含在证书中,例如 ClusterConfiguration.controlPlaneEndpointClusterConfiguration.certSANsInitConfiguration.APIEndpoint
  • 在同一宿主机上执行命令 kubeadm init phase kubeconfig all --config config.yamlkubeadm 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 initkubeadm 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 使用的客户端证书(admin.confcontroller-manager.confscheduler.conf)嵌入的 kubeconfig 文件。

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

由于 kubeadm 配置 kubelet 以使用 /var/lib/kubelet/pki 下的可旋转证书进行 自动证书续订,因此 kubelet.conf 配置文件不包含在上述列表中。有关修复过期的 kubelet 客户端证书,请参阅 Kubelet 客户端证书轮换失败

自动证书续订

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

此功能旨在解决最简单的用例;如果您没有关于证书续订的特定要求,并且定期执行 Kubernetes 版本升级(每个升级之间少于 1 年),kubeadm 将负责保持您的集群最新且相对安全。

如果您对证书续订有更复杂的要求,可以通过将 --certificate-renewal=false 传递给 kubeadm upgrade applykubeadm upgrade node 来选择退出默认行为。

手动证书续订

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

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

kubeadm certs renew 使用现有的证书作为属性(Common Name、Organization、subject alternative name)的权威来源,不依赖于 kubeadm-config ConfigMap。尽管如此,Kubernetes 项目建议将提供的证书和相关值在 ConfigMap 中保持同步,以避免任何混淆的风险。

运行命令后,您应该重启控制平面 Pod。这是必需的,因为目前并非所有组件和证书都支持动态证书重新加载。 静态 Pod 由本地 kubelet 管理,不由 API Server 管理,因此无法使用 kubectl 删除和重启它们。要重启静态 Pod,您可以临时将其 manifest 文件从 /etc/kubernetes/manifests/ 中删除,并等待 20 秒(请参阅 KubeletConfiguration struct 中的 fileCheckFrequency 值)。如果 Pod 不再位于 manifest 目录中,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)

请参阅 创建 CertificateSigningRequest,了解如何使用 Kubernetes API 创建 CSR。

使用外部 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 ConfigMap。在该 ConfigMap 中,kubelet 键具有 KubeletConfiguration 文档作为其值。编辑 KubeletConfiguration 文档以设置 serverTLSBootstrap: true
  • 在每个节点上,将 serverTLSBootstrap: true 字段添加到 /var/lib/kubelet/config.yaml 中,并使用 systemctl restart kubelet 重启 kubelet

字段 serverTLSBootstrap: true 将启用 kubelet 服务证书的引导,通过从 certificates.k8s.io API 请求它们来引导。一个已知的限制是,这些证书的 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 签名者。

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

除非该控制器不仅验证 CSR 中的 CommonName,还验证请求的 IP 和域名,否则它不是一种安全机制。这将防止具有 kubelet 客户端证书访问权限的恶意行为者创建请求任何 IP 或域名的服务证书的 CSR。

生成其他用户的 kubeconfig 文件

在集群创建期间,kubeadm init 会对 super-admin.conf 中的证书进行签名,使其具有 Subject: O = system:masters, CN = kubernetes-super-adminsystem:masters 是一个突破性、超级用户组,绕过授权层(例如,RBAC)。kubeadm 还在控制平面节点上创建文件 admin.conf,其中包含具有 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}"

以下示例将生成一个有效期为 24 小时、针对新用户 johndoe 且属于 appdevs 组的 kubeconfig 文件

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

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

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

这将填充文件夹 /etc/kubernetes/pki/etc/kubernetes/pki/etcd,其中包含 kubeadm 为控制平面节点所需的所有自签名 CA 文件(证书和密钥)以及服务帐户(公钥和私钥)。

对于辅助控制平面节点 (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。

如果这不适用于您的设置,您可以跳过处理辅助控制平面和工作节点上的 kubelet.conf.csr(所有调用 kubeadm join ... 的节点)。这是因为活动的 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.confkubelet.conf.csr 文件。

工作节点

根据 kubelet.conf 的注意事项 中的说明,可以选择调用

sudo kubeadm certs generate-csr

并仅保留 kubelet.confkubelet.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 目录,导航到该目录并执行该脚本。该脚本将获取为 kubeconfig 文件从 CSR 签名的 .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 initkubeadm join 命令从这些节点创建 Kubernetes 集群。在 initjoin 期间,kubeadm 使用在宿主机本地文件系统上的 /etc/kubernetes 树中找到的现有证书、加密密钥和 kubeconfig 文件。

此页面上的项目引用了 Kubernetes 所需功能的第三方产品或项目。Kubernetes 项目作者不对这些第三方产品或项目负责。有关更多详细信息,请参阅 CNCF 网站指南

在提出添加额外的第三方链接的更改之前,您应该阅读 内容指南