kubeadm join

此命令初始化一个新的 Kubernetes 节点并将其加入到现有的集群。

在您希望加入现有集群的任何机器上运行此命令

概要

在加入 kubeadm 初始化集群时,我们需要建立双向信任。 这分为发现(让节点信任 Kubernetes 控制平面)和 TLS 引导(让 Kubernetes 控制平面信任节点)。

有两种主要的发现方案。 第一种是使用共享令牌以及 API 服务器的 IP 地址。 第二种是提供一个文件 - 标准 kubeconfig 文件的一个子集。 发现/kubeconfig 文件支持令牌、client-go 身份验证插件(“exec”)、“tokenFile”和“authProvider”。 此文件可以是本地文件或通过 HTTPS URL 下载。 形式为 kubeadm join --discovery-token abcdef.1234567890abcdef 1.2.3.4:6443、kubeadm join --discovery-file path/to/file.conf 或 kubeadm join --discovery-file https://url/file.conf。 只能使用一种形式。 如果从 URL 加载发现信息,则必须使用 HTTPS。 此外,在这种情况下,安装的 CA 捆绑包用于验证连接。

如果您使用共享令牌进行发现,还应传递 --discovery-token-ca-cert-hash 标志,以验证 Kubernetes 控制平面呈现的根证书颁发机构 (CA) 的公钥。 此标志的值指定为“<hash-type>:<hex-encoded-value>”,其中支持的哈希类型为“sha256”。 哈希值是根据 Subject Public Key Info (SPKI) 对象(如 RFC7469 中所述)的字节计算得出的。 此值可在“kubeadm init”的输出中找到,或可以使用标准工具计算得出。 --discovery-token-ca-cert-hash 标志可以重复多次,以允许多个公钥。

如果您无法提前知道 CA 公钥哈希,则可以传递 --discovery-token-unsafe-skip-ca-verification 标志以禁用此验证。 这会削弱 kubeadm 安全模型,因为其他节点可能会冒充 Kubernetes 控制平面。

TLS 引导机制也通过共享令牌驱动。 这用于临时使用共享令牌进行身份验证,以提交本地创建的密钥对的证书签名请求 (CSR)。 默认情况下,kubeadm 将设置 Kubernetes 控制平面以自动批准这些签名请求。 此令牌通过 --tls-bootstrap-token abcdef.1234567890abcdef 标志传递。

通常,相同的令牌用于两部分。 在这种情况下,可以使用 --token 标志,而不是单独指定每个令牌。

“join [api-server-endpoint]”命令执行以下阶段

preflight               Run join pre-flight checks
control-plane-prepare   Prepare the machine for serving a control plane
  /download-certs         Download certificates shared among control-plane nodes from the kubeadm-certs Secret
  /certs                  Generate the certificates for the new control plane components
  /kubeconfig             Generate the kubeconfig for the new control plane components
  /control-plane          Generate the manifests for the new control plane components
kubelet-start           Write kubelet settings, certificates and (re)start the kubelet
etcd-join               Join etcd for control plane nodes
kubelet-wait-bootstrap  Wait for the kubelet to bootstrap itself
control-plane-join      Join a machine as a control plane instance
  /mark-control-plane     Mark a node as a control-plane
wait-control-plane      Wait for the control plane to start
kubeadm join [api-server-endpoint] [flags]

选项

--apiserver-advertise-address string

如果节点应托管新的控制平面实例,则 API 服务器将通告其正在侦听的 IP 地址。 如果未设置,将使用默认网络接口。

--apiserver-bind-port int32     默认值:6443

如果节点应托管新的控制平面实例,则 API 服务器绑定到的端口。

--certificate-key string

用于解密由 init 上传的证书密钥。 证书密钥是大小为 32 字节的 AES 密钥的十六进制编码字符串。

--config string

kubeadm 配置文件路径。

--control-plane

在此节点上创建一个新的控制平面实例

--cri-socket string

要连接的 CRI 套接字路径。如果为空,kubeadm 将尝试自动检测此值;仅当你安装了多个 CRI 或拥有非标准 CRI 套接字时,才使用此选项。

--discovery-file string

