配置文件详解

kind 集群配置

Kind 提供了丰富的配置选项,有集群级别的,也有节点级别的。Kind 缺省使用 kubeadm 创建和配置 Kubernetes 集群,通过 Kubeadm Config Patches 机制提供了针对 Kubeadm 的各种配置。Kind 配置详情可参考其官方文档:Configuration。

一般的开源项目或工具,都会在项目仓库中,存放一个示例配置文件,但是 kind 仓库没有。所以这里我阅读了 Configuration 文档后,将所有的配置项,整理到一个配置文件中,并给你解释每个配置项的作用,所有的配置项内容及释义如下:

# 提示:本 Kind 集群配置,可在 kind v0.19.0 版本下正常工作
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
# Kind 集群名字
name: onex
featureGates:
  # 开启 CSIMigration 特性。这个特性在 Kubernetes 开发课程中,用不到
  # Kubernetes 支持的所有 FeatureGate 请参考 https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/
  # "CSIMigration": true
# 用来配置 kube-apiserver 启动参数。所有的启动参数可参考 https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/
runtimeConfig:
  "api/alpha": "false"
networking:
  # 绑定到宿主机上的地址,如果需要外部访问请设置为宿主机 IP
  # 注意:这里需要设置为你的宿主机 IP 地址
  apiServerAddress: 10.37.83.200
  # 绑定到宿主机上的端口,如果建多个集群或者宿主机已经占用需要修改为不同的端口
  apiServerPort: 16443
  # 设置 Pod 子网
  # 默认情况下,kind 对 IPv4 使用 10.244.0.0/16 pod 子网,对 IPv6 使用 fd00:10:244::/56 pod 子网。
  podSubnet: "10.244.0.0/16"
  # 设置 Kubernetes Service 子网
  # 默认情况下,kind 对 IPv4 使用 10.96.0.0/16 服务子网,对 IPv6 使用 fd00:10:96::/112 服务子网。
  serviceSubnet: "10.96.0.0/12"
  # 设置集群网络模式为双栈,ipFamily 可用取值为 dual, ipv6, ipv4
  ipFamily: dual
  # 是否使用默认的 CNI 插件 kindnet
  # 你可以禁用默认的 CNI 插件,安装自己的 CNI 插件,这里我们使用默认的 CNI 插件
  disableDefaultCNI: false
  # kube-proxy 使用的网络模式,none 表示不需要 kube-proxy 组件
  kubeProxyMode: "ipvs"
# kubeadm 配置设置,以 Patch 方式来设置
# 可以设置 InitConfiguration, ClusterConfiguration, KubeProxyConfiguration, KubeletConfiguration
# 详细的 kubeadm 配置见:https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/control-plane-flags/
kubeadmConfigPatches:
- |
  kind: ClusterConfiguration
  networking:
    dnsDomain: "onex.io"
- |
  apiVersion: kubelet.config.k8s.io/v1beta1
  kind: KubeletConfiguration
  # 开启 imageGC,防止磁盘空间被 image 占满
  # imageGCHighThresholdPercent: 80 # NOTICE: 该选项慎开启,可能导致创建多 worker 节点的集群失败
  #evictionHard: # 不要打开,否则 nodes 可能 NotReady
  #nodefs.available: "0%"
  #nodefs.inodesFree: "0%"
  #imagefs.available: "90%"
nodes:
  # master 节点列表。一个列表元素,代表一个 Kubernetes 节点
