Skip to content

Commit b985165

Browse files
committed
[Chore] Remove unused step in development-environment-setup.md
1 parent 2284835 commit b985165

File tree

2 files changed

+15
-44
lines changed

2 files changed

+15
-44
lines changed

docs/docs/en/contribute/development-environment-setup.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Before setting up the DolphinScheduler development environment, please make sure you have installed the software as below:
66

77
- [Git](https://git-scm.com/downloads)
8-
- [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8.x (Currently does not support jdk 11)
8+
- [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8+
99
- [Maven](http://maven.apache.org/download.cgi): v3.5+
1010
- [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler version is lower than 3.0, please install node v12.20+)
1111
- [Pnpm](https://pnpm.io/installation): v6.x
@@ -180,10 +180,10 @@ Following steps will guide how to start the DolphinScheduler backend service
180180

181181
- File change
182182

183-
- If you use MySQL as your metadata database, you need to modify `dolphinscheduler/pom.xml` and change the `scope` of the `mysql-connector-java` dependency to `compile`. This step is not necessary to use PostgreSQL
183+
- If you use MySQL as your metadata database, you need to modify `dolphinscheduler-bom/pom.xml` and change the `scope` of the `mysql-connector-j` dependency to `compile`. This step is not necessary to use PostgreSQL
184184
- Modify database configuration, modify the database configuration in the `dolphinscheduler-master/src/main/resources/application.yaml`
185-
- Modify database configuration, modify the database configuration in the `dolphinscheduler-worker/src/main/resources/application.yaml`
186185
- Modify database configuration, modify the database configuration in the `dolphinscheduler-api/src/main/resources/application.yaml`
186+
- Modify database configuration, modify the database configuration in the `dolphinscheduler-alert/dolphinscheduler-alert-server/src/main/resources/application.yaml`
187187

188188
We here use MySQL with database, username, password named dolphinscheduler as an example
189189

@@ -196,30 +196,14 @@ spring:
196196
password: dolphinscheduler
197197
```
198198

199-
- Log level: add a line `<appender-ref ref="STDOUT"/>` to the following configuration to enable the log to be displayed on the command line
200-
201-
`dolphinscheduler-master/src/main/resources/logback-spring.xml`
202-
`dolphinscheduler-worker/src/main/resources/logback-spring.xml`
203-
`dolphinscheduler-api/src/main/resources/logback-spring.xml`
204-
205-
here we add the result after modify as below:
206-
207-
```diff
208-
<root level="INFO">
209-
+ <appender-ref ref="STDOUT"/>
210-
<appender-ref ref="APILOGFILE"/>
211-
</root>
212-
```
213-
214-
> **_Note:_** Only DolphinScheduler 2.0 and later versions need to install plugin before start server. It doesn't need it before version 2.0.
215-
216199
##### Server start
217200

218201
There are three services that need to be started, including MasterServer, WorkerServer, ApiApplicationServer.
219202

220-
- MasterServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.master.MasterServer` by IntelliJ IDEA, with the configuration _VM Options_ `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
221-
- WorkerServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.worker.WorkerServer` by IntelliJ IDEA, with the configuration _VM Options_ `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
222-
- ApiApplicationServer:Execute function `main` in the class `org.apache.dolphinscheduler.api.ApiApplicationServer` by IntelliJ IDEA, with the configuration _VM Options_ `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`. After it started, you could find Open API documentation in http://localhost:12345/dolphinscheduler/swagger-ui/index.html
203+
- MasterServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.master.MasterServer` by IntelliJ IDEA, with the configuration _VM Options_ `-DDOCKER=true -Dspring.profiles.active=mysql`
204+
- WorkerServer:Execute function `main` in the class `org.apache.dolphinscheduler.server.worker.WorkerServer` by IntelliJ IDEA, with the configuration _VM Options_ `-DDOCKER=true`
205+
- AlertServer:Execute function `main` in the class `org.apache.dolphinscheduler.alert.AlertServer` by IntelliJ IDEA, with the configuration _VM Options_ `-DDOCKER=true -Dspring.profiles.active=mysql`
206+
- ApiApplicationServer:Execute function `main` in the class `org.apache.dolphinscheduler.api.ApiApplicationServer` by IntelliJ IDEA, with the configuration _VM Options_ `-DDOCKER=true -Dspring.profiles.active=mysql`. After it started, you could find Open API documentation in http://localhost:12345/dolphinscheduler/swagger-ui/index.html
223207

224208
> The `mysql` in the VM Options `-Dspring.profiles.active=mysql` means specified configuration file
225209

docs/docs/zh/contribute/development-environment-setup.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
在搭建 DolphinScheduler 开发环境之前请确保你已经安装以下软件:
66

77
* [Git](https://git-scm.com/downloads)
8-
* [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8.x (当前暂不支持 jdk 11)
8+
* [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html): v1.8+
99
* [Maven](http://maven.apache.org/download.cgi): v3.5+
1010
* [Node](https://nodejs.org/en/download): v16.13+ (dolphinScheduler 版本低于 3.0, 请安装 node v12.20+)
1111
* [Pnpm](https://pnpm.io/installation): v6.x
@@ -110,7 +110,7 @@ DolphinScheduler 开发环境配置有两个方式,分别是standalone模式
110110

111111
## DolphinScheduler Standalone快速开发模式
112112

113-
> **_注意:_** 仅供单机开发调试使用,默认使用 H2 Database,Zookeeper Testing Server
113+
> **_注意:_** 仅供单机开发调试使用,默认使用 H2 Database, Zookeeper Testing Server
114114
>
115115
> Standalone 仅在 DolphinScheduler 1.3.9 及以后的版本支持
116116
@@ -174,10 +174,10 @@ DolphinScheduler 的元数据存储在关系型数据库中,目前支持的关
174174

175175
* 必要的修改
176176

177-
* 如果使用 MySQL 作为元数据库,需要先修改 `dolphinscheduler/pom.xml`,将 `mysql-connector-java` 依赖的 `scope` 改为 `compile`,使用 PostgreSQL 则不需要
177+
* 如果使用 MySQL 作为元数据库,需要先修改 `dolphinscheduler-bom/pom.xml`,将 `mysql-connector-j` 依赖的 `scope` 改为 `compile`,使用 PostgreSQL 则不需要
178178
* 修改 Master 数据库配置,修改 `dolphinscheduler-master/src/main/resources/application.yaml` 文件中的数据库配置
179-
* 修改 Worker 数据库配置,修改 `dolphinscheduler-worker/src/main/resources/application.yaml` 文件中的数据库配置
180179
* 修改 Api 数据库配置,修改 `dolphinscheduler-api/src/main/resources/application.yaml` 文件中的数据库配置
180+
* 修改 Alert 数据库配置,修改 `dolphinscheduler-alert/dolphinscheduler-alert-server/src/main/resources/application.yaml` 文件中的数据库配置
181181

182182
本样例以 MySQL 为例,其中数据库名为 dolphinscheduler,账户名密码均为 dolphinscheduler
183183

@@ -189,28 +189,15 @@ DolphinScheduler 的元数据存储在关系型数据库中,目前支持的关
189189
username: dolphinscheduler
190190
password: dolphinscheduler
191191
```
192-
* 修改日志级别:为以下配置增加一行内容 `<appender-ref ref="STDOUT"/>` 使日志能在命令行中显示
193-
194-
`dolphinscheduler-master/src/main/resources/logback-spring.xml`
195-
`dolphinscheduler-worker/src/main/resources/logback-spring.xml`
196-
`dolphinscheduler-api/src/main/resources/logback-spring.xml`
197-
198-
修改后的结果如下:
199-
200-
```diff
201-
<root level="INFO">
202-
+ <appender-ref ref="STDOUT"/>
203-
<appender-ref ref="APILOGFILE"/>
204-
</root>
205-
```
206192

207193
##### 启动服务
208194

209195
我们需要启动三个服务,包括 MasterServer,WorkerServer,ApiApplicationServer
210196

211-
* MasterServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.server.master.MasterServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
212-
* WorkerServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.server.worker.WorkerServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Ddruid.mysql.usePingMethod=false -Dspring.profiles.active=mysql`
213-
* ApiApplicationServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.api.ApiApplicationServer` 中的 `main` 方法,并配置 *VM Options* `-Dlogging.config=classpath:logback-spring.xml -Dspring.profiles.active=api,mysql`。启动完成可以浏览 Open API 文档,地址为 http://localhost:12345/dolphinscheduler/swagger-ui/index.html
197+
* MasterServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.server.master.MasterServer` 中的 `main` 方法,并配置 *VM Options* `-DDOCKER=true -Dspring.profiles.active=mysql`
198+
* WorkerServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.server.worker.WorkerServer` 中的 `main` 方法,并配置 *VM Options* `-DDOCKER=true`
199+
* AlertServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.alert.AlertServer` 中的 `main` 方法,并配置 *VM Options* `-DDOCKER=true -Dspring.profiles.active=mysql`
200+
* ApiApplicationServer:在 IntelliJ IDEA 中执行 `org.apache.dolphinscheduler.api.ApiApplicationServer` 中的 `main` 方法,并配置 *VM Options* `-DDOCKER=true -Dspring.profiles.active=mysql`。启动完成可以浏览 Open API 文档,地址为 http://localhost:12345/dolphinscheduler/swagger-ui/index.html
214201

215202
> VM Options `-Dspring.profiles.active=mysql``mysql` 表示指定的配置文件
216203

0 commit comments

Comments
 (0)