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/22 14:01:31 UTC
[incubator-linkis-website] branch dev updated: Linkis debugging guide documentation merged (#488)
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 8b940683a6 Linkis debugging guide documentation merged (#488)
8b940683a6 is described below
commit 8b940683a638d6dccb344b0c3fd33a0c02c384d8
Author: weixiao <le...@gmail.com>
AuthorDate: Mon Aug 22 22:01:26 2022 +0800
Linkis debugging guide documentation merged (#488)
Linkis debugging guide documentation merged
---
docs/development/linkis-debug-in-mac.md | 472 ------------------
docs/development/linkis-debug.md | 540 +++++++++++++++-----
.../current/development/linkis-debug-in-mac.md | 472 ------------------
.../current/development/linkis-debug.md | 538 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.0/development/linkis-debug.md | 535 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.1/development/linkis-debug.md | 541 ++++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.2/development/linkis-debug.md | 538 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.3/development/linkis-debug.md | 538 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.0/development/linkis-debug.md | 530 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.1/development/linkis-debug.md | 537 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.2/development/linkis-debug.md | 540 +++++++++++++++-----
.../development/linkis-debug-in-mac.md | 472 ------------------
.../version-1.1.3/development/linkis-debug.md | 540 +++++++++++++++-----
20 files changed, 4118 insertions(+), 5979 deletions(-)
diff --git a/docs/development/linkis-debug-in-mac.md b/docs/development/linkis-debug-in-mac.md
deleted file mode 100644
index 494bb1e15f..0000000000
--- a/docs/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: Linkis Debug In Mac
-sidebar_position: 2
----
-
-> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell.
-
-## 1. Code debugging environment
-
-- Mac OS m1 chip, Linkis' `linkis-cg-engineplugin` and `linkis-cg-engineconnmanager` services do not currently support debugging on Windows. You can refer to the development documentation on the official website for remote debugging.
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x, this article theoretically supports local development and debugging of Linkis 1.0.3 and above
-
-## 2. Prepare the code and compile
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-````
-
-Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
-
-```shell
-mvn -N install
-mvn clean install
-````
-
-After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
-
-## 3. Configure and start the service
-
-### 3.1 add mysql-connector-java to the classpath
-
-If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
-
-The services currently relying on mysql are:
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 Adjust log4j2.xml configuration
-
-Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-
-
-
-Only the configuration content that needs to be added is posted here.
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 Start the eureka service
-
-Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-
-Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-
-You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-
-
-
-Parameter explanation:
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-If you don't want the default 20303 port, you can modify the port configuration:
-
-```shell
-File path: conf/application-eureka.yml
-Modify the port:
-server:
- port: 8080 ##Starting port
-````
-
-After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-
-
-
-### 3.4 Start linkis-mg-gateway
-
-linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-
-Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-Set the startup Application of linkis-mg-gateway
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-After the above settings are completed, the Application can be run directly.
-
-### 3.5 Start linkis-ps-publicservice
-
-publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
-
-Set the startup Application of linkis-ps-publicservice
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting publicservice directly, you may encounter the following errors:
-
-
-
-The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
-
-
-
-
-
-
-
-
-
-After completing the above configuration, restart the Application of publicservice
-
-### 3.6 Start linkis-ps-cs
-
-Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.7 Start linkis-cg-linkismanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.8 Start linkis-cg-entrance
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.9 Start cg-engineconnmanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
--DJAVA_HOME is to specify the path where the java command used by ecm to start the engine is located
-
-### 3.10 Start linkis-cg-engineplugin
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting engineplugin, you may encounter the following error:
-
-
-
-The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
-
-### 3.11 Key Configuration Modifications
-
-The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis underlying database connection parameter configuration
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# Set the bml material storage path to not hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# Set the administrator username, your local username
-wds.linkis.governance.station.admin=leojie
-```
-
-Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
-
-The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# The result set is saved in the directory, the local user needs read and write permissions
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-If you do not modify it, you may encounter an exception that the path does not exist.
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-
-### 3.12 Set sudo password-free for the current user
-
-When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
-save file exit
-```
-
-### 3.13 Service Testing
-
-Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
-
-First visit the login interface to generate a cookie:
-
-
-
-Then submit the shell code for execution
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body parameter:
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-Results of the:
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-Finally, check the running status of the task and get the running result set:
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/docs/development/linkis-debug.md b/docs/development/linkis-debug.md
index 41973481b4..af8c11f0e0 100644
--- a/docs/development/linkis-debug.md
+++ b/docs/development/linkis-debug.md
@@ -3,229 +3,507 @@ title: Linkis Debug
sidebar_position: 2
---
-# Debugging related
-
-> Because linkis itself has many modules, it is difficult to debug, the following will guide you how to perform a local service debugging (based on version 1.0.3).
+> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell. On Mac OS, each microservice of Linkis supports local debugging.
+> However, on Windows OS, linkis-cg-engineplugin and linkis-cg-engineconnmanager do not support local debugging for the time being. You can refer to the remote debugging documentation in Section 4 below for debugging.
<h4><font color="red">Before version 1.0.3, linkis has not yet entered apache incubation. The organization still belongs to webank. The package name of the main class is `org.apache.linkis`. Pay attention to the distinction when debugging. </font></h4>
-## step 1 Prepare source code and compile
-```plain
-git clone https://github.com/apache/incubator-linkis.git
+## 1. Code debugging environment
+
+- jdk1.8
+- maven3.5+
+
+## 2. Prepare the code and compile
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
cd incubator-linkis
-#If needed, you can switch to the corresponding branch
-#git checkout dev-xxx
+git checkout dev-1.2.0
+````
+
+Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
+
+```shell
mvn -N install
mvn clean install
-```
+````
+
+After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
+
+## 3. Configure and start the service
-## step2 Necessary parameter configuration
+### 3.1 add mysql-connector-java to the classpath
-For the configuration file under incubator-linkis/linkis-dist/package/conf/, you need to configure the database and hive meta and other necessary startup parameters.
+If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
+The services currently relying on mysql are:
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
+### 3.2 Adjust log4j2.xml configuration
-## step3 Adjust log4j.xml configuration
+Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-In order to facilitate the printing of logs to the console during debugging, you need to modify the default log4j2.xml file and modify the appender to default to console. You need to remove the append of the default RollingFile and add the appender of the console, as shown below:
-
-log4j2.xml path incubator-linkis/linkis-dist/package/conf/log4j2.xml
+
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+Only the configuration content that needs to be added is posted here.
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M]-%msg%xEx %n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M-%msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 Overall debugging plan
-Both Linkis and DSS services rely on Eureka, so you need to start the Eureka service first, and the Eureka service can also use the Eureka you have started. After Eureka is started, other services can be started.
+### 3.3 Start the eureka service
-Because linkis internally uses the -DserviceName parameter to set the application name and the configuration file used, so -DserviceName is a necessary startup VM parameter
+Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-You can use the "-Xbootclasspath/a: configuration file path" command. Append the configuration file to the end of the search path of the bootloader class, and add the dependent configuration file to the classpath
+Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-<font color="red"> By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging. </font>
+You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-**Microservice Governance Services component**
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-### Start of linkis-mg-eureka
+
-```plain
-[main Class]
+Parameter explanation:
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[User classpath of module]
-linkis-eureka
```
-If you don’t want the default port 20303, you can modify the port configuration:
-```yml
+
+Note that the local path involved in the debugging configuration needs to be modified to the path set by yourself;
+The path writing rule in Windows is: D:\yourDir\incubator-linkis\linkis-dist\package\conf
+(The same applies to the following microservices)
+
+If you don't want the default 20303 port, you can modify the port configuration:
+
+```shell
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Started port
-```
-##### The specific configuration is as follows
+ port: 8080 ##Starting port
+````
-Old version idea configuration
-
-New version of idea configuration
-
+After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-After startup, you can view the list of eureka services through [http://localhost:20303/](http://localhost:20303/)
-
+
-### Linkis-mg-gateway startup configuration
+### 3.4 Start linkis-mg-gateway
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+Set the startup Application of linkis-mg-gateway
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-Note If there is a problem of'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j'
-Please exclude, the dependency on spring-boot-starter-logging
-**Public Enhancement Services component**
-### Linkis-ps-publicservice startup configuration
+After the above settings are completed, the Application can be run directly.
-```plain
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
+### 3.5 Start linkis-ps-publicservice
+
+publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
+
+Set the startup Application of linkis-ps-publicservice
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-[Use classpath of module]
-#linkis < 1.1.0 by linkis-jobhistory
-#linkis >= 1.1.0 by linkis-storage-script-dev-server
-linkis-storage-script-dev-server
+[main Class]
+org.apache.linkis.filesystem.LinkisPublicServiceApp
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### Linkis-ps-cs startup configuration
+When starting publicservice directly, you may encounter the following errors:
-```plain
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
+
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
+
+
+
+
+
+
+
+
+
+After completing the above configuration, restart the Application of publicservice
+
+### 3.6 Start linkis-ps-cs
+
+Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
linkis-cs-server
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.cs.server.LinkisCSApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-**Computation Governance Services component**
-### linkis-cg-linkismanager start
+### 3.7 Start linkis-cg-linkismanager
-```plain
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
+
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
linkis-application-manager
+
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.manager.am.LinkisManagerApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### linkis-cg-entrance start
-```plain
+
+### 3.8 Start linkis-cg-entrance
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-entrance
+
+[Use classpath of module]
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.9 Start cg-engineconnmanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+-DJAVA_HOME is to specify the path of the java command used by ecm to start the engine. If the version in the default JAVA environment variable meets your needs, this configuration can be omitted.
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.10 Start linkis-cg-engineplugin
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-<h4><font color="red">Note: Windows local debugging service is not currently supported</font></h4>
+When starting engineplugin, you may encounter the following error:
+
+
+
+The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
-linkis-cg-engineplugin(ecp): Need to read local ecp materials, local debugging needs to prepare the corresponding materials first, it is recommended to debug remotely
+### 3.11 Key Configuration Modifications
-linkis-cg-engineconnmanager(ecm): temporarily ecm starts the engine using the unix method and does not support the windows environment
+The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis underlying database connection parameter configuration
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# Set the bml material storage path to not hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# Set the administrator username, your local username
+wds.linkis.governance.station.admin=leojie
```
-The following are the specific detailed command parameters for starting the linkis service after a normal and successful installation
-LinkisInstallDir: complete linkis installation directory
+Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
+
+The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1> / data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1> /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+#### 3.11.2 conf/linkis-cg-entrance.properties
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1> /data/LinkisInstallDir /logs/linkis-ps-publicservice.out &
+```properties
+# The log directory of the entrance service execution task
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+# The result set is saved in the directory, the local user needs read and write permissions
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+```
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1> /data /LinkisInstallDir/logs/linkis-ps-cs.out &
+If you do not modify it, you may encounter an exception that the path does not exist.
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1> /data/LinkisInstallDir /logs/linkis-cg-entrance.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
```
-## Remote debugging service steps
+The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
+
+### 3.12 Set sudo password-free for the current user
+
+When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
+save file exit
+```
+
+### 3.13 Service Testing
+
+Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
+
+First visit the login interface to generate a cookie:
+
+
+
+Then submit the shell code for execution
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body parameter:
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+Results of the:
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+Finally, check the running status of the task and get the running result set:
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
+```
+
+## 4. Remote debugging service guide
+
+### 4.1 Open the remote debugging port
+
+Identify the service where the package that needs to be debugged is located, and determine the service to which it belongs according to the location of the code to be debugged
+
+### 4.2 Enter {LINKIS_HOME}/sbin/ext, modify the module configuration file to open the remote call port
+
+
+### 4.3 Restart the service that needs to be debugged
-### 1. Open remote debugging port
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+````
-#### 1.1 specify the service of the package to be debugged
-Determine the service it belongs to according to the location of the code to be debugged
+(If you are not sure about the service name, check in {LINKIS_HOME}/sbin/linkis-start-all.sh )
-#### 1.2 enter {LINKIS_HOME}/sbin/ext, modify the module configuration file, and open the remote call port
-
+### 4.4 Compiler configuration remote debugging
-### 2. Restart the service to be debugged
-sh linkis-daemon.sh restart ps-configuration (if you are not sure about the service name, query in {links_home}/sbin/links-start-all.sh)
+Open the window as shown below and configure the remote debugging port, service, and module
+
-### 3. Compiler configuration remote debugging
-As shown in the figure below, open the window and configure the port, service and module of remote debugging
-
+### 4.5 Start debugging
-### 4. Start debugging
-click the debugging button, and the following information appears, which means you can start debugging
-
-y
\ No newline at end of file
+Click the debug button, and the following information appears, indicating that you can start debugging
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug-in-mac.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug-in-mac.md
deleted file mode 100644
index 51e3b54ffc..0000000000
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: 在Mac上调试Linkis
-sidebar_position: 2
----
-
-> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。
-
-## 1. 代码调试环境
-
-- Mac OS m1芯片，Linkis的`linkis-cg-engineplugin`和`linkis-cg-engineconnmanager`两个服务暂不支持在Windows上进行调试，可参考官网的开发文档进行远程调试。
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x ，本篇文章理论上可支持对Linkis1.0.3和以上版本的本地开发调试
-
-## 2. 准备代码并编译
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-```
-
-克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-
-```shell
-mvn -N install
-mvn clean install
-```
-
-编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
-
-## 3. 配置并启动服务
-
-### 3.1 add mysql-connector-java到classpath中
-
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-
-目前依赖mysql的服务有：
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 调整log4j2.xml配置
-
-在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-
-
-
-这里只贴出来需要新增的配置内容。
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 启动eureka服务
-
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-
-在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-
-可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-
-
-
-参数解释：
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-如果不想默认的20303端口可以修改端口配置：
-
-```shell
-文件路径：conf/application-eureka.yml
-修改端口：
-server:
- port: 8080 ##启动的端口
-```
-
-上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-
-
-
-### 3.4 启动linkis-mg-gateway
-
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
-启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-设置 linkis-mg-gateway的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-上述设置完成之后，可直接运行此Application。
-
-### 3.5 启动linkis-ps-publicservice
-
-publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
-
-设置linkis-ps-publicservice的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-直接启动publicservice时，可能会遇到如下报错：
-
-
-
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
-
-
-
-做完上述配置后重新启动publicservice的Application
-
-### 3.6 启动linkis-ps-cs
-
-启动ps-cs服务之前，需要保证publicservice服务成功启动。
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.7 启动linkis-cg-linkismanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.8 启动linkis-cg-entrance
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.9 启动cg-engineconnmanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径
-
-### 3.10 启动linkis-cg-engineplugin
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-启动engineplugin的时候可能会遇到如下报错：
-
-
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-
-### 3.11 关键配置修改
-
-以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis底层数据库连接参数配置
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# 设置bml物料存储路径不为hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# 设置管理员用户名，你的本机用户名
-wds.linkis.governance.station.admin=leojie
-```
-
-在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
-
-其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-不修改可能会遇到路径不存在异常。
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-
-### 3.12 为当前用户设置sudo免密
-
-引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
-保存文件退出
-```
-
-### 3.13 服务测试
-
-保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
-
-首先访问登录接口来生成Cookie:
-
-
-
-然后提交执行shell代码
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body参数：
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-执行结果：
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-最后检查任务运行状态和获取运行结果集：
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug.md
index 737792bcaa..e046d6ad81 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/development/linkis-debug.md
@@ -3,223 +3,507 @@ title: 服务调试指引
sidebar_position: 2
---
-# 调试相关
-
-> 因为linkis本身模块比较多，调试起来有一定的难度，下面就指导大家如何进行一次本地的服务调试(基于1.0.3版本)。
+> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
+> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
-## step 1 准备源码并编译
+## 1. 代码调试环境
+
+- jdk1.8
+- maven3.5+
+
+## 2. 准备代码并编译
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
+cd incubator-linkis
+git checkout dev-1.2.0
+```
+
+克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-```plain
-git clone https://github.com/apache/incubator-linkis.git
-cd incubator-linkis
-#如果需要 可以切换到对应的分支上
-#git checkout dev-xxx
-mvn -N install
-mvn clean install
+```shell
+mvn -N install
+mvn clean install
```
-## step2 必要的参数配置
+编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
+
+## 3. 配置并启动服务
+
+### 3.1 add mysql-connector-java到classpath中
+
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
+
+目前依赖mysql的服务有：
-对于incubator-linkis/linkis-dist/package/conf/下的配置文件，需要对数据库以及hive meta等必要启动参数进行配置。
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
-## step3 调整log4j.xml配置
+### 3.2 调整log4j2.xml配置
-为了方便调试的时候将日志打印到控制台，需要修改下默认的log4j2.xml文件，修改appender默认为console。需要移除默认的RollingFile的append，增加console的appender,如下所示：
-
-log4j2.xml 路径 incubator-linkis/linkis-dist/package/conf/log4j2.xml
+在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+
+
+这里只贴出来需要新增的配置内容。
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M] - %msg%xEx%n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 整体调试方案
-Linkis和DSS的服务都依赖Eureka，所以需要首先启动Eureka服务，Eureka服务也可以用您已经启动的Eureka。Eureka启动后就可以启动其他服务了。
+### 3.3 启动eureka服务
-因为linkis内部通过-DserviceName参数设置应用名以及使用的配置文件，所以-DserviceName是必须的启动VM参数
+Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-可以通过 “-Xbootclasspath/a:配置文件路径“命令。将配置文件，追加到引导程序类的搜索路劲末尾，即将依赖的配置文件加到classpath中
+在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-<font color="red"> 通过勾选Include dependencies with “Provided” scope ，这样可以在调试时，引入provided级别的依赖包。</font>
+可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-**Microservice Governance Services组件**
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-### linkis-mg-eureka的启动
+
-```plain
-[main Class]
+参数解释：
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[Use classpath of module]
-linkis-eureka
```
+
+注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
+在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+（针对以下微服务同样适用）
+
如果不想默认的20303端口可以修改端口配置：
-```yml
+
+```shell
文件路径：conf/application-eureka.yml
修改端口：
server:
port: 8080 ##启动的端口
```
-##### 具体配置如下：
- 老版idea配置
-
- 新版idea配置
-
-启动后可以通过[http://localhost:20303/](http://localhost:20303/) 查看eureka服务列表
-
+上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-### linkis-mg-gateway的启动配置
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+### 3.4 启动linkis-mg-gateway
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
+
+启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+设置 linkis-mg-gateway的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-注意 若出现'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j' 问题
-请exclude掉，对spring-boot-starter-logging的依赖
-**Public Enhancement Services组件**
-### linkis-ps-publicservice的启动配置
+上述设置完成之后，可直接运行此Application。
+
+### 3.5 启动linkis-ps-publicservice
+
+publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
+
+设置linkis-ps-publicservice的启动Application
+
+
-```plain
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
+
+[VM Opitons]
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+直接启动publicservice时，可能会遇到如下报错：
+
+
+
+需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
+
+
+
+
+
+
+
+
+
+做完上述配置后重新启动publicservice的Application
+
+### 3.6 启动linkis-ps-cs
+
+启动ps-cs服务之前，需要保证publicservice服务成功启动。
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
-#linkis < 1.1.0 为linkis-jobhistory
-#linkis >= 1.1.0 为linkis-storage-script-dev-server
-linkis-storage-script-dev-server
-```
+linkis-cs-server
-### linkis-ps-cs的启动配置
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.cs.server.LinkisCSApplication
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.7 启动linkis-cg-linkismanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
-linkis-cs-server
+linkis-application-manager
-```
-**Computation Governance Services 组件**
-### linkis-cg-linkismanager启动
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.8 启动linkis-cg-entrance
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-entrance
[Use classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance启动
-```plain
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.9 启动cg-engineconnmanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+### 3.10 启动linkis-cg-engineplugin
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+启动engineplugin的时候可能会遇到如下报错：
+
+
+
+解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+### 3.11 关键配置修改
+
+以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis底层数据库连接参数配置
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# 设置bml物料存储路径不为hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# 设置管理员用户名，你的本机用户名
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">注：暂不支持Windows本地调试的服务</font></h4>
+在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
+
+其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
-linkis-cg-engineplugin(ecp)：需要读取本地的ecp物料，本地调试需要先准备好对应的物料，建议在远程进行调试
+```properties
+# entrance服务执行任务的日志目录
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-linkis-cg-engineconnmanager(ecm)：暂时ecm启动引擎使用的是unix的方式，不支持windows环境
+# 结果集保存目录，本机用户需要读写权限
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
```
-下面是通过正常成功安装后，linkis服务启动具体的详细命令参数
-LinkisInstallDir:完整linkis的安装目录
+不修改可能会遇到路径不存在异常。
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-publicservice.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-cs.out &
+### 3.12 为当前用户设置sudo免密
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-entrance.out &
+引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
+保存文件退出
+```
+
+### 3.13 服务测试
+
+保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
+
+首先访问登录接口来生成Cookie:
+
+
+
+然后提交执行shell代码
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body参数：
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+执行结果：
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+最后检查任务运行状态和获取运行结果集：
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
```
-## 远程调试服务步骤
-### 1. 打开远程调试端口
-#### 1.1 明确需要调试的包所在的服务
-根据需要调试的代码位置,确定其所属的服务
+## 4. 远程调试服务指引
+
+### 4.1 打开远程调试端口
+
+明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
-#### 1.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
+
-### 2. 重启需要调试的服务
-sh linkis-daemon.sh restart ps-publicservice(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+### 4.3 重启需要调试的服务
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+```
+
+(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+
+### 4.4 编译器配置远程调试
-### 3. 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-
+
-### 4. 开始调试
-点击调试按钮,出现如下信息代表可以开始调试
-
+### 4.5 开始调试
+点击调试按钮,出现如下信息代表可以开始调试
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug-in-mac.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug-in-mac.md
deleted file mode 100644
index 221a6c655f..0000000000
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: 在Mac上调试Linkis
-sidebar_position: 2
----
-
-> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。
-
-## 1. 代码调试环境
-
-- Mac OS m1芯片，Linkis的`linkis-cg-engineplugin`和`linkis-cg-engineconnmanager`两个服务暂不支持在Windows上进行调试，可参考官网的开发文档进行远程调试。
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x ，本篇文章理论上可支持对Linkis1.0.3和以上版本的本地开发调试
-
-## 2. 准备代码并编译
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-```
-
-克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-
-```shell
-mvn -N install
-mvn clean install
-```
-
-编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
-
-## 3. 配置并启动服务
-
-### 3.1 add mysql-connector-java到classpath中
-
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-
-目前依赖mysql的服务有：
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 调整log4j2.xml配置
-
-在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-
-
-
-这里只贴出来需要新增的配置内容。
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 启动eureka服务
-
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-
-在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-
-可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-
-
-
-参数解释：
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-如果不想默认的20303端口可以修改端口配置：
-
-```shell
-文件路径：conf/application-eureka.yml
-修改端口：
-server:
- port: 8080 ##启动的端口
-```
-
-上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-
-
-
-### 3.4 启动linkis-mg-gateway
-
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
-启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-设置 linkis-mg-gateway的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-上述设置完成之后，可直接运行此Application。
-
-### 3.5 启动linkis-ps-publicservice
-
-publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
-
-设置linkis-ps-publicservice的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-直接启动publicservice时，可能会遇到如下报错：
-
-
-
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
-
-
-
-做完上述配置后重新启动publicservice的Application
-
-### 3.6 启动linkis-ps-cs
-
-启动ps-cs服务之前，需要保证publicservice服务成功启动。
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.7 启动linkis-cg-linkismanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.8 启动linkis-cg-entrance
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.9 启动cg-engineconnmanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径
-
-### 3.10 启动linkis-cg-engineplugin
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-启动engineplugin的时候可能会遇到如下报错：
-
-
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-
-### 3.11 关键配置修改
-
-以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis底层数据库连接参数配置
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# 设置bml物料存储路径不为hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# 设置管理员用户名，你的本机用户名
-wds.linkis.governance.station.admin=leojie
-```
-
-在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
-
-其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-不修改可能会遇到路径不存在异常。
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-
-### 3.12 为当前用户设置sudo免密
-
-引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
-保存文件退出
-```
-
-### 3.13 服务测试
-
-保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
-
-首先访问登录接口来生成Cookie:
-
-
-
-然后提交执行shell代码
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body参数：
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-执行结果：
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-最后检查任务运行状态和获取运行结果集：
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug.md
index afdfd3dffa..e046d6ad81 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.0/development/linkis-debug.md
@@ -1,208 +1,509 @@
---
-title: 调试指引
+title: 服务调试指引
sidebar_position: 2
---
-# 调试相关
-
-> 因为linkis本身模块比较多，调试起来有一定的难度，下面就指导大家如何进行一次本地的服务调试(基于1.0.3版本)。
+> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
+> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
-## step 1 准备源码并编译
+## 1. 代码调试环境
+
+- jdk1.8
+- maven3.5+
+
+## 2. 准备代码并编译
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
+cd incubator-linkis
+git checkout dev-1.2.0
+```
+
+克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-```plain
-git clone https://github.com/apache/incubator-linkis.git
-cd incubator-linkis
-#如果需要 可以切换到对应的分支上
-#git checkout dev-xxx
-mvn -N install
-mvn clean install
+```shell
+mvn -N install
+mvn clean install
```
-## step2 必要的参数配置
+编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
+
+## 3. 配置并启动服务
+
+### 3.1 add mysql-connector-java到classpath中
+
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
+
+目前依赖mysql的服务有：
-对于incubator-linkis/assembly-combined-package/assembly-combined/conf/下的配置文件，需要对数据库以及hive meta等必要启动参数进行配置。
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
-## step3 调整log4j.xml配置
+### 3.2 调整log4j2.xml配置
-为了方便调试的时候将日志打印到控制台，需要修改下默认的log4j2.xml文件，修改appender默认为console。需要移除默认的RollingFile的append，增加console的appender,如下所示：
-
-log4j2.xml 路径 incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+
+
+这里只贴出来需要新增的配置内容。
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M] - %msg%xEx%n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 整体调试方案
-Linkis和DSS的服务都依赖Eureka，所以需要首先启动Eureka服务，Eureka服务也可以用您已经启动的Eureka。Eureka启动后就可以启动其他服务了。
+### 3.3 启动eureka服务
-因为linkis内部通过-DserviceName参数设置应用名以及使用的配置文件，所以-DserviceName是必须的启动VM参数
+Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-可以通过 “-Xbootclasspath/a:配置文件路径“命令。将配置文件，追加到引导程序类的搜索路劲末尾，即将依赖的配置文件加到classpath中
+在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-<font color="red"> 通过勾选Include dependencies with “Provided” scope ，这样可以在调试时，引入provided级别的依赖包。</font>
+可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-**Microservice Governance Services组件**
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-### linkis-mg-eureka的启动
+
-```plain
-[main Class]
+参数解释：
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[Use classpath of module]
-linkis-eureka
```
+
+注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
+在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+（针对以下微服务同样适用）
+
如果不想默认的20303端口可以修改端口配置：
-```yml
+
+```shell
文件路径：conf/application-eureka.yml
修改端口：
server:
port: 8080 ##启动的端口
```
-##### 具体配置如下：
-老版idea配置
-
-新版idea配置
-
-启动后可以通过[http://localhost:20303/](http://localhost:20303/) 查看eureka服务列表
-
+上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-### linkis-mg-gateway的启动配置
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+### 3.4 启动linkis-mg-gateway
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
+
+启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+设置 linkis-mg-gateway的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-注意 若出现'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j' 问题
-请exclude掉，对spring-boot-starter-logging的依赖
-**Public Enhancement Services组件**
-### linkis-ps-publicservice的启动配置
+上述设置完成之后，可直接运行此Application。
+
+### 3.5 启动linkis-ps-publicservice
+
+publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
+
+设置linkis-ps-publicservice的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
+
+[VM Opitons]
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+直接启动publicservice时，可能会遇到如下报错：
+
+
+
+需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
+
+
+
+
+
+
+
+
+
+做完上述配置后重新启动publicservice的Application
+
+### 3.6 启动linkis-ps-cs
+
+启动ps-cs服务之前，需要保证publicservice服务成功启动。
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
-#linkis < 1.1.0 为linkis-jobhistory
-#linkis >= 1.1.0 为linkis-storage-script-dev-server
-linkis-storage-script-dev-server
-```
+linkis-cs-server
-### linkis-ps-cs的启动配置
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.cs.server.LinkisCSApplication
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.7 启动linkis-cg-linkismanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
-linkis-cs-server
+linkis-application-manager
-```
-**Computation Governance Services 组件**
-### linkis-cg-linkismanager启动
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.8 启动linkis-cg-entrance
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-entrance
[Use classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance启动
-```plain
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.9 启动cg-engineconnmanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+### 3.10 启动linkis-cg-engineplugin
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+启动engineplugin的时候可能会遇到如下报错：
+
+
+
+解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+### 3.11 关键配置修改
+
+以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis底层数据库连接参数配置
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# 设置bml物料存储路径不为hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# 设置管理员用户名，你的本机用户名
+wds.linkis.governance.station.admin=leojie
+```
+
+在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
+
+其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
+
+```properties
+# entrance服务执行任务的日志目录
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+
+# 结果集保存目录，本机用户需要读写权限
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+```
+
+不修改可能会遇到路径不存在异常。
+
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
+
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
```
-<h4><font color="red">注：暂不支持Windows本地调试的服务</font></h4>
+这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-linkis-cg-engineplugin(ecp)：需要读取本地的ecp物料，本地调试需要先准备好对应的物料，建议在远程进行调试
+### 3.12 为当前用户设置sudo免密
-linkis-cg-engineconnmanager(ecm)：暂时ecm启动引擎使用的是unix的方式，不支持windows环境
+引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
+保存文件退出
```
-下面是通过正常成功安装后，linkis服务启动具体的详细命令参数
-LinkisInstallDir:完整linkis的安装目录
+### 3.13 服务测试
+
+保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
+
+首先访问登录接口来生成Cookie:
+
+
+
+然后提交执行shell代码
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body参数：
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+执行结果：
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+最后检查任务运行状态和获取运行结果集：
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-publicservice.out &
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
+```
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+## 4. 远程调试服务指引
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-cs.out &
+### 4.1 打开远程调试端口
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-entrance.out &
+明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
+
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+### 4.3 重启需要调试的服务
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
```
-## 远程调试服务步骤
+(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+
+### 4.4 编译器配置远程调试
+
+如下图所示打开窗口并配置远程调试的端口,服务,以及模块
+
+
+### 4.5 开始调试
-todo
+点击调试按钮,出现如下信息代表可以开始调试
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug-in-mac.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug-in-mac.md
deleted file mode 100644
index 221a6c655f..0000000000
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: 在Mac上调试Linkis
-sidebar_position: 2
----
-
-> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。
-
-## 1. 代码调试环境
-
-- Mac OS m1芯片，Linkis的`linkis-cg-engineplugin`和`linkis-cg-engineconnmanager`两个服务暂不支持在Windows上进行调试，可参考官网的开发文档进行远程调试。
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x ，本篇文章理论上可支持对Linkis1.0.3和以上版本的本地开发调试
-
-## 2. 准备代码并编译
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-```
-
-克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-
-```shell
-mvn -N install
-mvn clean install
-```
-
-编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
-
-## 3. 配置并启动服务
-
-### 3.1 add mysql-connector-java到classpath中
-
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-
-目前依赖mysql的服务有：
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 调整log4j2.xml配置
-
-在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-
-
-
-这里只贴出来需要新增的配置内容。
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 启动eureka服务
-
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-
-在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-
-可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-
-
-
-参数解释：
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-如果不想默认的20303端口可以修改端口配置：
-
-```shell
-文件路径：conf/application-eureka.yml
-修改端口：
-server:
- port: 8080 ##启动的端口
-```
-
-上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-
-
-
-### 3.4 启动linkis-mg-gateway
-
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
-启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-设置 linkis-mg-gateway的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-上述设置完成之后，可直接运行此Application。
-
-### 3.5 启动linkis-ps-publicservice
-
-publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
-
-设置linkis-ps-publicservice的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-直接启动publicservice时，可能会遇到如下报错：
-
-
-
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
-
-
-
-做完上述配置后重新启动publicservice的Application
-
-### 3.6 启动linkis-ps-cs
-
-启动ps-cs服务之前，需要保证publicservice服务成功启动。
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.7 启动linkis-cg-linkismanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.8 启动linkis-cg-entrance
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.9 启动cg-engineconnmanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径
-
-### 3.10 启动linkis-cg-engineplugin
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-启动engineplugin的时候可能会遇到如下报错：
-
-
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-
-### 3.11 关键配置修改
-
-以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis底层数据库连接参数配置
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# 设置bml物料存储路径不为hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# 设置管理员用户名，你的本机用户名
-wds.linkis.governance.station.admin=leojie
-```
-
-在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
-
-其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-不修改可能会遇到路径不存在异常。
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-
-### 3.12 为当前用户设置sudo免密
-
-引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
-保存文件退出
-```
-
-### 3.13 服务测试
-
-保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
-
-首先访问登录接口来生成Cookie:
-
-
-
-然后提交执行shell代码
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body参数：
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-执行结果：
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-最后检查任务运行状态和获取运行结果集：
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug.md
index 89e185182d..e046d6ad81 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.1/development/linkis-debug.md
@@ -1,224 +1,509 @@
---
-title: 调试指引
+title: 服务调试指引
sidebar_position: 2
---
-# 调试相关
-
-> 因为linkis本身模块比较多，调试起来有一定的难度，下面就指导大家如何进行一次本地的服务调试(基于1.0.3版本)。
+> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
+> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
-## step 1 准备源码并编译
+## 1. 代码调试环境
+
+- jdk1.8
+- maven3.5+
+
+## 2. 准备代码并编译
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
+cd incubator-linkis
+git checkout dev-1.2.0
+```
+
+克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-```plain
-git clone https://github.com/apache/incubator-linkis.git
-cd incubator-linkis
-#如果需要 可以切换到对应的分支上
-#git checkout dev-xxx
-mvn -N install
-mvn clean install
+```shell
+mvn -N install
+mvn clean install
```
-## step2 必要的参数配置
+编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
+
+## 3. 配置并启动服务
+
+### 3.1 add mysql-connector-java到classpath中
+
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
+
+目前依赖mysql的服务有：
-对于incubator-linkis/assembly-combined-package/assembly-combined/conf/下的配置文件，需要对数据库以及hive meta等必要启动参数进行配置。
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
-## step3 调整log4j.xml配置
+### 3.2 调整log4j2.xml配置
-为了方便调试的时候将日志打印到控制台，需要修改下默认的log4j2.xml文件，修改appender默认为console。需要移除默认的RollingFile的append，增加console的appender,如下所示：
-
-log4j2.xml 路径 incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+
+
+这里只贴出来需要新增的配置内容。
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M] - %msg%xEx%n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 整体调试方案
-Linkis和DSS的服务都依赖Eureka，所以需要首先启动Eureka服务，Eureka服务也可以用您已经启动的Eureka。Eureka启动后就可以启动其他服务了。
+### 3.3 启动eureka服务
-因为linkis内部通过-DserviceName参数设置应用名以及使用的配置文件，所以-DserviceName是必须的启动VM参数
+Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-可以通过 “-Xbootclasspath/a:配置文件路径“命令。将配置文件，追加到引导程序类的搜索路劲末尾，即将依赖的配置文件加到classpath中
+在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-<font color="red"> 通过勾选Include dependencies with “Provided” scope ，这样可以在调试时，引入provided级别的依赖包。</font>
+可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-**Microservice Governance Services组件**
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-### linkis-mg-eureka的启动
+
-```plain
-[main Class]
+参数解释：
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[Use classpath of module]
-linkis-eureka
```
+
+注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
+在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+（针对以下微服务同样适用）
+
如果不想默认的20303端口可以修改端口配置：
-```yml
+
+```shell
文件路径：conf/application-eureka.yml
修改端口：
server:
port: 8080 ##启动的端口
```
-##### 具体配置如下：
-老版idea配置
-
-新版idea配置
-
-启动后可以通过[http://localhost:20303/](http://localhost:20303/) 查看eureka服务列表
-
+上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-### linkis-mg-gateway的启动配置
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+### 3.4 启动linkis-mg-gateway
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
+
+启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+设置 linkis-mg-gateway的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-注意 若出现'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j' 问题
-请exclude掉，对spring-boot-starter-logging的依赖
-**Public Enhancement Services组件**
-### linkis-ps-publicservice的启动配置
+上述设置完成之后，可直接运行此Application。
+
+### 3.5 启动linkis-ps-publicservice
+
+publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
+
+设置linkis-ps-publicservice的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
+
+[VM Opitons]
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+直接启动publicservice时，可能会遇到如下报错：
+
+
+
+需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
+
+
+
+
+
+
+
+
+
+做完上述配置后重新启动publicservice的Application
+
+### 3.6 启动linkis-ps-cs
+
+启动ps-cs服务之前，需要保证publicservice服务成功启动。
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
-#linkis < 1.1.0 为linkis-jobhistory
-#linkis >= 1.1.0 为linkis-storage-script-dev-server
-linkis-storage-script-dev-server
-```
+linkis-cs-server
-### linkis-ps-cs的启动配置
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.cs.server.LinkisCSApplication
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.7 启动linkis-cg-linkismanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
-linkis-cs-server
+linkis-application-manager
-```
-**Computation Governance Services 组件**
-### linkis-cg-linkismanager启动
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.8 启动linkis-cg-entrance
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-entrance
[Use classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance启动
-```plain
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.9 启动cg-engineconnmanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+### 3.10 启动linkis-cg-engineplugin
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+启动engineplugin的时候可能会遇到如下报错：
+
+
+
+解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+### 3.11 关键配置修改
+
+以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis底层数据库连接参数配置
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# 设置bml物料存储路径不为hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# 设置管理员用户名，你的本机用户名
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">注：暂不支持Windows本地调试的服务</font></h4>
+在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
+
+其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
-linkis-cg-engineplugin(ecp)：需要读取本地的ecp物料，本地调试需要先准备好对应的物料，建议在远程进行调试
+```properties
+# entrance服务执行任务的日志目录
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-linkis-cg-engineconnmanager(ecm)：暂时ecm启动引擎使用的是unix的方式，不支持windows环境
+# 结果集保存目录，本机用户需要读写权限
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
```
-下面是通过正常成功安装后，linkis服务启动具体的详细命令参数
-LinkisInstallDir:完整linkis的安装目录
+不修改可能会遇到路径不存在异常。
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-publicservice.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-cs.out &
+### 3.12 为当前用户设置sudo免密
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-entrance.out &
+引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
+保存文件退出
+```
+
+### 3.13 服务测试
+
+保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
+
+首先访问登录接口来生成Cookie:
+
+
+
+然后提交执行shell代码
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body参数：
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+执行结果：
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+最后检查任务运行状态和获取运行结果集：
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
```
-## 远程调试服务步骤
-### 1. 打开远程调试端口
-#### 1.1 明确需要调试的包所在的服务
-根据需要调试的代码位置,确定其所属的服务
+## 4. 远程调试服务指引
+
+### 4.1 打开远程调试端口
+
+明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
-#### 1.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
+
-### 2. 重启需要调试的服务
-sh linkis-daemon.sh restart ps-publicservice(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+### 4.3 重启需要调试的服务
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+```
+
+(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+
+### 4.4 编译器配置远程调试
-### 3. 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-
+
-### 4. 开始调试
-点击调试按钮,出现如下信息代表可以开始调试
-
+### 4.5 开始调试
+点击调试按钮,出现如下信息代表可以开始调试
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug-in-mac.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug-in-mac.md
deleted file mode 100644
index 221a6c655f..0000000000
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: 在Mac上调试Linkis
-sidebar_position: 2
----
-
-> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。
-
-## 1. 代码调试环境
-
-- Mac OS m1芯片，Linkis的`linkis-cg-engineplugin`和`linkis-cg-engineconnmanager`两个服务暂不支持在Windows上进行调试，可参考官网的开发文档进行远程调试。
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x ，本篇文章理论上可支持对Linkis1.0.3和以上版本的本地开发调试
-
-## 2. 准备代码并编译
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-```
-
-克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-
-```shell
-mvn -N install
-mvn clean install
-```
-
-编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
-
-## 3. 配置并启动服务
-
-### 3.1 add mysql-connector-java到classpath中
-
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-
-目前依赖mysql的服务有：
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 调整log4j2.xml配置
-
-在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-
-
-
-这里只贴出来需要新增的配置内容。
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 启动eureka服务
-
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-
-在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-
-可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-
-
-
-参数解释：
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-如果不想默认的20303端口可以修改端口配置：
-
-```shell
-文件路径：conf/application-eureka.yml
-修改端口：
-server:
- port: 8080 ##启动的端口
-```
-
-上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-
-
-
-### 3.4 启动linkis-mg-gateway
-
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
-启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-设置 linkis-mg-gateway的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-上述设置完成之后，可直接运行此Application。
-
-### 3.5 启动linkis-ps-publicservice
-
-publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
-
-设置linkis-ps-publicservice的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-直接启动publicservice时，可能会遇到如下报错：
-
-
-
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
-
-
-
-做完上述配置后重新启动publicservice的Application
-
-### 3.6 启动linkis-ps-cs
-
-启动ps-cs服务之前，需要保证publicservice服务成功启动。
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.7 启动linkis-cg-linkismanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.8 启动linkis-cg-entrance
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.9 启动cg-engineconnmanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径
-
-### 3.10 启动linkis-cg-engineplugin
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-启动engineplugin的时候可能会遇到如下报错：
-
-
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-
-### 3.11 关键配置修改
-
-以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis底层数据库连接参数配置
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# 设置bml物料存储路径不为hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# 设置管理员用户名，你的本机用户名
-wds.linkis.governance.station.admin=leojie
-```
-
-在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
-
-其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-不修改可能会遇到路径不存在异常。
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-
-### 3.12 为当前用户设置sudo免密
-
-引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
-保存文件退出
-```
-
-### 3.13 服务测试
-
-保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
-
-首先访问登录接口来生成Cookie:
-
-
-
-然后提交执行shell代码
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body参数：
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-执行结果：
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-最后检查任务运行状态和获取运行结果集：
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug.md
index 5a464a547a..e046d6ad81 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.2/development/linkis-debug.md
@@ -3,223 +3,507 @@ title: 服务调试指引
sidebar_position: 2
---
-# 调试相关
-
-> 因为linkis本身模块比较多，调试起来有一定的难度，下面就指导大家如何进行一次本地的服务调试(基于1.0.3版本)。
+> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
+> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
-## step 1 准备源码并编译
+## 1. 代码调试环境
+
+- jdk1.8
+- maven3.5+
+
+## 2. 准备代码并编译
-```plain
-git clone https://github.com/apache/incubator-linkis.git
-cd incubator-linkis
-#如果需要 可以切换到对应的分支上
-#git checkout dev-xxx
-mvn -N install
-mvn clean install
+```shell
+git clone git@github.com:apache/incubator-linkis.git
+cd incubator-linkis
+git checkout dev-1.2.0
```
-## step2 必要的参数配置
+克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
+
+```shell
+mvn -N install
+mvn clean install
+```
+
+编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
+
+## 3. 配置并启动服务
+
+### 3.1 add mysql-connector-java到classpath中
+
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-对于incubator-linkis/assembly-combined-package/assembly-combined/conf/下的配置文件，需要对数据库以及hive meta等必要启动参数进行配置。
+目前依赖mysql的服务有：
-## step3 调整log4j.xml配置
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
-为了方便调试的时候将日志打印到控制台，需要修改下默认的log4j2.xml文件，修改appender默认为console。需要移除默认的RollingFile的append，增加console的appender,如下所示：
-
-log4j2.xml 路径 incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+### 3.2 调整log4j2.xml配置
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
+
+
+
+这里只贴出来需要新增的配置内容。
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M] - %msg%xEx%n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 整体调试方案
-Linkis和DSS的服务都依赖Eureka，所以需要首先启动Eureka服务，Eureka服务也可以用您已经启动的Eureka。Eureka启动后就可以启动其他服务了。
+### 3.3 启动eureka服务
-因为linkis内部通过-DserviceName参数设置应用名以及使用的配置文件，所以-DserviceName是必须的启动VM参数
+Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-可以通过 “-Xbootclasspath/a:配置文件路径“命令。将配置文件，追加到引导程序类的搜索路劲末尾，即将依赖的配置文件加到classpath中
+在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-<font color="red"> 通过勾选Include dependencies with “Provided” scope ，这样可以在调试时，引入provided级别的依赖包。</font>
+可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-**Microservice Governance Services组件**
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-### linkis-mg-eureka的启动
+
-```plain
-[main Class]
+参数解释：
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[Use classpath of module]
-linkis-eureka
```
+
+注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
+在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+（针对以下微服务同样适用）
+
如果不想默认的20303端口可以修改端口配置：
-```yml
+
+```shell
文件路径：conf/application-eureka.yml
修改端口：
server:
port: 8080 ##启动的端口
```
-##### 具体配置如下：
- 老版idea配置
-
- 新版idea配置
-
-启动后可以通过[http://localhost:20303/](http://localhost:20303/) 查看eureka服务列表
-
+上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-### linkis-mg-gateway的启动配置
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+### 3.4 启动linkis-mg-gateway
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
+
+启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+设置 linkis-mg-gateway的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-注意 若出现'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j' 问题
-请exclude掉，对spring-boot-starter-logging的依赖
-**Public Enhancement Services组件**
-### linkis-ps-publicservice的启动配置
+上述设置完成之后，可直接运行此Application。
+
+### 3.5 启动linkis-ps-publicservice
+
+publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
+
+设置linkis-ps-publicservice的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
-```plain
+[VM Opitons]
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+直接启动publicservice时，可能会遇到如下报错：
+
+
+
+需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
+
+
+
+
+
+
+
+
+
+做完上述配置后重新启动publicservice的Application
+
+### 3.6 启动linkis-ps-cs
+
+启动ps-cs服务之前，需要保证publicservice服务成功启动。
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
-#linkis < 1.1.0 为linkis-jobhistory
-#linkis >= 1.1.0 为linkis-storage-script-dev-server
-linkis-storage-script-dev-server
-```
+linkis-cs-server
-### linkis-ps-cs的启动配置
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.cs.server.LinkisCSApplication
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.7 启动linkis-cg-linkismanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
-linkis-cs-server
+linkis-application-manager
-```
-**Computation Governance Services 组件**
-### linkis-cg-linkismanager启动
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.8 启动linkis-cg-entrance
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-entrance
[Use classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance启动
-```plain
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.9 启动cg-engineconnmanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+### 3.10 启动linkis-cg-engineplugin
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+启动engineplugin的时候可能会遇到如下报错：
+
+
+
+解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+### 3.11 关键配置修改
+
+以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis底层数据库连接参数配置
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# 设置bml物料存储路径不为hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# 设置管理员用户名，你的本机用户名
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">注：暂不支持Windows本地调试的服务</font></h4>
+在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
+
+其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
-linkis-cg-engineplugin(ecp)：需要读取本地的ecp物料，本地调试需要先准备好对应的物料，建议在远程进行调试
+```properties
+# entrance服务执行任务的日志目录
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-linkis-cg-engineconnmanager(ecm)：暂时ecm启动引擎使用的是unix的方式，不支持windows环境
+# 结果集保存目录，本机用户需要读写权限
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
```
-下面是通过正常成功安装后，linkis服务启动具体的详细命令参数
-LinkisInstallDir:完整linkis的安装目录
+不修改可能会遇到路径不存在异常。
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-publicservice.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-cs.out &
+### 3.12 为当前用户设置sudo免密
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-entrance.out &
+引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
+保存文件退出
+```
+
+### 3.13 服务测试
+
+保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
+
+首先访问登录接口来生成Cookie:
+
+
+
+然后提交执行shell代码
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body参数：
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+执行结果：
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+最后检查任务运行状态和获取运行结果集：
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
```
-## 远程调试服务步骤
-### 1. 打开远程调试端口
-#### 1.1 明确需要调试的包所在的服务
-根据需要调试的代码位置,确定其所属的服务
+## 4. 远程调试服务指引
+
+### 4.1 打开远程调试端口
+
+明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
-#### 1.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
+
-### 2. 重启需要调试的服务
-sh linkis-daemon.sh restart ps-publicservice(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+### 4.3 重启需要调试的服务
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+```
+
+(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+
+### 4.4 编译器配置远程调试
-### 3. 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-
+
-### 4. 开始调试
-点击调试按钮,出现如下信息代表可以开始调试
-
+### 4.5 开始调试
+点击调试按钮,出现如下信息代表可以开始调试
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug-in-mac.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug-in-mac.md
deleted file mode 100644
index 2c4c890365..0000000000
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: 在Mac上调试Linkis
-sidebar_position: 2
----
-
-> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。
-
-## 1. 代码调试环境
-
-- Mac OS m1芯片，Linkis的`linkis-cg-engineplugin`和`linkis-cg-engineconnmanager`两个服务暂不支持在Windows上进行调试，可参考官网的开发文档进行远程调试。
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x ，本篇文章理论上可支持对Linkis1.0.3和以上版本的本地开发调试
-
-## 2. 准备代码并编译
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-```
-
-克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
-
-```shell
-mvn -N install
-mvn clean install
-```
-
-编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
-
-## 3. 配置并启动服务
-
-### 3.1 add mysql-connector-java到classpath中
-
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-
-目前依赖mysql的服务有：
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 调整log4j2.xml配置
-
-在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
-
-
-
-这里只贴出来需要新增的配置内容。
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 启动eureka服务
-
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-
-在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-
-可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-
-
-
-参数解释：
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-如果不想默认的20303端口可以修改端口配置：
-
-```shell
-文件路径：conf/application-eureka.yml
-修改端口：
-server:
- port: 8080 ##启动的端口
-```
-
-上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-
-
-
-### 3.4 启动linkis-mg-gateway
-
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
-启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-设置 linkis-mg-gateway的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-上述设置完成之后，可直接运行此Application。
-
-### 3.5 启动linkis-ps-publicservice
-
-publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
-
-设置linkis-ps-publicservice的启动Application
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-直接启动publicservice时，可能会遇到如下报错：
-
-
-
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
-
-
-
-做完上述配置后重新启动publicservice的Application
-
-### 3.6 启动linkis-ps-cs
-
-启动ps-cs服务之前，需要保证publicservice服务成功启动。
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.7 启动linkis-cg-linkismanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.8 启动linkis-cg-entrance
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-### 3.9 启动cg-engineconnmanager
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径
-
-### 3.10 启动linkis-cg-engineplugin
-
-
-
-参数解释：
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-```
-
-启动engineplugin的时候可能会遇到如下报错：
-
-
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-
-### 3.11 关键配置修改
-
-以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis底层数据库连接参数配置
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# 设置bml物料存储路径不为hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# 设置管理员用户名，你的本机用户名
-wds.linkis.governance.station.admin=leojie
-```
-
-在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
-
-其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-不修改可能会遇到路径不存在异常。
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-
-### 3.12 为当前用户设置sudo免密
-
-引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
-保存文件退出
-```
-
-### 3.13 服务测试
-
-保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
-
-首先访问登录接口来生成Cookie:
-
-
-
-然后提交执行shell代码
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body参数：
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-执行结果：
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-最后检查任务运行状态和获取运行结果集：
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug.md
index 5a464a547a..e046d6ad81 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.1.3/development/linkis-debug.md
@@ -3,223 +3,507 @@ title: 服务调试指引
sidebar_position: 2
---
-# 调试相关
-
-> 因为linkis本身模块比较多，调试起来有一定的难度，下面就指导大家如何进行一次本地的服务调试(基于1.0.3版本)。
+> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
+> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
-## step 1 准备源码并编译
+## 1. 代码调试环境
+
+- jdk1.8
+- maven3.5+
+
+## 2. 准备代码并编译
-```plain
-git clone https://github.com/apache/incubator-linkis.git
-cd incubator-linkis
-#如果需要 可以切换到对应的分支上
-#git checkout dev-xxx
-mvn -N install
-mvn clean install
+```shell
+git clone git@github.com:apache/incubator-linkis.git
+cd incubator-linkis
+git checkout dev-1.2.0
```
-## step2 必要的参数配置
+克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
+
+```shell
+mvn -N install
+mvn clean install
+```
+
+编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
+
+## 3. 配置并启动服务
+
+### 3.1 add mysql-connector-java到classpath中
+
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
-对于incubator-linkis/assembly-combined-package/assembly-combined/conf/下的配置文件，需要对数据库以及hive meta等必要启动参数进行配置。
+目前依赖mysql的服务有：
-## step3 调整log4j.xml配置
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
-为了方便调试的时候将日志打印到控制台，需要修改下默认的log4j2.xml文件，修改appender默认为console。需要移除默认的RollingFile的append，增加console的appender,如下所示：
-
-log4j2.xml 路径 incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+### 3.2 调整log4j2.xml配置
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+在Linkis源码文件夹下，子目录linkis-dist/package/conf中，是Linkis的一些默认配置文件，首先对log4j2.xml文件进行编辑，在其中增加日志输出到控制台的配置。
+
+
+
+这里只贴出来需要新增的配置内容。
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M] - %msg%xEx%n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 整体调试方案
-Linkis和DSS的服务都依赖Eureka，所以需要首先启动Eureka服务，Eureka服务也可以用您已经启动的Eureka。Eureka启动后就可以启动其他服务了。
+### 3.3 启动eureka服务
-因为linkis内部通过-DserviceName参数设置应用名以及使用的配置文件，所以-DserviceName是必须的启动VM参数
+Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
-可以通过 “-Xbootclasspath/a:配置文件路径“命令。将配置文件，追加到引导程序类的搜索路劲末尾，即将依赖的配置文件加到classpath中
+在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
-<font color="red"> 通过勾选Include dependencies with “Provided” scope ，这样可以在调试时，引入provided级别的依赖包。</font>
+可以通过 “-Xbootclasspath/a:配置文件路径”命令，将配置文件追加到引导程序类的路径末尾，即将依赖的配置文件加到classpath中。
-**Microservice Governance Services组件**
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
-### linkis-mg-eureka的启动
+
-```plain
-[main Class]
+参数解释：
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[Use classpath of module]
-linkis-eureka
```
+
+注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
+在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+（针对以下微服务同样适用）
+
如果不想默认的20303端口可以修改端口配置：
-```yml
+
+```shell
文件路径：conf/application-eureka.yml
修改端口：
server:
port: 8080 ##启动的端口
```
-##### 具体配置如下：
- 老版idea配置
-
- 新版idea配置
-
-启动后可以通过[http://localhost:20303/](http://localhost:20303/) 查看eureka服务列表
-
+上述设置完成之后，直接运行此Application，成功启动后可以通过http://localhost:20303/ 查看eureka服务列表。
-### linkis-mg-gateway的启动配置
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+### 3.4 启动linkis-mg-gateway
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
+
+启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+设置 linkis-mg-gateway的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-注意 若出现'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j' 问题
-请exclude掉，对spring-boot-starter-logging的依赖
-**Public Enhancement Services组件**
-### linkis-ps-publicservice的启动配置
+上述设置完成之后，可直接运行此Application。
+
+### 3.5 启动linkis-ps-publicservice
+
+publicservice是Linkis的公共增强服务，为其他微服务模块提供统一配置管理、上下文服务、物料库、数据源管理、微服务管理和历史任务查询等功能的模块。
+
+设置linkis-ps-publicservice的启动Application
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
-```plain
+[VM Opitons]
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+直接启动publicservice时，可能会遇到如下报错：
+
+
+
+需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
+
+
+
+
+
+
+
+
+
+做完上述配置后重新启动publicservice的Application
+
+### 3.6 启动linkis-ps-cs
+
+启动ps-cs服务之前，需要保证publicservice服务成功启动。
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
-#linkis < 1.1.0 为linkis-jobhistory
-#linkis >= 1.1.0 为linkis-storage-script-dev-server
-linkis-storage-script-dev-server
-```
+linkis-cs-server
-### linkis-ps-cs的启动配置
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.cs.server.LinkisCSApplication
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.7 启动linkis-cg-linkismanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
-linkis-cs-server
+linkis-application-manager
-```
-**Computation Governance Services 组件**
-### linkis-cg-linkismanager启动
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.8 启动linkis-cg-entrance
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-entrance
[Use classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance启动
-```plain
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+### 3.9 启动cg-engineconnmanager
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+### 3.10 启动linkis-cg-engineplugin
+
+
+
+参数解释：
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
+```
+
+启动engineplugin的时候可能会遇到如下报错：
+
+
+
+解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
+
+针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+### 3.11 关键配置修改
+
+以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis底层数据库连接参数配置
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# 设置bml物料存储路径不为hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# 设置管理员用户名，你的本机用户名
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">注：暂不支持Windows本地调试的服务</font></h4>
+在配置linkis底层数据库连接参数之前，请创建linkis数据库，并运行linkis-dist/package/db/linkis_ddl.sql和linkis-dist/package/db/linkis_dml.sql来初始化所有表和数据。
+
+其中wds.linkis.home=/Users/leojie/software/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
-linkis-cg-engineplugin(ecp)：需要读取本地的ecp物料，本地调试需要先准备好对应的物料，建议在远程进行调试
+```properties
+# entrance服务执行任务的日志目录
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-linkis-cg-engineconnmanager(ecm)：暂时ecm启动引擎使用的是unix的方式，不支持windows环境
+# 结果集保存目录，本机用户需要读写权限
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
```
-下面是通过正常成功安装后，linkis服务启动具体的详细命令参数
-LinkisInstallDir:完整linkis的安装目录
+不修改可能会遇到路径不存在异常。
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-publicservice.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-ps-cs.out &
+### 3.12 为当前用户设置sudo免密
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-entrance.out &
+引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+将#%admin ALL=(ALL) AL替换为 %admin ALL=(ALL) NOPASSWD: ALL
+保存文件退出
+```
+
+### 3.13 服务测试
+
+保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
+
+首先访问登录接口来生成Cookie:
+
+
+
+然后提交执行shell代码
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body参数：
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+执行结果：
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+最后检查任务运行状态和获取运行结果集：
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir/lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1 > /data/LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
```
-## 远程调试服务步骤
-### 1. 打开远程调试端口
-#### 1.1 明确需要调试的包所在的服务
-根据需要调试的代码位置,确定其所属的服务
+## 4. 远程调试服务指引
+
+### 4.1 打开远程调试端口
+
+明确需要调试的包所在的服务，并根据需要调试的代码位置,确定其所属的服务
-#### 1.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
-
+### 4.2 进入{LINKIS_HOME}/sbin/ext,修改模块配置文件开启远程调用端口
+
-### 2. 重启需要调试的服务
-sh linkis-daemon.sh restart ps-publicservice(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+### 4.3 重启需要调试的服务
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+```
+
+(如果不确定服务名称,在 {LINKIS_HOME}/sbin/linkis-start-all.sh 内查询)
+
+### 4.4 编译器配置远程调试
-### 3. 编译器配置远程调试
如下图所示打开窗口并配置远程调试的端口,服务,以及模块
-
+
-### 4. 开始调试
-点击调试按钮,出现如下信息代表可以开始调试
-
+### 4.5 开始调试
+点击调试按钮,出现如下信息代表可以开始调试
+
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.0/development/linkis-debug-in-mac.md b/versioned_docs/version-1.1.0/development/linkis-debug-in-mac.md
deleted file mode 100644
index b186b570d4..0000000000
--- a/versioned_docs/version-1.1.0/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: Linkis Debug In Mac
-sidebar_position: 2
----
-
-> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell.
-
-## 1. Code debugging environment
-
-- Mac OS m1 chip, Linkis' `linkis-cg-engineplugin` and `linkis-cg-engineconnmanager` services do not currently support debugging on Windows. You can refer to the development documentation on the official website for remote debugging.
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x, this article theoretically supports local development and debugging of Linkis 1.0.3 and above
-
-## 2. Prepare the code and compile
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-````
-
-Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
-
-```shell
-mvn -N install
-mvn clean install
-````
-
-After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
-
-## 3. Configure and start the service
-
-### 3.1 add mysql-connector-java to the classpath
-
-If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
-
-The services currently relying on mysql are:
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 Adjust log4j2.xml configuration
-
-Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-
-
-
-Only the configuration content that needs to be added is posted here.
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 Start the eureka service
-
-Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-
-Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-
-You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-
-
-
-Parameter explanation:
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-If you don't want the default 20303 port, you can modify the port configuration:
-
-```shell
-File path: conf/application-eureka.yml
-Modify the port:
-server:
- port: 8080 ##Starting port
-````
-
-After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-
-
-
-### 3.4 Start linkis-mg-gateway
-
-linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-
-Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-Set the startup Application of linkis-mg-gateway
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-After the above settings are completed, the Application can be run directly.
-
-### 3.5 Start linkis-ps-publicservice
-
-publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
-
-Set the startup Application of linkis-ps-publicservice
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting publicservice directly, you may encounter the following errors:
-
-
-
-The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
-
-
-
-
-
-
-
-
-
-After completing the above configuration, restart the Application of publicservice
-
-### 3.6 Start linkis-ps-cs
-
-Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.7 Start linkis-cg-linkismanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.8 Start linkis-cg-entrance
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.9 Start cg-engineconnmanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
--DJAVA_HOME is to specify the path where the java command used by ecm to start the engine is located
-
-### 3.10 Start linkis-cg-engineplugin
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting engineplugin, you may encounter the following error:
-
-
-
-The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
-
-### 3.11 Key Configuration Modifications
-
-The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis underlying database connection parameter configuration
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# Set the bml material storage path to not hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# Set the administrator username, your local username
-wds.linkis.governance.station.admin=leojie
-```
-
-Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
-
-The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# The result set is saved in the directory, the local user needs read and write permissions
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-If you do not modify it, you may encounter an exception that the path does not exist.
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-
-### 3.12 Set sudo password-free for the current user
-
-When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
-save file exit
-```
-
-### 3.13 Service Testing
-
-Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
-
-First visit the login interface to generate a cookie:
-
-
-
-Then submit the shell code for execution
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body parameter:
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-Results of the:
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-Finally, check the running status of the task and get the running result set:
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.0/development/linkis-debug.md b/versioned_docs/version-1.1.0/development/linkis-debug.md
index 9c56222d87..af8c11f0e0 100644
--- a/versioned_docs/version-1.1.0/development/linkis-debug.md
+++ b/versioned_docs/version-1.1.0/development/linkis-debug.md
@@ -3,205 +3,507 @@ title: Linkis Debug
sidebar_position: 2
---
-# Debugging related
-
-> Because linkis itself has many modules, it is difficult to debug, the following will guide you how to perform a local service debugging (based on version 1.0.3).
+> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell. On Mac OS, each microservice of Linkis supports local debugging.
+> However, on Windows OS, linkis-cg-engineplugin and linkis-cg-engineconnmanager do not support local debugging for the time being. You can refer to the remote debugging documentation in Section 4 below for debugging.
<h4><font color="red">Before version 1.0.3, linkis has not yet entered apache incubation. The organization still belongs to webank. The package name of the main class is `org.apache.linkis`. Pay attention to the distinction when debugging. </font></h4>
-## step 1 Prepare source code and compile
-```plain
-git clone https://github.com/apache/incubator-linkis.git
+## 1. Code debugging environment
+
+- jdk1.8
+- maven3.5+
+
+## 2. Prepare the code and compile
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
cd incubator-linkis
-#If needed, you can switch to the corresponding branch
-#git checkout dev-xxx
+git checkout dev-1.2.0
+````
+
+Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
+
+```shell
mvn -N install
mvn clean install
-```
+````
+
+After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
+
+## 3. Configure and start the service
-## step2 Necessary parameter configuration
+### 3.1 add mysql-connector-java to the classpath
-For the configuration file under incubator-linkis/assembly-combined-package/assembly-combined/conf/, you need to configure the database and hive meta and other necessary startup parameters.
+If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
+The services currently relying on mysql are:
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
+### 3.2 Adjust log4j2.xml configuration
-## step3 Adjust log4j.xml configuration
+Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-In order to facilitate the printing of logs to the console during debugging, you need to modify the default log4j2.xml file and modify the appender to default to console. You need to remove the append of the default RollingFile and add the appender of the console, as shown below:
-
-log4j2.xml path incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+Only the configuration content that needs to be added is posted here.
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M]-%msg%xEx %n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M-%msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 Overall debugging plan
-Both Linkis and DSS services rely on Eureka, so you need to start the Eureka service first, and the Eureka service can also use the Eureka you have started. After Eureka is started, other services can be started.
+### 3.3 Start the eureka service
+
+Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-Because linkis internally uses the -DserviceName parameter to set the application name and the configuration file used, so -DserviceName is a necessary startup VM parameter
+Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-You can use the "-Xbootclasspath/a: configuration file path" command. Append the configuration file to the end of the search path of the bootloader class, and add the dependent configuration file to the classpath
+You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-**Microservice Governance Services component**
+
-### Start of linkis-mg-eureka
+Parameter explanation:
-```plain
-[main Class]
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[User classpath of module]
-linkis-eureka
```
-If you don’t want the default port 20303, you can modify the port configuration:
-```yml
+
+Note that the local path involved in the debugging configuration needs to be modified to the path set by yourself;
+The path writing rule in Windows is: D:\yourDir\incubator-linkis\linkis-dist\package\conf
+(The same applies to the following microservices)
+
+If you don't want the default 20303 port, you can modify the port configuration:
+
+```shell
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Started port
+ port: 8080 ##Starting port
+````
+
+After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
+
+
+
+### 3.4 Start linkis-mg-gateway
+
+linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
+
+Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
```
-The specific configuration is as follows
-
-After startup, you can view the list of eureka services through [http://localhost:20303/](http://localhost:20303/)
-
+Set the startup Application of linkis-mg-gateway
-### Linkis-mg-gateway startup configuration
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+Parameter explanation:
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+```shell
+[Service Name]
+linkis-mg-gateway
-[User classpath of module]
+[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-Note If there is a problem of'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j'
-Please exclude, the dependency on spring-boot-starter-logging
-**Public Enhancement Services component**
-### Linkis-ps-publicservice startup configuration
+After the above settings are completed, the Application can be run directly.
-```plain
-[main Class]
-org.apache.linkis.jobhistory.LinkisPublicServiceApp
+### 3.5 Start linkis-ps-publicservice
+
+publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
+
+Set the startup Application of linkis-ps-publicservice
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-[User classpath of module]
-linkis-jobhistory
+[main Class]
+org.apache.linkis.filesystem.LinkisPublicServiceApp
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### Linkis-ps-cs startup configuration
+When starting publicservice directly, you may encounter the following errors:
-```plain
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
+
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
+
+
+
+
+
+
+
+
+
+After completing the above configuration, restart the Application of publicservice
+
+### 3.6 Start linkis-ps-cs
+
+Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
-[User classpath of module]
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-cs
+
+[Use classpath of module]
linkis-cs-server
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.cs.server.LinkisCSApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-**Computation Governance Services component**
-### linkis-cg-linkismanager start
+### 3.7 Start linkis-cg-linkismanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
+
+[Use classpath of module]
+linkis-application-manager
+
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.8 Start linkis-cg-entrance
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-entrance
+
+[Use classpath of module]
+linkis-entrance
+
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
-[User classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance start
-```plain
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.9 Start cg-engineconnmanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-[User classpath of module]
-linkis-entrance
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+-DJAVA_HOME is to specify the path of the java command used by ecm to start the engine. If the version in the default JAVA environment variable meets your needs, this configuration can be omitted.
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.10 Start linkis-cg-engineplugin
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
+
+[Use classpath of module]
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+When starting engineplugin, you may encounter the following error:
+
+
+
+The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.11 Key Configuration Modifications
+
+The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis underlying database connection parameter configuration
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# Set the bml material storage path to not hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# Set the administrator username, your local username
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">Note: Windows local debugging service is not currently supported</font></h4>
+Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
+
+The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-linkis-cg-engineplugin(ecp): Need to read local ecp materials, local debugging needs to prepare the corresponding materials first, it is recommended to debug remotely
+
-linkis-cg-engineconnmanager(ecm): temporarily ecm starts the engine using the unix method and does not support the windows environment
+#### 3.11.2 conf/linkis-cg-entrance.properties
+```properties
+# The log directory of the entrance service execution task
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+
+# The result set is saved in the directory, the local user needs read and write permissions
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
```
-The following are the specific detailed command parameters for starting the linkis service after a normal and successful installation
-LinkisInstallDir: complete linkis installation directory
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+```
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1> / data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+If you do not modify it, you may encounter an exception that the path does not exist.
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1> /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1> /data/LinkisInstallDir /logs/linkis-ps-publicservice.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1> /data /LinkisInstallDir/logs/linkis-ps-cs.out &
+The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1> /data/LinkisInstallDir /logs/linkis-cg-entrance.out &
+### 3.12 Set sudo password-free for the current user
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
+save file exit
```
-## Remote debugging service steps
+### 3.13 Service Testing
+
+Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
+
+First visit the login interface to generate a cookie:
+
+
+
+Then submit the shell code for execution
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body parameter:
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+Results of the:
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+Finally, check the running status of the task and get the running result set:
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
+```
+
+## 4. Remote debugging service guide
+
+### 4.1 Open the remote debugging port
+
+Identify the service where the package that needs to be debugged is located, and determine the service to which it belongs according to the location of the code to be debugged
+
+### 4.2 Enter {LINKIS_HOME}/sbin/ext, modify the module configuration file to open the remote call port
+
+
+### 4.3 Restart the service that needs to be debugged
+
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+````
+
+(If you are not sure about the service name, check in {LINKIS_HOME}/sbin/linkis-start-all.sh )
+
+### 4.4 Compiler configuration remote debugging
+
+Open the window as shown below and configure the remote debugging port, service, and module
+
+
+### 4.5 Start debugging
-todo
+Click the debug button, and the following information appears, indicating that you can start debugging
+
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.1/development/linkis-debug-in-mac.md b/versioned_docs/version-1.1.1/development/linkis-debug-in-mac.md
deleted file mode 100644
index b186b570d4..0000000000
--- a/versioned_docs/version-1.1.1/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: Linkis Debug In Mac
-sidebar_position: 2
----
-
-> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell.
-
-## 1. Code debugging environment
-
-- Mac OS m1 chip, Linkis' `linkis-cg-engineplugin` and `linkis-cg-engineconnmanager` services do not currently support debugging on Windows. You can refer to the development documentation on the official website for remote debugging.
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x, this article theoretically supports local development and debugging of Linkis 1.0.3 and above
-
-## 2. Prepare the code and compile
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-````
-
-Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
-
-```shell
-mvn -N install
-mvn clean install
-````
-
-After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
-
-## 3. Configure and start the service
-
-### 3.1 add mysql-connector-java to the classpath
-
-If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
-
-The services currently relying on mysql are:
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 Adjust log4j2.xml configuration
-
-Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-
-
-
-Only the configuration content that needs to be added is posted here.
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 Start the eureka service
-
-Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-
-Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-
-You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-
-
-
-Parameter explanation:
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-If you don't want the default 20303 port, you can modify the port configuration:
-
-```shell
-File path: conf/application-eureka.yml
-Modify the port:
-server:
- port: 8080 ##Starting port
-````
-
-After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-
-
-
-### 3.4 Start linkis-mg-gateway
-
-linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-
-Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-Set the startup Application of linkis-mg-gateway
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-After the above settings are completed, the Application can be run directly.
-
-### 3.5 Start linkis-ps-publicservice
-
-publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
-
-Set the startup Application of linkis-ps-publicservice
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting publicservice directly, you may encounter the following errors:
-
-
-
-The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
-
-
-
-
-
-
-
-
-
-After completing the above configuration, restart the Application of publicservice
-
-### 3.6 Start linkis-ps-cs
-
-Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.7 Start linkis-cg-linkismanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.8 Start linkis-cg-entrance
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.9 Start cg-engineconnmanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
--DJAVA_HOME is to specify the path where the java command used by ecm to start the engine is located
-
-### 3.10 Start linkis-cg-engineplugin
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting engineplugin, you may encounter the following error:
-
-
-
-The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
-
-### 3.11 Key Configuration Modifications
-
-The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis underlying database connection parameter configuration
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# Set the bml material storage path to not hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# Set the administrator username, your local username
-wds.linkis.governance.station.admin=leojie
-```
-
-Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
-
-The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# The result set is saved in the directory, the local user needs read and write permissions
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-If you do not modify it, you may encounter an exception that the path does not exist.
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-
-### 3.12 Set sudo password-free for the current user
-
-When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
-save file exit
-```
-
-### 3.13 Service Testing
-
-Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
-
-First visit the login interface to generate a cookie:
-
-
-
-Then submit the shell code for execution
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body parameter:
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-Results of the:
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-Finally, check the running status of the task and get the running result set:
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.1/development/linkis-debug.md b/versioned_docs/version-1.1.1/development/linkis-debug.md
index 8176e5a62f..af8c11f0e0 100644
--- a/versioned_docs/version-1.1.1/development/linkis-debug.md
+++ b/versioned_docs/version-1.1.1/development/linkis-debug.md
@@ -3,222 +3,507 @@ title: Linkis Debug
sidebar_position: 2
---
-# Debugging related
-
-> Because linkis itself has many modules, it is difficult to debug, the following will guide you how to perform a local service debugging (based on version 1.0.3).
+> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell. On Mac OS, each microservice of Linkis supports local debugging.
+> However, on Windows OS, linkis-cg-engineplugin and linkis-cg-engineconnmanager do not support local debugging for the time being. You can refer to the remote debugging documentation in Section 4 below for debugging.
<h4><font color="red">Before version 1.0.3, linkis has not yet entered apache incubation. The organization still belongs to webank. The package name of the main class is `org.apache.linkis`. Pay attention to the distinction when debugging. </font></h4>
-## step 1 Prepare source code and compile
-```plain
-git clone https://github.com/apache/incubator-linkis.git
+## 1. Code debugging environment
+
+- jdk1.8
+- maven3.5+
+
+## 2. Prepare the code and compile
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
cd incubator-linkis
-#If needed, you can switch to the corresponding branch
-#git checkout dev-xxx
+git checkout dev-1.2.0
+````
+
+Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
+
+```shell
mvn -N install
mvn clean install
-```
+````
+
+After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
+
+## 3. Configure and start the service
-## step2 Necessary parameter configuration
+### 3.1 add mysql-connector-java to the classpath
-For the configuration file under incubator-linkis/assembly-combined-package/assembly-combined/conf/, you need to configure the database and hive meta and other necessary startup parameters.
+If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
+The services currently relying on mysql are:
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
+### 3.2 Adjust log4j2.xml configuration
-## step3 Adjust log4j.xml configuration
+Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-In order to facilitate the printing of logs to the console during debugging, you need to modify the default log4j2.xml file and modify the appender to default to console. You need to remove the append of the default RollingFile and add the appender of the console, as shown below:
-
-log4j2.xml path incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+Only the configuration content that needs to be added is posted here.
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M]-%msg%xEx %n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M-%msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 Overall debugging plan
-Both Linkis and DSS services rely on Eureka, so you need to start the Eureka service first, and the Eureka service can also use the Eureka you have started. After Eureka is started, other services can be started.
+### 3.3 Start the eureka service
+
+Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-Because linkis internally uses the -DserviceName parameter to set the application name and the configuration file used, so -DserviceName is a necessary startup VM parameter
+Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-You can use the "-Xbootclasspath/a: configuration file path" command. Append the configuration file to the end of the search path of the bootloader class, and add the dependent configuration file to the classpath
+You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-**Microservice Governance Services component**
+
-### Start of linkis-mg-eureka
+Parameter explanation:
-```plain
-[main Class]
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[User classpath of module]
-linkis-eureka
```
-If you don’t want the default port 20303, you can modify the port configuration:
-```yml
+
+Note that the local path involved in the debugging configuration needs to be modified to the path set by yourself;
+The path writing rule in Windows is: D:\yourDir\incubator-linkis\linkis-dist\package\conf
+(The same applies to the following microservices)
+
+If you don't want the default 20303 port, you can modify the port configuration:
+
+```shell
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Started port
+ port: 8080 ##Starting port
+````
+
+After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
+
+
+
+### 3.4 Start linkis-mg-gateway
+
+linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
+
+Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
```
-The specific configuration is as follows
-
-After startup, you can view the list of eureka services through [http://localhost:20303/](http://localhost:20303/)
-
+Set the startup Application of linkis-mg-gateway
-### Linkis-mg-gateway startup configuration
+
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+Parameter explanation:
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+```shell
+[Service Name]
+linkis-mg-gateway
-[User classpath of module]
+[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-Note If there is a problem of'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j'
-Please exclude, the dependency on spring-boot-starter-logging
-**Public Enhancement Services component**
-### Linkis-ps-publicservice startup configuration
+After the above settings are completed, the Application can be run directly.
-```plain
-[main Class]
-org.apache.linkis.jobhistory.LinkisPublicServiceApp
+### 3.5 Start linkis-ps-publicservice
+
+publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
+
+Set the startup Application of linkis-ps-publicservice
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.filesystem.LinkisPublicServiceApp
-[User classpath of module]
-linkis-jobhistory
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### Linkis-ps-cs startup configuration
+When starting publicservice directly, you may encounter the following errors:
-```plain
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
+
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
+
+
+
+
+
+
+
+
+
+After completing the above configuration, restart the Application of publicservice
-[User classpath of module]
+### 3.6 Start linkis-ps-cs
+
+Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-cs
+
+[Use classpath of module]
linkis-cs-server
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.cs.server.LinkisCSApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-**Computation Governance Services component**
-### linkis-cg-linkismanager start
+### 3.7 Start linkis-cg-linkismanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
+
+[Use classpath of module]
+linkis-application-manager
+
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-```plain
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.8 Start linkis-cg-entrance
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-entrance
+
+[Use classpath of module]
+linkis-entrance
+
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
-[User classpath of module]
-linkis-application-manager
-```
-### linkis-cg-entrance start
-```plain
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.9 Start cg-engineconnmanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-[User classpath of module]
-linkis-entrance
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-<h4><font color="red">Note: Windows local debugging service is not currently supported</font></h4>
+-DJAVA_HOME is to specify the path of the java command used by ecm to start the engine. If the version in the default JAVA environment variable meets your needs, this configuration can be omitted.
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.10 Start linkis-cg-engineplugin
-linkis-cg-engineplugin(ecp): Need to read local ecp materials, local debugging needs to prepare the corresponding materials first, it is recommended to debug remotely
+
-linkis-cg-engineconnmanager(ecm): temporarily ecm starts the engine using the unix method and does not support the windows environment
+Parameter explanation:
+```shell
+[Service Name]
+linkis-cg-engineplugin
+
+[Use classpath of module]
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-The following are the specific detailed command parameters for starting the linkis service after a normal and successful installation
-LinkisInstallDir: complete linkis installation directory
+When starting engineplugin, you may encounter the following error:
+
+
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1> / data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1> /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+Debugging for linkis-cg-engineplugin module only supports Mac OS
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1> /data/LinkisInstallDir /logs/linkis-ps-publicservice.out &
+### 3.11 Key Configuration Modifications
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1> /data /LinkisInstallDir/logs/linkis-ps-cs.out &
+#### 3.11.1 conf/linkis.properties
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1> /data/LinkisInstallDir /logs/linkis-cg-entrance.out &
+```properties
+# linkis underlying database connection parameter configuration
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+# Set the bml material storage path to not hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+wds.linkis.home=/Users/leojie/software/linkis
+
+# Set the administrator username, your local username
+wds.linkis.governance.station.admin=leojie
```
-## Remote debugging service steps
+Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
+
+The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
+
+
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
+
+```properties
+# The log directory of the entrance service execution task
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+
+# The result set is saved in the directory, the local user needs read and write permissions
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+```
+
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+```
+
+If you do not modify it, you may encounter an exception that the path does not exist.
+
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
+
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
+
+The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
+
+### 3.12 Set sudo password-free for the current user
+
+When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
+save file exit
+```
+
+### 3.13 Service Testing
+
+Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
+
+First visit the login interface to generate a cookie:
+
+
+
+Then submit the shell code for execution
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body parameter:
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
+
+Results of the:
+
+```json
+{
+ "method": "/api/entrance/submit",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "taskID": 1,
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+Finally, check the running status of the task and get the running result set:
+
+GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
+
+```json
+{
+ "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "progress": 1,
+ "progressInfo": [],
+ "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
+ }
+}
+```
+
+GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
+
+GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
+
+```json
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": "NULL",
+ "totalPage": 0,
+ "totalLine": 1,
+ "page": 1,
+ "type": "1",
+ "fileContent": [
+ [
+ "hello"
+ ]
+ ]
+ }
+}
+```
+
+## 4. Remote debugging service guide
+
+### 4.1 Open the remote debugging port
+
+Identify the service where the package that needs to be debugged is located, and determine the service to which it belongs according to the location of the code to be debugged
+
+### 4.2 Enter {LINKIS_HOME}/sbin/ext, modify the module configuration file to open the remote call port
+
+
+### 4.3 Restart the service that needs to be debugged
-### 1. Open remote debugging port
+```shell
+sh linkis-daemon.sh restart ps-publicservice
+````
-#### 1.1 specify the service of the package to be debugged
-Determine the service it belongs to according to the location of the code to be debugged
+(If you are not sure about the service name, check in {LINKIS_HOME}/sbin/linkis-start-all.sh )
-#### 1.2 enter {LINKIS_HOME}/sbin/ext, modify the module configuration file, and open the remote call port
-
+### 4.4 Compiler configuration remote debugging
-### 2. Restart the service to be debugged
-sh linkis-daemon.sh restart ps-configuration (if you are not sure about the service name, query in {links_home}/sbin/links-start-all.sh)
+Open the window as shown below and configure the remote debugging port, service, and module
+
-### 3. Compiler configuration remote debugging
-As shown in the figure below, open the window and configure the port, service and module of remote debugging
-
+### 4.5 Start debugging
-### 4. Start debugging
-click the debugging button, and the following information appears, which means you can start debugging
-
+Click the debug button, and the following information appears, indicating that you can start debugging
+
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.2/development/linkis-debug-in-mac.md b/versioned_docs/version-1.1.2/development/linkis-debug-in-mac.md
deleted file mode 100644
index b186b570d4..0000000000
--- a/versioned_docs/version-1.1.2/development/linkis-debug-in-mac.md
+++ /dev/null
@@ -1,472 +0,0 @@
----
-title: Linkis Debug In Mac
-sidebar_position: 2
----
-
-> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell.
-
-## 1. Code debugging environment
-
-- Mac OS m1 chip, Linkis' `linkis-cg-engineplugin` and `linkis-cg-engineconnmanager` services do not currently support debugging on Windows. You can refer to the development documentation on the official website for remote debugging.
-- Zulu openjdk 1.8
-- maven3.6.3
-- Linkis 1.1.x, this article theoretically supports local development and debugging of Linkis 1.0.3 and above
-
-## 2. Prepare the code and compile
-
-```shell
-git clone git@github.com:apache/incubator-linkis.git
-cd incubator-linkis
-git checkout dev-1.2.0
-````
-
-Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
-
-```shell
-mvn -N install
-mvn clean install
-````
-
-After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
-
-## 3. Configure and start the service
-
-### 3.1 add mysql-connector-java to the classpath
-
-If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
-
-The services currently relying on mysql are:
-
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
-
-### 3.2 Adjust log4j2.xml configuration
-
-Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-
-
-
-Only the configuration content that needs to be added is posted here.
-
-```xml
-<configuration status="error" monitorInterval="30">
- <appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
- </Console>
- </appenders>
- <loggers>
- <root level="INFO">
- <appender-ref ref="Console"/>
- </root>
- </loggers>
-</configuration>
-```
-
-### 3.3 Start the eureka service
-
-Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-
-Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-
-You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-
-
-
-Parameter explanation:
-
-```shell
-[service name]
-linkis-mg-eureka
-
-[Use classpath of module]
-linkis-eureka
-
-[Main Class]
-org.apache.linkis.eureka.SpringCloudEurekaApplication
-
-[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[Program arguments]
---spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
-
-If you don't want the default 20303 port, you can modify the port configuration:
-
-```shell
-File path: conf/application-eureka.yml
-Modify the port:
-server:
- port: 8080 ##Starting port
-````
-
-After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-
-
-
-### 3.4 Start linkis-mg-gateway
-
-linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-
-Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
-
-```properties
-wds.linkis.admin.user=leojie
-wds.linkis.admin.password=123456
-```
-
-Set the startup Application of linkis-mg-gateway
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-mg-gateway
-
-[Use classpath of module]
-linkis-gateway-server-support
-
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
-```
-
-After the above settings are completed, the Application can be run directly.
-
-### 3.5 Start linkis-ps-publicservice
-
-publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
-
-Set the startup Application of linkis-ps-publicservice
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-publicservice
-
-[Module Name]
-linkis-public-enhancements
-
-[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting publicservice directly, you may encounter the following errors:
-
-
-
-The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
-
-
-
-
-
-
-
-
-
-After completing the above configuration, restart the Application of publicservice
-
-### 3.6 Start linkis-ps-cs
-
-Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-ps-cs
-
-[Use classpath of module]
-linkis-cs-server
-
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.7 Start linkis-cg-linkismanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-linkismanager
-
-[Use classpath of module]
-linkis-application-manager
-
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.8 Start linkis-cg-entrance
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-entrance
-
-[Use classpath of module]
-linkis-entrance
-
-[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-
-[main Class]
-org.apache.linkis.entrance.LinkisEntranceApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-### 3.9 Start cg-engineconnmanager
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineconnmanager
-
-[Use classpath of module]
-linkis-engineconn-manager-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
-
-[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
--DJAVA_HOME is to specify the path where the java command used by ecm to start the engine is located
-
-### 3.10 Start linkis-cg-engineplugin
-
-
-
-Parameter explanation:
-
-```shell
-[Service Name]
-linkis-cg-engineplugin
-
-[Use classpath of module]
-linkis-engineconn-plugin-server
-
-[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-
-[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
-
-[Add provided scope to classpath]
-By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-```
-
-When starting engineplugin, you may encounter the following error:
-
-
-
-The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
-
-### 3.11 Key Configuration Modifications
-
-The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
-
-#### 3.11.1 conf/linkis.properties
-
-```properties
-# linkis underlying database connection parameter configuration
-wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
-wds.linkis.server.mybatis.datasource.username=your username
-wds.linkis.server.mybatis.datasource.password=your password
-
-# Set the bml material storage path to not hdfs
-wds.linkis.bml.is.hdfs=false
-wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
-
-wds.linkis.home=/Users/leojie/software/linkis
-
-# Set the administrator username, your local username
-wds.linkis.governance.station.admin=leojie
-```
-
-Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
-
-The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-
-
-
-#### 3.11.2 conf/linkis-cg-entrance.properties
-
-```properties
-# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
-
-# The result set is saved in the directory, the local user needs read and write permissions
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
-```
-
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
-
-If you do not modify it, you may encounter an exception that the path does not exist.
-
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
-
-```properties
-wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-
-wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
-```
-
-The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-
-### 3.12 Set sudo password-free for the current user
-
-When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
-
-```shell
-sudo chmod u-w /etc/sudoers
-sudo visudo
-Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
-save file exit
-```
-
-### 3.13 Service Testing
-
-Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
-
-First visit the login interface to generate a cookie:
-
-
-
-Then submit the shell code for execution
-
-POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
-
-body parameter:
-
-```json
-{
- "executionContent": {
- "code": "echo 'hello'",
- "runType": "shell"
- },
- "params": {
- "variable": {
- "testvar": "hello"
- },
- "configuration": {
- "runtime": {},
- "startup": {}
- }
- },
- "source": {
- "scriptPath": "file:///tmp/hadoop/test.sql"
- },
- "labels": {
- "engineType": "shell-1",
- "userCreator": "leojie-IDE"
- }
-}
-```
-
-Results of the:
-
-```json
-{
- "method": "/api/entrance/submit",
- "status": 0,
- "message": "OK",
- "data": {
- "taskID": 1,
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-Finally, check the running status of the task and get the running result set:
-
-GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress
-
-```json
-{
- "method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
- "status": 0,
- "message": "OK",
- "data": {
- "progress": 1,
- "progressInfo": [],
- "execID": "exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0"
- }
-}
-```
-
-GET http://127.0.0.1:9001/api/rest_j/v1/jobhistory/1/get
-
-GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/leojie/software/linkis/data/resultSetDir/leojie/linkis/2022-07-16/214859/IDE/1/1_0.dolphin
-
-```json
-{
- "method": "/api/filesystem/openFile",
- "status": 0,
- "message": "OK",
- "data": {
- "metadata": "NULL",
- "totalPage": 0,
- "totalLine": 1,
- "page": 1,
- "type": "1",
- "fileContent": [
- [
- "hello"
- ]
- ]
- }
-}
-```
\ No newline at end of file
diff --git a/versioned_docs/version-1.1.2/development/linkis-debug.md b/versioned_docs/version-1.1.2/development/linkis-debug.md
index 326a70ed64..af8c11f0e0 100644
--- a/versioned_docs/version-1.1.2/development/linkis-debug.md
+++ b/versioned_docs/version-1.1.2/development/linkis-debug.md
@@ -3,229 +3,507 @@ title: Linkis Debug
sidebar_position: 2
---
-# Debugging related
-
-> Because linkis itself has many modules, it is difficult to debug, the following will guide you how to perform a local service debugging (based on version 1.0.3).
+> Introduction: This article records in detail how to configure and start various microservices of Linkis in IDEA, and implement the submission and execution of scripts such as JDBC, Python, and Shell. On Mac OS, each microservice of Linkis supports local debugging.
+> However, on Windows OS, linkis-cg-engineplugin and linkis-cg-engineconnmanager do not support local debugging for the time being. You can refer to the remote debugging documentation in Section 4 below for debugging.
<h4><font color="red">Before version 1.0.3, linkis has not yet entered apache incubation. The organization still belongs to webank. The package name of the main class is `org.apache.linkis`. Pay attention to the distinction when debugging. </font></h4>
-## step 1 Prepare source code and compile
-```plain
-git clone https://github.com/apache/incubator-linkis.git
+## 1. Code debugging environment
+
+- jdk1.8
+- maven3.5+
+
+## 2. Prepare the code and compile
+
+```shell
+git clone git@github.com:apache/incubator-linkis.git
cd incubator-linkis
-#If needed, you can switch to the corresponding branch
-#git checkout dev-xxx
+git checkout dev-1.2.0
+````
+
+Clone the source code of Linkis to the local, and open it with IDEA. When you open the project for the first time, the dependency jar package required for the compilation of the Linkis project will be downloaded from the maven repository. When the dependent jar package is loaded, run the following compile and package command.
+
+```shell
mvn -N install
mvn clean install
-```
+````
+
+After the compilation command runs successfully, the compiled installation package can be found in the directory incubator-linkis/linkis-dist/target/: apache-linkis-version-incubating-bin.tar.gz
+
+## 3. Configure and start the service
-## step2 Necessary parameter configuration
+### 3.1 add mysql-connector-java to the classpath
-For the configuration file under incubator-linkis/assembly-combined-package/assembly-combined/conf/, you need to configure the database and hive meta and other necessary startup parameters.
+If the mysql driver class cannot be found during the service startup, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module. For details, please refer to Section 3.5.
+The services currently relying on mysql are:
+- linkis-mg-gateway
+- linkis-ps-publicservice
+- linkis-cg-linkismanage
+### 3.2 Adjust log4j2.xml configuration
-## step3 Adjust log4j.xml configuration
+Under the Linkis source code folder, in the subdirectory linkis-dist/package/conf, are some default configuration files of Linkis. First, edit the log4j2.xml file, and add the configuration of log output to the console.
-In order to facilitate the printing of logs to the console during debugging, you need to modify the default log4j2.xml file and modify the appender to default to console. You need to remove the append of the default RollingFile and add the appender of the console, as shown below:
-
-log4j2.xml path incubator-linkis/assembly-combined-package/assembly-combined/conf/log4j2.xml
+
-```plain
- <?xml version="1.0" encoding="UTF-8"?>
+Only the configuration content that needs to be added is posted here.
+
+```xml
<configuration status="error" monitorInterval="30">
-<appenders>
- <RollingFile name="RollingFile" append="false" fileName="logs/${sys:serviceName}.log"
- filePattern="logs/$${date:yyyy-MM}/${sys:serviceName}/linkis-log-%d{yyyy-MM-dd}-%i.log">
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] [%-40t] %c{1.} (%L) [%M]-%msg%xEx %n"/>
- <SizeBasedTriggeringPolicy size="100MB"/>
- <DefaultRolloverStrategy max="10"/>
- </RollingFile>
-
- <Console name="Console" target="SYSTEM_OUT">
- <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
- <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M-%msg%xEx%n"/>
- </Console>
-</appenders>
-<loggers>
- <root level="INFO">
- <appender-ref ref="RollingFile"/>
- <appender-ref ref="Console"/>
- </root>
-</loggers>
+ <appenders>
+ <Console name="Console" target="SYSTEM_OUT">
+ <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/>
+ <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%t] %logger{36} %L %M - %msg%xEx%n"/>
+ </Console>
+ </appenders>
+ <loggers>
+ <root level="INFO">
+ <appender-ref ref="Console"/>
+ </root>
+ </loggers>
</configuration>
```
-## step 4 Overall debugging plan
-Both Linkis and DSS services rely on Eureka, so you need to start the Eureka service first, and the Eureka service can also use the Eureka you have started. After Eureka is started, other services can be started.
+### 3.3 Start the eureka service
-Because linkis internally uses the -DserviceName parameter to set the application name and the configuration file used, so -DserviceName is a necessary startup VM parameter
+Both Linkis and DSS services depend on Eureka, so we need to start the Eureka service first. The Eureka service can be started locally or remotely. After ensuring that each service can access Eureka's IP and port, you can start to start other microservices.
-You can use the "-Xbootclasspath/a: configuration file path" command. Append the configuration file to the end of the search path of the bootloader class, and add the dependent configuration file to the classpath
+Inside Linkis, the application name and configuration file are set through the -DserviceName parameter, so -DserviceName is a VM startup parameter that must be specified.
-<font color="red"> By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging. </font>
+You can use the "-Xbootclasspath/a: configuration file path" command to append the configuration file to the end of the bootstrap class path, that is, add the dependent configuration file to the classpath.
-**Microservice Governance Services component**
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
-### Start of linkis-mg-eureka
+
-```plain
-[main Class]
+Parameter explanation:
+
+```shell
+[service name]
+linkis-mg-eureka
+
+[Use classpath of module]
+linkis-eureka
+
+[Main Class]
org.apache.linkis.eureka.SpringCloudEurekaApplication
[VM Opitons]
--DserviceName=linkis-mg-eureka -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-
-[User classpath of module]
-linkis-eureka
```
-If you don’t want the default port 20303, you can modify the port configuration:
-```yml
+
+Note that the local path involved in the debugging configuration needs to be modified to the path set by yourself;
+The path writing rule in Windows is: D:\yourDir\incubator-linkis\linkis-dist\package\conf
+(The same applies to the following microservices)
+
+If you don't want the default 20303 port, you can modify the port configuration:
+
+```shell
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Started port
-```
-##### The specific configuration is as follows
+ port: 8080 ##Starting port
+````
-Old version idea configuration
-
-New version of idea configuration
-
+After the above settings are completed, run the Application directly. After successful startup, you can view the eureka service list through http://localhost:20303/.
-After startup, you can view the list of eureka services through [http://localhost:20303/](http://localhost:20303/)
-
+
-### Linkis-mg-gateway startup configuration
+### 3.4 Start linkis-mg-gateway
-```plain
-[main Class]
-org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
+linkis-mg-gateway is the service gateway of Linkis, and all requests will be forwarded to the corresponding service through the gateway.
-[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+Before starting the server, you first need to edit the conf/linkis-mg-gateway.properties configuration file and add the administrator username and password. The username must be the same as the mac username you are currently logged in to.
+
+```properties
+wds.linkis.admin.user=leojie
+wds.linkis.admin.password=123456
+```
+
+Set the startup Application of linkis-mg-gateway
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-mg-gateway
[Use classpath of module]
linkis-gateway-server-support
+[VM Opitons]
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
```
-Note If there is a problem of'org.apache.logging.log4j.LoggingException: log4j-slf4j-impl cannot be present with log4j-to-slf4j'
-Please exclude, the dependency on spring-boot-starter-logging
-**Public Enhancement Services component**
-### Linkis-ps-publicservice startup configuration
+After the above settings are completed, the Application can be run directly.
-```plain
-[main Class]
-org.apache.linkis.filesystem.LinkisPublicServiceApp
+### 3.5 Start linkis-ps-publicservice
+
+publicservice is a public enhancement service of Linkis, a module that provides functions such as unified configuration management, context service, material library, data source management, microservice management and historical task query for other microservice modules.
+
+Set the startup Application of linkis-ps-publicservice
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-publicservice
+
+[Module Name]
+linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
-[Use classpath of module]
-#linkis < 1.1.0 by linkis-jobhistory
-#linkis >= 1.1.0 by linkis-storage-script-dev-server
-linkis-storage-script-dev-server
+[main Class]
+org.apache.linkis.filesystem.LinkisPublicServiceApp
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### Linkis-ps-cs startup configuration
+When starting publicservice directly, you may encounter the following errors:
-```plain
-[main Class]
-org.apache.linkis.cs.server.LinkisCSApplication
+
-[VM Opitons]
--DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+The public-module module needs to be added to the classpath of the linkis-public-enhancements module. The detailed steps are as follows:
+
+
+
+
+
+
+
+
+
+After completing the above configuration, restart the Application of publicservice
+
+### 3.6 Start linkis-ps-cs
+
+Before starting the ps-cs service, you need to ensure that the publicservice service starts successfully.
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-ps-cs
[Use classpath of module]
linkis-cs-server
+[VM Opitons]
+-DserviceName=linkis-ps-cs -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.cs.server.LinkisCSApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-**Computation Governance Services component**
-### linkis-cg-linkismanager start
+### 3.7 Start linkis-cg-linkismanager
-```plain
-[main Class]
-org.apache.linkis.manager.am.LinkisManagerApplication
+
-[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-linkismanager
[Use classpath of module]
linkis-application-manager
+
+[VM Opitons]
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.manager.am.LinkisManagerApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
```
-### linkis-cg-entrance start
-```plain
+
+### 3.8 Start linkis-cg-entrance
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-entrance
+
+[Use classpath of module]
+linkis-entrance
+
+[VM Opitons]
+-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\linkis-dist\package\conf
+
[main Class]
org.apache.linkis.entrance.LinkisEntranceApplication
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+### 3.9 Start cg-engineconnmanager
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineconnmanager
+
+[Use classpath of module]
+linkis-engineconn-manager-server
+
[VM Opitons]
--DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
+
+[main Class]
+org.apache.linkis.ecm.server.LinkisECMApplication
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+-DJAVA_HOME is to specify the path of the java command used by ecm to start the engine. If the version in the default JAVA environment variable meets your needs, this configuration can be omitted.
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.10 Start linkis-cg-engineplugin
+
+
+
+Parameter explanation:
+
+```shell
+[Service Name]
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-entrance
+linkis-engineconn-plugin-server
+
+[VM Opitons]
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+
+[main Class]
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+
+[Add provided scope to classpath]
+By checking Include dependencies with "Provided" scope, you can introduce provided-level dependency packages during debugging.
+```
+
+When starting engineplugin, you may encounter the following error:
+
+
+
+The solution is to add the public-module module to the classpath of the linkis-engineconn-plugin-server module, refer to section 3.5
+
+Debugging for linkis-cg-engineplugin module only supports Mac OS
+
+### 3.11 Key Configuration Modifications
+
+The above operation only completes the configuration of the application startup of each Linkis microservice. In addition, in the configuration file loaded when the Linkis service starts, some key configurations also need to be modified in a targeted manner, otherwise the process of starting the service or script execution Some errors will be encountered. The key configuration modifications are summarized as follows:
+
+#### 3.11.1 conf/linkis.properties
+
+```properties
+# linkis underlying database connection parameter configuration
+wds.linkis.server.mybatis.datasource.url=jdbc:mysql://yourip:3306/linkis?characterEncoding=UTF-8
+wds.linkis.server.mybatis.datasource.username=your username
+wds.linkis.server.mybatis.datasource.password=your password
+
+# Set the bml material storage path to not hdfs
+wds.linkis.bml.is.hdfs=false
+wds.linkis.bml.local.prefix=/Users/leojie/software/linkis/data/bml
+
+wds.linkis.home=/Users/leojie/software/linkis
+
+# Set the administrator username, your local username
+wds.linkis.governance.station.admin=leojie
```
-<h4><font color="red">Note: Windows local debugging service is not currently supported</font></h4>
+Before configuring linkis underlying database connection parameters, please create linkis database and run linkis-dist/package/db/linkis_ddl.sql and linkis-dist/package/db/linkis_dml.sql to initialize all tables and data.
-linkis-cg-engineplugin(ecp): Need to read local ecp materials, local debugging needs to prepare the corresponding materials first, it is recommended to debug remotely
+The directory structure of wds.linkis.home=/Users/leojie/software/linkis is as follows, only the lib directory and the conf directory are placed in it. When the engine process starts, the conf and lib paths in wds.linkis.home will be added to the classpath. If wds.linkis.home is not specified, an exception that the directory cannot be found may be encountered.
-linkis-cg-engineconnmanager(ecm): temporarily ecm starts the engine using the unix method and does not support the windows environment
+
+#### 3.11.2 conf/linkis-cg-entrance.properties
+
+```properties
+# The log directory of the entrance service execution task
+wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+
+# The result set is saved in the directory, the local user needs read and write permissions
+wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
```
-The following are the specific detailed command parameters for starting the linkis service after a normal and successful installation
-LinkisInstallDir: complete linkis installation directory
+#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
-[linkis-mg-eureka]
-nohup java -DserviceName=linkis-mg-eureka -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-eureka-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-eureka/* org.apache.linkis.eureka.SpringCloudEurekaApplication --eureka.instance.hostname=bdpujes110001 --spring.profiles.active=eureka 2>&1> / data/LinkisInstallDir/logs/linkis-mg-eureka.out &
+```properties
+wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+```
-[linkis-mg-gateway]
-nohup java -DserviceName=linkis-mg-gateway -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-mg-gateway-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-spring-cloud-services/linkis-mg-gateway/* org.apache.linkis.gateway.springcloud.LinkisGatewayApplication 2>&1> /data/LinkisInstallDir/logs/linkis-mg-gateway.out &
+If you do not modify it, you may encounter an exception that the path does not exist.
-[linkis-ps-publicservice]
-nohup java -DserviceName=linkis-ps-publicservice -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-publicservice-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-publicservice/* org.apache.linkis.jobhistory.LinkisPublicServiceApp 2>&1> /data/LinkisInstallDir /logs/linkis-ps-publicservice.out &
+#### 3.11.4 conf/linkis-cg-engineplugin.properties
-[linkis-cg-linkismanager]
-nohup java -DserviceName=linkis-cg-linkismanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-linkismanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-linkismanager/* org.apache.linkis.manager.am.LinkisManagerApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-linkismanager.out &
+```properties
+wds.linkis.engineconn.home=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+
+wds.linkis.engineconn.plugin.loader.store.path=/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-engineconn-plugins/shell/target/out
+```
-[linkis-ps-cs]
-nohup java -DserviceName=linkis-ps-cs -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-ps-cs-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-public-enhancements/linkis-ps-cs/* org.apache.linkis.cs.server.LinkisCSApplication 2>&1> /data /LinkisInstallDir/logs/linkis-ps-cs.out &
+The two configurations here are mainly to specify the root directory of the engine storage, and the main purpose of specifying it as target/out is that after the engine-related code or configuration changes, the engineplugin service can be restarted directly to take effect.
-[linkis-cg-entrance]
-nohup java -DserviceName=linkis-cg-entrance -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-entrance-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-entrance/* org.apache.linkis.entrance.LinkisEntranceApplication 2>&1> /data/LinkisInstallDir /logs/linkis-cg-entrance.out &
+### 3.12 Set sudo password-free for the current user
-[linkis-cg-engineconnmanager]
-nohup java -DserviceName=linkis-cg-engineconnmanager -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineconnmanager-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineconnmanager/* org.apache.linkis.ecm.server.LinkisECMApplication 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineconnmanager.out &
+When the engine is started, sudo needs to be used to execute the shell command to start the engine process. The current user on the mac generally needs to enter a password when using sudo. Therefore, it is necessary to set sudo password-free for the current user. The setting method is as follows:
+
+```shell
+sudo chmod u-w /etc/sudoers
+sudo visudo
+Replace #%admin ALL=(ALL) AL with %admin ALL=(ALL) NOPASSWD: ALL
+save file exit
+```
+
+### 3.13 Service Testing
+
+Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
+
+First visit the login interface to generate a cookie:
+
+
+
+Then submit the shell code for execution
+
+POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
+
+body parameter:
+
+```json
+{
+ "executionContent": {
+ "code": "echo 'hello'",
+ "runType": "shell"
+ },
+ "params": {
+ "variable": {
+ "testvar": "hello"
+ },
+ "configuration": {
+ "runtime": {},
+ "startup": {}
+ }
+ },
+ "source": {
+ "scriptPath": "file:///tmp/hadoop/test.sql"
+ },
+ "labels": {
+ "engineType": "shell-1",
+ "userCreator": "leojie-IDE"
+ }
+}
+```
-[linkis-cg-engineplugin]
-nohup java -DserviceName=linkis-cg-engineplugin -Xmx512M -XX:+UseG1GC -Xloggc:/data/LinkisInstallDir/logs/linkis-cg-engineplugin-gc.log -cp /data/LinkisInstallDir/conf/:/data/LinkisInstallDir /lib/linkis-commons/public-module/*:/data/LinkisInstallDir/lib/linkis-computation-governance/linkis-cg-engineplugin/* org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer 2>&1> /data /LinkisInstallDir/logs/linkis-cg-engineplugin.out &
+Results of the:
+
+```json
... 1219 lines suppressed ...
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org