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 75b431f593 feat:adding scenarios for common parameters (#567)
75b431f593 is described below
commit 75b431f5937afcf3adfc42c93e0d071d85ef075d
Author: jacktao007 <[email protected]>
AuthorDate: Tue Nov 8 21:49:48 2022 +0800
feat:adding scenarios for common parameters (#567)
* feat:adding scenarios for common parameters
---
docs/tuning-and-troubleshooting/configuration.md | 99 ++++++++++++++++++++
.../tuning-and-troubleshooting/configuration.md | 101 +++++++++++++++++++++
.../tuning-and-troubleshooting/configuration.md | 87 ++++++++++++++++++
3 files changed, 287 insertions(+)
diff --git a/docs/tuning-and-troubleshooting/configuration.md
b/docs/tuning-and-troubleshooting/configuration.md
index 005a3d5719..3b7172f80d 100644
--- a/docs/tuning-and-troubleshooting/configuration.md
+++ b/docs/tuning-and-troubleshooting/configuration.md
@@ -238,3 +238,102 @@ sidebar_position: 1
|v1.1.0 | wds.linkis.server.mdm.service.sql.url |
jdbc:mysql://%s:%s/%s | set url format for
hive-metadata mysql service |
|v1.1.0 | wds.linkis.server.mdm.service.sql.connect.timeout | 3000
| set timeout for mysql connect
for hive-metadata mysql service |
|v1.1.0 | wds.linkis.server.mdm.service.sql.socket.timeout | 6000
| set timeout for socket open
for hive-metadata mysql service |
+
+### 7. Common scene parameters
+
+#### 7.1 Enable test mode
+If you need a no-seal interface during development, you can replace or add
this configuration in `linkis.properties`
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.test.mode | false | Whether to enable debug mode. If true, all
microservices support unencrypted login and all Engineconns open the remote
debug port |
+| wds.linkis.test.user | hadoop | Default logon user for password-free login
when wds.linkis.test.mode=true |
+
+
+#### 7.2 Login user Settings
+Apache Linkis uses a configuration file to manage admin users by default. This
configuration can be replaced or append in 'linkis-mg-gateway.properties'.
Multi-user access to LDAP implementation.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.admin.user | hadoop | Admin username |
+| wds.linkis.admin.password | 123456 | Admin password |
+
+#### 7.3 LDAP setup
+Apache Linkis can be parameterized to LDAP for multi-user management. You can
replace or append this configuration in 'linkis-mg-gateway.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.ldap.proxy.url | None | The LDAP URL address |
+| wds.linkis.ldap.proxy.baseDN | None | LDAP baseDN address |
+| wds.linkis.ldap.proxy.userNameFormat | None | |
+
+#### 7.4 Disable resource checking
+Apache Linkis sometimes has debugging exceptions when submitting tasks, such
as: insufficient resources; You can replace or append this configuration at
'linkis-cg-linkismanager.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.manager.rm.request.enable | true | Resources to check |
+
+#### 7.5 Enable engine debugging
+Apache Linkis EC can enable debugging mode, you can replace or append this
configuration in 'linkis-cg-Linkismanager.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.engineconn.debug.enable | false | Whether to enable engine
debugging |
+
+#### 7.6 Hive metadata configuration
+The public-service service of Apache Linkis reads hive metadata. You can
replace or append this configuration at 'linkis-ps-publicservice.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| hive.meta.url | None | HiveMetaStore database URL |
+| hive.meta.user | None | HiveMetaStore database user |
+| hive.meta.password | None | HiveMetaStore database password |
+
+#### 7.7 Linkis database configuration
+Apache Linkis access uses Mysql as the data store by default. You can replace
or append this configuration in 'linkis.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.mybatis.datasource.url | None | Database connection
string, such as: JDBC: mysql: / / 127.0.0.1:3306 / DSS? characterEncoding=UTF-8
|
+| wds.linkis.server.mybatis.datasource.username | None | Database user name,
for example, root |
+| wds.linkis.server.mybatis.datasource.password | None | Database password,
for example, root |
+
+#### 7.8 Linkis Session cache configuration
+Apache Linkis supports sharing sessions using redis; You can replace or append
this configuration at 'linkis.properties'.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| linkis.session.redis.cache.enabled | None | Whether open |
+| linkis.session.redis.host | 127.0.0.1 | host name |
+| linkis.session.redis.port | 6379 | port |
+| linkis.session.redis.password | None | password |
+
+
+#### 7.9 Linkis module development configuration
+During the development of Apache Linkis, the database, Rest interface and
entity object of the loading module can be customized through this parameter.
It can be modified in 'linkis-ps-publicservice.properties' with comma
separation between multiple modules.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.restful.scan.packages | None | restful Scan packages, for
example: org.apache.linkis.basedatamanager.server.restful |
+| wds.linkis.server.mybatis.mapperLocations | None | mybatis mapper file path,
for example:
`classpath*:org/apache/linkis/basedatamanager/server/dao/mapper/*.xml` |
+| wds.linkis.server.mybatis.typeAliasesPackage | None | Entity alias scan
package, for example:org.apache.linkis.basedatamanager.server.domain |
+| wds.linkis.server.mybatis.BasePackage | None | Database dao layer scanning,
for example:org.apache.linkis.basedatamanager.server.dao |
+
+#### 7.10 Linkis module development configuration
+When Apache Linkis is developed, the route of loading module can be customized
through this parameter; It can be modified in 'linkis.properties' with comma
separation between multiple modules.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.gateway.conf.publicservice.list |
cs,contextservice,data-source-manager,metadataQuery,metadatamanager,query,jobhistory,application,configuration,filesystem,udf,variable,microservice,errorcode,bml,datasource,basedata-manager
| publicservice Indicates the module that supports routing |
+
+#### 7.11 Linkis file system and material storage path
+Apache Linkis development through this parameter, control file and file
storage path; This can be modified in 'linkis.properties' to separate modules
by commas.
+
+| Parameter name | Default value | Description |
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.filesystem.root.path | file:///tmp/linkis/ | The local user
directory, in which a folder with the user's name should be created |
+| wds.linkis.filesystem.hdfs.root.path | hdfs:///tmp/ | HDFS user directory,
where a folder with the user's name should be created |
+| wds.linkis.bml.is.hdfs | true | Whether hdfs is enabled |
+| wds.linkis.bml.hdfs.prefix | /apps-data | HDFS path |
+| wds.linkis.bml.local.prefix | /apps-data | local path |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tuning-and-troubleshooting/configuration.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tuning-and-troubleshooting/configuration.md
index dd3c873d38..d17635ff17 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/tuning-and-troubleshooting/configuration.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/tuning-and-troubleshooting/configuration.md
@@ -239,3 +239,104 @@ sidebar_position: 1
|v1.1.0 | wds.linkis.server.mdm.service.sql.connect.timeout | 3000
| 设置mysql服务连接mysql服务的连接超时时间
|
|v1.1.0 | wds.linkis.server.mdm.service.sql.socket.timeout | 6000
| 设置mysql服务打开mysql服务的socket超时时间
|
|v1.1.0 | wds.linkis.server.mdm.service.temp.location |
/tmp/keytab |
设置服务的本地临时存储路径，主要是存储从bml物料服务下载的认证文件|
+
+
+### 7. 常用场景参数
+
+#### 7.1 开启测试模式
+开发过程需要免密接口，可在`linkis.properties`替换或追加此配置
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.test.mode | false | 是否打开调试模式，如果设置为
true，所有微服务都支持免密登录，且所有EngineConn打开远程调试端口 |
+| wds.linkis.test.user | hadoop | 当wds.linkis.test.mode=true时，免密登录的默认登录用户 |
+
+
+#### 7.2 登录用户设置
+Apache Linkis
默认使用配置文件来管理admin用户，可以在`linkis-mg-gateway.properties`替换或追加此配置。如需多用户可接入LDAP实现。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.admin.user | hadoop | 管理员用户名 |
+| wds.linkis.admin.password | 123456 | 管理员用户密码 |
+
+#### 7.3 LDAP设置
+Apache Linkis 可以通过参数接入LDAP实现多用户管理，可以在`linkis-mg-gateway.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.ldap.proxy.url | 无 | LDAP URL地址 |
+| wds.linkis.ldap.proxy.baseDN | 无 | LDAP baseDN地址 |
+| wds.linkis.ldap.proxy.userNameFormat | 无 | |
+
+#### 7.4 关闭资源检查
+Apache Linkis
提交任务时有时会调试异常，如：资源不足；可以在`linkis-cg-linkismanager.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.manager.rm.request.enable | true | 资源检查 |
+
+#### 7.5 开启引擎调试
+Apache Linkis EC可以开启调试模式，可以在`linkis-cg-linkismanager.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.engineconn.debug.enable | false | 是否开启引擎调试 |
+
+#### 7.6 Hive元数据配置
+Apache Linkis
的public-service服务需要读取hive的元数据；可以在`linkis-ps-publicservice.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| hive.meta.url | 无 | HiveMetaStore数据库的URL。 |
+| hive.meta.user | 无 | HiveMetaStore数据库的user |
+| hive.meta.password | 无 | HiveMetaStore数据库的password |
+
+#### 7.7 Linkis 数据库配置
+Apache Linkis 访问默认使用Mysql作为数据存储，可以在`linkis.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.mybatis.datasource.url | 无 |
数据库连接字符串，例如：jdbc:mysql://127.0.0.1:3306/dss?characterEncoding=UTF-8 |
+| wds.linkis.server.mybatis.datasource.username | 无 | 数据库用户名，例如：root |
+| wds.linkis.server.mybatis.datasource.password | 无 | 数据库密码，例如：root |
+
+#### 7.8 Linkis Session 缓存配置
+Apache Linkis 支持使用redis进行session的共享；可以在`linkis.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| linkis.session.redis.cache.enabled | None | 是否开启 |
+| linkis.session.redis.host | 127.0.0.1 | 主机名 |
+| linkis.session.redis.port | 6379 | 端口，例如 |
+| linkis.session.redis.password | None | 密码 |
+
+
+
+#### 7.9 Linkis 模块开发配置
+Apache Linkis
开发时可通过此参数，自定义加载模块的数据库、Rest接口、实体对象；可以在`linkis-ps-publicservice.properties`进行修改，多个模块之间使用逗号分割。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.restful.scan.packages | 无 | restful
扫描包，例如：org.apache.linkis.basedatamanager.server.restful |
+| wds.linkis.server.mybatis.mapperLocations | 无 | mybatis mapper文件路径，例如：
classpath*:org/apache/linkis/basedatamanager/server/dao/mapper/*.xml|
+| wds.linkis.server.mybatis.typeAliasesPackage | 无 |
实体别名扫描包，例如：org.apache.linkis.basedatamanager.server.domain |
+| wds.linkis.server.mybatis.BasePackage | 无 |
数据库dao层扫描，例如：org.apache.linkis.basedatamanager.server.dao |
+
+#### 7.10 Linkis 模块开发配置
+Apache Linkis 开发时可通过此参数，自定义加载模块的路由；可以在`linkis.properties`进行修改，多个模块之间使用逗号分割。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.gateway.conf.publicservice.list |
cs,contextservice,data-source-manager,metadataQuery,metadatamanager,query,jobhistory,application,configuration,filesystem,udf,variable,microservice,errorcode,bml,datasource,basedata-manager
| publicservice服务支持路由的模块 |
+
+#### 7.11 Linkis 文件系统及物料存放路径
+Apache Linkis 开发时可通过此参数，自定义加载模块的路由；可以在`linkis.properties`进行修改，多个模块之间使用逗号分割。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.filesystem.root.path | file:///tmp/linkis/ |
本地用户目录，需在该目录下建立以用户名为名称的文件夹 |
+| wds.linkis.filesystem.hdfs.root.path | hdfs:///tmp/ | HDFS用户目录 |
+| wds.linkis.bml.is.hdfs | true | 是否启用hdfs |
+| wds.linkis.bml.hdfs.prefix | /apps-data | hdfs路径 |
+| wds.linkis.bml.local.prefix | /apps-data | 本地路径 |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/tuning-and-troubleshooting/configuration.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/tuning-and-troubleshooting/configuration.md
index dd3c873d38..6d7511bac5 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/tuning-and-troubleshooting/configuration.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.3.0/tuning-and-troubleshooting/configuration.md
@@ -239,3 +239,90 @@ sidebar_position: 1
|v1.1.0 | wds.linkis.server.mdm.service.sql.connect.timeout | 3000
| 设置mysql服务连接mysql服务的连接超时时间
|
|v1.1.0 | wds.linkis.server.mdm.service.sql.socket.timeout | 6000
| 设置mysql服务打开mysql服务的socket超时时间
|
|v1.1.0 | wds.linkis.server.mdm.service.temp.location |
/tmp/keytab |
设置服务的本地临时存储路径，主要是存储从bml物料服务下载的认证文件|
+
+### 7. 常用场景参数
+
+#### 7.1 开启测试模式
+开发过程需要免密接口，可在`linkis.properties`替换或追加此配置
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.test.mode | false | 是否打开调试模式，如果设置为
true，所有微服务都支持免密登录，且所有EngineConn打开远程调试端口 |
+| wds.linkis.test.user | hadoop | 当wds.linkis.test.mode=true时，免密登录的默认登录用户 |
+
+
+#### 7.2 登录用户设置
+Apache Linkis
默认使用配置文件来管理admin用户，可以在`linkis-mg-gateway.properties`替换或追加此配置。如需多用户可接入LDAP实现。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.admin.user | hadoop | 管理员用户名 |
+| wds.linkis.admin.password | 123456 | 管理员用户密码 |
+
+#### 7.3 LDAP设置
+Apache Linkis 可以通过参数接入LDAP实现多用户管理，可以在`linkis-mg-gateway.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.ldap.proxy.url | 无 | LDAP URL地址 |
+| wds.linkis.ldap.proxy.baseDN | 无 | LDAP baseDN地址 |
+| wds.linkis.ldap.proxy.userNameFormat | 无 | |
+
+#### 7.4 关闭资源检查
+Apache Linkis
提交任务时有时会调试异常，如：资源不足；可以在`linkis-cg-linkismanager.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.manager.rm.request.enable | true | 资源检查 |
+
+#### 7.5 开启引擎调试
+Apache Linkis EC可以开启调试模式，可以在`linkis-cg-linkismanager.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.engineconn.debug.enable | false | 是否开启引擎调试 |
+
+#### 7.6 Hive元数据配置
+Apache Linkis
的public-service服务需要读取hive的元数据；可以在`linkis-ps-publicservice.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| hive.meta.url | 无 | HiveMetaStore数据库的URL。 |
+| hive.meta.user | 无 | HiveMetaStore数据库的user |
+| hive.meta.password | 无 | HiveMetaStore数据库的password |
+
+#### 7.7 Linkis 数据库配置
+Apache Linkis 访问默认使用Mysql作为数据存储，可以在`linkis.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.mybatis.datasource.url | 无 |
数据库连接字符串，例如：jdbc:mysql://127.0.0.1:3306/dss?characterEncoding=UTF-8 |
+| wds.linkis.server.mybatis.datasource.username | 无 | 数据库用户名，例如：root |
+| wds.linkis.server.mybatis.datasource.password | 无 | 数据库密码，例如：root |
+
+#### 7.8 Linkis Session 缓存配置
+Apache Linkis 支持使用redis进行session的共享；可以在`linkis.properties`替换或追加此配置。
+
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| linkis.session.redis.cache.enabled | None | 是否开启 |
+| linkis.session.redis.host | 127.0.0.1 | 主机名 |
+| linkis.session.redis.port | 6379 | 端口，例如 |
+| linkis.session.redis.password | None | 密码 |
+
+
+
+#### 7.9 Linkis 模块开发配置
+Apache Linkis
开发时可通过此参数，自定义加载模块的数据库、Rest接口、实体对象；可以在`linkis-ps-publicservice.properties`进行修改，多个模块之间使用逗号分割。
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.server.restful.scan.packages | 无 | restful
扫描包，例如：org.apache.linkis.basedatamanager.server.restful |
+| wds.linkis.server.mybatis.mapperLocations | 无 | mybatis mapper文件路径，例如：
classpath*:org/apache/linkis/basedatamanager/server/dao/mapper/*.xml|
+| wds.linkis.server.mybatis.typeAliasesPackage | 无 |
实体别名扫描包，例如：org.apache.linkis.basedatamanager.server.domain |
+| wds.linkis.server.mybatis.BasePackage | 无 |
数据库dao层扫描，例如：org.apache.linkis.basedatamanager.server.dao |
+
+#### 7.10 Linkis 模块开发配置
+Apache Linkis 开发时可通过此参数，自定义加载模块的路由；可以在`linkis.properties`进行修改，多个模块之间使用逗号分割。
+| 参数名 | 默认值 | 描述
|
+| ------------------------- | ------- |
-----------------------------------------------------------|
+| wds.linkis.gateway.conf.publicservice.list |
cs,contextservice,data-source-manager,metadataQuery,metadatamanager,query,jobhistory,application,configuration,filesystem,udf,variable,microservice,errorcode,bml,datasource,basedata-manager
| publicservice服务支持路由的模块 |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
