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

Merge remote-tracking branch 'origin/master'

This commit is contained in:
pixiake 2020-05-12 00:07:07 +08:00
parent a1b23dbcd7 afafc01f16
commit f78dd30e6f
1 changed files with 61 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
README.md
View File

@ -1,70 +1,100 @@
# KubeKey
Start Kubernetes and KubeSphere flexibly and easily.
Since v3.0, KubeSphere changes the ansible-based installer to the new installer called KubeKey that is developed in Go language. With KubeKey, you can install Kubernetes and KubeSphere separately or as a whole easily, efficiently and flexibly.
## Motivation
* Kubekey is developed with Golang to reduce software dependency issues.
* Kubekey uses Kubeadm to concurrently install k8s cluster to reduce installation complexity and improve installation efficiency.
* Support for scaling cluster from allinone to multi-node.
* Ansible-based installer has a bunch of software dependency such as Python. KubeKey is developed in Go language to get rid of the problem in a variety of environment so that increasing the success rate of installation.
* KubeKey uses Kubeadm to install K8s cluster on nodes in parallel as much as possible in order to reduce installation complexity and improve efficiency. It will greatly save installation time compared to the older installer.
* KubeKey supports for scaling cluster from allinone to multi-node cluster.
* KubeKey aims to install cluster as an object, i.e., CaaO.
## 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.
* 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.<br>
* OS requirements (For Minimal Installation of KubeSphere only)：at least 2 vCPUs and 4 GB 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](./docs/storage-client.md).
* 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.<br>
It's recommended that you turn off the firewall or follow the link configuriation: [NetworkAccess](./docs/network-access.md)
* A container image mirror (accelerator) is recommended to be prepared, if you have trouble downloading images from dockerhub.io.
* 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](./docs/network-access.md).
* A container image mirror (accelerator) is recommended to be prepared, if you have trouble downloading images from dockerhub.io.
### Usage
* Download binary
#### Download binary
```shell script
curl -O -k https://kubernetes.pek3b.qingstor.com/tools/kubekey/kk
chmod +x kk
```
* Deploy a cluster
```shell script
# 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)
#### Deploy a cluster
* allinone
```shell script
./kk create cluster
```
* multi-node
```shell script
# 1. Create an example configuration file by the following command or the docs/config-example.md
$ ./kk create config # Only for 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
$ ./kk create cluster -f ./k2cluster-example.yaml
```
* Add Nodes
> Add new node's information to the cluster config file
#### Add Nodes
> Add new node's information to the cluster config file, then apply the changes.
```shell script
./kk scale -f ./k2cluster-example.yaml
```
* Reset Cluster
```shell script
# allinone
./kk reset
# multinodes
#### Reset Cluster
* allinone
```shell script
./kk reset
```
* multi-node
```shell script
./kk reset -f ./k2cluster-example.yaml
```
## Build
```shell script
git clone https://github.com/kubesphere/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
> Note: Docker needs to be installed before building.
## Road Map
* CaaO (Cluster as an Object)
* Support more container runtimes: cri-o containerd