- role: control-plane
  # 自定义节点使用的镜像及版本
  image: kindest/node:v1.28.0@sha256:dad5a6238c5e41d7cac405fae3b5eda2ad1de6f1190fa8bfc64ff5bb86173213
  kubeadmConfigPatches:
  - |
    kind: ClusterConfiguration
    apiServer:
        extraArgs:
          # 自动创建命名空间
          enable-admission-plugins: NamespaceAutoProvision,NamespaceExists,NamespaceLifecycle
  # 宿主机和节点文件共享挂载
  extraMounts:
    # 宿主机目录
  - hostPath: /kind/onex
    # 节点数据目录
    containerPath: /data
    # 是否以只读方式挂载
    readOnly: false
    # 是否重新生成 SELinux 标签
    selinuxRelabel: false
    propagation: HostToContainer
    # 节点端口到宿主机端口映射
  extraPortMappings:
    # 节点端口 nodeport
  - containerPort: 32080 # 对应到 traefik web.nodePort
    # 宿主机端口
    hostPort: 18080
    # 宿主机端口监听地址,需要外部访问设置为"0.0.0.0"
    listenAddress: "0.0.0.0"
    # 通信协议
    protocol: TCP
  - containerPort: 32443 # 对应到 traefik websecure.nodePort
    hostPort: 18443
    listenAddress: "0.0.0.0"
    protocol: TCP
 # worker 节点,配置同 master 节点
- role: worker
  labels:
    # 设置节点标签
    nodePool: onex
  image: kindest/node:v1.28.0@sha256:dad5a6238c5e41d7cac405fae3b5eda2ad1de6f1190fa8bfc64ff5bb86173213
- role: worker
  image: kindest/node:v1.28.0@sha256:dad5a6238c5e41d7cac405fae3b5eda2ad1de6f1190fa8bfc64ff5bb86173213
- role: worker
  image: kindest/node:v1.28.0@sha256:dad5a6238c5e41d7cac405fae3b5eda2ad1de6f1190fa8bfc64ff5bb86173213

上面是 Kind 支持的几乎全部的配置,其中有一些配置项可以满足一些重要的、常见的功能需求,接下来,我再给你讲解下。

端口映射

在测试、开发的过程中,我们在 Kinud 集群中部署了一个 Deployment,并为该 Deployment 创建了一个 NodePort 类型的 Service,但是我们发现,在宿主机上无法访问 Service 中配置的 nodePort 端口,进而访问 Pod 端口。这是因为:Service 中配置的 nodePort 是监听在 Kubernetes 节点容器上的,而非宿主机。

Kind 支持 extraPortMappings 配置项,用来将宿主机的端口映射到 Kubernetes 节点容器上的某个端口,可以通过 extraPortMappings 配置,来实现宿主机访问 Kubernetes 节点容器端口,进而访问 Kubernetes Pod 端口的目的。具体配置如下:

  extraPortMappings:
    # 节点端口 nodeport
  - containerPort: 32080 # 对应到 traefik web.nodePort
    # 宿主机端口
    hostPort: 18080
    # 宿主机端口监听地址,需要外部访问设置为"0.0.0.0"
    listenAddress: "0.0.0.0"
    # 通信协议
    protocol: TCP
  - containerPort: 32443 # 对应到 traefik websecure.nodePort
    hostPort: 18443
    listenAddress: "0.0.0.0"
    protocol: TCP

暴露 kube-apiserver

在测试、开发的过程中, 有时候我们可能想在 B 机器上访问 A 机器上的 Kind 集群,这时候,你会发现访问不通。这是因为,默认情况下,Kind 集群的 kube-apiserver 是监听在 A 机器上的 lo网络设备上的,并且监听端口也是随机的。如果你想从 B 机器上访问,就需要使 Kind 集群的 kube-apiserver 监听在可访问网络设备的(例如:eth0)的某个端口上。

Kind 提供了apiServerAddress和apiServerPort 来满足此种场景的需求。具体配置如下:

networking:
  # 绑定到宿主机上的地址,如果需要外部访问请设置为宿主机 IP
  # 注意:这里需要设置为你的宿主机 IP 地址
  apiServerAddress: 10.37.83.200
  # 绑定到宿主机上的端口,如果建多个集群或者宿主机已经占用需要修改为不同的端口
  apiServerPort: 16443

启用 Feature Gates

Kubernetes 支持 Feature Gates,我们可以开启或关闭 Feature Gates 来开启或关闭某些功能。Kind 也提供了开启或关闭 Feature Gates 功能的配置,具体配置如下:

featureGates: 
  # 开启 CSIMigration 特性。这个特性在 Kubernetes 开发课程中,用不到
  # Kubernetes 支持的所有 FeatureGate 请参考 https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/
  # "CSIMigration": true