Skip to content

Commit

Permalink
Some optimization of docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
wushengyeyouya committed Nov 12, 2021
1 parent 77ccd40 commit c9a5833
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 90 deletions.
38 changes: 22 additions & 16 deletions README-ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,39 @@

## 引言

       Streamis 是微众银行联合萨摩耶金服和仙翁科技联合共建的一站式流式应用开发管理系统
       Streamis **微众银行** 联合 **天翼云****仙翁科技****萨摩耶云** 联合共建的流式应用开发管理系统

       基于DataSphere Studio的Orchestrator编排模式、工作流微模块和框架化能力,以及底层对接Linkis的Flink引擎,以工作流式的图形化拖拽开发体验,将实时流式应用以Source节点、
Dimension节点、Transform节点、Sink节点和Visualis节点串连成一条实时工作流,让用户几乎0学习成本完成流式应用的开发、调试、发布和生产管理。
       基于 [DataSphere Studio](https://github.com/WeBankFinTech/DataSphereStudio) 的框架化能力,以及底层对接 [Linkis](https://github.com/apache/incubator-linkis)**Flink 引擎**,让用户低成本完成流式应用的开发、调试、发布和生产管理。

       未来还规划将以工作流式的图形化拖拽开发体验,将流式应用以Source节点、
Dimension节点、Transform节点、Sink节点和 [Visualis](https://github.com/WeBankFinTech/Visualis) 节点串连成一条流式工作流,让用户以更低的学习成本完成流式应用的开发、调试和发布。

----

## 核心特点

#### 基于DSS,打造业界领先的工作流式图形化拖拽开发体验
#### 基于 DSS 和 DSS-Scriptis,打造业界领先的流式应用开发管理系统

#### 覆盖流式应用开发全流程。提供Source节点、Dimension节点、Transform节点、Sink节点和Visualis节点,基本满足流式应用的所有使用场景
#### 强大的流式应用开发调试能力,基于 DSS-Scriptis 提供流式应用的开发和调试功能,支持对 FlinkSQL 进行实时调试和结果集展示

#### 强大的调试和数据预览能力。基于DSS的跨系统、跨用户级上下文能力,让流式工作流真正具备“开发即调试”、“调试即预览”的开发能力
#### 强大的流式应用生产中心能力。支持流式作业的多版本管理、全生命周期管理、监控告警、checkpoint和savepoint管理能力

#### 基于Linkis计算中间件,打造金融级高并发、高可用、多租户隔离和资源管控等全生命周期管理与checkpoint能力的实时生产中心
#### 基于 Linkis 计算中间件,打造金融级具备高并发、高可用、多租户隔离和资源管控等能力的流式生产中心

----

## 与类似系统对比

       Streamis是一个引领流式应用开发方向的开源项目,开源社区目前尚没有同类型产品。

| 功能模组 | 描述 | Streamis |
| :----: | :----: |-------|
| UI | 集成便捷的管理界面和监控窗口| 已集成 |
| 安装部署 | 部署难易程度和第三方依赖 | 一键部署,依赖Linkis Flink引擎 |
| 开发中心| 流式应用编辑 | 支持(未开源),集成DSS |
| | 与DSS无缝衔接,支持工作流 | 支持 (未开源) |
| 开发中心| FlinkSQL 流式应用实时开发、调试 | 支持,需集成DSS |
|生产中心 | 流式应用管理运维能力 | 支持 |
| | 复用Linkis计算治理能力 | 支持 |
| |支持SQL和jar包等方式发布|支持 |
| 服务高可用 | 服务多点,故障不影响使用| 应用高可用 |
| | 复用 Linkis 计算治理能力 | 支持 |
| |支持 FlinkSQL 和 FlinkJar 包等方式发布 | 支持 |
| 服务高可用 | 服务多点,故障不影响使用 | 应用高可用 |
| 系统管理 | 节点、资源管理 | 支持 |
----

Expand All @@ -49,14 +49,20 @@ Dimension节点、Transform节点、Sink节点和Visualis节点串连成一条
----

## 编译和安装部署
请参照 [编译指引]() Flink引擎编译/Streamis编译。

请参考 [安装部署文档]() Flink引擎安装。
请参照 [编译指引](docs/zh_CN/0.1.0/development/Streamis编译文档.md) ,用于编译 Streamis。

在安装Streamis之前,请先安装 Linkis1.0.3 和 DSS1.0.2,可参照:[DSS + Linkis 安装部署文档](https://github.com/WeBankFinTech/DataSphereStudio-Doc/blob/main/zh_CN/%E5%AE%89%E8%A3%85%E9%83%A8%E7%BD%B2/DSS%E5%8D%95%E6%9C%BA%E9%83%A8%E7%BD%B2%E6%96%87%E6%A1%A3.md)

同时,请确保 Linkis Flink 引擎已可正常使用,可参照:[Linkis Flink 引擎插件安装文档](https://github.com/WeBankFinTech/Linkis-Doc/blob/master/zh_CN/Deployment_Documents/EngineConnPlugin%E5%BC%95%E6%93%8E%E6%8F%92%E4%BB%B6%E5%AE%89%E8%A3%85%E6%96%87%E6%A1%A3.md)

最后,请参考 [Streamis 安装部署文档]() ,用于安装部署 Streamis。


----
## 示例和使用指引
请到 [用户使用文档]() ,了解如何快速使用Streamis。

请到 [用户使用文档](docs/zh_CN/0.1.0/使用文档/Streamis用户手册.md) ,了解如何快速使用 Streamis。

----
## 交流贡献
Expand Down
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,33 @@
English | [中文](README-ZH.md)
## Introduction

       Streamis is an associated joint development application management system jointly established by WeBank Samoyed Financial Services and Xian Weng Technology.
       Streamis is a streaming application development and management system jointly built by **WeBank** in conjunction with **Ctyun**, **Xianweng Technology** and **Samoyed Cloud**.

       Based on DataSphere Studio’s Orchestrator orchestration mode, workflow micro-modules and framework capabilities, as well as the underlying docking Linkis’s Flink engine, using a workflow-style graphical drag-and-drop development experience, real-time streaming applications are based on Source nodes,
The Dimension node, Transform node, Sink node and Visualis node are cascaded into a real-time workflow, allowing users to complete the development, debugging, release and production management of streaming applications with almost zero learning costs.
       Based on the framework capabilities of [DataSphere Studio](https://github.com/WeBankFinTech/DataSphereStudio) and the underlying engine with the **Flink engine* of [Linkis](https://github.com/apache/incubator-linkis) *, Streamis allows users to complete the development, debugging, release and production management of streaming applications at low cost.

       In the future, it is also planned to use a workflow-style graphical drag-and-drop development experience, and the streaming application will be formed as a streaming workflow by connected series of the Source node, Dimension node, Transform node, Sink node and [Visualis](https://github.com/WeBankFinTech/Visualis) nodes, allowing users to develope, debug and publish streaming applications at a lower learning cost.

----

## Core features

#### Based on DSS, create a star-like workflow graphical drag-and-drop development experience.
#### Based on DataSphere Studio and DSS-Scriptis, build an industry-leading streaming application development management system.

#### Cover the whole process of streaming application development. Provides Source node, Dimension node, Transform node, Sink node and Visualis node, basically satisfying all usage scenarios of streaming applications.
#### Powerful streaming application development and debugging capabilities, based on DSS-Scriptis, provides streaming application development and debugging functions, and supports real-time debugging and result set display of FlinkSQL.

#### Powerful debugging and data preview capabilities. Based on the cross-system and cross-user-level context capabilities of DSS, the flow workflow truly has the development capabilities of "development is debugging" and "debugging is preview".
#### Powerful streaming application production center capabilities. Support multi-version management, full life cycle management, monitoring alarm, checkpoint and savepoint management capabilities of streaming jobs.

#### Based on Linkis computing middleware, build a real-time production center with financial-level high concurrency, high availability, multi-tenant isolation, and resource management and control, and other full life cycle management and checkpoint capabilities.
#### Based on Linkis computing middleware, build a financial-level streaming production center with high concurrency, high availability, multi-tenant isolation, and resource management and control capabilities.

----

## Comparison With Existing Systems

       Streamis is an open source project that leads the direction of streaming application development. There is no similar product in the open source community.

| Function module | describe | Streamis |
| Function module | describe | Streamis |
| :----: | :----: |-------|
| UI | Integrated convenient management interface and monitoring window | Integrated |
| Installation and deployment | Ease of deployment and third-party dependence | One-click deployment, relying on Linkis Flink engine |
| open your heart | Streaming application editing | Support (not open source), integrated DSS |
| | Seamlessly connect with DSS and support workflow | Support (not open source) |
| open your heart | support to develop and debug streaming applications | Support , integrated DSS |
|production center | Streaming application management operation and maintenance capabilities | support |
| | Reuse Linkis computing governance capabilities | support |
| |Support SQL and jar package release|support |
Expand Down
62 changes: 0 additions & 62 deletions docs/zh_CN/0.1.0/Streamis使用文档.md

This file was deleted.

0 comments on commit c9a5833

Please sign in to comment.