History

liujian 192af7bb7e feat: add Chinese README and documentation updates (#2791 ) - Introduced a new Chinese version of the README file (README_zh-CN.md) to enhance accessibility for Chinese-speaking users. - Updated the English README to reflect new features and installation instructions. - Added detailed documentation for project structure, playbooks, roles, tasks, and modules to improve user understanding and usability. Signed-off-by: [Your Name] <[Your Email]> Signed-off-by: redscholar <blacktiledhouse@gmail.com>		2025-09-30 10:00:07 +08:00
..
README.md	docs: builtin docs (#2626 )	2025-06-18 09:29:32 +00:00
architecture.md	feat: add Chinese README and documentation updates (#2791 )	2025-09-30 10:00:07 +08:00
image_registry.md	feat: add role dependency in builtin playbook (#2653 )	2025-07-09 16:10:18 +08:00

README.md

kubernetes cluster manager

内建的playbook实现了kubernetes的一整套生命周期管理，包含创建集群，删除集群，添加节点，删除节点，升级集群等。

requirement

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

构建inventory

默认的inventory配置如下：

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:

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

构建config

默认的 config 配置如下：

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

安装集群

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

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