English | 中文

👋 Welcome to KubeKey!

KubeKey is an open-source lightweight task flow execution tool. It provides a flexible and fast way to install Kubernetes.

KubeKey has passed the CNCF Kubernetes Conformance Certification

Comparison of new features in 3.x

1. Expanded from Kubernetes lifecycle management tool to task execution tool (flow design refers to Ansible)
2. Supports multiple ways to manage task templates: git, local, etc.
3. Supports multiple node connection methods, including: local, ssh, kubernetes, prometheus.
4. Supports cloud-native automated batch task management
5. Advanced features: UI page (not yet open)

Get KubeKey

Method 1: Release Page

Get the corresponding binary files from the Release page.

Method 2: Run Script

curl -sfL https://get-kk.kubesphere.io | sh -

Original File	Extracted File
kubekey-v4.x.x-linux-amd64.tar.gz	kk: KubeKey binary
web-installer.tgz	dist: Web UI resources. host-check.yaml, kubernetes, kubesphere: Task template files. schema: Configuration files. README.md: Installation documentation.
package.sh	Offline package build script.

Quick Start

Method 1: Command Line

./kk create cluster

Method 2: Web UI

UI only supported after v4.0.0

./kk web --schema-path web-installer/schema --ui-path web-installer/dist

Documentation Navigation

• Install Kubernetes
  • Component Versions
  • Online Installation
  • Offline Installation
  • Add Cluster Nodes
  • Delete Cluster Nodes
• Configuration Reference
• Playbooks
  • Create Kubernetes Cluster
  • Delete Kubernetes Cluster
  • Add Nodes
  • Delete Nodes
  • Renew Certificates
  • Export Offline Artifact
  • Pre-installation Check
  • Initialize OS
• Image Registry Installation
• Dependency Packages
• Task Execution Framework
  • Project
  • Playbook
  • Role
  • Task
  • Template Syntax
  • Variables