Skip to content

README_zh-CN.md

Latest commit

 

History

History
179 lines (138 loc) · 7.13 KB

README_zh-CN.md

File metadata and controls

179 lines (138 loc) · 7.13 KB

CI

English | 中文

👋 欢迎使用KubeKey!

KubeKey 是一个开源的轻量的任务流程执行工具。提供了一种灵活、快速的方式来安装kubernetes。

KubeKey 通过了 CNCF kubernetes 一致性认证

对比3.x新特性

  1. 从kubernetes生命周期管理工具扩展为任务执行工具(流程设计参考Ansible)
  2. 支持多种方式管理任务模版：git，本地等。
  3. 支持多种节点连接方式。包括：local、ssh、kubernetes、prometheus。
  4. 支持云原生方式自动化批量任务管理
  5. 高级特性：UI页面（暂未开放）

安装kubekey

kubernetes中安装

通过helm安装kubekey。

helm upgrade --install --create-namespace -n kubekey-system kubekey config/kubekey

二进制

在 release 页面获取对应的二进制文件。

包含UI页面的kubekey

UI 页面仅在 v4.0.0 及以上版本提供支持

前提： hack/downloadKubekey.sh 默认会下载 web-installer，除非设置 export SKIP_WEB_INSTALLER=true。

export SKIP_WEB_INSTALLER=false
KKZONE=cn curl -sfL https://get-kk.kubesphere.io | sh -
# run with UI
kk web --schema-path schema --ui-path dist

使用 config.yaml 构建离线包

执行 hack/downloadKubekey.sh 结束后，视版本与参数可能在当前目录生成 package.sh。将 config.yaml 放在该目录下，执行 ./package.sh config.yaml 即可构建离线制品包。需要生成或补全 config.yaml（含镜像列表等）时，可使用在线工具 KubeSphere Images。

部署kubernetes

  • 支持部署环境：Linux发行版

    • almaLinux: 9.0 (未充分测试)
    • centOS: 8
    • debian: 10, 11
    • kylin: V10SP3 (未充分测试)
    • ubuntu: 18.04, 20.04, 22.04, 24.04.

  • 支持的Kubernetes版本：v1.23.x ~ v1.34.x

requirement

  • 一台或多台运行兼容 deb/rpm 的 Linux 操作系统的计算机；例如：Ubuntu 或 CentOS。
  • 每台机器 2 GB 以上的内存，内存不足时应用会受限制。
  • 用作控制平面节点的计算机上至少有 2 个 CPU。
  • 集群中所有计算机之间具有完全的网络连接。你可以使用公共网络或专用网络

定义节点信息

kubekey使用 inventory 资源来定义节点的连接信息。
可使用 kk create inventory 来获取默认的inventory.yaml 资源。默认的inventory.yaml配置如下：

apiVersion: kubekey.kubesphere.io/v1
kind: Inventory
metadata:
  name: default
spec:
  hosts: # your can set all nodes here. or set nodes on special groups.
#    node1:
#      connector:
#        type: ssh
#        host: node1
#        port: 22
#        user: root
#        password: 123456
  groups:
    # all kubernetes nodes.
    k8s_cluster:
      groups:
        - kube_control_plane
        - kube_worker
    # control_plane nodes
    kube_control_plane:
      hosts:
        - localhost
    # worker nodes
    kube_worker:
      hosts:
        - localhost
    # etcd nodes when etcd_deployment_type is external
    etcd:
      hosts:
        - localhost
#    image_registry:
#      hosts:
#        - localhost
    # nfs nodes for registry storage. and kubernetes nfs storage
#    nfs:
#      hosts:
#        - localhost

inventory包含如下几个内置的group:

  1. k8s_cluster: kubernetes集群。包含两个子group: kube_control_plane, kube_worker
  2. kube_control_plane: kubernetes集群中的control_plane节点组
  3. kube_worker: kubernetes集群中的worker节点组。
  4. etcd: 安装etcd集群的节点组。
  5. image_registry: 安装镜像仓库的节点组。（包含harbor，registry）
  6. nfs: 安装nfs的节点组。

定义关键配置信息

kubekey使用 config 资源来定义节点的连接信息。
可使用 kk create config --with-kubernetes v1.33.1 来获取默认的inventory.yaml 资源。默认的config.yaml配置如下：

针对不同的kubernetes版本，给出了不同默认config配置作为参考:

安装集群

创建集群有 两种方式：Web 页面 或 命令行。环境与 inventory / config 的含义见上文各节。

方式一：Web（页面）

需要 KubeKey v4.0.0 及以上 且带 Web 安装包。获取方式见上文 安装 kubekey 中的 包含UI页面的kubekey，启动例如：

kk web --schema-path schema --ui-path dist

在浏览器中维护节点与配置，并按界面流程执行创建集群（对应 playbook playbooks/create_cluster.yaml）。

方式二：命令行

准备好 inventory.yaml 与 config.yaml 后，执行内置子命令 kk create cluster，会自动运行 playbooks/create_cluster.yaml，无需再单独指定 playbook 路径。

kk create cluster -i inventory.yaml -c config.yaml

-i inventory.yaml不传时，使用默认的inventory.yaml. 只会在执行的机器上安装kubernetes. -c config.yaml不传时，使用默认的config.yaml. 安装 v1.34.1 版本的kubernetes

常用参数：

  • --workdir：KubeKey 工作目录（默认：<当前目录>/kubekey）。
  • --with-kubernetes：Kubernetes 版本（例如 v1.33.1），在 config.yaml 未指定版本时使用。
  • -a / --artifact：离线制品包路径（.tgz）；指定后通常会关闭在线拉取依赖。
  • --set：覆盖配置项，例如 --set download.fetch=false，具体嵌套键以 KubeKey 支持的 --set 语法为准。
  • -n / --namespace：本地运行时与 playbook 关联资源的命名空间。

离线安装示例：

kk create cluster -i inventory.yaml -c config.yaml --workdir ./kubekey --artifact /path/to/kubekey-artifact.tgz

文档

自定义 任务
Kubernetes 任务