Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Orientsoft/kubekit
A Kubernetes deployment toolkit for offline environment.
https://github.com/Orientsoft/kubekit
kubernetes kubernetes-deployment kubernetes-offline kubernetes-setup toolkit
Last synced: about 2 months ago
JSON representation
A Kubernetes deployment toolkit for offline environment.
- Host: GitHub
- URL: https://github.com/Orientsoft/kubekit
- Owner: Orientsoft
- License: mit
- Created: 2017-08-22T07:35:09.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-07T09:29:10.000Z (almost 7 years ago)
- Last Synced: 2024-08-03T20:10:34.961Z (5 months ago)
- Topics: kubernetes, kubernetes-deployment, kubernetes-offline, kubernetes-setup, toolkit
- Language: Go
- Size: 7.47 MB
- Stars: 322
- Watchers: 33
- Forks: 94
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```text
___ __ ___ ___ ________ _______ ___ __ ___ _________
|\ \|\ \ |\ \|\ \|\ __ \|\ ___ \ |\ \|\ \ |\ \|\___ ___\
\ \ \/ /|\ \ \\\ \ \ \|\ /\ \ __/|\ \ \/ /|\ \ \|___ \ \_|
\ \ ___ \ \ \\\ \ \ __ \ \ \_|/_\ \ ___ \ \ \ \ \ \
\ \ \\ \ \ \ \\\ \ \ \|\ \ \ \_|\ \ \ \\ \ \ \ \ \ \ \
\ \__\\ \__\ \_______\ \_______\ \_______\ \__\\ \__\ \__\ \ \__\
\|__| \|__|\|_______|\|_______|\|_______|\|__| \|__|\|__| \|__|
```
A Kubernetes deployment toolkit for offline environment.
---
[![Go][1]][2] [![Kubernetes][3]][4] [![Build][7]][8] [![Release][5]][6]
[1]: https://img.shields.io/badge/go-v1.9.3-green.svg
[2]: https://golang.org
[3]: https://img.shields.io/badge/kubernetes-v1.9.2-brightgreen.svg
[4]: https://kubernetes.io/
[5]: https://img.shields.io/badge/release-v0.3-blue.svg
[6]: https://github.com/Orientsoft/kubekit/releases
[7]: https://travis-ci.org/Orientsoft/kubekit.svg?branch=master
[8]: https://travis-ci.org/Orientsoft/kubekit
- [About](#about)
- [Highlights](#highlights)
- [Supported OS](#supported-os)
- [Requirements](#requirements)
- [Quick Start](#quick-start)
- [User Manual](#user-manual)
- [CLI Commands](#cli-commands)
- [Uninstall](#uninstall)
- [Web UI Portal](#web-ui-portal)
- [License](#license)
# About
Kubekit is a deployment toolkit, it provides offline installation solution for kubernetes. You can use it for deploying Kubernetes to **OFFLINE** production environment.
The Kubekit will install
* Docker (1.12.6)
* Kubernetes and all its components
* Kubernetes dashboard, with default node port:**31234**
# Highlights
* Easy to bring up Kubernetes master by only one CLI command
* Ease of use through Web UI portal
* Manage and initialize multiple nodes with "one-click"
# Supported OS
* CentOS release 7.3.1611 __with minimal installation__ (**Already tested & verified**)
* CentOS release 7.4.1708 __with minimal installation__ (**Already tested & verified**)
# Requirements
* Make sure you have root privileges for all the servers.
* The firewalls are not managed, you'll need to implement your own rules the way you used to, in order to avoid any issue during deployment you should disable your firewall.
* Make sure all the kubernetes nodes have different hostnames.
* __Make sure the date and timezone of all the kubernetes nodes are the same.__
# Quick Start
1. Download latest release of kubekit:
* Download it form our mirror server:[[Download]](https://kubekit.orientsoft.cn/kubekit-linux64-0.3.tar.gz) (__RECOMMENDED!__)
* Or download it from [GitHub](https://github.com/Orientsoft/kubekit/releases)
Then extract it to ```./kubekit/```
2. Download offline package according to your OS version:
OS Version
K8S Version
Dashboard Version
Latest Release
Package Download
CentOS 7.3.1611
V1.7.2
V1.6.3
2017.12.22
Download
CentOS 7.4.1708
V1.8.1
V1.7.1
2017.12.22
Download
CentOS 7.4.1708
V1.9.2
V1.8.2
2018.2.1
Download
3. Extract all the files from offline package to ```./kubekit/package``` and make *.sh executable:
```bash
cd package
chmod +x *.sh
```
4. COPY ./kubekit to a node which is selected to be Kubernetes master.
5. Login to that node, initialize it with Kubernetes master by its IP:
```bash
./kubekit init 192.168.0.100
```
6. Take a cup of coffee and wait until master node is ready. And also, a Web UI portal will be available with default port: 9000.
7. Access the Web UI Portal with ```http://MASTER_IP:9000``` and initialize other Kubernetes worker nodes through it.
8. __Don't forget to reload bash settings before using kubectl: ```source ~/.bashrc```__
# User Manual
For detailed usage, please refer to [《Kubekit安装与使用手册》](https://github.com/Orientsoft/kubekit/wiki/Kubekit-%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C)
# CLI Commands
## Basic Usage
```
→ ./kubekit h
NAME:
KubeKit - A toolkit for Kubernetes & apps offline deployment.
USAGE:
kubekit [global options] command [command options] [arguments...]
VERSION:
0.3
COMMANDS:
init, i Initialize current server with Docker engine & Kubernetes master.
server, s Start kubekit file server & toolkit server.
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```
## Customized listening ports
By default, kubekit will use port ```8000``` for file server and port ```9000``` for toolkit server, if they are conflicted with any running program, you can start kubekit with specified port.
```bash
USAGE:
kubekit server FILE_SERVER_PORT TOOLKIT_SERVER_PORT
```
Get more help via:
```bash
./kubekit server -h
```
# Uninstall
To uninstall Kubernetes & kubekit, there are several steps:
1. Reset the Kubernetes node:
```bash
kubeadm reset
```
2. Remove kubelet and related components:
```bash
yum -y remove kubelet kubeadm kubectl
```
3. Delete kubekit and the offline package:
```bash
rm -rf /path/to/kubekit
```
# Web UI Portal
With Web UI Portal, you can manage all the Kubernetes worker nodes and initialize them, join them to Kubernetes cluster with "one-click".
You can start Web UI Portal manually when kubekit program exited:
```bash
./kubekit server
```
## Multiple Languages Support
Language is auto-detected by browser's language settings.
Supported languages:
* Chinese
* English
# License
[MIT License](https://github.com/Orientsoft/kubekit/blob/master/LICENSE)