15308555518/ kubekey
1
0
Fork 0
mirror of https://github.com/kubesphere/kubekey.git synced 2025-12-26 01:22:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
Install Kubernetes/K3s only, both Kubernetes/K3s and KubeSphere, and related cloud-native add-ons, it supports all-in-one, multi-node, and HA 🔥 ⎈ 🐳
45 Commits 28 Branches 122 Tags 88 MiB
Go 50.3%
JavaScript 45.7%
Shell 3%
Makefile 0.7%
Python 0.1%
Go to file
shaowenchen c84607d2e6
add owners 		2020-05-01 16:04:53 +08:00
build add K2Cluster object 2020-04-26 10:40:50 +08:00
cmd update generate config 2020-04-29 20:45:13 +08:00
deploy add K2Cluster object 2020-04-26 10:40:50 +08:00
docs update storage-client.md 2020-04-29 20:24:59 +08:00
pkg update command 2020-04-30 23:52:41 +08:00
scripts update command 2020-04-30 23:52:41 +08:00
version add K2Cluster object 2020-04-26 10:40:50 +08:00
OWNERS add owners 2020-05-01 16:04:53 +08:00
README.md update README.md 2020-04-29 22:10:02 +08:00
build.sh update build.sh 2020-04-29 23:10:29 +08:00
go.mod add K2Cluster object 2020-04-26 10:40:50 +08:00
kubekey.go add K2Cluster object 2020-04-21 23:47:22 +08:00
tools.go add K2Cluster object 2020-04-26 10:40:50 +08:00

README.md

KubeKey

Start Kubernetes and KubeSphere flexibly and easily.

Quick Start

Prepare

Please follow the list to prepare environment.

Supported Linux Distributions

  • Ubuntu 16.04, 18.04
  • Debian Buster, Stretch
  • CentOS/RHEL 7

Requirements and Recommendations

  • Require SSH can access to all nodes, sudo and curl can be used in all nodes.
  • It's recommended that Your OS is clean (without any other software installed), otherwise there may be conflicts.
  • OS requirements (For Minimal Installation of KubeSphere only)：at least 2 vCPUs and 4GB RAM.
  • Make sure the storage service is available if you want to deploy a cluster with KubeSphere.
    The relevant client should be installed on all nodes in cluster, if you storage server is nfs / ceph / glusterfs.
  • Make sure the DNS address in /etc/resolv.conf is available. Otherwise, it may cause some issues of DNS in cluster.
  • If your network configuration uses Firewall or Security Group，you must ensure infrastructure components can communicate with each other through specific ports.
    It's recommended that you turn off the firewall or follow the link configuriation: NetworkAccess
  • A container image mirror (accelerator) is recommended to be prepared, if you have trouble downloading images from dockerhub.io.

Usage

  • Download binary
curl -O -k https://kubernetes.pek3b.qingstor.com/tools/kubekey/kk
chmod +x kk
  • Deploy a cluster
# allinone
./kk create cluster

# multiNodes
# 1. Create a example configuration file by following command or reference docs/config-example.md
./kk create config      # Only kubernetes
./kk create config --add localVolume      # Add plugins (eg: localVolume / nfsClient / localVolume,nfsClient)

# 2. Please fill in the configuration file under the current path (k2cluster-example.yaml) according to the environmental information.

# 3. Deploy cluster
./kk create cluster -f ./k2cluster-example.yaml
  • Add Nodes

Add new node's information to the cluster config file

./kk scale -f ./k2cluster-example.yaml
  • Reset Cluster
# allinone
./kk reset

# multinodes
./kk reset -f ./k2cluster-example.yaml

Build

git clone https://github.com/pixiake/kubekey.git
cd kubekey
./build.sh

Note: Docker needs to be installed before building.

Road Map

  • CaaO (Cluster as a Object)
  • Support more container runtimes: cri-o containerd