This is an automated email from the ASF dual-hosted git repository.
peacewong pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 8c0ff23 update engine usage
new 42feb3f Merge pull request #93 from casionone/dev
8c0ff23 is described below
commit 8c0ff23e51ee127d8c9cb04a55b7d4c1a0e6bb31
Author: casionone <[email protected]>
AuthorDate: Thu Jan 6 18:02:27 2022 +0800
update engine usage
---
.github/workflows/deploy.yml | 4 ++--
docs/engine_usage/flink.md | 22 +++++++++++++++-----
docs/engine_usage/hive.md | 8 +++-----
docs/engine_usage/jdbc.md | 4 +---
docs/engine_usage/overview.md | 6 ++++--
docs/engine_usage/python.md | 4 +---
docs/engine_usage/shell.md | 4 ++--
docs/engine_usage/spark.md | 4 +---
.../current/engine_usage/flink.md | 24 ++++++++++++++++++----
.../current/engine_usage/overview.md | 7 +++++--
versioned_docs/version-1.0.2/engine_usage/hive.md | 7 +++----
versioned_docs/version-1.0.2/engine_usage/jdbc.md | 5 +----
.../version-1.0.2/engine_usage/python.md | 5 +----
versioned_docs/version-1.0.2/engine_usage/shell.md | 4 ++--
versioned_docs/version-1.0.2/engine_usage/spark.md | 4 +---
15 files changed, 64 insertions(+), 48 deletions(-)
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index c6ee04f..cf00e8a 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -2,9 +2,9 @@ name: Build and Deploy
on:
pull_request:
- branches: [dev]
+ branches: [dev-*]
push:
- branches: [dev]
+ branches: [dev-*]
schedule:
# Run everyday at 9:00 AM (See
https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07)
- cron: "0 5 * * *"
diff --git a/docs/engine_usage/flink.md b/docs/engine_usage/flink.md
index 0e2d082..ec566a9 100644
--- a/docs/engine_usage/flink.md
+++ b/docs/engine_usage/flink.md
@@ -1,4 +1,7 @@
-# Flink engine usage documentation
+---
+title: Flink Engine Usage
+sidebar_position: 8
+---
This article mainly introduces the configuration, deployment and use of the
flink engine in Linkis1.0.
@@ -53,13 +56,13 @@ cd ${LINKIS_HOME}/sbin
sh linkis-daemon restart cg-engineplugin
```
A more detailed introduction to engineplugin can be found in the following
article.
-https://github.com/WeBankFinTech/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
+[EngineConnPlugin Installation](deployment/engine_conn_plugin_installation.md)
### 2.3 Flink engine tags
Linkis1.0 is done through tags, so we need to insert data in our database, the
way of inserting is shown below.
-https://github.com/WeBankFinTech/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
+[EngineConnPlugin Installation > 2.2 Configuration modification of management
console (optional)](deployment/engine_conn_plugin_installation.md)
## 3. The use of Flink engine
@@ -67,7 +70,7 @@
https://github.com/WeBankFinTech/Linkis/wiki/EngineConnPlugin%E5%BC%95%E6%93%8E%
The Flink engine of Linkis 1.0 is started by flink on yarn, so you need to
specify the queue used by the user. The way to specify the queue is shown in
Figure 3-1.
-
+
Figure 3-1 Queue settings
@@ -105,7 +108,16 @@ select * from mysql_binlog where id> 10;
```
When debugging with select syntax in Scriptis, the Flink engine will have an
automatic cancel mechanism, that is, when the specified time is reached or the
number of sampled rows reaches the specified number, the Flink engine will
actively cancel the task, and it will have been obtained The result set of is
persisted, and then the front end will call the interface to open the result
set to display the result set on the front end.
-### 3.2 OnceEngineConn method
+### 3.2 Task submission via Linkis-cli
+
+After Linkis 1.0, a cli method is provided to submit tasks. We only need to
specify the corresponding EngineConn and CodeType tag types. The use of Hive is
as follows:
+```shell
+sh ./bin/linkis-cli -engineType flink-1.12.2 -codeType sql -code "show tables"
-submitUser hadoop -proxyUser hadoop
+```
+
+For specific usage, please refer to: [Linkis CLI
Manual](user_guide/linkiscli_manual.md).
+
+### 3.3 OnceEngineConn method
The use of OnceEngineConn is to officially start Flink's streaming
application. Specifically, it calls LinkisManager's createEngineConn interface
through LinkisManagerClient, and sends the code to the created Flink engine,
and then the Flink engine starts to execute. This method can be used by other
systems. Make a call, such as Streamis. The use of Client is also very simple,
first create a new maven project, or introduce the following dependencies in
your project
```xml
diff --git a/docs/engine_usage/hive.md b/docs/engine_usage/hive.md
index c38b0ac..b524e07 100644
--- a/docs/engine_usage/hive.md
+++ b/docs/engine_usage/hive.md
@@ -1,10 +1,8 @@
---
-title: Hive engineConn Usage
+title: Hive Engine Usage
sidebar_position: 2
---
-# Hive engineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of Hive
engineConn in Linkis1.0.
## 1. Environment configuration before Hive engineConn use
@@ -34,13 +32,13 @@ Other hive operating modes are similar, just copy the
corresponding dependencies
If you have already compiled your hive engineConn plug-in has been compiled,
then you need to put the new plug-in in the specified location to load, you can
refer to the following article for details
-[engineConnConnPlugin
Installation](deployment/engineConn_conn_plugin_installation.md)
+[EngineConnPlugin Installation](deployment/engine_conn_plugin_installation.md)
### 2.3 Linkis adds Hive console parameters(optional)
Linkis can configure the corresponding EngineConn parameters on the management
console. If your newly added EngineConn needs this feature, you can refer to
the following documents:
-[engineConnConnPlugin Installation > 2.2 Configuration modification of
management console
(optional)](deployment/engineConn_conn_plugin_installation.md)
+[EngineConnPlugin Installation > 2.2 Configuration modification of management
console (optional)](deployment/engine_conn_plugin_installation.md)
## 3. Use of hive engineConn
diff --git a/docs/engine_usage/jdbc.md b/docs/engine_usage/jdbc.md
index f7c6421..1db1d63 100644
--- a/docs/engine_usage/jdbc.md
+++ b/docs/engine_usage/jdbc.md
@@ -1,11 +1,9 @@
---
-title: JDBC EngineConn Usage
+title: JDBC Engine Usage
sidebar_position: 2
---
-# JDBC EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of JDBC
EngineConn in Linkis1.0.
## 1. Environment configuration before using the JDBC EngineConn
diff --git a/docs/engine_usage/overview.md b/docs/engine_usage/overview.md
index b252925..6e4c195 100644
--- a/docs/engine_usage/overview.md
+++ b/docs/engine_usage/overview.md
@@ -13,10 +13,11 @@ sidebar_position: 1
| Hive | Support | Support |
| Presto | Support | Support |
| ElasticSearch | Support | Support |
-| python | support | support |
+| Python | support | support |
| Shell | Support | Support |
| JDBC | Support | Support |
| MySQL | Support | Support |
+| Flink | Support | Support |
## 2. Document structure
You can refer to the following documents for the related documents of the
engines that have been accessed.
@@ -24,4 +25,5 @@ You can refer to the following documents for the related
documents of the engine
- [Hive Engine Usage](hive.md)
- [Python Engine Usage](python.md)
- [Shell Engine Usage](shell.md)
-- [JDBC Engine Usage](jdbc.md)
\ No newline at end of file
+- [JDBC Engine Usage](jdbc.md)
+- [Flink Engine Usage](flink.md)
\ No newline at end of file
diff --git a/docs/engine_usage/python.md b/docs/engine_usage/python.md
index 6a13512..97ee168 100644
--- a/docs/engine_usage/python.md
+++ b/docs/engine_usage/python.md
@@ -1,11 +1,9 @@
---
-title: Python EngineConn Usage
+title: Python Engine Usage
sidebar_position: 2
---
-# Python EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of the
Python EngineConn in Linkis1.0.
## 1. Environment configuration before using Python EngineConn
diff --git a/docs/engine_usage/shell.md b/docs/engine_usage/shell.md
index 82117fa..d99a4ca 100644
--- a/docs/engine_usage/shell.md
+++ b/docs/engine_usage/shell.md
@@ -1,9 +1,9 @@
---
-title: Shell EngineConn Usage
+title: Shell Engine Usage
sidebar_position: 2
---
-# Shell EngineConn usage document
+# Shell Engine Usage document
This article mainly introduces the configuration, deployment and use of Shell
EngineConn in Linkis1.0
## 1. The environment configuration before using the Shell EngineConn
diff --git a/docs/engine_usage/spark.md b/docs/engine_usage/spark.md
index 517a382..e5ec911 100644
--- a/docs/engine_usage/spark.md
+++ b/docs/engine_usage/spark.md
@@ -1,11 +1,9 @@
---
-title: Spark EngineConn Usage
+title: Spark Engine Usage
sidebar_position: 2
---
-# Spark EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of spark
EngineConn in Linkis1.0.
## 1. Environment configuration before using Spark EngineConn
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/flink.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/flink.md
index 89ac1af..dcc2f65 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/flink.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/flink.md
@@ -1,3 +1,8 @@
+---
+title: Flink 引擎
+sidebar_position: 8
+---
+
# Flink 引擎使用文档
本文主要介绍在Linkis1.0中，flink引擎的配置、部署和使用。
@@ -59,7 +64,7 @@
https://github.com/WeBankFinTech/Linkis/wiki/EngineConnPlugin%E5%BC%95%E6%93%8E%
Linkis1.0是通过标签来进行的，所以需要在我们数据库中插入数据，插入的方式如下文所示。
-https://github.com/WeBankFinTech/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
+[EngineConnPlugin引擎插件安装](deployment/engine_conn_plugin_installation.md)
## 3.Flink引擎的使用
@@ -67,7 +72,7 @@
https://github.com/WeBankFinTech/Linkis/wiki/EngineConnPlugin%E5%BC%95%E6%93%8E%
Linkis1.0的Flink引擎是通过flink on yarn的方式进行启动的,所以需要指定用户使用的队列。指定队列的方式如图3-1所示。
-
+
图3-1 队列设置
@@ -105,12 +110,23 @@ select * from mysql_binlog where id > 10;
```
在Scriptis中使用select语法进行调试的时候，Flink引擎会有一个自动cancel的机制，即到了指定的时间或者采样的行数到了指定的数量，Flink引擎将会主动将任务cancel，并且将已经获取到的结果集持久化，然后前端会调用打开结果集的接口将结果集在前端进行展示。
-### 3.2 OnceEngineConn方式
+
+### 3.2 通过Linkis-cli进行任务提交
+
+Linkis 1.0后提供了cli的方式提交任务，我们只需要指定对应的EngineConn和CodeType标签类型即可，Hive的使用如下：
+```shell
+sh ./bin/linkis-cli -engineType flink-1.12.2 -codeType sql -code "show tables"
-submitUser hadoop -proxyUser hadoop
+```
+
+具体使用可以参考： [Linkis CLI Manual](user_guide/linkiscli_manual.md).
+
+
+### 3.3 OnceEngineConn方式
OnceEngineConn的使用方式是用于正式启动Flink的流式应用,具体的是通过LinkisManagerClient调用LinkisManager的createEngineConn的接口，并将代码发给创建的Flink引擎，然后Flink引擎就开始执行，此方式可以被其他系统进行调用，比如Streamis。Client的使用方式也很简单，首先新建一个maven项目，或者在您的项目中引入以下的依赖
```xml
<dependency>
- <groupId>com.webank.wedatasphere.linkis</groupId>
+ <groupId>org.apache.linkis</groupId>
<artifactId>linkis-computation-client</artifactId>
<version>${linkis.version}</version>
</dependency>
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/overview.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/overview.md
index 315f800..f5683f8 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/overview.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine_usage/overview.md
@@ -12,10 +12,12 @@ sidebar_position: 0
| Hive | 支持 | 支持 |
| Presto | 支持 | 支持 |
| ElasticSearch | 支持 | 支持 |
-| python | 支持 | 支持 |
+| Python | 支持 | 支持 |
| Shell | 支持 | 支持 |
| JDBC | 支持 | 支持 |
| MySQL | 支持 | 支持 |
+| Flink | 支持 | 支持 |
+
## 2. 文档结构
已经接入的引擎相关文档可以参考如下文档。
@@ -23,4 +25,5 @@ sidebar_position: 0
- [Hive 引擎使用](hive.md)
- [Python 引擎使用](python.md)
- [Shell 引擎使用](shell.md)
-- [JDBC 引擎使用](jdbc.md)
\ No newline at end of file
+- [JDBC 引擎使用](jdbc.md)
+- [Flink 引擎使用](flink.md)
\ No newline at end of file
diff --git a/versioned_docs/version-1.0.2/engine_usage/hive.md
b/versioned_docs/version-1.0.2/engine_usage/hive.md
index c38b0ac..c4b530b 100644
--- a/versioned_docs/version-1.0.2/engine_usage/hive.md
+++ b/versioned_docs/version-1.0.2/engine_usage/hive.md
@@ -1,9 +1,8 @@
---
-title: Hive engineConn Usage
+title: Hive Engine Usage
sidebar_position: 2
---
-# Hive engineConn usage documentation
This article mainly introduces the configuration, deployment and use of Hive
engineConn in Linkis1.0.
@@ -34,13 +33,13 @@ Other hive operating modes are similar, just copy the
corresponding dependencies
If you have already compiled your hive engineConn plug-in has been compiled,
then you need to put the new plug-in in the specified location to load, you can
refer to the following article for details
-[engineConnConnPlugin
Installation](deployment/engineConn_conn_plugin_installation.md)
+[EngineConnPlugin Installation](deployment/engine_conn_plugin_installation.md)
### 2.3 Linkis adds Hive console parameters(optional)
Linkis can configure the corresponding EngineConn parameters on the management
console. If your newly added EngineConn needs this feature, you can refer to
the following documents:
-[engineConnConnPlugin Installation > 2.2 Configuration modification of
management console
(optional)](deployment/engineConn_conn_plugin_installation.md)
+[EngineConnPlugin Installation > 2.2 Configuration modification of management
console (optional)](deployment/engine_conn_plugin_installation.md)
## 3. Use of hive engineConn
diff --git a/versioned_docs/version-1.0.2/engine_usage/jdbc.md
b/versioned_docs/version-1.0.2/engine_usage/jdbc.md
index f7c6421..ed4372e 100644
--- a/versioned_docs/version-1.0.2/engine_usage/jdbc.md
+++ b/versioned_docs/version-1.0.2/engine_usage/jdbc.md
@@ -1,11 +1,8 @@
---
-title: JDBC EngineConn Usage
+title: JDBC Engine Usage
sidebar_position: 2
---
-
-# JDBC EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of JDBC
EngineConn in Linkis1.0.
## 1. Environment configuration before using the JDBC EngineConn
diff --git a/versioned_docs/version-1.0.2/engine_usage/python.md
b/versioned_docs/version-1.0.2/engine_usage/python.md
index 6a13512..1b46994 100644
--- a/versioned_docs/version-1.0.2/engine_usage/python.md
+++ b/versioned_docs/version-1.0.2/engine_usage/python.md
@@ -1,11 +1,8 @@
---
-title: Python EngineConn Usage
+title: Python Engine Usage
sidebar_position: 2
---
-
-# Python EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of the
Python EngineConn in Linkis1.0.
## 1. Environment configuration before using Python EngineConn
diff --git a/versioned_docs/version-1.0.2/engine_usage/shell.md
b/versioned_docs/version-1.0.2/engine_usage/shell.md
index 82117fa..d99a4ca 100644
--- a/versioned_docs/version-1.0.2/engine_usage/shell.md
+++ b/versioned_docs/version-1.0.2/engine_usage/shell.md
@@ -1,9 +1,9 @@
---
-title: Shell EngineConn Usage
+title: Shell Engine Usage
sidebar_position: 2
---
-# Shell EngineConn usage document
+# Shell Engine Usage document
This article mainly introduces the configuration, deployment and use of Shell
EngineConn in Linkis1.0
## 1. The environment configuration before using the Shell EngineConn
diff --git a/versioned_docs/version-1.0.2/engine_usage/spark.md
b/versioned_docs/version-1.0.2/engine_usage/spark.md
index 517a382..e5ec911 100644
--- a/versioned_docs/version-1.0.2/engine_usage/spark.md
+++ b/versioned_docs/version-1.0.2/engine_usage/spark.md
@@ -1,11 +1,9 @@
---
-title: Spark EngineConn Usage
+title: Spark Engine Usage
sidebar_position: 2
---
-# Spark EngineConn usage documentation
-
This article mainly introduces the configuration, deployment and use of spark
EngineConn in Linkis1.0.
## 1. Environment configuration before using Spark EngineConn
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
