Skip to content
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.

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

update installation documentation #33

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 12 additions & 15 deletions README-ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,27 @@ Dimension节点、Transform节点、Sink节点 和 [Visualis](https://github.com

       支持流式作业的多版本管理、全生命周期管理、监控告警、checkpoint 和 savepoint 管理能力。

![流式应用生产](docs/images/生产中心.png)
![流式应用生产](docs/images/stream_product_center.png)

       流式应用运行情况:

![流式应用运行情况](docs/images/流式作业运行情况.png)
![流式应用运行情况](docs/images/stream_job_detail.png)

       流式应用参数配置:

![流式应用配置](docs/images/流式应用配置.png)
![流式应用配置](docs/images/stream_job_config_1.png)
![流式应用配置](docs/images/stream_job_config_2.png)

       更多功能,请参考:[Streamis 用户手册](docs/zh_CN/0.2.0/使用文档/Streamis用户手册.md)。

----

## 依赖的生态组件

| 依赖的应用工具 | 描述 | Streamis 兼容版本 |
| -------------- | -------------------------------------------------------------- | --------------|
| [DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio) | 数据应用开发管理集成框架。以工作流式的图形化拖拽开发体验,将满足从数据交换、脱敏清洗、分析挖掘、质量检测、可视化展现、定时调度到数据输出应用等,数据应用开发全流程场景需求。 | >= DSS1.0.1(已发布)|
| [Linkis](https://github.com/apache/incubator-linkis) | 计算中间件 Apache Linkis,通过提供 REST/WebSocket/JDBC/SDK 等标准接口,上层应用可以方便地连接访问 MySQL/Spark/Hive/Presto/Flink 等底层引擎。 | >= Linkis1.0.3(已发布) |
| 依赖的应用工具 | 描述 | Streamis 兼容版本 |
|--------------|---------------------------------------------------------------|--------------|
| [DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio) | 数据应用开发管理集成框架。以工作流式的图形化拖拽开发体验,将满足从数据交换、脱敏清洗、分析挖掘、质量检测、可视化展现、定时调度到数据输出应用等,数据应用开发全流程场景需求。 | >= DSS1.1.0(已发布)|
| [Linkis](https://github.com/apache/incubator-linkis) | 计算中间件 Apache Linkis,通过提供 REST/WebSocket/JDBC/SDK 等标准接口,上层应用可以方便地连接访问 MySQL/Spark/Hive/Presto/Flink 等底层引擎。 | >= Linkis1.1.1(已发布) |

----

Expand All @@ -72,13 +73,7 @@ Dimension节点、Transform节点、Sink节点 和 [Visualis](https://github.com

## 编译和安装部署

       请参照 [编译指引](docs/zh_CN/0.2.0/development/Streamis编译文档.md) ,用于编译 Streamis。

       在安装Streamis之前,请先安装 Linkis1.0.3 和 DSS1.0.1,可参照:[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 安装部署文档](docs/zh_CN/0.2.0/Streamis安装文档.md) ,用于安装部署 Streamis。
       请参考 [Streamis 安装部署文档](docs/zh_CN/0.2.0/Streamis安装文档.md) ,用于安装部署 Streamis 及其依赖环境。


----
Expand All @@ -100,8 +95,10 @@ Dimension节点、Transform节点、Sink节点 和 [Visualis](https://github.com
| | 支持 FlinkSQL 和 FlinkJar 包等方式发布 | 支持 |
| | 流式应用的多版本管理能力 | 支持 |
| | 流式应用的参数配置和告警能力 | 支持 |
| 服务高可用 | 应用高可用,服务多点,故障不影响使用 | 支持 |
| 服务高可用 | 应用高可用,服务多点,状态快照实现容错处理,故障不影响使用 | 支持 |
| 系统管理 | 节点、资源管理 | 支持 |
|权限管理 |任务的操作权限控制 |支持 |

----

## 架构
Expand Down
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ The Dimension node, Transform node, Sink node and [Visualis](https://github.com/

| Depended Component | Description | Streamis compatibility |
| -------------- | -------------------------------------------------------------- | --------------|
| [DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio) | Data application development management framework. With a unified UI, the workflow-like graphical drag-and-drop development experience meets the entire lifecycle of data application development from data import, desensitization cleaning, data analysis, data mining, quality inspection, visualization, scheduling to data output applications, etc. | >= DSS1.0.1 (Released) |
| [Linkis](https://github.com/apache/incubator-linkis) | Apache Linkis, builds a layer of computation middleware, by using standard interfaces such as REST/WS/JDBC provided by Linkis, the upper applications can easily access the underlying engines such as MySQL/Spark/Hive/Presto/Flink, etc. | >= Linkis1.0.3 (Released) |
| [DataSphereStudio](https://github.com/WeBankFinTech/DataSphereStudio) | Data application development management framework. With a unified UI, the workflow-like graphical drag-and-drop development experience meets the entire lifecycle of data application development from data import, desensitization cleaning, data analysis, data mining, quality inspection, visualization, scheduling to data output applications, etc. | >= DSS1.1.0 (Released) |
| [Linkis](https://github.com/apache/incubator-linkis) | Apache Linkis, builds a layer of computation middleware, by using standard interfaces such as REST/WS/JDBC provided by Linkis, the upper applications can easily access the underlying engines such as MySQL/Spark/Hive/Presto/Flink, etc. | &gt= Linkis1.1.1 (Released) |

## Demo Trial environment

Expand All @@ -70,13 +70,7 @@ The Dimension node, Transform node, Sink node and [Visualis](https://github.com/

## Compile and install deployment

       Please refer to [Compilation guidelines](docs/en_US/0.1.0/StreamisCompiledDocument.md) used to compile Streamis.

       Before installing Streamis, please install Linkis1.0.3 and DSS1.0.1 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.
please refer to [Streamis Installation and Deployment Document](docs/en_US/0.2.0/StreamisDeployment.md) for installing and deploying Streamis.

----

Expand All @@ -98,8 +92,9 @@ The Dimension node, Transform node, Sink node and [Visualis](https://github.com/
| | Support FlinkSQL and FlinkJar package release | Support |
| | Multi-version management capabilities | Support |
| | Configuration and alert management capabilities | Support |
| Service high availability | Multiple services, failure does not affect the use | Application high availability |
| Service high availability | Multiple services,State snapshot for fault tolerance, failure does not affect the use | Application high availability |
| System Management | Node and Resource Management | Support |
| Permission management | Task operation permission control | Support |

----

Expand Down
28 changes: 0 additions & 28 deletions docs/en_US/0.1.0/StreamisCompiledDocument.md

This file was deleted.

165 changes: 0 additions & 165 deletions docs/en_US/0.1.0/StreamisDeployment.md

This file was deleted.

Loading