Skip to content

readme init #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlimeng merged 1 commit into from
Nov 15, 2021
Merged

readme init #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README-ZH.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Dimension节点、Transform节点、Sink节点和 [Visualis](https://github.com/

同时，请确保 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
45 changes: 25 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,41 @@
English | [中文](README-ZH.md)
## Introduction

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

       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.
       Based on the framework capabilities of [DataSphere Studio](https://github.com/WeBankFinTech/DataSphereStudio) and the underlying docking [Linkis](https://github.com/apache/incubator-linkis/blob/master/README.md) 's **Flink engine** 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 based on the Source node,
The Dimension node, Transform node, Sink node and [Visualis](https://github.com/WeBankFinTech/Visualis) nodes are connected in series to form a streaming workflow, allowing users to complete the development of streaming applications at a lower learning cost. Debug and release.
----

## Core features

#### Based on DataSphere Studio and DSS-Scriptis, build an industry-leading streaming application development management system.
#### Based on DSS and DSS-Scriptis, to create an industry-leading streaming application development management system.

#### 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 streaming application production center capabilities. Support multi-version management, full life cycle management, monitoring alarm, checkpoint and savepoint management capabilities of streaming jobs.
#### Powerful streaming application production center capabilities. Supports multi-version management, full life cycle management, monitoring alarm, checkpoint and savepoint management capabilities of streaming jobs.

#### 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.
#### 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

| Function module | describe | Streamis |
       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 |
| :----: | :----: |-------|
| 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 | 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 |
| High service availability | Multiple services, failure does not affect the use | Application high availability |
| System Management | Node and resource management | support |
| 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) |
|production center | Streaming application management operation and maintenance capabilities | support |
| | Reuse Linkis computing governance capabilities | support |
| |Support SQL and jar package release|support |
| High service availability | Multiple services, failure does not affect the use | Application high availability |
| System Management | Node and resource management | support |
----

## Architecture
Expand All @@ -46,14 +49,16 @@ English | [中文](README-ZH.md)
----

## Compile and install deployment
Please refer to [Compilation guidelines]() Flink engine compilation/Streamis compilation.
Please refer to [Compilation guidelines](docs/en_US/0.1.0/StreamisCompiledDocument.md) used to compile Streamis.

Please refer to [Install and deploy documentation]() Flink engine installation.
Before installing Streamis, please install Linkis1.0.3 and DSS1.0.2 first, please refer to:：[DSS deployment documents](https://github.com/WeBankFinTech/DataSphereStudio/blob/master/docs/en_US/ch1/DataSphereStudio_Compile_Manual.md) and [Linkis deployment documents](https://github.com/WeBankFinTech/Linkis-Doc/blob/master/en_US/Deployment_Documents/Quick_Deploy_Linkis1.0.md)

At the same time, please make sure that the Linkis Flink engine can be used normally, please refer to:[Linkis Flink Engine Plug-in Installation Document](https://github.com/WeBankFinTech/Linkis-Doc/blob/master/en_US/Deployment_Documents/EngineConnPlugin_installation_document.md)

Finally, please refer to [Streamis Installation and Deployment Document](docs/en_US/0.1.0/StreamisDeployment.md) for installing and deploying Streamis.
----
## Examples and usage guidelines
Please come [User documentation]() ,Learn how to use Streamis quickly.
Please come [User documentation](docs/en_US/userManual/StreamisUserManual.md) ,Learn how to use Streamis quickly.

----
## Communication contribution
Expand All @@ -64,5 +69,5 @@ Please come [User documentation]() ,Learn how to use Streamis quickly.

## License

       DSS is under the Apache 2.0 license. See the [License](LICENSE) file for details.
       DSS is under the Apache 2.0 license. See the [License](LICENSE) file for details.