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 引导机制也通过共享令牌驱动。这用于临时使用 Kubernetes 控制平面进行身份验证,以提交本地创建的密钥对的证书签名请求 (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
control-plane-join     Join a machine as a control plane instance
  /etcd                  Add a new local etcd member
  /mark-control-plane    Mark a node as a control-plane
wait-control-plane     EXPERIMENTAL: 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 成员。

将 join 阶段与 kubeadm 一起使用

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 证书固定(CA pinning)的基于令牌的发现

这是 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

如果 kubeadm init 命令使用 --upload-certs 调用,你还可以使用 --certificate-key 为控制平面节点调用 join 以将证书复制到此节点。

优点

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

  • 易于手动执行,因为所需的所有信息都包含在一个 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 引导和 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 自动批准器,它基本上会在使用引导令牌进行身份验证时批准任何 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. 这会将 CRS 资源更改为 Active 状态。

    kubectl get csr
    

    输出类似于这样

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

这强制执行工作流程,即只有在运行 kubectl certificate approve 之后,kubeadm join 才会成功。

关闭对 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 对此主机所做的任何更改。
上次修改时间为 2024 年 10 月 17 日上午 11:29 PST:更新 kubeadm 文档 (12e2d9ba28)