You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2022/08/17 10:12:56 UTC
[incubator-linkis-website] branch dev updated: doc repair for linkis-web 1.2.0 (#485)
This is an automated email from the ASF dual-hosted git repository.
casion 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 a571eb8452 doc repair for linkis-web 1.2.0 (#485)
a571eb8452 is described below
commit a571eb8452a0675b07011e3724b50922b7fadd25
Author: aiceflower <ki...@sina.com>
AuthorDate: Wed Aug 17 18:12:52 2022 +0800
doc repair for linkis-web 1.2.0 (#485)
* update release doc for linkis-web 1.2.0
* es doc repair
---
docs/engine-usage/elasticsearch.md | 9 ++++---
docs/release.md | 31 ++++++++++++++++++++--
.../current/engine-usage/elasticsearch.md | 8 +++---
.../current/release.md | 31 ++++++++++++++++++++--
4 files changed, 67 insertions(+), 12 deletions(-)
diff --git a/docs/engine-usage/elasticsearch.md b/docs/engine-usage/elasticsearch.md
index ff5a1e62b5..8ec480969a 100644
--- a/docs/engine-usage/elasticsearch.md
+++ b/docs/engine-usage/elasticsearch.md
@@ -64,7 +64,7 @@ insert into `linkis_ps_configuration_category` (`label_id`, `level`) VALUES (@la
-- insert configuration key
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.cluster', 'eg:http://127.0.0.1:9200', 'connection address', 'http://127.0.0.1:9200', 'Regex', '^\\s*http://([^:]+)(:\\d+)(/[^\\?]+)?(\\?\\S*)?$', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
-INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.datasource', 'datasource', 'datasource', 'hadoop', 'None', '', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
+INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.datasource', 'datasource', 'datasource', 'hadoop', 'None', '', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.username', 'username', 'ES cluster username', 'None', 'None', '', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.password', 'password', 'ES cluster password', 'None', 'None', '', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.auth.cache', 'Whether the client is cache authenticated', 'Whether the client is cache authenticated', 'false', 'None', '', @ENGINE_NAME, 0, 0, 1, 'datasource conf');
@@ -101,7 +101,7 @@ INNER JOIN `linkis_cg_manager_label` label ON relation.engine_type_label_id = la
| linkis.es.sniffer.enable | false |no | Whether the sniffer is enabled on the client |
| linkis.es.http.method | GET | no | Request methods |
| linkis.es.http.endpoint | /_search |no | the Endpoint in JSON Script |
-| linkis.es.sql.endpoint | /_sql |no | the Endpoint in SQL |
+| linkis.es.sql.endpoint | /_sql |no | the Endpoint in SQL Script |
| linkis.es.sql.format | {"query":"%s"} | no | the template of SQL script call , %s replaced with SQL as the body of the request request ElasticSearch cluster |
| linkis.es.headers.* | None | no | Client Headers configuration |
| linkis.engineconn.concurrent.limit | 100 | no | Maximum engine concurrency of ElasticSearch cluster |
@@ -118,7 +118,7 @@ You can also specify in the RuntimeMap of the submitted task.
```shell
linkis.es.cluster
linkis.es.datasource
-linkis.es.username |
+linkis.es.username
linkis.es.password
```
@@ -137,8 +137,9 @@ For the ElasticSearch task, you only need to change the EngineConnType and CodeT
### 3.2 How to use Linkis-cli
**-codeType parameter description**
+
- essql：Execute ES engine tasks through SQL scripts
-- esjson：Execute ES engine tasks using JSON scripts
+- esjson：Execute ES engine tasks through JSON scripts
**Using the sample**
diff --git a/docs/release.md b/docs/release.md
index 7f26ef6cb6..2bb0cbe3ba 100644
--- a/docs/release.md
+++ b/docs/release.md
@@ -3,6 +3,8 @@ title: Version overview
sidebar_position: 0.1
---
+- [ElasticSearch Engine usage introduction](/engine-usage/elasticsearch.md)
+- [Presto Engine usage introduction](/engine-usage/presto.md)
- [Enable Prometheus monitoring](/deployment/involve-prometheus-into-linkis.md)
- [Custom Variable Design & Built-in Variables](/architecture/commons/variable.md)
- [EngineConn History Information Recording Features](/architecture/computation-governance-services/engine/engine-conn-history.md)
@@ -19,7 +21,32 @@ sidebar_position: 0.1
|common(application-linkis.yml) | New | eureka.instance.metadata-map:.prometheus.path|${prometheus.path:${prometheus.endpoint}} | ditto|
|common | New |wds.linkis.prometheus.enable | false| |
|common | Modify | wds.linkis.server.user.restful.uri.pass.auth | /api/rest_j/v1/actuator/prometheus| |
-|common | modify | spring.spring.cloud.config.enabled | false | |
+|common | Modify | spring.spring.cloud.config.enabled | false | |
+|ec-es | New | linkis.es.cluster | 127.0.0.1:9200 | ElasticSearch cluster，Separate multiple nodes using commas |
+|ec-es | New | linkis.es.username | None | ElasticSearch cluster username |
+|ec-es | New | linkis.es.password | None | ElasticSearch cluster password |
+|ec-es | New | linkis.es.auth.cache | false | Whether the client is cache authenticated |
+|ec-es | New | linkis.es.sniffer.enable | false | Whether Sniffer is enabled on the client |
+|ec-es | New | linkis.es.http.method | GET | request method |
+|ec-es | New | linkis.es.http.endpoint | /_search | the Endpoint in JSON Script |
+|ec-es | New | linkis.es.sql.endpoint | /_sql | the Endpoint in SQL |
+|ec-es | New | linkis.es.sql.format | {"query":"%s"} | the template of SQL script call , %s replaced with SQL as the body of the request request ElasticSearch cluster |
+|ec-es | New | linkis.es.headers.* | None | Client Headers configuration |
+|ec-es | New | linkis.engineconn.concurrent.limit | 100 | Maximum engine concurrency of ElasticSearch cluster |
+|ec-presto | New | wds.linkis.presto.url | http://127.0.0.1:8080 | Presto cluster connection |
+|ec-presto | New | wds.linkis.presto.username | default | Presto cluster username |
+|ec-presto | New | wds.linkis.presto.password | None | Presto cluster password |
+|ec-presto | New | wds.linkis.presto.catalog | system |Catalog for queries |
+|ec-presto | New | wds.linkis.presto.schema | None |Query Schema |
+|ec-presto | New | wds.linkis.presto.source | global | source used by the query |
+|ec-presto | New | presto.session.query_max_total_memory | 8GB | query uses maximum memory |
+|ec-presto | New | wds.linkis.presto.http.connectTimeout | 60 | Presto client connect timeout (unit: seconds) |
+|ec-presto | New | wds.linkis.presto.http.readTimeout | 60 | Presto client read timeout (unit: seconds) |
+|ec-presto | New | wds.linkis.engineconn.concurrent.limit | 100 | The maximum number of concurrent Presto engines |
+|ec-jdbc | Modify | wds.linkis.jdbc.connect.url | jdbc:mysql://127.0.0.1:3306/test | jdbc conn url |
+|ec-jdbc | Modify | wds.linkis.jdbc.driver | com.mysql.jdbc.Driver | jdbc conn driver |
+|ec-jdbc | Modify | wds.linkis.jdbc.username | None | jdbc conn username |
+|ec-jdbc | Modify | wds.linkis.jdbc.password | None | jdbc conn password |
## DB Table Changes
-For details, see the upgrade schema`db/upgrade/1.1.3_schema` file in the corresponding branch of the code repository (https://github.com/apache/incubator-linkis).
\ No newline at end of file
+For details, see the upgrade schema`db/upgrade/1.2.0_schema` file in the corresponding branch of the code repository (https://github.com/apache/incubator-linkis).
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine-usage/elasticsearch.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine-usage/elasticsearch.md
index ee59322f3f..85efdcd309 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine-usage/elasticsearch.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/engine-usage/elasticsearch.md
@@ -65,7 +65,7 @@ insert into `linkis_ps_configuration_category` (`label_id`, `level`) VALUES (@la
-- insert configuration key
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.cluster', 'eg:http://127.0.0.1:9200', 'connection address', 'http://127.0.0.1:9200', 'Regex', '^\\s*http://([^:]+)(:\\d+)(/[^\\?]+)?(\\?\\S*)?$', @ENGINE_NAME, 0, 0, 1, '数据源配置');
-INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.datasource', 'datasource', 'datasource', 'hadoop', 'None', '', @ENGINE_NAME, 0, 0, 1, '数据源配置');
+INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.datasource', 'datasource', 'datasource', 'hadoop', 'None', '', @ENGINE_NAME, 0, 0, 1, '数据源配置');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.username', 'username', 'ES cluster username', 'None', 'None', '', @ENGINE_NAME, 0, 0, 1, '数据源配置');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.password', 'password', 'ES cluster password', 'None', 'None', '', @ENGINE_NAME, 0, 0, 1, '数据源配置');
INSERT INTO `linkis_ps_configuration_config_key` (`key`, `description`, `name`, `default_value`, `validate_type`, `validate_range`, `engine_conn_type`, `is_hidden`, `is_advanced`, `level`, `treeName`) VALUES ('linkis.es.auth.cache', 'Whether the client is cache authenticated', 'Whether the client is cache authenticated', 'false', 'None', '', @ENGINE_NAME, 0, 0, 1, '数据源配置');
@@ -119,14 +119,14 @@ INNER JOIN `linkis_cg_manager_label` label ON relation.engine_type_label_id = la
```shell
linkis.es.cluster
linkis.es.datasource
-linkis.es.username |
+linkis.es.username
linkis.es.password
```
### 3.2 通过Linkis-cli进行任务提交
**-codeType 参数说明**
-- sql/essql：通过SQL语句的方式执行ElasticSearch引擎任务
-- json/esjson：通过JSON数据的方式执行ElasticSearch引擎任务
+- essql：通过SQL脚本的方式执行ElasticSearch引擎任务
+- esjson：通过JSON脚本的方式执行ElasticSearch引擎任务
**使用示例**
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/release.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/release.md
index 617ad357a6..38ff6e058a 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/release.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/release.md
@@ -2,6 +2,8 @@
title: 版本总览
sidebar_position: 0.1
---
+- [ElasticSearch引擎使用说明](/engine-usage/elasticsearch.md)
+- [Presto引擎使用说明](/engine-usage/presto.md)
- [开启Prometheus监控](/deployment/involve-prometheus-into-linkis.md)
- [自定义变量设计&内置变量](/architecture/commons/variable.md)
- [EngineConn 历史信息记录特性](/architecture/computation-governance-services/engine/engine-conn-history.md)
@@ -15,10 +17,35 @@ sidebar_position: 0.1
| ----------- | ----- | -------------------------------------------------------- | ---------------- | ------------------------------------------------------- |
|eureka(application-eureka.yml) | 新增 | management.endpoints.web.exposure.include|refresh,info,health,metrics | Spring Boot Actuator暴露端口范围|
|eureka(application-eureka.yml) | 新增 |eureka.instance.metadata-map:.prometheus.path| ${prometheus.path:/actuator/prometheus} | 注册在eureka元数据中的微服务prometheus监控端口|
-|common(application-linkis.yml) | 新增 | eureka.instance.metadata-map:.prometheus.path|${prometheus.path:${prometheus.endpoint}} | 同上|
+|common(application-linkis.yml) | 新增 | eureka.instance.metadata-map:.prometheus.path| ${prometheus.path:${prometheus.endpoint}}} | 同上|
|common | 新增 |wds.linkis.prometheus.enable | false| |
|common | 修改 | wds.linkis.server.user.restful.uri.pass.auth | /api/rest_j/v1/actuator/prometheus| |
|common | 修改 | spring.spring.cloud.config.enabled | false| |
+|ec-es | 新增 | linkis.es.cluster | 127.0.0.1:9200 | ElasticSearch 集群，多个节点使用逗号分隔 |
+|ec-es | 新增 | linkis.es.username | 无 | ElasticSearch 集群用户名 |
+|ec-es | 新增 | linkis.es.password | 无 | ElasticSearch 集群密码 |
+|ec-es | 新增 | linkis.es.auth.cache | false | 客户端是否缓存认证 |
+|ec-es | 新增 | linkis.es.sniffer.enable | false | 客户端是否开启 sniffer |
+|ec-es | 新增 | linkis.es.http.method | GET | 调用方式 |
+|ec-es | 新增 | linkis.es.http.endpoint | /_search | JSON 脚本调用的 Endpoint |
+|ec-es | 新增 | linkis.es.sql.endpoint | /_sql | SQL 脚本调用的 Endpoint |
+|ec-es | 新增 | linkis.es.sql.format | {"query":"%s"} | SQL 脚本调用的模板，%s 替换成 SQL 作为请求体请求Es 集群 |
+|ec-es | 新增 | linkis.es.headers.* | 无 | 客户端 Headers 配置 |
+|ec-es | 新增 | linkis.engineconn.concurrent.limit | 100 | 引擎最大并发 |
+|ec-presto | 新增 | wds.linkis.presto.url | http://127.0.0.1:8080 | Presto 集群连接 |
+|ec-presto | 新增 | wds.linkis.presto.username | default | Presto 集群用户名 |
+|ec-presto | 新增 | wds.linkis.presto.password | 无 | Presto 集群密码 |
+|ec-presto | 新增 | wds.linkis.presto.catalog | system | 查询的 Catalog |
+|ec-presto | 新增 | wds.linkis.presto.schema | 无 | 查询的 Schema |
+|ec-presto | 新增 | wds.linkis.presto.source | global | 查询使用的 source |
+|ec-presto | 新增 | presto.session.query_max_total_memory | 8GB | 查询使用最大的内存 |
+|ec-presto | 新增 | wds.linkis.presto.http.connectTimeout | 60 | Presto 客户端的 connect timeout（单位：秒） |
+|ec-presto | 新增 | wds.linkis.presto.http.readTimeout | 60 | Presto 客户端的 read timeout（单位：秒） |
+|ec-presto | 新增 | wds.linkis.engineconn.concurrent.limit | 100 | Presto 引擎最大并发数 |
+|ec-jdbc | 修改 | wds.linkis.jdbc.connect.url | jdbc:mysql://127.0.0.1:3306/test | jdbc连接url |
+|ec-jdbc | 修改 | wds.linkis.jdbc.driver | com.mysql.jdbc.Driver | jdbc连接驱动包 |
+|ec-jdbc | 修改 | wds.linkis.jdbc.username | 无 | jdbc连接用户名 |
+|ec-jdbc | 修改 | wds.linkis.jdbc.password | 无 | jdbc连接密码 |
## 数据库表变化
-详细见代码仓库(https://github.com/apache/incubator-linkis) 对应分支中的升级schema`db/upgrade/1.1.3_schema`文件
+详细见代码仓库(https://github.com/apache/incubator-linkis) 对应分支中的升级schema`db/upgrade/1.2.0_schema`文件
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org