Skip to content

Commit 8c1f621

Browse files
author
FeynmanZhou
committed
refine readme, remove the out-of-date docs
Signed-off-by: FeynmanZhou <[email protected]>
1 parent 179fbdb commit 8c1f621

27 files changed

+39
-1519
lines changed

CONTRIBUTING.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
# Guide
22

3-
This [document](docs/en/guides/README.md) walks you through how to get started contributing KubeSphere.
4-
3+
This [document](https://github.com/kubesphere/community) walks you through how to get started contributing KubeSphere.

README.md

+18-20
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,10 @@
1212

1313
> English | [中文](README_zh.md)
1414
15-
[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**.
15+
[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.
1616

17-
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.
1817

19-
![](docs/images/kubesphere-platform-overview.png)
20-
21-
22-
> 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.
18+
> 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.
2319
2420

2521
<table>
@@ -28,23 +24,29 @@ KubeSphere provides a complete user experience around Kubernetes that incorporat
2824
<td width="50%" align="center"><b>Project Resources</b></td>
2925
</tr>
3026
<tr>
31-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094014.png"/></td>
32-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094426.png"/></td>
27+
<td><img src="docs/images/console.png"/></td>
28+
<td><img src="docs/images/project.png"/></td>
3329
</tr>
3430
<tr>
3531
<td width="50%" align="center"><b>CI/CD Pipeline</b></td>
3632
<td width="50%" align="center"><b>Application Store</b></td>
3733
</tr>
3834
<tr>
39-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20190925000712.png"/></td>
40-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112095006.png"/></td>
35+
<td><img src="docs/images/cicd.png"/></td>
36+
<td><img src="docs/images/app-store.png"/></td>
4137
</tr>
4238
</table>
4339

4440
## Demo Environment
4541

4642
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).
4743

44+
## Architecture
45+
46+
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.
47+
48+
![](docs/images/architecture.png)
49+
4850

4951
## Features
5052

@@ -67,18 +69,14 @@ Using the account `demo1 / Demo123` to log in the [demo environment](https://dem
6769
6870
----
6971

70-
## Architecture
71-
72-
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.
73-
7472

7573
## Latest Release
7674

7775
KubeSphere 2.1.1 was released on **February 23th, 2020**. See the [Release Notes For 2.1.1](https://kubesphere.io/docs/v2.1/en/release/release-v211/) for the updates.
7876

7977
## Installation
8078

81-
KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any Kubernetes distribution.
79+
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.
8280

8381
### Deploy on Existing Kubernetes
8482

@@ -119,7 +117,9 @@ KubeSphere Installer can help you to install KubeSphere and Kubernetes on your l
119117
- Hardware
120118
- CPU:2 Core, Memory:4 G, Disk Space:100 G
121119

122-
##### All-in-One (QuickStart)
120+
> Note: Please disable the firewall, or ensure your firewall meets the [port requirements](https://kubesphere.io/docs/installation/port-firewall/).
121+
122+
#### All-in-One (QuickStart)
123123

124124
```bash
125125
curl -L https://kubesphere.io/download/stable/latest > installer.tar.gz \
@@ -129,8 +129,6 @@ $ ./install.sh
129129

130130
Choose `"1) All-in-one"` to start the default minimal installation.
131131

132-
> Note: It's highly recommended to install [multi-node](https://kubesphere.io/docs/v2.1/en/installation/multi-node/) in production environment.
133-
134132
You can enable other components after installation, see [Pluggable Components Installation](https://kubesphere.io/docs/v2.1/en/installation/pluggable-components/).
135133

136134

@@ -141,7 +139,7 @@ You can enable other components after installation, see [Pluggable Components In
141139

142140
## To start developing KubeSphere
143141

144-
The [development guide](CONTRIBUTING.md) hosts all information about building KubeSphere from source, git workflow, how to contribute code and how to test.
142+
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.
145143

146144
## RoadMap
147145

@@ -175,4 +173,4 @@ Please submit any KubeSphere bugs, issues, and feature requests to [KubeSphere G
175173

176174
## Contributing to the project
177175

178-
This [document](docs/en/guides/README.md) walks you through how to get started contributing KubeSphere.
176+
This [document](https://github.com/kubesphere/community) walks you through how to get started contributing KubeSphere.

README_zh.md

+20-32
Original file line numberDiff line numberDiff line change
@@ -11,43 +11,41 @@
1111

1212
> [English](README.md) | 中文
1313
14-
[KubeSphere](https://kubesphere.io/) 是在 [Kubernetes](https://kubernetes.io) 之上构建的以**应用为中心的**多租户**容器平台**,提供全栈的 IT 自动化运维的能力,简化企业的 DevOps 工作流。KubeSphere 提供了 **运维友好的向导式操作界面**,帮助企业快速构建一个强大和功能丰富的容器云平台,包括 **Kubernetes 资源管理、DevOps (CI/CD)、应用生命周期管理、微服务治理 (Service Mesh)、多租户管理、监控日志、告警通知、存储与网络管理、GPU support** 等功能,未来还将提供 **多集群管理、Network Policy、镜像仓库管理** 等功能。KubeSphere 愿景是打造一个基于 Kubernetes 的云原生分布式操作系统,它的架构可以很方便地与云原生生态系统进行即插即用(plug-and-play)的集成。
14+
[KubeSphere](https://kubesphere.com.cn) 是在 [Kubernetes](https://kubernetes.io) 之上构建的以**应用为中心的**多租户容器平台,提供全栈的 IT 自动化运维的能力,简化企业的 DevOps 工作流。KubeSphere 提供了运维友好的向导式操作界面,帮助企业快速构建一个强大和功能丰富的容器云平台,包括 Kubernetes 资源管理、DevOps (CI/CD)、应用生命周期管理、微服务治理 (Service Mesh)、多租户管理、监控日志、告警通知、存储与网络管理、GPU support** 等功能,未来还将提供多集群管理、Network Policy、镜像仓库管理等功能。KubeSphere 愿景是打造一个基于 Kubernetes 的云原生分布式操作系统,它的架构可以很方便地与云原生生态系统进行即插即用(plug-and-play)的集成。
1515

1616

17-
KubeSphere 作为一个**全栈的容器平台**,不仅支持**安装和纳管原生 Kubernetes**,还设计了一套完整的管理界面方便开发者与运维在一个**统一的平台**中安装与管理最常用的云原生工具,**从业务视角提供了一致的用户体验来降低复杂性**,并且所有功能组件都是可插拔的
17+
> 说明:KubeSphere 目前最新的版本为 2.1.1,所有版本 100% 开源,关于 KubeSphere 更详细的介绍与说明请参阅 [什么是 KubeSphere](https://kubesphere.com.cn/docs/zh-CN/introduction/intro/)
1818
19-
![](docs/images/kubesphere-platform-overview.png)
20-
21-
KubeSphere 可以运行在任何私有或托管的 Kubernetes、私有云、公有云、VM 或物理环境之上。已大规模服务于社区用户,广泛地应用在以容器为中心的开发测试及生产环境,大量服务平稳地运行在 KubeSphere 之上。
22-
23-
> 说明:KubeSphere 目前最新的版本为 2.1.1,并且所有版本 100% 开源,关于 KubeSphere 更详细的介绍与说明请参阅 [什么是 KubeSphere](https://kubesphere.com.cn/docs/v2.1/zh-CN/introduction/intro/)
24-
25-
26-
点击 [KubeSphere 快览](docs/en/guides/screenshots.md) 快速查看 KubeSphere UI;
2719

2820
<table>
2921
<tr>
3022
<td width="50%" align="center"><b>KubeSphere Dashboard</b></td>
3123
<td width="50%" align="center"><b>Project Resources</b></td>
3224
</tr>
3325
<tr>
34-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094014.png"/></td>
35-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112094426.png"/></td>
26+
<td><img src="docs/images/console.png"/></td>
27+
<td><img src="docs/images/project.png"/></td>
3628
</tr>
3729
<tr>
3830
<td width="50%" align="center"><b>CI/CD Pipeline</b></td>
3931
<td width="50%" align="center"><b>Application Store</b></td>
4032
</tr>
4133
<tr>
42-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20190925000712.png"/></td>
43-
<td><img src="https://pek3b.qingstor.com/kubesphere-docs/png/20191112095006.png"/></td>
34+
<td><img src="docs/images/cicd.png"/></td>
35+
<td><img src="docs/images/app-store.png"/></td>
4436
</tr>
4537
</table>
4638

4739
## 快速体验
4840

4941
使用体验账号 `demo1 / Demo123` 登录 [Demo 环境](https://demo.kubesphere.io/),该账号仅授予了 viewer 权限,建议自行安装体验完整的管理功能。您还可以访问 Youtube 查看 [KubeSphere Demo 视频](https://youtu.be/u5lQvhi_Xlc)
5042

43+
## 架构
44+
45+
KubeSphere 采用了前后端分离的架构设计,后端的各个功能组件可通过 REST API 对接外部系统,详见 [架构说明](https://kubesphere.com.cn/docs/zh-CN/introduction/architecture/)。本仓库仅包含后端代码,前端代码参考 [Console 项目](https://github.com/kubesphere/console)
46+
47+
![](docs/images/architecture.png)
48+
5149
## 核心功能
5250

5351
|功能 |介绍 |
@@ -65,18 +63,13 @@ KubeSphere 可以运行在任何私有或托管的 Kubernetes、私有云、公
6563
| GPU support | 集群支持添加 GPU 与 vGPU,可运行 TensorFlow 等 ML 框架 |
6664

6765

68-
> 以上功能说明详见 [产品功能](https://kubesphere.io/docs/v2.1/zh-CN/introduction/features/)
66+
> 以上功能说明详见 [产品功能](https://kubesphere.com.cn/docs/zh-CN/introduction/features/)
6967
7068
----
7169

72-
## 架构
73-
74-
KubeSphere 采用了前后端分离的架构设计,后端的各个功能组件可通过 REST API 对接外部系统,详见 [架构说明](https://kubesphere.com.cn/docs/v2.1/zh-CN/introduction/architecture/)。本仓库仅包含后端代码,前端代码参考 [Console 项目](https://github.com/kubesphere/console)
75-
76-
7770
## 最新发布
7871

79-
KubeSphere 2.1.1 已于 2020 年 02 月 23 日 正式发布,点击 [Release Notes For 2.1.1](https://kubesphere.io/docs/v2.1/zh-CN/release/release-v211/) 查看 2.1.1 版本的更新详情。
72+
KubeSphere 2.1.1 已于 2020 年 02 月 23 日 正式发布,点击 [Release Notes For 2.1.1](https://kubesphere.com.cn/docs/zh-CN/release/release-v211/) 查看 2.1.1 版本的更新详情。
8073

8174
## 快速安装
8275

@@ -101,14 +94,14 @@ curl -L https://kubesphere.io/download/stable/latest > installer.tar.gz \
10194
./install.sh
10295
```
10396

104-
直接选择 `"1) All-in-one"` 即可开始快速安装。默认仅开启最小安装,请参考 [开启可插拔功能功能组件](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/pluggable-components/) 按需开启其它功能组件。
97+
直接选择 `"1) All-in-one"` 即可开始快速安装。默认仅开启最小安装,请参考 [开启可插拔功能功能组件](https://kubesphere.com.cn/docs/zh-CN/installation/pluggable-components/) 按需开启其它功能组件。
10598

106-
> 注意:All-in-One 仅适用于**测试环境****正式环境** 安装和使用请参考 [安装说明](https://kubesphere.com.cn/docs/v2.1/zh-CN/installation/intro/)
99+
> 注意:All-in-One 仅适用于**测试环境****正式环境** 安装和使用请参考 [安装说明](https://kubesphere.com.cn/docs/zh-CN/installation/intro/)
107100
108101

109102
### 部署在 Kubernetes
110103

111-
可参考 [前提条件](https://kubesphere.io/docs/v2.1/zh-CN/installation/prerequisites/) 验证是否满足以下条件:
104+
可参考 [前提条件](https://kubesphere.com.cn/docs/zh-CN/installation/prerequisites/) 验证是否满足以下条件:
112105

113106
> - `Kubernetes` 版本: `1.15.x、1.16.x、1.17.x`
114107
> - `Helm`版本: `2.10.0 ≤ Helm Version < 3.0.0`(不支持 helm 2.16.0 [#6894](https://github.com/helm/helm/issues/6894)),且已安装了 Tiller,参考 [如何安装与配置 Helm](https://devopscube.com/install-configure-helm-kubernetes/) (预计 3.0 支持 Helm v3);
@@ -142,7 +135,7 @@ kubectl logs -n kubesphere-system $(kubectl get pod -n kubesphere-system -l app=
142135

143136
## 开发 KubeSphere
144137

145-
[开发指南](CONTRIBUTING.md) 详细说明了如何从源码编译、KubeSphere 的 GitHub 工作流、如何贡献代码以及如何测试等。
138+
[开发指南](https://github.com/kubesphere/community/tree/master/developer-guide/development) 详细说明了如何从源码编译、KubeSphere 的 GitHub 工作流、如何贡献代码以及如何测试等。
146139

147140
## 路线图
148141

@@ -169,15 +162,10 @@ KubeSphere 是 CNCF 基金会成员并且通过了 <a href="https://www.cncf.io/
169162

170163
## 技术社区
171164

172-
- [技术论坛](https://kubesphere.com.cn/forum/)
173-
165+
- [论坛](https://kubesphere.com.cn/forum/)
174166
- [Slack Channel](https://join.slack.com/t/kubesphere/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE)
175167

176-
- 微信群 (请备注 “公司 - 名字”)
177-
178-
<img width="150px" src="https://pek3b.qingstor.com/kubesphere-docs/png/20190902002055.png" />
179-
180168

181169
## Bug 与建议反馈
182170

183-
KubeSphere 的日益完善与快速发展离不开社区用户的支持,KubeSphere 也一直在反哺社区,为开源用户提供更多的支持。若您安装使用时有任何建议问题、反馈或发现的 Bug,欢迎在 [GitHub Issue](https://github.com/kubesphere/kubesphere/issues) 提交 Issue。
171+
欢迎在 [GitHub Issue](https://github.com/kubesphere/kubesphere/issues) 提交 Issue。

docs/cla.md

-26
This file was deleted.

0 commit comments

Comments
 (0)