kubeadm 配置 (v1beta3)

概述

Package v1beta3 定义了 kubeadm 配置文件的 v1beta3 版本格式。此版本通过修复一些小问题和增加一些新字段改进了 v1beta2 格式。

自 v1beta2 以来的变更列表

• 已弃用的 "ClusterConfiguration.useHyperKubeImage" 字段已被移除。Kubeadm 不再支持 hyperkube 镜像。
• 已移除 "ClusterConfiguration.dns.type" 字段，因为 CoreDNS 是 kubeadm 唯一支持的 DNS 服务器类型。
• 在保存 Secrets 的字段上包含 "datapolicy" 标签。这样当使用 klog 打印 API 结构时，这些字段值将被省略。
• 增加 "InitConfiguration.skipPhases" 和 "JoinConfiguration.skipPhases"，以允许在执行 kubeadm init/join 命令期间跳过阶段列表。
• 增加 "InitConfiguration.nodeRegistration.imagePullPolicy" 和 "JoinConfiguration.nodeRegistration.imagePullPolicy"，以允许在 kubeadm "init" 和 "join" 期间指定镜像拉取策略。值必须是 "Always"、"Never" 或 "IfNotPresent" 之一。"IfNotPresent" 是默认值，这在增加此字段之前就是现有行为。
• 增加 "InitConfiguration.patches.directory" 和 "JoinConfiguration.patches.directory"，以允许用户配置一个目录，用于存放对 kubeadm 部署的组件应用的补丁。
• 将 BootstrapToken* API 和相关工具从 "kubeadm" API Group 移至新的 Group "bootstraptoken"。kubeadm API v1beta3 版本不再包含 BootstrapToken* 结构体。

从旧版 kubeadm 配置迁移

• kubeadm v1.15.x 及更新版本可用于从 v1beta1 迁移到 v1beta2。
• kubeadm v1.22.x 及更新版本不再支持 v1beta1 和更旧的 API，但可用于将 v1beta2 迁移到 v1beta3。
• kubeadm v1.27.x 及更新版本不再支持 v1beta2 和更旧的 API，

基础知识

配置 kubeadm 的首选方式是使用 --config 选项传递 YAML 配置文件。kubeadm 配置文件中定义的一些配置选项也可以通过命令行 Flag 提供，但此方法仅支持最常用/简单的用例。

一个 kubeadm 配置文件可以包含多种配置类型，使用三个破折号 (---) 分隔。

kubeadm 支持以下配置类型

apiVersion: kubeadm.k8s.io/v1beta3
kind: InitConfiguration

apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration

apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration

apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration

apiVersion: kubeadm.k8s.io/v1beta3
kind: JoinConfiguration

要打印 "init" 和 "join" 操作的默认值，请使用以下命令

kubeadm config print init-defaults
kubeadm config print join-defaults

配置文件中必须包含的配置类型列表取决于你正在执行的操作（init 或 join）以及你将使用的配置选项（默认或高级自定义）。

如果未提供某些配置类型，或仅提供了部分，kubeadm 将使用默认值；kubeadm 提供的默认值还包括在需要时强制执行组件之间值的一致性（例如，控制器管理器上的 --cluster-cidr Flag 和 kube-proxy 上的 clusterCIDR）。

用户始终可以覆盖默认值，唯一例外是与安全性相关的一小部分设置（例如，强制在 api server 上使用 authorization-mode Node 和 RBAC）。

如果用户提供了与你正在执行的操作不符的配置类型，kubeadm 将忽略这些类型并打印警告。

Kubeadm init 配置类型

使用 --config 选项执行 kubeadm init 时，可以使用以下配置类型：InitConfiguration、ClusterConfiguration、KubeProxyConfiguration、KubeletConfiguration，但 InitConfiguration 和 ClusterConfiguration 中只有一个是必需的。

apiVersion: kubeadm.k8s.io/v1beta3
kind: InitConfiguration
bootstrapTokens:
  ...
nodeRegistration:
  ...

InitConfiguration 类型应用于配置运行时设置，在 kubeadm init 的情况下，这些设置是引导 Token 的配置以及所有特定于执行 kubeadm 的节点上的设置，包括

• NodeRegistration：包含与将新节点注册到集群相关的字段；使用它自定义节点名称、要使用的 CRI Socket 或任何其他仅应应用于此节点的设置（例如，节点 IP）。

• LocalAPIEndpoint：表示将部署在此节点上的 API server 实例的端点；使用它来自定义 API server 通告地址等。

apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration
networking:
  ...
etcd:
  ...
