diff --git a/docs/en_US/0.1.0/FlinkEnginePluginCompileDocument.md b/docs/en_US/0.1.0/FlinkEnginePluginCompileDocument.md new file mode 100644 index 000000000..ad63a4547 --- /dev/null +++ b/docs/en_US/0.1.0/FlinkEnginePluginCompileDocument.md @@ -0,0 +1,54 @@ +# Flink Engine Compilation Guide + +This doc is a step-by-step guidance of the compilation of flink engine in Linkis 1.0.2. + +### 1. Configuration and compilation of Flink engine + +The Flink version supported by *Linkis 1.0.2* is ***Flink 1.12.2***. Theoretically, *Linkis 1.x* is able to support various versions of Flink, however, the API difference between Flink versions is too big to ignore, so you may need to modify the code of the Flink engine in Linkis project code (according to the API changes) and recompile it. + +### 2. Flink engineConn compilation and loading + +The Flink engine will not be installed by default in *Linkis 1.0.2*, you need to compile and install it manually. + +**Compile** the Flink engine separately: + +``` +${linkis_code_dir}/linkis-enginepconn-lugins/engineconn-plugins/flink/ +mvn clean install +``` + +Once the compilation completes, you can get the Flink engine package flink-engineconn.zip in the ${linkis_code_dir}/linkis-enginepconn-lugins/engineconn-plugins/flink/target directory. + +Then, **deploy** the flink-engineconn.zip package to + +``` +${LINKIS_HOME}/lib/linkis-engineplugins +``` + +and **unzip** it. + +The directory structure of the Flink engine package is: + +``` +flink +├── dist +│   └── v1.12.2 +│   ├── conf +│   ├── conf.zip +│   ├── lib +│   └── lib.zip +└── plugin + └── 1.12.2 + └── linkis-engineconn-plugin-flink-1.0.2.jar +``` + +Next, **restart** linkis-engineplugin: + +``` +cd ${LINKIS_HOME}/sbin +sh linkis-daemon restart cg-engineplugin +``` + +For more detailed introduction of the engineplugin, please refer to [this article](https://github.com/apache/incubator-linkis/wiki/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#22-%E7%AE%A1%E7%90%86%E5%8F%B0configuration%E9%85%8D%E7%BD%AE%E4%BF%AE%E6%94%B9%E5%8F%AF%E9%80%89). + +Please note that once you **unzip** the Flink engine package (flink-engineconn.zip), it is recommended to delete the flink-engineconn.zip immediately to avoid loading it into the library after the engine started. \ No newline at end of file diff --git a/docs/en_US/0.1.0/StreamisCompiledDocument.md b/docs/en_US/0.1.0/StreamisCompiledDocument.md new file mode 100644 index 000000000..ca6a4856e --- /dev/null +++ b/docs/en_US/0.1.0/StreamisCompiledDocument.md @@ -0,0 +1,28 @@ +# Streamis Compilation Guide + +This doc is a step-by-step compilation guidance of Streamis, a streaming application platform, including front-end web and back-end server. + +### 1. Streamis code compilation + +Get the source code from [github](https://github.com/WeBankFinTech/Streamis), and compile it: + +#### Back-end server: + +``` +cd ${STREAMIS_CODE_HOME} +mvn -N install +mvn clean install +``` + +Once the compilation completes, you can get the installation package wedatasphere-streamis-0.1.0-dist.tar.gz in the *${STREAMIS_CODE_HOME}/assembly/target* directory. + +#### Front-end server: + +``` +cd ${STREAMIS_CODE_HOME}/web +npm i +npm run build +``` + +Once the compilation completes, you can get the installation package dist.zip in the *${STREAMIS_CODE_HOME}/web* directory. + diff --git "a/docs/zh_CN/AppConn\347\232\204\344\275\277\347\224\250.md" "b/docs/zh_CN/0.1.0/AppConn\347\232\204\344\275\277\347\224\250.md" similarity index 100% rename from "docs/zh_CN/AppConn\347\232\204\344\275\277\347\224\250.md" rename to "docs/zh_CN/0.1.0/AppConn\347\232\204\344\275\277\347\224\250.md" diff --git "a/docs/zh_CN/0.1.0/Flink\345\274\225\346\223\216\347\274\226\350\257\221\346\226\207\346\241\243.md" "b/docs/zh_CN/0.1.0/Flink\345\274\225\346\223\216\347\274\226\350\257\221\346\226\207\346\241\243.md" new file mode 100644 index 000000000..18bf85efa --- /dev/null +++ "b/docs/zh_CN/0.1.0/Flink\345\274\225\346\223\216\347\274\226\350\257\221\346\226\207\346\241\243.md" @@ -0,0 +1,54 @@ +# Flink引擎编译文档 + +本文主要介绍在Linkis1.0.2中，Flink引擎的编译 + +### 1、Flink引擎的配置和部署 + +Linkis1.0.2支持的Flink版本是Flink1.12.2,理论上Linkis1.x 可以支持各个版本的Flink,但是Flink个版本之间的API差异太大，可能需要您按照API的变化修改Linkis中Flink引擎的代码并重新编译。 + +### 2、Flink engineConn的部署和加载 + +Linkis Flink引擎默认在Linkis1.0.2中是不会安装的，需要您手动进行编译并安装。 + +单独编译Flink引擎的方式 + +``` +${linkis_code_dir}/linkis-enginepconn-lugins/engineconn-plugins/flink/ +mvn clean install +``` + +编译完成后，您可以在${linkis_code_dir}/linkis-enginepconn-lugins/engineconn-plugins/flink/target目录下获取到Flink引擎的引擎包flink-engineconn.zip + +然后将其部署到 + +``` +${LINKIS_HOME}/lib/linkis-engineplugins +``` + +并将其解压，Flink引擎包的目录结构 + +``` +flink +├── dist +│   └── v1.12.2 +│   ├── conf +│   ├── conf.zip +│   ├── lib +│   └── lib.zip +└── plugin + └── 1.12.2 + └── linkis-engineconn-plugin-flink-1.0.2.jar +``` + +并重启linkis-engineplugin + +``` +cd ${LINKIS_HOME}/sbin +sh linkis-daemon restart cg-engineplugin +``` + +engineplugin更详细的介绍可以参看下面的文章。 +https://github.com/apache/incubator-linkis/wiki/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#22-%E7%AE%A1%E7%90%86%E5%8F%B0configuration%E9%85%8D%E7%BD%AE%E4%BF%AE%E6%94%B9%E5%8F%AF%E9%80%89 + +需要注意的是，当您解压完Flink引擎包后，建议将flink-engineconn.zip删除，避免引擎启动后，将flink-engineconn.zip加载进物料库中。 + diff --git "a/docs/zh_CN/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" "b/docs/zh_CN/0.1.0/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" similarity index 91% rename from "docs/zh_CN/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" rename to "docs/zh_CN/0.1.0/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" index 442114e14..f9e4ee109 100644 --- "a/docs/zh_CN/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" +++ "b/docs/zh_CN/0.1.0/Streamis\344\275\277\347\224\250\346\226\207\346\241\243.md" @@ -38,22 +38,22 @@ meta.txt文件中存储任务的基本信息，具体格式和内容如下： 项目名(projectName)，任务名(jobName)，文件名(fileName)，单个标签（tag）均限制为最大长度为64字符，且仅允许输入中文，数字，英文和下划线。描述（description）长度限制为128字符，内容不做限制。 meta.txt的一个样例如下
-![components](../images/zh_CN/meta_txt_demo.png) +![components](../../images/zh_CN/meta_txt_demo.png) ### 1.2流式应用物料包上传 物料打包结束之后，进入streamis流式应用管理中心,开始上传物料包
-![components](../images/zh_CN/upload_zip.png) +![components](../../images/zh_CN/upload_zip.png) ### 1.3流式应用参数配置 物料包上传完毕之后，就可以看到已经有一个新的流式应用，点击该流式应用，可以进入配置界面
-![components](../images/zh_CN/streamis_config.png) +![components](../../images/zh_CN/streamis_config.png) ### 1.4流式应用启停 参数等内容配置完毕之后，即可以开启流式应用
-![components](../images/zh_CN/start-app.png) +![components](../../images/zh_CN/start-app.png) ## 2.实时数仓版本使用 ---------- diff --git "a/docs/zh_CN/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" "b/docs/zh_CN/0.1.0/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" similarity index 99% rename from "docs/zh_CN/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" rename to "docs/zh_CN/0.1.0/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" index fe009f864..8ee85b51e 100644 --- "a/docs/zh_CN/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" +++ "b/docs/zh_CN/0.1.0/Streamis\345\256\211\350\243\205\346\226\207\346\241\243.md" @@ -91,7 +91,7 @@ sh bin/start-streamis.sh - 启动验证 验证方式，因为Streamis和Linkis同用一套Eureka,所以您需要检查Linkis的Eureka页面是否已经包含了Streamis的服务，如图, -![components](../images/zh_CN/eureka_streamis.png) +![components](../../images/zh_CN/eureka_streamis.png) diff --git "a/docs/zh_CN/0.1.0/Streamis\347\274\226\350\257\221\346\226\207\346\241\243.md" "b/docs/zh_CN/0.1.0/Streamis\347\274\226\350\257\221\346\226\207\346\241\243.md" new file mode 100644 index 000000000..9a1c63251 --- /dev/null +++ "b/docs/zh_CN/0.1.0/Streamis\347\274\226\350\257\221\346\226\207\346\241\243.md" @@ -0,0 +1,30 @@ +# Streamis编译文档 + +本文主要介绍Streamis流式应用平台的编译，包括前端web和后端server。 + +### 1、Streamis代码编译 + +​ 从github上面获取源代码 + +​ 后台编译方式如下： + +``` +cd ${STREAMIS_CODE_HOME} +mvn -N install +mvn clean install +``` + +执行成功后会在工程的${STREAMIS_CODE_HOME}/assembly/target目录下生成安装包wedatasphere-streamis-0.1.0-dist.tar.gz + + 前端编译方式如下 + +``` +cd ${STREAMIS_CODE_HOME}/web +npm i +npm run build +``` + +编译成功后 + +在${STREAMIS_CODE_HOME}/web目录下生成dist.zip +