对于基于文件的发现,从加载集群信息的的文件或 URL。

--discovery-token string

对于基于令牌的发现,用于验证从 API 服务器获取的集群信息的令牌。

--discovery-token-ca-cert-hash strings

对于基于令牌的发现,验证根 CA 公钥是否与此哈希匹配(格式:“<type>:<value>”)。

--discovery-token-unsafe-skip-ca-verification

对于基于令牌的发现,允许在没有 --discovery-token-ca-cert-hash 引脚的情况下加入。

--dry-run

不应用任何更改;仅输出将要执行的操作。

-h, --help

join 的帮助

--ignore-preflight-errors strings

一个列表,其错误将被显示为警告的检查项。例如:'IsPrivilegedUser,Swap'。值 'all' 忽略所有检查项的错误。

--node-name string

指定节点名称。

--patches string

指向包含名为“target[suffix][+patchtype].extension”的文件(例如,“kube-apiserver0+merge.yaml”或仅“etcd.json”)的目录的路径。“target”可以是“kube-apiserver”、“kube-controller-manager”、“kube-scheduler”、“etcd”、“kubeletconfiguration”、“corednsdeployment”之一。“patchtype”可以是“strategic”、“merge”或“json”之一,它们与 kubectl 支持的补丁格式匹配。 默认“patchtype”为“strategic”。 “extension”必须是“json”或“yaml”。 “suffix”是一个可选字符串,可用于确定首先应用哪些补丁(按字母数字顺序)。

--skip-phases strings

要跳过的阶段列表

--tls-bootstrap-token string

指定用于在加入节点时临时与 Kubernetes 控制平面进行身份验证的令牌。

--token string

当未提供这些值时,将此令牌用于 discovery-token 和 tls-bootstrap-token。

从父命令继承的选项

--rootfs string

指向“真实”主机根文件系统的路径。这将导致 kubeadm chroot 到提供的路径。

join 工作流程

kubeadm join 引导 Kubernetes 工作节点或控制平面节点并将其添加到集群。 对于工作节点,此操作包括以下步骤

  1. kubeadm 从 API 服务器下载必要的集群信息。 默认情况下,它使用引导令牌和 CA 密钥哈希来验证数据的真实性。 根 CA 也可以通过文件或 URL 直接发现。

  2. 一旦知道了集群信息,kubelet 就可以启动 TLS 引导过程。

    TLS 引导使用共享令牌临时与 Kubernetes API 服务器进行身份验证,以提交证书签名请求 (CSR);默认情况下,控制平面会自动签署此 CSR 请求。

  3. 最后,kubeadm 配置本地 kubelet 以使用分配给节点的明确身份连接到 API 服务器。

对于控制平面节点,执行其他步骤

  1. 下载控制平面节点之间共享的证书(如果用户显式请求)。

  2. 生成控制平面组件清单、证书和 kubeconfig。

  3. 添加新的本地 etcd 成员。

使用 kubeadm 的 join 阶段

Kubeadm 允许您使用 kubeadm join phase 以阶段方式将节点加入集群。

要查看有序的阶段和子阶段列表,您可以调用 kubeadm join --help。 列表将位于帮助屏幕的顶部,并且每个阶段旁边都会有一个描述。 请注意,通过调用 kubeadm join,将按此确切顺序执行所有阶段和子阶段。

某些阶段具有唯一的标志,因此如果您想查看可用选项的列表,请添加 --help,例如

kubeadm join phase kubelet-start --help

kubeadm init phase 命令类似,kubeadm join phase 允许您使用 --skip-phases 标志跳过阶段列表。

例如

sudo kubeadm join --skip-phases=preflight --config=config.yaml
功能状态: Kubernetes v1.22 [beta]

或者,您可以使用 JoinConfiguration 中的 skipPhases 字段。

发现要信任的集群 CA

kubeadm 发现有几种选项,每种选项都有安全权衡。 您环境的最佳方法取决于您如何配置节点以及您对网络和节点生命周期的安全期望。

基于令牌的发现和 CA 引脚

