From de2baa695b5c9d02ee1957cf7d27ab817a32ab28 Mon Sep 17 00:00:00 2001 From: runzexia Date: Mon, 25 Nov 2019 16:51:13 +0800 Subject: [PATCH] add project overrview Signed-off-by: runzexia --- docs/en/concepts-and-designs/README.md | 60 ++++++++++++++++++++++++ docs/en/concepts-and-designs/overview.md | 34 ++++++++++++++ docs/en/guides/README.md | 4 ++ 3 files changed, 98 insertions(+) create mode 100644 docs/en/concepts-and-designs/overview.md diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md index e69de29bb..d1f40885c 100644 --- a/docs/en/concepts-and-designs/README.md +++ b/docs/en/concepts-and-designs/README.md @@ -0,0 +1,60 @@ +# Concepts and Designs + +Concepts and Designs help you to learn and understand the KubeSphere and the landscape. + +## What is Kubesphere ? + +- [Overview and Core concepts](overview.md). Provides a high-level description and introduction, including the problems the project solves. + +- Project Goals. Provides the goals, which KubeSphere is trying to focus and provide features about them. + +After you read the above documents, you should understand the KubeSphere basic goals. Now, you can choose which following parts you are interested, then dive in. + +### KubeSphere Core + +### KubeSphere Installer + +### KubeSphere UI + +TODO: UI opensource is on the way + +### KubeSphere Application Management + +TODO(@pengcong) + +### KubeSphere Service Mesh + +TODO(@zryfish) + +## Porter + +TODO(@magicsong) + +### KubeSphere Networking + +TODO + +### KubeSphere DevOps + +TODO(@runzexia) + +### KubeSphere S2I/B2I + +TODO(@soulseen) + +### KubeSphere Monitoring + +TODO(@huanggze) + +### KubeSphere Logging + +TODO(@huanggze) + +### KubeSphere Altering + +TODO + +### KubeSphere Notification + +TODO + diff --git a/docs/en/concepts-and-designs/overview.md b/docs/en/concepts-and-designs/overview.md new file mode 100644 index 000000000..7f1f44a78 --- /dev/null +++ b/docs/en/concepts-and-designs/overview.md @@ -0,0 +1,34 @@ +# Overview + +KubeSphere is a multi-tenant cluster management platform which is based on Kubernetes. KubeSphere provides easy-to-use UI to reduce your learning cost for employing the container management platform and make it easier to develop, test and maintain your daily work. It's aimed to resolve the problems relating to Kubernetes’ storage, network, security and its usability. + +In addition, the platform has integrated and optimized a range of functional modules which are suitable for containers. KubeSphere provides enterprises with a complete solution for development, automation operation and maintenance, microservice governance, multi-tanency management. Besides, our platform is also able to manage workload, container cluster, service and network, application orchestration as well as database mirroring and storage. + + + + + + + + + + + + + + + + + + +
KubeSphere DashboardProject Resources
CI/CD PipelineApplication Template
+ + + +## Architecture + + + +KubeSphere adopts the separation of front and back ends, also realizes a cloud native design, the back ends' service components can communicate with external systems through the REST API, see [API documentation](https://kubesphere.io/docs/v2.0/api/kubesphere) for more details. All component are included in the architecture diagram below. KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any Kubernetes distribution. + +![](https://pek3b.qingstor.com/kubesphere-docs/png/20190810073322.png) diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md index 35a295fa8..356835a87 100644 --- a/docs/en/guides/README.md +++ b/docs/en/guides/README.md @@ -48,6 +48,10 @@ TODO(@pengcong) TODO(@zryfish) +### Porter developer + +TODO(@magicsong) + ### KubeSphere Networking developer ### KubeSphere DevOps developer