KubeKey

    There are several scenarios to use KubeKey:

    • Install Kubernetes and KubeSphere together in one command;
    • Scale a cluster;
    • Upgrade a cluster;
    • Install Kubernetes-related add-ons (Chart or YAML).

    After you download KubeKey, you use an executable called to perform different operations. No matter you use it to create, scale or upgrade a cluster, you must prepare a configuration file using beforehand. This configuration file contains basic parameters of your cluster, such as host information, network configurations (CNI plugin and Pod and Service CIDR), registry mirrors, add-ons (YAML or Chart) and pluggable component options (if you install KubeSphere). For more information, see an example configuration file.

    With the configuration file in place, you execute the command with varied flags for different operations. After that, KubeKey automatically installs Docker and pulls all the necessary images for installation. When the installation is complete, you can inspect installation logs.

    • KubeKey supports multiple installation options, such as , multi-node installation, and .
    • KubeKey uses Kubeadm to install Kubernetes clusters on nodes in parallel as much as possible in order to reduce installation complexity and improve efficiency. It greatly saves installation time compared to the older installer.
    • KubeKey aims to install clusters as an object, i.e., CaaO.

    Run the following command first to make sure you download KubeKey from the correct zone.

    Run the following command to download KubeKey:

    Note

    Note

    The commands above download the latest release (v1.2.0) of KubeKey. You can change the version number in the command to download a specific version.

    If you want to use KubeKey to install both Kubernetes and KubeSphere 3.2.0, see the following table of all supported Kubernetes versions.

    • You can also run to see all supported Kubernetes versions that can be installed by KubeKey.