install

Additional install commands

macOS

Homebrewverified · 100%

brew install kubekey

local Homebrew formula metadata

overview

Package summary

Installer for Kubernetes and / or KubeSphere, and related cloud-native add-ons

Project links

Commands and aliases

kk

history

Project history and usage

KubeKey is the KubeSphere ecosystem's installer and task-execution CLI for Kubernetes, KubeSphere, and related cloud-native add-ons. It is packaged as the kk executable and is used for cluster creation, upgrades, scaling, offline artifacts, and later task-flow style automation.

Project history

The public GitHub repository was created on March 19, 2020. KubeSphere documentation from the KubeKey installation guide refers to KubeKey version 1.0.1, and the repository README describes KubeKey as an open source lightweight task-flow execution tool that provides a flexible way to install Kubernetes.

The README says the 3.x line expanded KubeKey from a Kubernetes lifecycle-management tool into a task-execution tool with template management and multiple connection methods. The 4.x release packaging also includes web-installer assets, schema files, task templates, and offline package tooling.

Adoption history

KubeKey adoption is tied closely to KubeSphere installation and lifecycle management. It became the path for installing Kubernetes alone or installing Kubernetes and KubeSphere together, especially for users who wanted all-in-one, multi-node, highly available, or offline setups.

The project is less broadly packaged than kubectx or kubelogin, but its Homebrew formula is useful for operators who want the kk binary installed through the same package manager as kubectl and other cluster tools.

How it is used

A common workflow is to run kk create config to generate config-sample.yaml, edit host and cluster settings, and then run kk create cluster -f config-sample.yaml. The repository documentation also covers node add/delete operations, certificate renewal, offline artifact export, image registry setup, and dependency packages.

KubeKey's configuration file can include host connection details, Kubernetes version, networking, registry mirrors, and add-ons. That makes it closer to an installer plus declarative cluster recipe than a single-purpose kubectl plugin.

Why package nerds care

KubeKey is notable because it packages a full Kubernetes/KubeSphere installer as a single CLI binary. For package-manager users, kk sits in the same mental bucket as kubeadm wrappers and distribution installers: a bootstrap executable whose version controls a large amount of cluster state.

Timeline

2020-03-19: Public GitHub repository created
2021: KubeSphere installation documentation referenced KubeKey version 1.0.1
2023: 3.x README described expansion from lifecycle management to task execution
2026-06-05: v4.0.5 release published

Related projects

KubeSphere is the platform ecosystem for which KubeKey is an installer and lifecycle tool.
kubeadm is listed among the repository topics and is part of the broader Kubernetes bootstrap context.
Ansible is referenced by the README as an inspiration for KubeKey's task-flow design.

Sources

security posture

Risk level: orange

infrastructure mutation or orchestration signal.

Risk classifier

orange risk · medium confidence · infrastructure

Why

infrastructure mutation or orchestration signal

Signals

text:kubernetes,cloud

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 6 platform targets.
Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: config-sample.yaml

executables

Installed executables

Command	Kind	Exposure	Note
`kk`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-07-08

manager version4.0.5

manager updated2026-06-05

local dataok

upstreamnot checked

latest detectednot detected

https://github.com/kubesphere/kubekey

infoNo cached GitHub release or tag data was available.https://github.com/kubesphere/kubekeynone confidence

install metadata

Package metadata

Package key	brew:kubekey
Version	4.0.5
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/kubekey
Homepage	https://kubesphere.io
Repository	https://github.com/kubesphere/kubekey
Upstream docs	https://github.com/kubesphere/kubekey
License	Apache-2.0
Source archive	https://github.com/kubesphere/kubekey.git
Last updated	2026-06-05T12:50:08Z
Pulse	updated
Build dependencies	go
Bottle	available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	kubekey
Aliases	kk
Version Scheme	0
Revision	0
Head Version	HEAD
Bottle Stable Root URL	https://ghcr.io/v2/homebrew/core
Deprecated	no
Disabled	no
Keg Only	no
URL Keys	head stable

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/kubekey.yml

Used sources

Geiger risk classifier
Nucleus package database
av.db category and tag curation
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
package relationship graph
package version freshness
package-page enrichment

Install kubekey with Homebrew