kubekey

module

v4.0.7 Latest Latest Go to latest Published: Sep 4, 2026 License: Apache-2.0

Details

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

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

Get the corresponding binary files from the Release page.

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.

./kk create cluster

UI only supported after v4.0.0

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

Install Kubernetes
Configuration Reference
Playbooks
Image Registry Installation
Dependency Packages
Task Execution Framework
- Project
- Playbook
- Role
- Task
- Template Syntax
- Variables

Path	Synopsis
cmd
controller-manager command
controller-manager/app
controller-manager/app/options
kk command
kk/app
kk/app/options
config
pkg
connector
const
controllers/core
controllers/infrastructure
controllers/util
converter
converter/tmpl
executor
manager
modules
modules/add_hostvars
modules/assert
modules/command
modules/copy
modules/debug
modules/fetch
modules/gen_cert
modules/http_get_file
modules/image Package image provides functionality for managing container image operations in KubeKey.	Package image provides functionality for managing container image operations in KubeKey.
modules/include_vars
modules/internal
modules/prometheus
modules/result
modules/set_fact
modules/setup
modules/template
modules/testutil Package testutil provides helpers shared by pkg/modules/* unit and integration tests.	Package testutil provides helpers shared by pkg/modules/* unit and integration tests.
project Package project provides functionality for managing Ansible-like projects in KubeKey.	Package project provides functionality for managing Ansible-like projects in KubeKey.
proxy
proxy/internal
proxy/resources
proxy/resources/inventory
proxy/resources/playbook
proxy/resources/task
utils
variable Package variable provides functionality for handling variables in YAML format.	Package variable provides functionality for handling variables in YAML format.
variable/source
web
web/api
web/handler
web/query
version Package version implements version handling code.	Package version implements version handling code.