apiServer:
  extraArgs:
    ...
  extraVolumes:
    ...
...

ClusterConfiguration 类型应用于配置集群范围的设置，包括以下设置

• networking：包含集群网络拓扑的配置；使用它来自定义 Pod 子网或服务子网等。

• etcd：使用它来自定义本地 etcd 或配置 API server 以使用外部 etcd 集群。

• kube-apiserver、kube-scheduler、kube-controller-manager 配置；使用它通过添加自定义设置或覆盖 kubeadm 默认设置来定制控制平面组件。

apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
  ...

KubeProxyConfiguration 类型应用于更改传递给部署在集群中的 kube-proxy 实例的配置。如果未提供此对象或仅提供了部分，则 kubeadm 应用默认值。

请参阅 https://kubernetes.ac.cn/docs/reference/command-line-tools-reference/kube-proxy/ 或 https://pkg.go.dev/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration 获取 kube-proxy 官方文档。

apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
  ...

KubeletConfiguration 类型应用于更改将传递给部署在集群中所有 kubelet 实例的配置。如果未提供此对象或仅提供了部分，则 kubeadm 应用默认值。

请参阅 https://kubernetes.ac.cn/docs/reference/command-line-tools-reference/kubelet/ 或 https://pkg.go.dev/k8s.io/kubelet/config/v1beta1#KubeletConfiguration 获取 kubelet 官方文档。

这是一个包含多个配置类型且完全填充的单个 YAML 文件示例，可在 kubeadm init 运行期间使用。

apiVersion: kubeadm.k8s.io/v1beta3
kind: InitConfiguration
bootstrapTokens:
  - token: "9a08jv.c0izixklcxtmnze7"
    description: "kubeadm bootstrap token"
    ttl: "24h"
  - token: "783bde.3f89s0fje9f38fhf"
    description: "another bootstrap token"
    usages:
      - authentication
      - signing
    groups:
      - system:bootstrappers:kubeadm:default-node-token
nodeRegistration:
  name: "ec2-10-100-0-1"
  criSocket: "/var/run/dockershim.sock"
  taints:
    - key: "kubeadmNode"
      value: "someValue"
      effect: "NoSchedule"
  kubeletExtraArgs:
    v: 4
  ignorePreflightErrors:
    - IsPrivilegedUser
  imagePullPolicy: "IfNotPresent"
localAPIEndpoint:
  advertiseAddress: "10.100.0.1"
  bindPort: 6443
certificateKey: "e6a2eb8581237ab72a4f494f30285ec12a9694d750b9785706a83bfcbbbd2204"
skipPhases:
  - addon/kube-proxy
---
apiVersion: kubeadm.k8s.io/v1beta3
kind: ClusterConfiguration
etcd:
  # one of local or external
  local:
    imageRepository: "registry.k8s.io"
    imageTag: "3.2.24"
    dataDir: "/var/lib/etcd"
    extraArgs:
      listen-client-urls: "http://10.100.0.1:2379"
    serverCertSANs:
      -  "ec2-10-100-0-1.compute-1.amazonaws.com"
    peerCertSANs:
      - "10.100.0.1"
  # external:
    # endpoints:
    # - "10.100.0.1:2379"
    # - "10.100.0.2:2379"
    # caFile: "/etcd/kubernetes/pki/etcd/etcd-ca.crt"
    # certFile: "/etcd/kubernetes/pki/etcd/etcd.crt"
    # keyFile: "/etcd/kubernetes/pki/etcd/etcd.key"
networking:
  serviceSubnet: "10.96.0.0/16"
  podSubnet: "10.244.0.0/24"
  dnsDomain: "cluster.local"
kubernetesVersion: "v1.21.0"
controlPlaneEndpoint: "10.100.0.1:6443"
apiServer:
  extraArgs:
    authorization-mode: "Node,RBAC"
  extraVolumes:
    - name: "some-volume"
      hostPath: "/etc/some-path"
      mountPath: "/etc/some-pod-path"
      readOnly: false
      pathType: File
  certSANs:
    - "10.100.1.1"
    - "ec2-10-100-0-1.compute-1.amazonaws.com"
  timeoutForControlPlane: 4m0s
controllerManager:
  extraArgs:
    "node-cidr-mask-size": "20"
  extraVolumes:
    - name: "some-volume"
      hostPath: "/etc/some-path"
      mountPath: "/etc/some-pod-path"
      readOnly: false
      pathType: File
