refine readme, remove the out-of-date docs
Signed-off-by: FeynmanZhou <pengfeizhou@yunify.com>
This commit is contained in:
FeynmanZhou
38
README.md
38
README.md
@@ -12,14 +12,10 @@
|
||||
|
||||
> English | [中文](README_zh.md)
|
||||
|
||||
[KubeSphere](https://kubesphere.io/) is a multi-tenant enterprise-grade container platform built on [Kubernetes](http://kubernetes.io), with full-stack automated IT operation and streamlined DevOps workflows. KubeSphere provides developer-friendly wizard web UI, helping enterprises to build out a more robust and feature-rich platform, which includes most common functionalities needed for enterprise Kubernetes strategy, such as the **Kubernetes resource management, DevOps (CI/CD), application lifecycle management, monitoring, logging, Service Mesh (Istio-based), multi-tenancy, alerting and notification, storage and networking, autoscaling, access control, GPU support, etc.**, as well as **multi-cluster management, Network Policy, registry management, more security enhancements** in upcoming releases. KubeSphere is a **distributed operating system with cloud native stack** with Kubernetes as its kernel, and will be very well architected for **plug-and-play integration for third-party applications to boost its ecosystem**.
|
||||
|
||||
KubeSphere provides a complete user experience around Kubernetes that incorporates a set of cloud native ecosystem tools, allowing developers and DevOps teams use their favorite tools in a unified console. KubeSphere delivers **consolidated views while integrating a wide breadth of ecosystem tools** around Kubernetes and offers consistent user experience to reduce complexity. Most importantly, these functionalities are loosely coupled with the platform since they are pluggable and optional at your will. Last but not least, it does not change Kubernetes itself anything. In another word, KubeSphere can be deployed on any existing version-compatible Kubernetes cluster.
|
||||
|
||||
|
||||
[KubeSphere](https://kubesphere.io/) is a **distributed operating system providing cloud native stack** with [Kubernetes](https://kubernetes.io) as its kernel, and aims to be plug-and-play architecture for third-party applications seamless integration to boost its ecosystem. KubeSphere is also a multi-tenant enterprise-grade container platform with full-stack automated IT operation and streamlined DevOps workflows. It provides developer-friendly wizard web UI, helping enterprises to build out a more robust and feature-rich platform, which includes most common functionalities needed for enterprise Kubernetes strategy, see [Feature list](#features) for details.
|
||||
|
||||
|
||||
> Note: The [Screenshots](docs/en/guides/screenshots.md) give a close insight into KubeSphere, see [What is KubeSphere](https://kubesphere.io/docs/v2.1/en/introduction/what-is-kubesphere) for details.
|
||||
> Note: The [Screenshots](docs/en/guides/screenshots.md) give a close insight into KubeSphere, see [What is KubeSphere](https://kubesphere.io/docs/v2.1/en/introduction/what-is-kubesphere) for further information.
|
||||
|
||||
|
||||
<table>
|
||||
@@ -28,16 +24,16 @@ KubeSphere provides a complete user experience around Kubernetes that incorporat
|
||||
<td width="50%" align="center"><b>Project Resources</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094014.png"/></td>
|
||||
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094426.png"/></td>
|
||||
<td><img src="docs/images/console.png"/></td>
|
||||
<td><img src="docs/images/project.png"/></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="50%" align="center"><b>CI/CD Pipeline</b></td>
|
||||
<td width="50%" align="center"><b>Application Store</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20190925000712.png"/></td>
|
||||
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112095006.png"/></td>
|
||||
<td><img src="docs/images/cicd.png"/></td>
|
||||
<td><img src="docs/images/app-store.png"/></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -45,6 +41,12 @@ KubeSphere provides a complete user experience around Kubernetes that incorporat
|
||||
|
||||
Using the account `demo1 / Demo123` to log in the [demo environment](https://demo.kubesphere.io/). Please note the account is granted viewer access. You can also have a quick view of [KubeSphere Demo Video](https://youtu.be/u5lQvhi_Xlc).
|
||||
|
||||
## Architecture
|
||||
|
||||
KubeSphere uses a loosely-coupled architecture that separates the [frontend](https://github.com/kubesphere/console) from the [backend](https://github.com/kubesphere/kubesphere), the back end can also be connected with external systems through the REST API, all components are designed as Docker containers. See [Architecture](https://kubesphere.io/docs/v2.1/en/introduction/architecture/) for details.
|
||||
|
||||
|
||||
|
||||
|
||||
## Features
|
||||
|
||||
@@ -67,10 +69,6 @@ Using the account `demo1 / Demo123` to log in the [demo environment](https://dem
|
||||
|
||||
----
|
||||
|
||||
## Architecture
|
||||
|
||||
KubeSphere uses a loosely-coupled architecture that separates the [frontend](https://github.com/kubesphere/console) from the [backend](https://github.com/kubesphere/kubesphere), the back end can also be connected with external systems through the REST API, all components are designed as Docker containers. See [Architecture](https://kubesphere.io/docs/v2.1/en/introduction/architecture/) for details.
|
||||
|
||||
|
||||
## Latest Release
|
||||
|
||||
@@ -78,7 +76,7 @@ KubeSphere 2.1.1 was released on **February 23th, 2020**. See the [Release Notes
|
||||
|
||||
## Installation
|
||||
|
||||
KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any Kubernetes distribution.
|
||||
KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any version-compatible Kubernetes cluster.
|
||||
|
||||
### Deploy on Existing Kubernetes
|
||||
|
||||
@@ -119,7 +117,9 @@ KubeSphere Installer can help you to install KubeSphere and Kubernetes on your l
|
||||
- Hardware
|
||||
- CPU：2 Core, Memory：4 G, Disk Space：100 G
|
||||
|
||||
##### All-in-One (QuickStart)
|
||||
> Note: Please disable the firewall, or ensure your firewall meets the [port requirements](https://kubesphere.io/docs/installation/port-firewall/).
|
||||
|
||||
#### All-in-One (QuickStart)
|
||||
|
||||
```bash
|
||||
curl -L https://kubesphere.io/download/stable/latest > installer.tar.gz \
|
||||
@@ -129,8 +129,6 @@ $ ./install.sh
|
||||
|
||||
Choose `"1) All-in-one"` to start the default minimal installation.
|
||||
|
||||
> Note: It's highly recommended to install [multi-node](https://kubesphere.io/docs/v2.1/en/installation/multi-node/) in production environment.
|
||||
|
||||
You can enable other components after installation, see [Pluggable Components Installation](https://kubesphere.io/docs/v2.1/en/installation/pluggable-components/).
|
||||
|
||||
|
||||
@@ -141,7 +139,7 @@ You can enable other components after installation, see [Pluggable Components In
|
||||
|
||||
## To start developing KubeSphere
|
||||
|
||||
The [development guide](CONTRIBUTING.md) hosts all information about building KubeSphere from source, git workflow, how to contribute code and how to test.
|
||||
The [development guide](https://github.com/kubesphere/community/tree/master/developer-guide/development) hosts all information about building KubeSphere from source, git workflow, how to contribute code and how to test.
|
||||
|
||||
## RoadMap
|
||||
|
||||
@@ -175,4 +173,4 @@ Please submit any KubeSphere bugs, issues, and feature requests to [KubeSphere G
|
||||
|
||||
## Contributing to the project
|
||||
|
||||
This [document](docs/en/guides/README.md) walks you through how to get started contributing KubeSphere.
|
||||
This [document](https://github.com/kubesphere/community) walks you through how to get started contributing KubeSphere.
|
||||
|
||||
Reference in New Issue
Block a user