这是 kubeadm 中的默认模式。 在此模式下,kubeadm 下载集群配置(包括根 CA)并使用令牌以及验证根 CA 公钥是否与提供的哈希匹配,并验证 API 服务器证书是否在根 CA 下有效来验证它。

CA 密钥哈希的格式为 sha256:<hex_encoded_hash>。 默认情况下,哈希值打印在 kubeadm init 命令的末尾或在 kubeadm token create --print-join-command 命令的输出中。 它采用标准格式(请参阅 RFC7469),也可以通过第三方工具或配置系统计算得出。 例如,使用 OpenSSL CLI

openssl x509 -pubkey -in /etc/kubernetes/pki/ca.crt | openssl rsa -pubin -outform der 2>/dev/null | openssl dgst -sha256 -hex | sed 's/^.* //'

示例 kubeadm join 命令

对于工作节点

kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef 1.2.3.4:6443

对于控制平面节点

kubeadm join --discovery-token abcdef.1234567890abcdef --discovery-token-ca-cert-hash sha256:1234..cdef --control-plane 1.2.3.4:6443

如果您使用 --upload-certs 调用 kubeadm init 命令,则还可以使用 join 命令和 --certificate-key 将证书复制到此节点。

优点

  • 即使其他工作节点或网络受到损害,也可以引导节点以安全地发现控制平面节点的信任根。

  • 便于手动执行,因为所有必需的信息都适合于单个 kubeadm join 命令。

缺点

  • 通常在配置控制平面节点后才能知道 CA 哈希,这可能会使使用 kubeadm 构建自动化配置工具更加困难。 通过提前生成 CA,您可以解决此限制。

基于令牌的发现,不带 CA 引脚

此模式仅依赖于对称令牌来签署(HMAC-SHA256)建立控制平面信任根的发现信息。 要使用此模式,加入节点必须跳过 CA 公钥的哈希验证,使用 --discovery-token-unsafe-skip-ca-verification。 如果可能,请考虑使用其他模式之一。

示例 kubeadm join 命令

kubeadm join --token abcdef.1234567890abcdef --discovery-token-unsafe-skip-ca-verification 1.2.3.4:6443

优点

  • 仍然可以防止许多网络级攻击。

  • 令牌可以提前生成并与控制平面节点和工作节点共享,然后它们可以并行引导,而无需协调。 这使其可以在许多配置场景中使用。

缺点

  • 如果攻击者能够通过某种漏洞窃取引导令牌,他们可以使用该令牌(以及网络级访问权限)来冒充控制平面节点到其他引导节点。 这在您的环境中可能或可能不是一个合适的权衡。

基于文件或 HTTPS 的发现

这提供了一种建立控制平面节点和引导节点之间信任根的带外方法。如果您正在使用 kubeadm 构建自动化配置,请考虑使用此模式。发现文件的格式是标准的 Kubernetes kubeconfig 文件。

如果发现文件不包含凭据,将使用 TLS 发现令牌。

示例 kubeadm join 命令

  • kubeadm join --discovery-file path/to/file.conf (本地文件)

  • kubeadm join --discovery-file https://url/file.conf (远程 HTTPS URL)

优点

  • 允许引导节点安全地发现控制平面节点的信任根,即使网络或其他工作节点受到损害。

缺点

  • 要求您有某种方法将发现信息从控制平面节点携带到引导节点。如果发现文件包含凭据,您必须将其保密并使用安全通道进行传输。这可能可以通过您的云提供商或配置工具实现。

kubeadm join 中使用自定义 kubelet 凭据

为了允许 kubeadm join 使用预定义的 kubelet 凭据并跳过新节点的客户端 TLS bootstrap 和 CSR 审批

  1. 从集群中具有 /etc/kubernetes/pki/ca.key 的工作控制平面节点执行 kubeadm kubeconfig user --org system:nodes --client-name system:node:$NODE > kubelet.conf$NODE 必须设置为新节点的名称。
  2. 手动修改生成的 kubelet.conf 以调整集群名称和服务器端点,或运行 kubeadm kubeconfig user --config(它接受 InitConfiguration)。

