ContextQMD
Back to Dolphinscheduler

DolphinScheduler development

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

3.4.110.7 KB
Original Source

DolphinScheduler development

Software Requirements

Before setting up the DolphinScheduler development environment, please make sure you have installed the software as below:

Clone Git Repository

Download the git repository through your git management tool, here we use git-core as an example

shell
mkdir dolphinscheduler
cd dolphinscheduler
git clone [email protected]:apache/dolphinscheduler.git

Compile Source Code

Supporting system:

  • MacOS
  • Liunx

Run ./mvnw clean install -Prelease -Dmaven.test.skip=true

Backend Code Style

DolphinScheduler uses Spotless for backend code style and formatting checks. You could run the following command and Spotless will automatically fix the backend code style and formatting errors for you:

shell
./mvnw spotless:apply

We also have provided a pre-commit config file for easy configuration. To use it, you need to have python installed and then install pre-commit by running the following command:

shell
python -m pip install pre-commit

After that, you can run the following command to install the pre-commit hook:

shell
pre-commit install

Now, every time you commit your code, pre-commit will automatically run Spotless to check the code style and formatting.

Frontend Code Style

DolphinScheduler uses pnpm to check and automatically fix frontend code style and formatting issues. First, navigate to the frontend project directory:

shell
cd dolphinscheduler-ui

Then, run the following commands to automatically fix ESLint-fixable issues and format the code:

shell
pnpm run lint      # Fix ESLint issues
pnpm run prettier  # Format code

Finally, you can run the following command to perform a full TypeScript type check and catch type-related errors early:

shell
pnpm exec vue-tsc --noEmit  # Type check

Helm Template Guidelines

After modifying files related to Helm templates, you can use the following command to debug the Helm templates:

shell
helm template ./deploy/kubernetes/dolphinscheduler --debug

Once the Helm templates are debugged and verified, use the following command to automatically update the README.md file (manually updating may likely result in incorrect formatting):

shell
./mvnw validate -P helm-doc -pl :dolphinscheduler

Docker image build

DolphinScheduler will release new Docker images after it released, you could find them in Docker Hub.

  • If you want to modify DolphinScheduler source code, and build Docker images locally, you can run when finished the modification

-Pstaging contains plugins, suitable for development and testing as well as offline deployment without a network environment -Prelease does not contain plugins, suitable for production environments, and plugins can be downloaded on demand from a network that can access plugins

shell
cd dolphinscheduler
./mvnw -B clean package \
       -Dmaven.test.skip \
       -Dspotless.skip = true \
       -Ddocker.tag=<TAG> \
       -Pdocker,[release|staging]

When the command is finished you could find them by command docker images.

  • If you want to modify DolphinScheduler source code, build and push Docker images to your registry <HUB_URL>，you can run when finished the modification
shell
cd dolphinscheduler
./mvnw -B clean deploy \
       -Dmaven.test.skip \
       -Dspotless.skip = true \
       -Ddocker.tag=<TAG> \
       -Ddocker.hub=<HUB_URL> \
       -Pdocker,[release|staging]
  • If you want to modify DolphinScheduler source code, and also want to add customize dependencies of Docker image, you can modify the definition of Dockerfile after modifying the source code. You can run the following command to find all Dockerfile files.
shell
cd dolphinscheduler
find . -iname 'Dockerfile'

Then run the Docker build command above

  • You could create custom Docker images base on those images if you want to change image like add some dependencies or upgrade package.
Dockerfile
FROM dolphinscheduler-standalone-server
RUN apt update ; \
    apt install -y <YOUR-CUSTOM-DEPENDENCE> ; \

Note： Docker will build and push linux/amd64,linux/arm64 multi-architecture images by default

Have to use version after Docker 19.03, because after 19.03 docker contains buildx

Notice

There are two ways to configure the DolphinScheduler development environment, standalone mode and normal mode

  • Standalone mode: Recommended，more convenient to build development environment, it can cover most scenes.
  • Normal mode: Separate server master, worker, api, which can cover more test environments than standalone, and it is more like production environment in real life.

DolphinScheduler Standalone Quick Start

Note: Use standalone server only for development and debugging, because it uses H2 Database as default database and Zookeeper Testing Server which may not be stable in production.

Standalone is only supported in DolphinScheduler 1.3.9 and later versions.

Standalone server is able to connect to external databases like mysql and postgresql, see Standalone Deployment for instructions.

Git Branch Choose

Use different Git branch to develop different codes

  • If you want to develop based on a binary package, switch git branch to specific release branch, for example, if you want to develop base on 1.3.9, you should choose branch 1.3.9-release.
  • If you want to develop the latest code, choose branch branch dev.

Start backend server

Find the class org.apache.dolphinscheduler.StandaloneServer in IntelliJ IDEA and click run main function to startup.

Note: Please check the option Add dependencies with "provided" scope to classpath in the startup configuration before starting, so as to avoid the problem that no dependencies can be found during startup.

Start frontend server

Install frontend dependencies and run it.

Note: You can see more detail about the frontend setting in frontend development.

If you have not yet installed pnpm, you can install it using the following command before running the front-end component:

shell
npm install -g pnpm

After ensuring that pnpm has been installed, run the following command:

shell
cd dolphinscheduler-ui
pnpm install
pnpm run dev

The browser access address http://localhost:5173 can login DolphinScheduler UI. The default username and password are admin/dolphinscheduler123

DolphinScheduler Normal Mode

Prepare

zookeeper

Download ZooKeeper, and extract it.

  • Create directory zkData and zkLog

  • Go to the zookeeper installation directory, copy configure file zoo_sample.cfg to conf/zoo.cfg, and change value of dataDir in conf/zoo.cfg to dataDir=./tmp/zookeeper

    shell
    # We use path /data/zookeeper/data and /data/zookeeper/datalog here as example
dataDir=/data/zookeeper/data
dataLogDir=/data/zookeeper/datalog

  • Run ./bin/zkServer.sh in terminal by command ./bin/zkServer.sh start.

Database

The DolphinScheduler's metadata is stored in relational database. Currently supported MySQL and Postgresql. We use MySQL as an example. Start the database and create a new database named dolphinscheduler as DolphinScheduler metabase

After creating the new database, run the sql file under dolphinscheduler/dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_mysql.sql directly in MySQL to complete the database initialization

Start Backend Server

Following steps will guide how to start the DolphinScheduler backend service

Backend Start Prepare

  • Open project: Use IDE open the project, here we use IntelliJ IDEA as an example, after opening it will take a while for IntelliJ IDEA to complete the dependent download

  • File change

    • 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
    • Modify database configuration, modify the database configuration in the dolphinscheduler-master/src/main/resources/application.yaml
    • Modify database configuration, modify the database configuration in the dolphinscheduler-api/src/main/resources/application.yaml
    • Modify database configuration, modify the database configuration in the dolphinscheduler-alert/dolphinscheduler-alert-server/src/main/resources/application.yaml

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

application.yaml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8
    username: dolphinscheduler
    password: dolphinscheduler
Server start

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

  • 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
  • WorkerServer：Execute function main in the class org.apache.dolphinscheduler.server.worker.WorkerServer by IntelliJ IDEA, with the configuration VM Options -DDOCKER=true
  • 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
  • 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

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

Start Frontend Server

Install frontend dependencies and run it

shell
cd dolphinscheduler-ui
pnpm install
pnpm run dev

The browser access address http://localhost:5173 can login DolphinScheduler UI. The default username and password are admin/dolphinscheduler123