kubeadm join

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

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

Synopsis

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

有两种主要的发现方案。第一种是使用共享令牌和 API 服务器的 IP 地址。第二种是提供一个文件——这是标准 kubeconfig 文件的一个子集。发现/kubeconfig 文件支持 token、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”。哈希值根据主体公钥信息 (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` 标志传递。

通常,发现和 TLS 引导使用相同的令牌。在这种情况下,可以使用 `--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     Wait for the control plane to start
kubeadm join [api-server-endpoint] [flags]

Options

--apiserver-advertise-address string

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

--apiserver-bind-port int32     Default: 6443

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

--certificate-key string

使用此密钥解密由 init 上传的证书。证书密钥是 AES 密钥(32 字节),以十六进制编码的字符串表示。

--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”的文件的目录路径。“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

您也可以使用 --certificate-key 调用 join 来为一个控制平面节点复制证书,前提是 kubeadm init 命令是用 --upload-certs 调用的。

优点

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

  • 易于手动执行,因为所需的所有信息都包含在单个 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 自动批准器,它会批准在使用 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:Fix typo in kubeadm-join.md (36b4c70304)