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/09/09 03:58:51 UTC
[incubator-linkis-website] branch dev updated: update debug doc (#508)
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 6aa5e0e3be update debug doc (#508)
6aa5e0e3be is described below
commit 6aa5e0e3be58f6d43ca73ab88aaf93a3fab64a5c
Author: peacewong <pe...@apache.org>
AuthorDate: Fri Sep 9 11:58:46 2022 +0800
update debug doc (#508)
---
docs/development/linkis-debug.md | 241 +++++++++++----------
.../current/main.md | 24 +-
.../current/development/linkis-debug.md | 172 ++++++++-------
.../version-1.2.0/development/linkis-debug.md | 170 ++++++++-------
.../version-1.2.0/development/linkis-debug.md | 241 +++++++++++----------
5 files changed, 448 insertions(+), 400 deletions(-)
diff --git a/docs/development/linkis-debug.md b/docs/development/linkis-debug.md
index af8c11f0e0..d2aaef29da 100644
--- a/docs/development/linkis-debug.md
+++ b/docs/development/linkis-debug.md
@@ -1,13 +1,12 @@
---
-title: Linkis Debug
+title: Service Debugging Guide
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. 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>
+> However, on Windows OS, the linkis-cg-engineconnmanager service does 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">Linkis before version 1.0.3 has not yet entered the apache incubation, the organization still belongs to webank, the package name of the main class is `com.webank.wedatasphere.linkis`, when debugging, pay attention to the distinction . </font></h4>
## 1. Code debugging environment
@@ -22,11 +21,12 @@ 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.
+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
+##If the corresponding version has been released, you can skip this step. The released version-related dependencies have been deployed to the maven central repository
mvn -N install
-mvn clean install
+mvn clean install -DskipTests
````
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
@@ -35,13 +35,23 @@ After the compilation command runs successfully, the compiled installation packa
### 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.
+If the mysql driver class cannot be found during the service startup process, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module.
+
+At present, the services that rely on mysql and the corresponding pom.xml paths are as follows:
-The services currently relying on mysql are:
+- linkis-mg-gateway: linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/pom.xml
+- linkis-ps-publicservice: linkis-public-enhancements/pom.xml
+- linkis-cg-linkismanage: linkis-computation-governance/linkis-manager/linkis-application-manager/pom.xml
+- linkis-cg-engineplugin: linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
+The way to add to the dependency is as follows, modify the pom.xml file of the corresponding service to add the mysql dependency,
+````xml
+<dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+````
### 3.2 Adjust log4j2.xml configuration
@@ -51,7 +61,7 @@ Under the Linkis source code folder, in the subdirectory linkis-dist/package/con
Only the configuration content that needs to be added is posted here.
-```xml
+````xml
<configuration status="error" monitorInterval="30">
<appenders>
<Console name="Console" target="SYSTEM_OUT">
@@ -65,11 +75,12 @@ Only the configuration content that needs to be added is posted here.
</root>
</loggers>
</configuration>
-```
+````
+__Note:__linkis.properties needs to modify the parameters of the corresponding jdbc
### 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.
+Linkis' services rely on Eureka as the registry, 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.
@@ -92,14 +103,14 @@ linkis-eureka
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
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
+````
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 path writing rule in Windows is: D:\{YourPathPrefix}\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:
@@ -108,7 +119,7 @@ If you don't want the default 20303 port, you can modify the port configuration:
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Starting 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/.
@@ -118,13 +129,12 @@ After the above settings are completed, run the Application directly. After succ
### 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
+````properties
wds.linkis.admin.user=leojie
wds.linkis.admin.password=123456
-```
+````
Set the startup Application of linkis-mg-gateway
@@ -140,11 +150,11 @@ linkis-mg-gateway
linkis-gateway-server-support
[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:{YourPathPrefix}/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.
@@ -166,57 +176,39 @@ linkis-ps-publicservice
linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:{YourPathPrefix}/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:
+You need to add the publicly dependent modules to the classpath of the linkis-public-enhancements module, and modify the pom of pes to add the following dependencies:
+linkis-public-enhancements/pom.xml
+````xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-
-
-
-
-
-
-
+````
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
+### 3.6 Start linkis-cg-linkismanager
@@ -230,16 +222,16 @@ linkis-cg-linkismanager
linkis-application-manager
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:{YourPathPrefix}/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
+### 3.7 Start linkis-cg-entrance
@@ -260,73 +252,86 @@ 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
+### 3.8 Start linkis-cg-engineplugin
-
+
Parameter explanation:
```shell
[Service Name]
-linkis-cg-engineconnmanager
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-engineconn-manager-server
+linkis-engineconn-plugin-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/
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
+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.
-```
+````
--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.
+When starting engineplugin, you may encounter the following error:
+
+
-Debugging for linkis-cg-engineplugin module only supports Mac OS
+You need to add the publicly dependent modules to the classpath of the ecp module, and modify the pom of pes to add the following dependencies:
+linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+````xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-### 3.10 Start linkis-cg-engineplugin
+````
-
+### 3.9 Start linkis-cg-engineconnmanager
+
+
Parameter explanation:
```shell
[Service Name]
-linkis-cg-engineplugin
+linkis-cg-engineconnmanager
[Use classpath of module]
-linkis-engineconn-plugin-server
+linkis-engineconn-manager-server
[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+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.
-```
-
-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
+-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
+Debugging the linkis-cg-engineconnmanager module only supports Mac OS and Linux systems.
-### 3.11 Key Configuration Modifications
+### 3.10 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
+#### 3.10.1 conf/linkis.properties
-```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
@@ -340,54 +345,54 @@ 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.
+The directory structure of wds.linkis.home={YourPathPrefix}/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
+#### 3.10.2 conf/linkis-cg-entrance.properties
-```properties
+````properties
# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+wds.linkis.entrance.config.log.path=file:///{YourPathPrefix}/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
-```
+wds.linkis.resultSet.store.path=file:///{YourPathPrefix}/linkis/data/resultSetDir
+````
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+#### 3.10.3 conf/linkis-cg-engineconnmanager.properties
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
+````properties
+wds.linkis.engineconn.root.dir={YourPathPrefix}/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
+#### 3.10.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
+````properties
+wds.linkis.engineconn.home={YourPathPrefix}/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
-```
+wds.linkis.engineconn.plugin.loader.store.path={YourPathPrefix}/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
+### 3.11 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:
+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 the 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
+### 3.12 Service Test
Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
@@ -401,7 +406,7 @@ POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
body parameter:
-```json
+````json
{
"executionContent": {
"code": "echo 'hello'",
@@ -424,11 +429,11 @@ body parameter:
"userCreator": "leojie-IDE"
}
}
-```
+````
Results of the:
-```json
+````json
{
"method": "/api/entrance/submit",
"status": 0,
@@ -438,13 +443,13 @@ Results of the:
"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
+````json
{
"method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
"status": 0,
@@ -455,13 +460,13 @@ GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance
"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
+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
+````json
{
"method": "/api/filesystem/openFile",
"status": 0,
@@ -479,7 +484,7 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
]
}
}
-```
+````
## 4. Remote debugging service guide
@@ -506,4 +511,4 @@ Open the window as shown below and configure the remote debugging port, service,
### 4.5 Start debugging
Click the debug button, and the following information appears, indicating that you can start debugging
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs-faq/current/main.md b/i18n/zh-CN/docusaurus-plugin-content-docs-faq/current/main.md
index 9829f81626..0c3c952463 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs-faq/current/main.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs-faq/current/main.md
@@ -502,4 +502,26 @@ ERROR [main] com.webank.wedatasphere.linkis.engineconn.computation.executor.hook
override protected def constructCode(udfInfo: UDFInfo): String = {
"%sql\n" + "add jar " + udfInfo.getPath + "\n%sql\n" + udfInfo.getRegisterFormat
}
-```
\ No newline at end of file
+```
+
+### Q56 CDH环境Linkis执行Spark任务报：Failed to start bean 'webServerStartStop
+
+详细日志：
+```shell
+Caused by: java.lang.IllegalStateException
+at org.eclipse.jetty.servlet.ServletHolder.setClassFrom(ServletHolder.java:300) ~[jetty-servlet-9.4.48.v20220622.jar:9.4.48.v20220622]
+at org.eclipse.jetty.servlet.ServletHolder.doStart(ServletHolder.java:347) ~[jetty-servlet-9.4.48.v20220622.jar:9.4.48.v20220622]
+at org.eclipse.jetty.util.component.AbstractLifeCycle.start(AbstractLifeCycle.java:73) ~[jetty-util-9.4.48.v20220622.jar:9.4.48.v20220622]
+at org.eclipse.jetty.servlet.ServletHandler.lambda$initialize$0(ServletHandler.java:749) ~[jetty-servlet-9.4.48.v20220622.jar:9.4.48.v20220622]
+at java.util.stream.SortedOps$SizedRefSortingSink.end(SortedOps.java:357) ~[?:1.8.0_292]
+at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:483) ~[?:1.8.0_292]
+at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:472) ~[?:1.8.0_292]
+at java.util.stream.StreamSpliterators$WrappingSpliterator.forEachRemaining(StreamSpliterators.java:313) ~[?:1.8.0_292]
+at java.util.stream.Streams$ConcatSpliterator.forEachRemaining(Streams.java:743) ~[?:1.8.0_292]
+at java.util.stream.ReferencePipeline$Head.forEach(ReferencePipeline.java:647) ~[?:1.8.0_292]
+at org.eclipse.jetty.servlet.ServletHandler.initialize(ServletHandler.java:774) ~[jetty-servlet-9.4.48.v20220622.jar:9.4.48.v20220622]
+at org.springframework.boot.web.embedded.jetty.JettyEmbeddedWebAppContext$JettyEmbeddedServletHandler.deferredInitialize(JettyEmbeddedWebAppContext.java:46) ~[spring-boot-2.3.12.RELEASE.jar:2.3.12.RELEASE]
+at
+```
+原因：这个是因为CDH—Spark底层依赖的classPath和Linkis的存在冲突导致
+解决办法：在linkis部署的机器上面可以检查spark-env.sh里面的classPath并进行注释掉，重新运行。详情可以参考[3282](https://github.com/apache/incubator-linkis/issues/3282)
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 e046d6ad81..f472899254 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
@@ -4,7 +4,7 @@ sidebar_position: 2
---
> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
-> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
+> 但在Windows OS上，linkis-cg-engineconnmanager服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
@@ -24,8 +24,9 @@ git checkout dev-1.2.0
克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
```shell
+##如果对应版本已经发布，则可以跳过该步骤。发布的版本相关依赖已经deploy到maven中央仓库
mvn -N install
-mvn clean install
+mvn clean install -DskipTests
```
编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
@@ -34,13 +35,23 @@ mvn clean install
### 3.1 add mysql-connector-java到classpath中
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下。
-目前依赖mysql的服务有：
+目前依赖mysql的服务有和对应的pom.xml路径如下：
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
+- linkis-mg-gateway：linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/pom.xml
+- linkis-ps-publicservice：linkis-public-enhancements/pom.xml
+- linkis-cg-linkismanage：linkis-computation-governance/linkis-manager/linkis-application-manager/pom.xml
+- linkis-cg-engineplugin: linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+
+增加到依赖的方式如下，修改对应服务的pom.xml文件讲mysql依赖加入进去，
+```xml
+<dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+```
### 3.2 调整log4j2.xml配置
@@ -65,10 +76,11 @@ mvn clean install
</loggers>
</configuration>
```
+__注意：__ linkis.properties需要修改对应的jdbc的参数
### 3.3 启动eureka服务
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
+Linkis的服务依赖Eureka作为注册中心，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
@@ -91,14 +103,14 @@ linkis-eureka
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
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
```
注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
-在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+在Windows中路径书写规则是：D:\{YourPathPrefix}\incubator-linkis\linkis-dist\package\conf
（针对以下微服务同样适用）
如果不想默认的20303端口可以修改端口配置：
@@ -116,8 +128,7 @@ server:
### 3.4 启动linkis-mg-gateway
-linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
+linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
```properties
@@ -139,7 +150,7 @@ linkis-mg-gateway
linkis-gateway-server-support
[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
@@ -165,7 +176,7 @@ linkis-ps-publicservice
linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
@@ -178,44 +189,26 @@ org.apache.linkis.filesystem.LinkisPublicServiceApp
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
+需要把公共依赖的模块加到linkis-public-enhancements模块的classpath下，修改pes的pom增加以下依赖：
+linkis-public-enhancements/pom.xml
+```xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-
+```
做完上述配置后重新启动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
+### 3.6 启动linkis-cg-linkismanager
@@ -229,7 +222,7 @@ linkis-cg-linkismanager
linkis-application-manager
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
@@ -238,7 +231,7 @@ org.apache.linkis.manager.am.LinkisManagerApplication
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-### 3.8 启动linkis-cg-entrance
+### 3.7 启动linkis-cg-entrance
@@ -261,70 +254,85 @@ org.apache.linkis.entrance.LinkisEntranceApplication
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-### 3.9 启动cg-engineconnmanager
+### 3.8 启动linkis-cg-engineplugin
-
+
参数解释：
```shell
[Service Name]
-linkis-cg-engineconnmanager
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-engineconn-manager-server
+linkis-engineconn-plugin-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/
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
[Add provided scope to classpath]
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+启动engineplugin的时候可能会遇到如下报错：
-针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+需要把公共依赖的模块加到ecp模块的classpath下，修改pes的pom增加以下依赖：
+linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+```xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+```
-### 3.10 启动linkis-cg-engineplugin
+### 3.9 启动linkis-cg-engineconnmanager
-
+
参数解释：
```shell
[Service Name]
-linkis-cg-engineplugin
+linkis-cg-engineconnmanager
[Use classpath of module]
-linkis-engineconn-plugin-server
+linkis-engineconn-manager-server
[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+org.apache.linkis.ecm.server.LinkisECMApplication
[Add provided scope to classpath]
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-启动engineplugin的时候可能会遇到如下报错：
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineconnmanager模块调试暂只支持Mac OS 和 Linux系统
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-针对linkis-cg-engineplugin模块调试暂只支持Mac OS
-### 3.11 关键配置修改
+### 3.10 关键配置修改
以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-#### 3.11.1 conf/linkis.properties
+#### 3.10.1 conf/linkis.properties
```properties
# linkis底层数据库连接参数配置
@@ -344,39 +352,39 @@ 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不指定，可能会遇到目录找不到的异常。
+其中wds.linkis.home={YourPathPrefix}/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-#### 3.11.2 conf/linkis-cg-entrance.properties
+#### 3.10.2 conf/linkis-cg-entrance.properties
```properties
# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+wds.linkis.entrance.config.log.path=file:///{YourPathPrefix}/linkis/data/entranceConfigLog
# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+wds.linkis.resultSet.store.path=file:///{YourPathPrefix}/linkis/data/resultSetDir
```
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+#### 3.10.3 conf/linkis-cg-engineconnmanager.properties
```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+wds.linkis.engineconn.root.dir={YourPathPrefix}/linkis/data/engineconnRootDir
```
不修改可能会遇到路径不存在异常。
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
+#### 3.10.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.home={YourPathPrefix}/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
+wds.linkis.engineconn.plugin.loader.store.path={YourPathPrefix}/incubator-linkis/linkis-engineconn-plugins/shell/target/out
```
这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-### 3.12 为当前用户设置sudo免密
+### 3.11 为当前用户设置sudo免密
引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
@@ -387,7 +395,7 @@ sudo visudo
保存文件退出
```
-### 3.13 服务测试
+### 3.12 服务测试
保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
@@ -506,4 +514,4 @@ sh linkis-daemon.sh restart ps-publicservice
### 4.5 开始调试
点击调试按钮,出现如下信息代表可以开始调试
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2.0/development/linkis-debug.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2.0/development/linkis-debug.md
index e046d6ad81..12648dbcdc 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2.0/development/linkis-debug.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/version-1.2.0/development/linkis-debug.md
@@ -4,7 +4,7 @@ sidebar_position: 2
---
> 导语：本文详细记录了如何在IDEA中配置和启动Linkis的各个微服务，并实现JDBC、Python、Shell等脚本的提交和执行。在Mac OS上，Linkis的各个微服务都支持本地调试。
-> 但在Windows OS上，linkis-cg-engineplugin和linkis-cg-engineconnmanager两个服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
+> 但在Windows OS上，linkis-cg-engineconnmanager服务暂不支持在本地进行调试，可参考下文第4小节的远程调试文档进行调试。
<h4><font color="red">linkis 1.0.3版本前，还未进入apache孵化，组织还是归属webank,主类的包名为`com.webank.wedatasphere.linkis`，调试时，注意区分。</font></h4>
@@ -24,8 +24,9 @@ git checkout dev-1.2.0
克隆Linkis的源码到本地，并用IDEA打开，首次打开项目会从maven仓库中下载Linkis项目编译所需的依赖jar包。当依赖jar包加载完毕之后，运行如下编译打包命令。
```shell
+##如果对应版本已经发布，则可以跳过该步骤。发布的版本相关依赖已经deploy到maven中央仓库
mvn -N install
-mvn clean install
+mvn clean install -DskipTests
```
编译命令运行成功之后，在目录incubator-linkis/linkis-dist/target/下可找到编译好的安装包：apache-linkis-版本号-incubating-bin.tar.gz
@@ -34,13 +35,23 @@ mvn clean install
### 3.1 add mysql-connector-java到classpath中
-服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下，详细操作请参考3.5小节。
+服务启动过程中如果遇到mysql驱动类找不到的情况，可以把mysql-connector-java-版本号.jar添加到对应服务模块的classpath下。
-目前依赖mysql的服务有：
+目前依赖mysql的服务有和对应的pom.xml路径如下：
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
+- linkis-mg-gateway：linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/pom.xml
+- linkis-ps-publicservice：linkis-public-enhancements/pom.xml
+- linkis-cg-linkismanage：linkis-computation-governance/linkis-manager/linkis-application-manager/pom.xml
+- linkis-cg-engineplugin: linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+
+增加到依赖的方式如下，修改对应服务的pom.xml文件讲mysql依赖加入进去，
+```xml
+<dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+```
### 3.2 调整log4j2.xml配置
@@ -65,10 +76,11 @@ mvn clean install
</loggers>
</configuration>
```
+__注意：__ linkis.properties需要修改对应的jdbc的参数
### 3.3 启动eureka服务
-Linkis和DSS的服务都依赖Eureka，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
+Linkis的服务依赖Eureka作为注册中心，所以我们需要首先启动Eureka服务，Eureka服务可以在本地启动，也可以使用远程启动的服务。保证各个服务都能访问到Eureka的IP和端口之后，就可以开始着手启动其他微服务了。
在Linkis内部是通过-DserviceName参数设置应用名以及使用配置文件，所以-DserviceName是必须要指定的VM启动参数。
@@ -91,14 +103,14 @@ linkis-eureka
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
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
```
注意调试配置中涉及到的本地路径，需要要修改成自己设置的路径；
-在Windows中路径书写规则是：D:\yourDir\incubator-linkis\linkis-dist\package\conf
+在Windows中路径书写规则是：D:\{YourPathPrefix}\incubator-linkis\linkis-dist\package\conf
（针对以下微服务同样适用）
如果不想默认的20303端口可以修改端口配置：
@@ -117,7 +129,6 @@ server:
### 3.4 启动linkis-mg-gateway
linkis-mg-gateway是Linkis的服务网关，所有的请求都会经由gateway来转发到对应的服务上。
-
启动服务器前，首先需要编辑conf/linkis-mg-gateway.properties配置文件，增加管理员用户名和密码，用户名需要与你当前登录的mac用户名保持一致。
```properties
@@ -139,7 +150,7 @@ linkis-mg-gateway
linkis-gateway-server-support
[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
@@ -165,7 +176,7 @@ linkis-ps-publicservice
linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.filesystem.LinkisPublicServiceApp
@@ -178,44 +189,26 @@ org.apache.linkis.filesystem.LinkisPublicServiceApp
-需要把public-module模块加到linkis-public-enhancements模块的classpath下，详细步骤如下：
-
-
-
-
-
-
+需要把公共依赖的模块加到linkis-public-enhancements模块的classpath下，修改pes的pom增加以下依赖：
+linkis-public-enhancements/pom.xml
+```xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-
+```
做完上述配置后重新启动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
+### 3.6 启动linkis-cg-linkismanager
@@ -229,7 +222,7 @@ linkis-cg-linkismanager
linkis-application-manager
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
org.apache.linkis.manager.am.LinkisManagerApplication
@@ -238,7 +231,7 @@ org.apache.linkis.manager.am.LinkisManagerApplication
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-### 3.8 启动linkis-cg-entrance
+### 3.7 启动linkis-cg-entrance
@@ -261,70 +254,85 @@ org.apache.linkis.entrance.LinkisEntranceApplication
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-### 3.9 启动cg-engineconnmanager
+### 3.8 启动linkis-cg-engineplugin
-
+
参数解释：
```shell
[Service Name]
-linkis-cg-engineconnmanager
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-engineconn-manager-server
+linkis-engineconn-plugin-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/
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
+org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
[Add provided scope to classpath]
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
--DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+启动engineplugin的时候可能会遇到如下报错：
-针对linkis-cg-engineplugin模块调试暂只支持Mac OS
+
+
+需要把公共依赖的模块加到ecp模块的classpath下，修改pes的pom增加以下依赖：
+linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+```xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+```
-### 3.10 启动linkis-cg-engineplugin
+### 3.9 启动linkis-cg-engineconnmanager
-
+
参数解释：
```shell
[Service Name]
-linkis-cg-engineplugin
+linkis-cg-engineconnmanager
[Use classpath of module]
-linkis-engineconn-plugin-server
+linkis-engineconn-manager-server
[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+org.apache.linkis.ecm.server.LinkisECMApplication
[Add provided scope to classpath]
通过勾选Include dependencies with “Provided” scope ，可以在调试时，引入provided级别的依赖包。
```
-启动engineplugin的时候可能会遇到如下报错：
+-DJAVA_HOME是为了指定ecm启动引擎时所使用的java命令所在的路径，如果你默认JAVA环境变量中的版本满足需要，此配置可以不加
+
+针对linkis-cg-engineconnmanager模块调试暂只支持Mac OS 和 Linux系统
-
-解决办法是把public-module模块加到linkis-engineconn-plugin-server模块的classpath下，参考3.5小节
-针对linkis-cg-engineplugin模块调试暂只支持Mac OS
-### 3.11 关键配置修改
+### 3.10 关键配置修改
以上操作只是完成了对Linkis各个微服务启动Application的配置，除此之外，Linkis服务启动时所加载的配置文件中，有些关键配置也需要做针对性地修改，否则启动服务或脚本执行的过程中会遇到一些报错。关键配置的修改归纳如下：
-#### 3.11.1 conf/linkis.properties
+#### 3.10.1 conf/linkis.properties
```properties
# linkis底层数据库连接参数配置
@@ -344,39 +352,39 @@ 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不指定，可能会遇到目录找不到的异常。
+其中wds.linkis.home={YourPathPrefix}/linkis的目录结构如下，里面只放置了lib目录和conf目录。引擎进程启动时会把wds.linkis.home中的conf和lib路径，加到classpath下，如果wds.linkis.home不指定，可能会遇到目录找不到的异常。
-#### 3.11.2 conf/linkis-cg-entrance.properties
+#### 3.10.2 conf/linkis-cg-entrance.properties
```properties
# entrance服务执行任务的日志目录
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+wds.linkis.entrance.config.log.path=file:///{YourPathPrefix}/linkis/data/entranceConfigLog
# 结果集保存目录，本机用户需要读写权限
-wds.linkis.resultSet.store.path=file:///Users/leojie/software/linkis/data/resultSetDir
+wds.linkis.resultSet.store.path=file:///{YourPathPrefix}/linkis/data/resultSetDir
```
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+#### 3.10.3 conf/linkis-cg-engineconnmanager.properties
```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
+wds.linkis.engineconn.root.dir={YourPathPrefix}/linkis/data/engineconnRootDir
```
不修改可能会遇到路径不存在异常。
-#### 3.11.4 conf/linkis-cg-engineplugin.properties
+#### 3.10.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.home={YourPathPrefix}/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
+wds.linkis.engineconn.plugin.loader.store.path={YourPathPrefix}/incubator-linkis/linkis-engineconn-plugins/shell/target/out
```
这里两个配置主要为了指定引擎存储的根目录，指定为target/out的主要目的是，引擎相关代码或配置改动后可以直接重启engineplugin服务后生效。
-### 3.12 为当前用户设置sudo免密
+### 3.11 为当前用户设置sudo免密
引擎拉起时需要使用sudo来执行启动引擎进程的shell命令，mac上当前用户使用sudo时一般都需要输入密码，因此，需要为当前用户设置sudo免密，设置方法如下：
@@ -387,7 +395,7 @@ sudo visudo
保存文件退出
```
-### 3.13 服务测试
+### 3.12 服务测试
保证上述服务都是成功启动状态，然后在postman中测试提交运行shell脚本作业。
@@ -506,4 +514,4 @@ sh linkis-daemon.sh restart ps-publicservice
### 4.5 开始调试
点击调试按钮,出现如下信息代表可以开始调试
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/versioned_docs/version-1.2.0/development/linkis-debug.md b/versioned_docs/version-1.2.0/development/linkis-debug.md
index af8c11f0e0..d2aaef29da 100644
--- a/versioned_docs/version-1.2.0/development/linkis-debug.md
+++ b/versioned_docs/version-1.2.0/development/linkis-debug.md
@@ -1,13 +1,12 @@
---
-title: Linkis Debug
+title: Service Debugging Guide
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. 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>
+> However, on Windows OS, the linkis-cg-engineconnmanager service does 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">Linkis before version 1.0.3 has not yet entered the apache incubation, the organization still belongs to webank, the package name of the main class is `com.webank.wedatasphere.linkis`, when debugging, pay attention to the distinction . </font></h4>
## 1. Code debugging environment
@@ -22,11 +21,12 @@ 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.
+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
+##If the corresponding version has been released, you can skip this step. The released version-related dependencies have been deployed to the maven central repository
mvn -N install
-mvn clean install
+mvn clean install -DskipTests
````
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
@@ -35,13 +35,23 @@ After the compilation command runs successfully, the compiled installation packa
### 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.
+If the mysql driver class cannot be found during the service startup process, you can add mysql-connector-java-version.jar to the classpath of the corresponding service module.
+
+At present, the services that rely on mysql and the corresponding pom.xml paths are as follows:
-The services currently relying on mysql are:
+- linkis-mg-gateway: linkis-spring-cloud-services/linkis-service-gateway/linkis-gateway-server-support/pom.xml
+- linkis-ps-publicservice: linkis-public-enhancements/pom.xml
+- linkis-cg-linkismanage: linkis-computation-governance/linkis-manager/linkis-application-manager/pom.xml
+- linkis-cg-engineplugin: linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
-- linkis-mg-gateway
-- linkis-ps-publicservice
-- linkis-cg-linkismanage
+The way to add to the dependency is as follows, modify the pom.xml file of the corresponding service to add the mysql dependency,
+````xml
+<dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
+````
### 3.2 Adjust log4j2.xml configuration
@@ -51,7 +61,7 @@ Under the Linkis source code folder, in the subdirectory linkis-dist/package/con
Only the configuration content that needs to be added is posted here.
-```xml
+````xml
<configuration status="error" monitorInterval="30">
<appenders>
<Console name="Console" target="SYSTEM_OUT">
@@ -65,11 +75,12 @@ Only the configuration content that needs to be added is posted here.
</root>
</loggers>
</configuration>
-```
+````
+__Note:__linkis.properties needs to modify the parameters of the corresponding jdbc
### 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.
+Linkis' services rely on Eureka as the registry, 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.
@@ -92,14 +103,14 @@ linkis-eureka
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
+-DserviceName=linkis-mg-eureka -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[Program arguments]
--spring.profiles.active=eureka --eureka.instance.preferIpAddress=true
-```
+````
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 path writing rule in Windows is: D:\{YourPathPrefix}\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:
@@ -108,7 +119,7 @@ If you don't want the default 20303 port, you can modify the port configuration:
File path: conf/application-eureka.yml
Modify the port:
server:
- port: 8080 ##Starting 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/.
@@ -118,13 +129,12 @@ After the above settings are completed, run the Application directly. After succ
### 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
+````properties
wds.linkis.admin.user=leojie
wds.linkis.admin.password=123456
-```
+````
Set the startup Application of linkis-mg-gateway
@@ -140,11 +150,11 @@ linkis-mg-gateway
linkis-gateway-server-support
[VM Opitons]
--DserviceName=linkis-mg-gateway -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-mg-gateway -Xbootclasspath/a:{YourPathPrefix}/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.
@@ -166,57 +176,39 @@ linkis-ps-publicservice
linkis-public-enhancements
[VM Opitons]
--DserviceName=linkis-ps-publicservice -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:{YourPathPrefix}/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:
+You need to add the publicly dependent modules to the classpath of the linkis-public-enhancements module, and modify the pom of pes to add the following dependencies:
+linkis-public-enhancements/pom.xml
+````xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-
-
-
-
-
-
-
+````
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
+### 3.6 Start linkis-cg-linkismanager
@@ -230,16 +222,16 @@ linkis-cg-linkismanager
linkis-application-manager
[VM Opitons]
--DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:{YourPathPrefix}/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
+### 3.7 Start linkis-cg-entrance
@@ -260,73 +252,86 @@ 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
+### 3.8 Start linkis-cg-engineplugin
-
+
Parameter explanation:
```shell
[Service Name]
-linkis-cg-engineconnmanager
+linkis-cg-engineplugin
[Use classpath of module]
-linkis-engineconn-manager-server
+linkis-engineconn-plugin-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/
+-DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf
[main Class]
-org.apache.linkis.ecm.server.LinkisECMApplication
+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.
-```
+````
--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.
+When starting engineplugin, you may encounter the following error:
+
+
-Debugging for linkis-cg-engineplugin module only supports Mac OS
+You need to add the publicly dependent modules to the classpath of the ecp module, and modify the pom of pes to add the following dependencies:
+linkis-computation-governance/linkis-engineconn/linkis-engineconn-plugin-server/pom.xml
+````xml
+ <dependency>
+ <groupId>org.apache.linkis</groupId>
+ <artifactId>linkis-dist</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>mysql</groupId>
+ <artifactId>mysql-connector-java</artifactId>
+ <version>${mysql.connector.version}</version>
+</dependency>
-### 3.10 Start linkis-cg-engineplugin
+````
-
+### 3.9 Start linkis-cg-engineconnmanager
+
+
Parameter explanation:
```shell
[Service Name]
-linkis-cg-engineplugin
+linkis-cg-engineconnmanager
[Use classpath of module]
-linkis-engineconn-plugin-server
+linkis-engineconn-manager-server
[VM Opitons]
--DserviceName=linkis-cg-engineplugin -Xbootclasspath/a:/Users/leojie/other_project/apache/linkis/incubator-linkis/linkis-dist/package/conf
+-DserviceName=linkis-cg-engineconnmanager -Xbootclasspath/a:{YourPathPrefix}/incubator-linkis/linkis-dist/package/conf -DJAVA_HOME=/Library/Java/JavaVirtualMachines/zulu-8.jdk/Contents/Home/
[main Class]
-org.apache.linkis.engineplugin.server.LinkisEngineConnPluginServer
+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.
-```
-
-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
+-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
+Debugging the linkis-cg-engineconnmanager module only supports Mac OS and Linux systems.
-### 3.11 Key Configuration Modifications
+### 3.10 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
+#### 3.10.1 conf/linkis.properties
-```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
@@ -340,54 +345,54 @@ 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.
+The directory structure of wds.linkis.home={YourPathPrefix}/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
+#### 3.10.2 conf/linkis-cg-entrance.properties
-```properties
+````properties
# The log directory of the entrance service execution task
-wds.linkis.entrance.config.log.path=file:///Users/leojie/software/linkis/data/entranceConfigLog
+wds.linkis.entrance.config.log.path=file:///{YourPathPrefix}/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
-```
+wds.linkis.resultSet.store.path=file:///{YourPathPrefix}/linkis/data/resultSetDir
+````
-#### 3.11.3 conf/linkis-cg-engineconnmanager.properties
+#### 3.10.3 conf/linkis-cg-engineconnmanager.properties
-```properties
-wds.linkis.engineconn.root.dir=/Users/leojie/software/linkis/data/engineconnRootDir
-```
+````properties
+wds.linkis.engineconn.root.dir={YourPathPrefix}/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
+#### 3.10.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
+````properties
+wds.linkis.engineconn.home={YourPathPrefix}/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
-```
+wds.linkis.engineconn.plugin.loader.store.path={YourPathPrefix}/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
+### 3.11 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:
+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 the 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
+### 3.12 Service Test
Make sure that the above services are all successfully started, and then test and submit the shell script job in postman.
@@ -401,7 +406,7 @@ POST: http://127.0.0.1:9001/api/rest_j/v1/entrance/submit
body parameter:
-```json
+````json
{
"executionContent": {
"code": "echo 'hello'",
@@ -424,11 +429,11 @@ body parameter:
"userCreator": "leojie-IDE"
}
}
-```
+````
Results of the:
-```json
+````json
{
"method": "/api/entrance/submit",
"status": 0,
@@ -438,13 +443,13 @@ Results of the:
"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
+````json
{
"method": "/api/entrance/exec_id018017linkis-cg-entrance192.168.3.13:9104IDE_leojie_shell_0/progress",
"status": 0,
@@ -455,13 +460,13 @@ GET http://127.0.0.1:9001/api/rest_j/v1/entrance/exec_id018017linkis-cg-entrance
"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
+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
+````json
{
"method": "/api/filesystem/openFile",
"status": 0,
@@ -479,7 +484,7 @@ GET http://127.0.0.1:9001/api/rest_j/v1/filesystem/openFile?path=file:///Users/l
]
}
}
-```
+````
## 4. Remote debugging service guide
@@ -506,4 +511,4 @@ Open the window as shown below and configure the remote debugging port, service,
### 4.5 Start debugging
Click the debug button, and the following information appears, indicating that you can start debugging
-
\ No newline at end of file
+
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org