NOTICE: Kubeaver is a CNCF conformance-certified installer.

Kubeaver is a tool for quickly deploying high-availability Kubernetes (K8s) clusters, supporting offline and online(in progress) methods. The project is based on kubespray, leveraging Ansible to automate deployment tasks, and provides a user-friendly graphical user interface. Refer to the documentation for more details on how to use Kubeaver.

中文版 README

Features

• Cluster Management
• Deploy Cluster (Offline Cluster Deployment)
• Task Management
• Task Time Statistics
• Task Real-time Output
• Node Management
• Offline Package Management
• Host Management

System Architecture

Screenshots

Compatibility

The default backend for Kubeaver 1.0.0 is v1.0.0-125, which supports Kubernetes versions 1.25 to 1.27. To extend support to include versions 1.28 through 1.30, you can modify the Docker Compose configuration.

kubeaver version	backend version	1.25.x	1.26.x	1.27.x	1.28.x	1.29.x	1.30.x
1.0.0	v1.0.0-125	✔	✔	✔	x	x	x
1.0.0	v1.0.0-128	x	x	x	✔	✔	✔

Key:

• ✔: Compatible: The components are tested and guaranteed to work with this Kubernetes version.
• x: Incompatible: The components are not guaranteed to support this Kubernetes version, as it falls outside the tested and supported range.

Install & Run kubeaver

System requirements:

On a Linux host:

• Software:
  • docker 20.10.10-ce+
• Hardware:
  • CPU: 2 vCPU
  • Memory: 4 GB
  • Disk: 60 GB

Download and Unpack the Installer:

1. Go to the Kubeaver releases page.

2. Download the online or offline installer for the version you want to install.

   Download binaries of Kubeaver release and follow.

3. Use tar to extract the installer package:

tar xzvf kubeaver-offline-installer-1.0.0.tgz

4. Change to the installation directory:

cd kubeaver-offline-installer-1.0.0

5. Install and start Kubeaver by using the start.sh script:

./start.sh

After this, Kubeaver will be successfully installed on your host. You can now access it via port 80.

Offline Package Import

Before deploying a Kubernetes cluster, you need to import the base package and extension packages according to your requirements. The base package contains essential components required for K8s cluster deployment, including the basic Flannel network plugin. If you intend to use Calico, you will need to import the Calico extension package. It’s important to note that you must import the corresponding operating system extension package based on the OS of your target cluster nodes.

Below shows how to download the Kubernetes base package for version v1.27.10 and the extension package for CentOS 7 operating system:

# download base package
cd ./deploy/data/kubeaver/offline   

docker pull ghcr.io/eb-k8s/kubeaver/kubeaver_offline:v1.27.10
docker run -d --name kubeaver_offline ghcr.io/eb-k8s/kubeaver/kubeaver_offline:v1.27.10  
docker cp kubeaver_offline:/root/base_k8s_v1.27.10.tgz .
docker rm -f kubeaver_offline    ##delete container

# download os package
docker pull ghcr.io/eb-k8s/kubeaver/oslib_centos:v1.0
docker run -d --name kubeaver_oslib ghcr.io/eb-k8s/kubeaver/oslib_centos:v1.0 
docker cp kubeaver_oslib:/root/extend_CentOS_7_Core.tgz .
docker rm -f kubeaver_oslib    ##delete container

You can then obtain the offline package base_k8s_v1.27.10.tgz、extend_CentOS_7_Core.tgz and import it into Kubeaver.

Click here to view more detailed offline package download methods: Offline package download

Deploy a K8s Cluster

1. Add the hosts where you want to deploy the K8s cluster in the Host Management section.
2. In the Cluster Management interface, create your cluster by selecting the cluster version, network plugin, and the hosts included in the cluster.
3. Click Save, then select the newly created cluster in the Cluster Management interface and click Deploy to start the deployment.
4. View the status and progress of tasks in the Task Queue or check running/completed tasks in the Task History.

K8s Node Requirements

• Control Plane
  • Memory: 2 GB
• Worker Node
  • Memory: 2 GB
• OS
  • Ubuntu 22.04
  • CentOS 7
  • Rocky Linux 9
  • openEuler 22.03

Supported Components

• Core
  • kubernetes
  • etcd
  • containerd
• Network Plugin
  • cni-plugins
  • calico
  • flannel
• Application
  • coredns

License

Kubeaver is released under the terms of the Apache 2.0 license.