English | 中文
KubeKey是一个开源的轻量级工具，用于部署Kubernetes集群。它提供了一种灵活、快速、方便的方式来安装Kubernetes/K3s、Kubernetes/K3s和KubeSphere，以及相关的云原生附加组件。它也是扩展和升级集群的有效工具。
此外，KubeKey还支持定制离线包（artifact），方便用户在离线环境下快速部署集群。
KubeKey 通过了 CNCF kubernetes 一致性认证。
有三种情况可以使用 KubeKey。
- 仅安装 Kubernetes
- 用一个命令中安装 Kubernetes 和 KubeSphere
- 首先安装 Kubernetes，然后使用 ks-installer 在其上部署 KubeSphere
重要提示：Kubekey 将会帮您安装 Kubernetes，若已有 Kubernetes 集群请参考 在 Kubernetes 之上安装 KubeSphere。
- 基于 Ansible 的安装程序具有大量软件依赖性，例如 Python。KubeKey 是使用 Go 语言开发的，可以消除在各种环境中出现的问题，从而提高安装成功率。
- KubeKey 使用 Kubeadm 在节点上尽可能多地并行安装 K8s 集群，以降低安装复杂性并提高效率。与较早的安装程序相比，它将大大节省安装时间。
- KubeKey 支持将集群从 all-in-one 扩展到多节点集群甚至 HA 集群。
- KubeKey 旨在将集群当作一个对象操作，即 CaaO。
- Ubuntu 16.04, 18.04, 20.04, 22.04
- Debian Bullseye, Buster, Stretch
- CentOS/RHEL 7
- AlmaLinux 9.0
- SUSE Linux Enterprise Server 15
建议使用 Linux Kernel 版本:
4.15 or later可以通过命令uname -srm查看 Linux Kernel 版本。
- v1.19: v1.19.15
- v1.20: v1.20.10
- v1.21: v1.21.14
- v1.22: v1.22.15
- v1.23: v1.23.10 (default)
- v1.24: v1.24.7
- v1.25: v1.25.3
查看更多支持的版本：
Kubernetes 版本
K3s 版本
- 最低资源要求（仅对于最小安装 KubeSphere）：
- 2 核虚拟 CPU
- 4 GB 内存
- 20 GB 储存空间
/var/lib/docker 主要用于存储容器数据，在使用和操作过程中会逐渐增大。对于生产环境，建议 /var/lib/docker 单独挂盘。
- 操作系统要求：
SSH可以访问所有节点。- 所有节点的时间同步。
sudo/curl/openssl应在所有节点使用。docker可以自己安装，也可以通过 KubeKey 安装。Red Hat在其Linux发行版本中包括了SELinux，建议关闭SELinux或者将SELinux的模式切换为Permissive[宽容]工作模式
- 建议您的操作系统环境足够干净 (不安装任何其他软件)，否则可能会发生冲突。
- 如果在从 dockerhub.io 下载镜像时遇到问题，建议准备一个容器镜像仓库 (加速器)。为 Docker 守护程序配置镜像加速。
- 默认情况下，KubeKey 将安装 OpenEBS 来为开发和测试环境配置 LocalPV，这对新用户来说非常方便。对于生产，请使用 NFS/Ceph/GlusterFS 或商业化存储作为持久化存储，并在所有节点中安装相关的客户端 。
- 如果遇到拷贝时报权限问题Permission denied,建议优先考虑查看SELinux的原因。
- 依赖要求:
KubeKey 可以同时安装 Kubernetes 和 KubeSphere。在版本1.18之后，安装kubernetes前需要安装一些依赖。你可以参考下面的列表，提前在你的节点上检查并安装相关依赖。
| Kubernetes 版本 ≥ 1.18 | |
|---|---|
socat |
必须安装 |
conntrack |
必须安装 |
ebtables |
可选，但推荐安装 |
ipset |
可选，但推荐安装 |
ipvsadm |
可选，但推荐安装 |
- 网络和 DNS 要求：
- 确保
/etc/resolv.conf中的 DNS 地址可用。否则，可能会导致集群中出现某些 DNS 问题。 - 如果您的网络配置使用防火墙或安全组，则必须确保基础结构组件可以通过特定端口相互通信。建议您关闭防火墙或遵循链接配置：网络访问。
- 确保
-
使用脚本获取 KubeKey
如果无法访问 https://github.com, 请先执行 export KKZONE=cn.
curl -sfL https://get-kk.kubesphere.io | sh - -
下载KubeKey可执行文件 Releases page
下载解压后可直接使用。
-
从源代码生成二进制文件
git clone https://github.com/kubesphere/kubekey.git cd kubekey make kk
快速入门使用 all-in-one 安装，这是熟悉 KubeSphere 的良好开始。
注意： 由于 Kubernetes 暂不支持大写 NodeName， hostname 中包含大写字母将导致后续安装过程无法正常结束
如果无法访问
https://storage.googleapis.com, 请先执行export KKZONE=cn.
./kk create cluster [--with-kubernetes version] [--with-kubesphere version]-
使用默认版本创建一个纯 Kubernetes 集群
./kk create cluster
-
创建指定一个（支持的版本）的 Kubernetes 集群
./kk create cluster --with-kubernetes v1.19.8
-
创建一个部署了 KubeSphere 的 Kubernetes 集群 （例如
--with-kubesphere v3.1.0）./kk create cluster --with-kubesphere [version]
-
创建一个指定的 container runtime 的 Kubernetes 集群（docker, crio, containerd and isula）
./kk create cluster --container-manager containerd
您可以使用高级安装来控制自定义参数或创建多节点集群。具体来说，通过指定配置文件来创建集群。
如果无法访问
https://storage.googleapis.com, 请先执行export KKZONE=cn.
-
首先，创建一个示例配置文件
./kk create config [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]例子：
-
使用默认配置创建一个示例配置文件。您也可以指定文件名称或文件所在的文件夹。
./kk create config [-f ~/myfolder/config-sample.yaml] -
同时安装 KubeSphere
./kk create config --with-kubesphere
-
-
根据您的环境修改配置文件 config-sample.yaml
注意： 由于 Kubernetes 暂不支持大写 NodeName， worker 节点名中包含大写字母将导致后续安装过程无法正常结束
当指定安装KubeSphere时，要求集群中有可用的持久化存储。默认使用localVolume，如果需要使用其他持久化存储，请参阅 addons 配置。
-
使用配置文件创建集群。
./kk create cluster -f ~/myfolder/config-sample.yaml
默认情况下，Kubekey 将仅安装一个 Solo 模式的单集群，即未开启 Kubernetes 多集群联邦。如果您希望将 KubeSphere 作为一个支持多集群集中管理的中央面板，您需要在 config-example.yaml 中设置 ClusterRole。关于多集群的使用文档，请参考 如何启用多集群。
KubeSphere 从 2.1.0 版本开始对 Installer 的各功能组件进行了解耦，快速安装将默认仅开启最小化安装（Minimal Installation），Installer 支持在安装前或安装后自定义可插拔的功能组件的安装。使最小化安装更快速轻量且资源占用更少，也方便不同用户按需选择安装不同的功能组件。
KubeSphere 有多个可插拔功能组件，功能组件的介绍可参考 配置示例。您可以根据需求，选择开启安装 KubeSphere 的可插拔功能组件。我们非常建议您开启这些功能组件来体验 KubeSphere 完整的功能以及端到端的解决方案。请在安装前确保您的机器有足够的 CPU 与内存资源。开启可插拔功能组件可参考 开启可选功能组件。
将新节点的信息添加到集群配置文件，然后应用更改。
./kk add nodes -f config-sample.yaml通过以下命令删除节点，nodename指需要删除的节点名。
./kk delete node <nodeName> -f config-sample.yaml您可以通过以下命令删除集群：
- 如果您以快速入门（all-in-one）开始：
./kk delete cluster- 如果从高级安装开始（使用配置文件创建的集群）：
./kk delete cluster [-f config-sample.yaml]升级集群到指定版本。
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] --with-kubernetes指定kubernetes目标版本。--with-kubesphere指定kubesphere目标版本。
通过指定配置文件对集群进行升级。
./kk upgrade [--with-kubernetes version] [--with-kubesphere version] [(-f | --filename) path]--with-kubernetes指定kubernetes目标版本。--with-kubesphere指定kubesphere目标版本。-f指定集群安装时创建的配置文件。
注意: 升级多节点集群需要指定配置文件. 如果集群非kubekey创建，或者创建集群时生成的配置文件丢失，需要重新生成配置文件，或使用以下方法生成。
Getting cluster info and generating kubekey's configuration file (optional).
./kk create config [--from-cluster] [(-f | --filename) path] [--kubeconfig path]--from-cluster根据已存在集群信息生成配置文件.-f指定生成配置文件路径.--kubeconfig指定集群kubeconfig文件.- 由于无法全面获取集群配置，生成配置文件后，请根据集群实际信息补全配置文件。
KubeKey 不会启用 kubectl 自动补全功能。请参阅下面的指南并将其打开：
先决条件：确保已安装 bash-autocompletion 并可以正常工作。
# 安装 bash-completion
apt-get install bash-completion
# 将 completion 脚本添加到你的 ~/.bashrc 文件
echo 'source <(kubectl completion bash)' >>~/.bashrc
# 将 completion 脚本添加到 /etc/bash_completion.d 目录
kubectl completion bash >/etc/bash_completion.d/kubectl更详细的参考可以在这里找到。
欢迎任何形式的贡献! 感谢这些优秀的贡献者，是他们让我们的项目快速成长。