scheduler:
  extraArgs:
    bind-address: "10.100.0.1"
  extraVolumes:
    - name: "some-volume"
      hostPath: "/etc/some-path"
      mountPath: "/etc/some-pod-path"
      readOnly: false
      pathType: File
certificatesDir: "/etc/kubernetes/pki"
imageRepository: "registry.k8s.io"
clusterName: "example-cluster"
---
apiVersion: kubelet.config.k8s.io/v1beta1
kind: KubeletConfiguration
# kubelet specific options here
---
apiVersion: kubeproxy.config.k8s.io/v1alpha1
kind: KubeProxyConfiguration
# kube-proxy specific options here

Kubeadm join 配置类型

使用 --config 选项执行 kubeadm join 时，应提供 JoinConfiguration 类型。

apiVersion: kubeadm.k8s.io/v1beta3
kind: JoinConfiguration
  ...

JoinConfiguration 类型应用于配置运行时设置，在 kubeadm join 的情况下，这些设置是用于访问集群信息的发现方法以及所有特定于执行 kubeadm 的节点上的设置，包括

• nodeRegistration：包含与将新节点注册到集群相关的字段；使用它自定义节点名称、要使用的 CRI Socket 或任何其他仅应应用于此节点的设置（例如，节点 IP）。

• apiEndpoint：表示最终将部署在此节点上的 API server 实例的端点。

资源类型

• ClusterConfiguration
• InitConfiguration
• JoinConfiguration

BootstrapToken

出现在

• InitConfiguration

BootstrapToken 描述一个引导 Token，存储在集群中的一个 Secret 中

BootstrapTokenString

出现在

• BootstrapToken

BootstrapTokenString 是一种格式为 abcdef.abcdef0123456789 的 Token，用于从加入节点的角度验证 API server 的可用性，并作为节点在 "kubeadm join" 引导阶段的身份验证方法。此 Token 是且应为短期有效。

ClusterConfiguration

ClusterConfiguration 包含 kubeadm 集群的集群范围配置。

InitConfiguration

InitConfiguration 包含特定于 "kubeadm init" 运行时的信息列表。kubeadm init 运行时信息。这些字段仅在首次运行 kubeadm init 时使用。之后，字段中的信息不会上传到供 kubeadm upgrade 使用的 kubeadm-config ConfigMap。这些字段必须是 omitempty。

JoinConfiguration

JoinConfiguration 包含描述特定节点的元素。

APIEndpoint

出现在

• InitConfiguration

• JoinControlPlane

APIEndpoint struct 包含部署在节点上的 API server 实例的元素。

APIServer

出现在

• ClusterConfiguration

APIServer 包含集群中 API server 部署所需的设置

BootstrapTokenDiscovery

出现在

• Discovery

BootstrapTokenDiscovery 用于设置基于引导 Token 的发现选项。

ControlPlaneComponent

出现在

• ClusterConfiguration

• APIServer

ControlPlaneComponent 包含集群控制平面组件通用的设置

DNS

出现在

• ClusterConfiguration

DNS 定义了集群中应使用的 DNS 插件

Discovery

出现在

• JoinConfiguration

Discovery 指定 kubelet 在 TLS 引导过程中使用的选项。

Etcd

出现在

• ClusterConfiguration

Etcd 包含描述 Etcd 配置的元素。

ExternalEtcd

出现在

• Etcd

ExternalEtcd 描述一个外部 etcd 集群。Kubeadm 不知道证书文件在哪里，必须提供它们。

FileDiscovery

出现在

• Discovery

FileDiscovery 用于指定 kubeconfig 文件路径或 URL，从中加载集群信息。

HostPathMount

出现在

• ControlPlaneComponent

HostPathMount 包含描述从主机挂载的卷的元素。

ImageMeta

出现在

• DNS

• LocalEtcd

ImageMeta 允许自定义非源自 Kubernetes/Kubernetes 发布流程的组件所使用的镜像

JoinControlPlane

出现在

• JoinConfiguration

JoinControlPlane 包含描述要部署在加入节点上的额外控制平面实例的元素。

LocalEtcd

出现在

• Etcd

LocalEtcd 描述了 kubeadm 应该在本地运行一个 etcd 集群。

网络

出现在

• ClusterConfiguration

Networking 包含描述集群网络配置的元素。

NodeRegistrationOptions

出现在

• InitConfiguration

• JoinConfiguration

NodeRegistrationOptions 包含与通过 kubeadm init 或 kubeadm join 将新的控制平面或节点注册到集群相关的字段。

Patches

出现在

• InitConfiguration

• JoinConfiguration

Patches 包含与对 kubeadm 部署的组件应用补丁相关的选项。