README.md 5.2 KB
Newer Older
J
jeff 已提交
1 2 3 4 5
# KubeSphere
[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/KubeSphere/KubeSphere/blob/master/LICENSE)
[![Build Status](https://travis-ci.org/kubesphere/kubesphere.svg?branch=master)](https://travis-ci.org/kubesphere/kubesphere)

----
6 7 8 9 10

## What is KubeSphere

[KubeSphere](https://kubesphere.io/) is an enterprise-grade multi-tenant container management platform that built on [Kubernetes](https://kubernetes.io). It provides an easy-to-use UI enables creation of computing resources with a few clicks and one-click deployment, which reduces the learning curve and empower the DevOps teams. It greatly reduces the complexity of the daily work of development, testing, operation and maintenance, aiming to solve the pain spots of Kubernetes' storage, network, security and ease of use, etc.

P
pengfeizhou 已提交
11
> See this [document](https://docs.kubesphere.io/advanced-v2.0/zh-CN/introduction/intro/) that describes the KubeSphere landscape and details.
12 13 14

## Features

P
pengfeizhou 已提交
15
KubeSphere Advanced Edition 2.0.0 provides an easy-to-use console with the awesome user experience that allows you to quickly get started with a container management platform. KubeSphere provides and supports following core features:
16

P
pengfeizhou 已提交
17 18 19 20 21 22

- Workload management
- Microservice governance
- DevOps Delivery
- Source to Image
- Multi-tenant management
P
pengfeizhou 已提交
23
- Multi-dimensional and Multi-tenant monitoring, Logging, Alerting, Notification
P
pengfeizhou 已提交
24
- Service and network management
P
pengfeizhou 已提交
25
- Application template and repository
P
pengfeizhou 已提交
26 27 28 29 30 31 32 33 34
- Infrastructure management, image registry management
- Interate Harbor and GitLab
- LB controller for Kubernetes on bare metal ([Porter](https://github.com/kubesphere/porter)), [cloud LB plugin](https://github.com/yunify/qingcloud-cloud-controller-manager)
- Support GPU node


It also supports multiple open source storage and high-performance cloud storage as the persistent storage services, as well as support multiple open source network plugins.

> See this [document](https://docs.kubesphere.io/advanced-v2.0/zh-CN/introduction/features/) that elaborates on the KubeSphere features and services from a professional point of view.
35

J
jeff 已提交
36 37
----

P
pengfeizhou 已提交
38 39 40 41
## Latest Release

KubeSphere Advanced Edition 2.0.0 was released on **May 18th, 2019**. See the [Release Notes For 2.0.0](https://docs.kubesphere.io/advanced-v2.0/release/release-v200/) to preview the updates.

42 43
## Installation

P
pengfeizhou 已提交
44
KubeSphere installation supports following 2 kinds of installation, please reference the following guides on how to get KubeSphere up and running.
P
pengfeizhou 已提交
45

P
pengfeizhou 已提交
46
### All-in-One
P
pengfeizhou 已提交
47

P
pengfeizhou 已提交
48
[All-in-One](https://docs.kubesphere.io/advanced-v2.0/zh-CN/installation/all-in-one/): For those who are new to KubeSphere and looking for the fastest way to install and experience the dashboard. 
P
pengfeizhou 已提交
49

P
pengfeizhou 已提交
50 51 52 53 54 55 56 57
Just download the installer and execute the `install.sh` under `/scripts` folder, choose `"1) All-in-one"` to trigger the installation. Generally, you can install it directly without any modification, for details please reference [All-in-One](https://docs.kubesphere.io/advanced-v2.0/zh-CN/installation/all-in-one/).

```bash
$ curl -L https://kubesphere.io/download/stable/advanced-2.0.0 > advanced-2.0.0.tar.gz
$ tar -zxf advanced-2.0.0.tar.gz
```

### Multi-Node
P
pengfeizhou 已提交
58

P
pengfeizhou 已提交
59
[Multi-Node](https://docs.kubesphere.io/advanced-v2.0/zh-CN/installation/multi-node/) is used for installing KubeSphere on multiple instances, supports for installing a highly available cluster which is able to use in a formal environment.
60 61 62 63


### Minimum Requirements

P
pengfeizhou 已提交
64
- Operating Systems
65 66 67 68 69
   - CentOS 7.5 (64 bit)
   - Ubuntu 16.04/18.04 LTS (64 bit)
   - Red Hat Enterprise Linux Server 7.4 (64 bit)
   - Debian Stretch 9.5 (64 bit)
- Hardware
P
pengfeizhou 已提交
70
   - CPU:8 Core,  Memory:16 G, Disk Space:100 G
J
jeff 已提交
71

72
## Quick Start
J
jeff 已提交
73

P
pengfeizhou 已提交
74
The [Quick Start Guide](https://docs.kubesphere.io/advanced-v2.0/quick-start/admin-quick-start/) provides 12 quick-start examples to walk you through the process and common manipulation in KubeSphere, with a quick overview of the core features of KubeSphere that helps you to get familiar with it.
75 76 77 78


## RoadMap

P
pengfeizhou 已提交
79
Currently, KubeSphere has released the following 4 major editions. Advanced Edition 2.0.0 was released on May 18, 2019. The future releases will include Big data, AI, Multicluster, QingCloud SDN, etc.
80

P
pengfeizhou 已提交
81
**Community Edition** => **Express Edition** => **Advanced Edition 1.0.0** => **Advanced Edition 2.0.0**
82 83 84 85 86 87

![Roadmap](docs/images/roadmap-en.png)

## Documentation

- [KubeSphere Documentation (En/中) ](https://docs.kubesphere.io/)
P
pengfeizhou 已提交
88
- [KubeSphere Docementation (PDF)](https://docs.kubesphere.io/KubeSphere-advanced-v2.0.pdf)
89 90 91 92 93 94

## Support, Discussion, and Community

If you need any help with KubeSphere, please join us at [Slack channel](http://kubesphere.slack.com/) where most of our team hangs out at.

Please submit any KubeSphere bugs, issues, and feature requests to [KubeSphere GitHub Issue](https://github.com/kubesphere/kubesphere/issues).
J
jeff 已提交
95 96 97 98 99

## Contributing to the project

All members of the KubeSphere community must abide by [Code of Conduct](docs/code-of-conduct.md). Only by respecting each other can we develop a productive, collaborative community.

100 101 102
How to submit a pull request to KubeSphere? See [Pull Request Instruction](docs/pull-requests.md).

You can then find out more detail [here](docs/welcome-to-KubeSphere-new-developer-guide.md).
J
jeff 已提交
103 104