Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.58 KB

kk.md

File metadata and controls

27 lines (22 loc) · 1.58 KB

NAME

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

Command Description
kk add Add nodes to kubernetes cluster.
kk artifact Manage a KubeKey offline installation package.
kk certs Manage cluster certs.
kk completion Generate shell completion scripts.
kk create Create a cluster, a cluster configuration file or an offline installation package configuration file.
kk delete Delete node or cluster.
kk init Initializes the installation environment.
kk plugin Provides utilities for interacting with plugins.
kk upgrade Upgrade your cluster smoothly to a newer version with this command.
kk version Print the client version information.