如果您的集群没有 ca.key 文件,则必须在外部签名 kubelet.conf 中嵌入的证书。有关更多信息,请参阅 PKI 证书和要求使用 kubeadm 进行证书管理

  1. 将生成的 kubelet.conf 复制到新节点上的 /etc/kubernetes/kubelet.conf
  2. 在新节点上使用 --ignore-preflight-errors=FileAvailable--etc-kubernetes-kubelet.conf 标志执行 kubeadm join

进一步保护您的安装

kubeadm 的默认设置可能不适用于所有人。本节介绍了如何以牺牲一些可用性的代价来加强 kubeadm 安装。

关闭节点客户端证书的自动批准

默认情况下,启用了 CSR 自动批准器,基本上批准了在使用 Bootstrap Token 进行身份验证时 kubelet 的任何客户端证书请求。如果您不希望集群自动批准 kubelet 客户端证书,可以通过执行此命令将其关闭

kubectl delete clusterrolebinding kubeadm:node-autoapprove-bootstrap

之后,kubeadm join 将阻塞,直到管理员手动批准正在进行的 CSR

  1. 使用 kubectl get csr,您可以查看原始 CSR 处于 Pending 状态。

    kubectl get csr
    

    输出类似于此

    NAME                                                   AGE       REQUESTOR                 CONDITION
    node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ   18s       system:bootstrap:878f07   Pending
    
  2. kubectl certificate approve 允许管理员批准 CSR。此操作告诉证书签名控制器向请求者颁发证书,并带有 CSR 中请求的属性。

    kubectl certificate approve node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ
    

    输出类似于此

    certificatesigningrequest "node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ" approved
    
  3. 这将使 CSR 资源变为 Active 状态。

    kubectl get csr
    

    输出类似于此

    NAME                                                   AGE       REQUESTOR                 CONDITION
    node-csr-c69HXe7aYcqkS1bKmH4faEnHAWxn6i2bHZ2mD04jZyQ   1m        system:bootstrap:878f07   Approved,Issued
    

这强制执行 kubeadm join 仅在运行 kubectl certificate approve 后才能成功的流程。

关闭对 cluster-info ConfigMap 的公共访问

为了实现仅使用令牌作为唯一验证信息的加入流程,默认情况下会公开一个包含一些用于验证控制平面节点身份的数据的 ConfigMap。虽然此 ConfigMap 中没有私有数据,但有些用户可能希望无论如何都将其关闭。这样做将禁用使用 kubeadm join 流程的 --discovery-token 标志的能力。以下是执行此操作的步骤

  • 从 API 服务器获取 cluster-info 文件
kubectl -n kube-public get cm cluster-info -o jsonpath='{.data.kubeconfig}' | tee cluster-info.yaml

输出类似于此

apiVersion: v1
kind: Config
clusters:
- cluster:
    certificate-authority-data: <ca-cert>
    server: https://<ip>:<port>
  name: ""
contexts: []
current-context: ""
preferences: {}
users: []
  • cluster-info.yaml 文件作为参数传递给 kubeadm join --discovery-file

  • 关闭对 cluster-info ConfigMap 的公共访问

kubectl -n kube-public delete rolebinding kubeadm:bootstrap-signer-clusterinfo

这些命令应在 kubeadm init 之后但在 kubeadm join 之前运行。

使用配置文件进行 kubeadm join

可以配置 kubeadm join 使用配置文件而不是命令行标志,并且一些更高级的功能可能仅作为配置文件选项可用。该文件使用 --config 标志传递,并且必须包含 JoinConfiguration 结构。在某些情况下,将 --config 与其他标志混合使用可能不允许。

可以使用 kubeadm config print 命令打印默认配置。

如果您的配置没有使用最新版本,建议您使用 kubeadm config migrate 命令进行迁移。

有关配置字段和用法的更多信息,您可以导航到我们的 API 参考

接下来

  • kubeadm init 用于引导 Kubernetes 控制平面节点。
  • kubeadm token 用于管理 kubeadm join 的令牌。
  • kubeadm reset 用于撤消 kubeadm initkubeadm join 对此主机所做的任何更改。
最后修改时间:2025 年 4 月 18 日上午 10:04 PST:修复 kubeadm-join.md 中的拼写错误 (36b4c70304)