kubeadm 配置 (v1beta3)
概述
包 v1beta3 定义了 kubeadm 配置文件格式的 v1beta3 版本。此版本通过修复一些小问题并添加一些新字段来改进 v1beta2 格式。
自 v1beta2 以来更改的列表
- 已弃用的“ClusterConfiguration.useHyperKubeImage”字段已删除。Kubeadm 不再支持 hyperkube 镜像。
- 已删除“ClusterConfiguration.DNS.Type”字段,因为 CoreDNS 是 kubeadm 支持的唯一 DNS 服务器类型。
- 在包含密钥的字段上包含“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 组移到一个新的组“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 配置文件中定义的一些配置选项也作为命令行标志可用,但只有最常见/简单的用例支持这种方法。
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
标志和kube-proxy上的clusterCIDR
)。
用户始终允许覆盖默认值,唯一的例外是与安全相关的设置子集(例如,在 api 服务器上强制执行授权模式节点和 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 的情况下,是引导令牌的配置以及在执行 kubeadm 的节点上特有的所有设置,包括
NodeRegistration,它包含与将新节点注册到集群相关的字段;使用它来自定义节点名称、要使用的 CRI 套接字或仅适用于此节点的任何其他设置(例如,节点 IP)。
LocalAPIEndpoint,它表示要在此节点上部署的 API 服务器实例的端点;使用它(例如)来自定义 API 服务器的广告地址。
apiVersion: kubeadm.k8s.io/v1beta3 kind: ClusterConfiguration networking: ... etcd: ... apiServer: extraArgs: ... extraVolumes: ... ...
ClusterConfiguration 类型应用于配置集群范围的设置,包括以下设置
networking
,它包含有关集群网络拓扑的配置;使用它(例如)来自定义 Pod 子网或服务子网。etcd
:使用它(例如)来自定义本地 etcd 或配置 API 服务器以使用外部 etcd 集群。kube-apiserver、kube-scheduler、kube-controller-manager 配置;使用它通过添加自定义设置或覆盖 kubeadm 默认设置来自定义控制平面组件。
apiVersion: kubeproxy.config.k8s.io/v1alpha1 kind: KubeProxyConfiguration ...
KubeProxyConfiguration 类型应用于更改传递给集群中部署的 kube-proxy 实例的配置。如果此对象未提供或仅部分提供,kubeadm 将应用默认值。
有关 kube-proxy 的官方文档,请参见 https://kubernetes.ac.cn/docs/reference/command-line-tools-reference/kube-proxy/ 或 https://pkg.go.dev/k8s.io/kube-proxy/config/v1alpha1#KubeProxyConfiguration。
apiVersion: kubelet.config.k8s.io/v1beta1 kind: KubeletConfiguration ...
KubeletConfiguration 类型应用于更改将传递给集群中部署的所有 kubelet 实例的配置。如果此对象未提供或仅部分提供,kubeadm 将应用默认值。
有关 kubelet 的官方文档,请参见 https://kubernetes.ac.cn/docs/reference/command-line-tools-reference/kubelet/ 或 https://pkg.go.dev/k8s.io/kubelet/config/v1beta1#KubeletConfiguration。
以下是一个完全填充的单个 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 套接字或仅适用于此节点的任何其他设置(例如,节点 IP)。apiEndpoint
,它表示最终要在此节点上部署的 API 服务器实例的端点。
资源类型
BootstrapToken
出现于
BootstrapToken 描述一个引导令牌,存储在集群中的 Secret 中
字段 | 描述 |
---|---|
token [Required]BootstrapTokenString |
|
description string |
|
ttl meta/v1.Duration |
|
expires meta/v1.Time |
|
usages []string |
|
groups []string |
|
BootstrapTokenString
出现于
BootstrapTokenString 是格式为abcdef.abcdef0123456789
的令牌,用于验证从加入节点的角度来看 API 服务器的实用性,以及作为“kubeadm join”引导阶段中节点的身份验证方法。此令牌是短期的,也应该是短期的。
字段 | 描述 |
---|---|
- [Required]string | 未提供描述。 |
- [Required]string | 未提供描述。 |
ClusterConfiguration
ClusterConfiguration 包含 kubeadm 集群的集群范围配置。
字段 | 描述 |
---|---|
apiVersion string | kubeadm.k8s.io/v1beta3 |
kind string | ClusterConfiguration |
etcd Etcd |
|
networking 网络 |
|
kubernetesVersion string |
|
controlPlaneEndpoint string |
|
apiServer APIServer |
|
controllerManager ControlPlaneComponent |
|
scheduler ControlPlaneComponent |
|
dns DNS |
|
certificatesDir string |
|
imageRepository string |
|
featureGates map[string]bool |
|
clusterName string | 集群名称。 |
InitConfiguration
InitConfiguration 包含一个元素列表,该列表是特定于“kubeadm init”的运行时信息。kubeadm init
专用的信息。这些字段仅在第一次运行kubeadm init
时使用。之后,这些字段中的信息将不会上传到kubeadm-config
ConfigMap,例如kubeadm upgrade
使用该 ConfigMap。这些字段必须是 omitempty。
字段 | 描述 |
---|---|
apiVersion string | kubeadm.k8s.io/v1beta3 |
kind string | InitConfiguration |
bootstrapTokens []BootstrapToken |
|
节点注册 NodeRegistrationOptions |
|
本地 API 端点 APIEndpoint |
|
证书密钥 string |
|
跳过阶段 []string |
|
补丁 Patches |
|
JoinConfiguration
JoinConfiguration 包含描述特定节点的元素。
字段 | 描述 |
---|---|
apiVersion string | kubeadm.k8s.io/v1beta3 |
kind string | JoinConfiguration |
节点注册 NodeRegistrationOptions |
|
caCertPath string |
|
discovery [必需]Discovery |
|
控制平面 JoinControlPlane |
|
跳过阶段 []string |
|
补丁 Patches |
|
APIEndpoint
出现于
APIEndpoint 结构体包含在节点上部署的 API 服务器实例的元素。
字段 | 描述 |
---|---|
公告地址 string |
|
绑定端口 int32 |
|
APIServer
出现于
APIServer 包含集群中 API 服务器部署所需的设置
字段 | 描述 |
---|---|
ControlPlaneComponent [必需]ControlPlaneComponent | (ControlPlaneComponent 的成员嵌入到此类型中。) 未提供描述。 |
certSANs []string |
|
控制平面超时 meta/v1.Duration |
|
BootstrapTokenDiscovery
出现于
BootstrapTokenDiscovery 用于设置基于引导令牌的发现的选项。
字段 | 描述 |
---|---|
token [Required]string |
|
apiServerEndpoint string |
|
caCertHashes []string |
|
unsafeSkipCAVerification bool |
|
ControlPlaneComponent
出现于
ControlPlaneComponent 包含集群控制平面组件的通用设置
字段 | 描述 |
---|---|
额外参数 map[string]string |
|
额外卷 []HostPathMount |
|
DNS
出现于
DNS 定义了集群中应该使用的 DNS 附加组件
字段 | 描述 |
---|---|
ImageMeta [必需]ImageMeta | (ImageMeta 的成员嵌入到此类型中。)
|
Discovery
出现于
Discovery 指定 kubelet 在 TLS 引导过程中使用的选项。
字段 | 描述 |
---|---|
bootstrapToken BootstrapTokenDiscovery |
|
文件 FileDiscovery |
|
tlsBootstrapToken string |
|
超时 meta/v1.Duration |
|
Etcd
出现于
Etcd 包含描述 Etcd 配置的元素。
字段 | 描述 |
---|---|
本地 LocalEtcd |
|
外部 ExternalEtcd |
|
ExternalEtcd
出现于
ExternalEtcd 描述了一个外部 etcd 集群。 Kubeadm 不知道证书文件在哪里,必须提供它们。
字段 | 描述 |
---|---|
endpoints [必需][]string |
|
caFile [必需]string |
|
certFile [必需]string |
|
keyFile [必需]string |
|
FileDiscovery
出现于
FileDiscovery 用于指定一个文件或 URL 到一个 kubeconfig 文件,从中加载集群信息。
字段 | 描述 |
---|---|
kubeConfigPath [必需]string |
|
HostPathMount
出现于
HostPathMount 包含描述从主机挂载的卷的元素。
字段 | 描述 |
---|---|
name [必需]string |
|
hostPath [必需]string |
|
mountPath [必需]string |
|
只读 bool |
|
pathType core/v1.HostPathType |
|
ImageMeta
出现于
ImageMeta 允许自定义用于未来自 Kubernetes/Kubernetes 发布过程的组件的镜像
字段 | 描述 |
---|---|
imageRepository string |
|
imageTag string |
|
JoinControlPlane
出现于
JoinControlPlane 包含描述要部署在加入节点上的额外控制平面实例的元素。
字段 | 描述 |
---|---|
本地 API 端点 APIEndpoint |
|
证书密钥 string |
|
LocalEtcd
出现于
LocalEtcd 描述了 kubeadm 应该在本地运行一个 etcd 集群。
字段 | 描述 |
---|---|
ImageMeta [必需]ImageMeta | (ImageMeta 的成员嵌入到此类型中。)ImageMeta 允许自定义用于 etcd 的容器。 |
dataDir [必需]string |
|
额外参数 map[string]string |
|
serverCertSANs []string |
|
peerCertSANs []string |
|
网络
出现于
Networking 包含描述集群网络配置的元素。
字段 | 描述 |
---|---|
serviceSubnet string |
|
podSubnet string |
|
dnsDomain string |
|
NodeRegistrationOptions
出现于
NodeRegistrationOptions 包含与通过 kubeadm init
或 kubeadm join
将新的控制平面或节点注册到集群相关的字段。
字段 | 描述 |
---|---|
名字 string |
|
criSocket string |
|
taints [必需][]core/v1.Taint |
|
kubeletExtraArgs map[string]string |
|
ignorePreflightErrors []string |
|
imagePullPolicy core/v1.PullPolicy |
|
Patches
出现于
Patches 包含与将补丁应用于 kubeadm 部署的组件相关的选项。
字段 | 描述 |
---|---|
directory string |
|
此页面是自动生成的。
如果您要报告此页面的问题,请在问题描述中提及该页面是自动生成的。修复可能需要在 Kubernetes 项目中的其他地方进行。