NAME

March 17, 2022 ยท View on GitHub

kk: Kubernetes/KubeSphere Deploy Tool

DESCRIPTION

KubeKey is an open-source lightweight tool for deploying Kubernetes clusters. It provides a flexible, rapid, and convenient way to install Kubernetes/K3s only, both Kubernetes/K3s and KubeSphere, and related cloud-native add-ons. It is also an efficient tool to scale and upgrade your cluster.

In addition, KubeKey also supports customized Air-Gap package, which is convenient for users to quickly deploy clusters in offline environments.

Use KubeKey in the following three scenarios.

  • Install Kubernetes/K3s only
  • Install Kubernetes/K3s and KubeSphere together in one command
  • Install Kubernetes/K3s first, then deploy KubeSphere on it using ks-installer

COMMANDS

CommandDescription
kk addAdd nodes to kubernetes cluster.
kk artifactManage a KubeKey offline installation package.
kk certsManage cluster certs.
kk completionGenerate shell completion scripts.
kk createCreate a cluster, a cluster configuration file or an offline installation package configuration file.
kk deleteDelete node or cluster.
kk initInitializes the installation environment.
kk pluginProvides utilities for interacting with plugins.
kk upgradeUpgrade your cluster smoothly to a newer version with this command.
kk versionPrint the client version information.