Quickly Deploy a Kubernetes Cluster with KubeKey: Step‑by‑Step Guide

Operation Steps

Official site: https://kubesphere.io/zh/

1. Execute the following commands to quickly create a Kubernetes cluster

Master node If access to GitHub/Googleapis is restricted, log into the Linux host and set the download region:

export KKZONE=cn

Master node Install the KubeKey tool:

curl -sfL https://get-kk.kubesphere.io | sh -

The KubeKey binary kk will be generated in the current directory.

Each node Install required dependencies:

apt install socat conntrack -y

Master node Create a single‑node Kubernetes cluster (example with containerd):

./kk create cluster --with-local-storage --with-kubernetes v1.31.0 --container-manager containerd -y

Generate a KubeKey config template: ./kk create config Sample config-sample.yaml (excerpt):

apiVersion: kubekey.kubesphere.io/v1alpha2
kind: Cluster
metadata:
  name: sample
spec:
  hosts:
    - {name: k8s-master, address: 11.0.1.10, internalAddress: 11.0.1.10, user: root, password: "000000"}
    - {name: k8s-node01, address: 11.0.1.11, internalAddress: 11.0.1.11, user: root, password: "000000"}
    - {name: k8s-node02, address: 11.0.1.12, internalAddress: 11.0.1.12, user: root, password: "000000"}
  roleGroups:
    etcd:
      - k8s-master
    control-plane:
      - k8s-master
    worker:
      - k8s-node01
      - k8s-node02
  controlPlaneEndpoint:
    domain: lb.kubesphere.local
    address: ""
    port: 6443
  kubernetes:
    version: v1.31.0
    clusterName: cluster.local
    autoRenewCerts: true
    containerManager: docker
  network:
    plugin: calico
    kubePodsCIDR: 10.233.64.0/18
    kubeServiceCIDR: 10.233.0.0/18

Create the cluster using the config file: ./kk create cluster config-sample.yaml The tool will check and install any missing dependencies.

Check Cluster Deployment Status

Run the following command to confirm that the cluster is fully deployed: kubectl get pod -A Sample output:

Cluster deployment is complete.