update README to 2.0.2, refine development guide, add screenshots
Signed-off-by: 周鹏飞@yunify <pengfeizhou@yunify.com>
This commit is contained in:
周鹏飞@yunify
13
README.md
13
README.md
@@ -14,7 +14,7 @@
|
||||
|
||||
## Features
|
||||
|
||||
KubeSphere Advanced Edition 2.0.1 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:
|
||||
KubeSphere Advanced Edition 2.0.2 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:
|
||||
|
||||
|
||||
- Workload management
|
||||
@@ -33,13 +33,15 @@ KubeSphere Advanced Edition 2.0.1 provides an easy-to-use console with the aweso
|
||||
|
||||
It also supports multiple open source storage and high-performance cloud storage as the persistent storage services, as well as supports 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.
|
||||
> Note:
|
||||
> - See the [Screenshots](docs/screenshots.md) of KubeSphere to have a most intuitive understanding of KubeSphere dashboard and features.
|
||||
> - 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.
|
||||
|
||||
----
|
||||
|
||||
## Latest Release
|
||||
|
||||
KubeSphere Advanced Edition 2.0.1 was released on **May 18th, 2019**. See the [Release Notes For 2.0.1](https://docs.kubesphere.io/advanced-v2.0/release/release-v201/) to preview the updates.
|
||||
KubeSphere Advanced Edition 2.0.2 was released on **July 9th, 2019**. See the [Release Notes For 2.0.2](https://docs.kubesphere.io/advanced-v2.0/release/release-v202/) to preview the updates.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -58,12 +60,11 @@ KubeSphere Advanced Edition 2.0.1 was released on **May 18th, 2019**. See the [R
|
||||
[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. Execute following commands to download and install KubeSphere in a single node.
|
||||
|
||||
```bash
|
||||
$ curl -L https://kubesphere.io/download/stable/advanced-2.0.1 > advanced-2.0.1.tar.gz && tar -zxf advanced-2.0.1.tar.gz
|
||||
$ cd kubesphere-all-advanced-2.0.1/scripts
|
||||
$ curl -L https://kubesphere.io/download/stable/advanced-2.0.2 > advanced-2.0.2.tar.gz && tar -zxf advanced-2.0.2.tar.gz && cd kubesphere-all-advanced-2.0.2/scripts
|
||||
$ ./install.sh
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
Choose `"1) All-in-one"` to trigger the installation. Generally, you can install it directly without any configuration. For details please reference [All-in-One](https://docs.kubesphere.io/advanced-v2.0/zh-CN/installation/all-in-one/).
|
||||
|
||||
|
||||
@@ -25,6 +25,14 @@ KubeSphere uses `dep` to manage dependencies in the `vendor/` tree, execute foll
|
||||
```go
|
||||
go get -u github.com/golang/dep/cmd/dep
|
||||
```
|
||||
#### Dependencies
|
||||
|
||||
[kubesphere/kubesphere](https://github.com/kubesphere/kubesphere) repository contains the source code . If you're looking for its dependent components, they live in their own repositories since they can be individual and universal.
|
||||
|
||||
- [Alert](https://github.com/kubesphere/alert): Alert is an enterprise-grade general-purpose high-performance alerting system.
|
||||
- [Notification](https://github.com/openpitrix/notification): Notification is an enterprise-grade general-purpose high-performance notification system, it provides email notification service for KubeSphere currently.
|
||||
- [OpenPitrix](https://github.com/openpitrix/openpitrix): Application management platform on multi-cloud environment, it provides application template and application management for KubeSphere currently.
|
||||
- [SonarQube](https://github.com/SonarSource/sonarqube): Integrated in KubeSphere DevOps, it provides the capability to not only show health of an application but also to highlight issues newly introduced.
|
||||
|
||||
### Test
|
||||
|
||||
@@ -153,6 +161,10 @@ The components of KubeSphere need to be compiled and build include following:
|
||||
|
||||
After your PR is merged，Travis CI will compile the entire project and build the image, and push the image `kubespheredev/[component-name]:latest` to Dockerhub (e.g. `kubespheredev/ks-apiserver:latest`)
|
||||
|
||||
## API Reference
|
||||
|
||||
KubeSphere provides standard RESTFul API and detailed API documentations for developers, see [KubeSphere API Reference](https://docs.kubesphere.io/advanced-v2.0/zh-CN/api-reference/api-docs/) for more information.
|
||||
|
||||
## Code conventions
|
||||
|
||||
Please reference [Code conventions](https://github.com/kubernetes/community/blob/master/contributors/guide/coding-conventions.md) and follow with the rules.
|
||||
|
||||
54
docs/screenshots.md
Normal file
54
docs/screenshots.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# KubeSphere Screenshots
|
||||
|
||||
Screenshots of various KubeSphere dashboard views:
|
||||
|
||||
## Workbench Overview
|
||||
|
||||
|
||||
|
||||
## Application Template
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Project Resources Management
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## DevOps Project
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Node Management
|
||||
|
||||
|
||||
|
||||
## Service Components
|
||||
|
||||
|
||||
|
||||
## Workspace Management
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Monitoring Center
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Log and Alert
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user