11 KiB
What is Dolphin Scheduler?
Dolphin Scheduler is a distributed and easy-to-expand visual DAG workflow scheduling system, dedicated to solving the complex dependencies in data processing, making the scheduling system out of the box for data processing.
GitHub URL: https://github.com/apache/incubator-dolphinscheduler
Official Website: https://dolphinscheduler.apache.org
How to use this docker image
You can start a dolphinscheduler by docker-compose (recommended)
$ docker-compose -f ./docker/docker-swarm/docker-compose.yml up -d
The default postgres user root, postgres password root and database dolphinscheduler are created in the docker-compose.yml.
The default zookeeper is created in the docker-compose.yml.
Access the Web UI：http://192.168.xx.xx:12345/dolphinscheduler
The default username is admin and the default password is dolphinscheduler123
Or via Environment Variables DATABASE_HOST DATABASE_PORT DATABASE_DATABASE ZOOKEEPER_QUORUM
You can specify existing postgres and zookeeper service. Example:
$ docker run -d --name dolphinscheduler \
-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \
-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \
-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
-p 12345:12345 \
apache/dolphinscheduler:latest all
Access the Web UI：http://192.168.xx.xx:12345/dolphinscheduler
Or start a standalone dolphinscheduler server
You can start a standalone dolphinscheduler server.
- Create a local volume for resource storage, For example:
docker volume create dolphinscheduler-resource-local
- Start a master server, For example:
$ docker run -d --name dolphinscheduler-master \
-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \
-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \
-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
apache/dolphinscheduler:latest master-server
- Start a worker server, For example:
$ docker run -d --name dolphinscheduler-worker \
-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \
-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \
-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
-e ALERT_LISTEN_HOST="dolphinscheduler-alert" \
-v dolphinscheduler-resource-local:/dolphinscheduler \
apache/dolphinscheduler:latest worker-server
- Start a api server, For example:
$ docker run -d --name dolphinscheduler-api \
-e ZOOKEEPER_QUORUM="192.168.x.x:2181" \
-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \
-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
-v dolphinscheduler-resource-local:/dolphinscheduler \
-p 12345:12345 \
apache/dolphinscheduler:latest api-server
- Start a alert server, For example:
$ docker run -d --name dolphinscheduler-alert \
-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e DATABASE_DATABASE="dolphinscheduler" \
-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
apache/dolphinscheduler:latest alert-server
Note: You must be specify DATABASE_HOST DATABASE_PORT DATABASE_DATABASE DATABASE_USERNAME DATABASE_PASSWORD ZOOKEEPER_QUORUM when start a standalone dolphinscheduler server.
How to build a docker image
You can build a docker image in A Unix-like operating system, You can also build it in Windows operating system.
In Unix-Like, Example:
$ cd path/incubator-dolphinscheduler
$ sh ./docker/build/hooks/build
In Windows, Example:
C:\incubator-dolphinscheduler>.\docker\build\hooks\build.bat
Please read ./docker/build/hooks/build ./docker/build/hooks/build.bat script files if you don't understand
Environment Variables
The Dolphin Scheduler image uses several environment variables which are easy to miss. While none of the variables are required, they may significantly aid you in using the image.
DATABASE_TYPE
This environment variable sets the type for database. The default value is postgresql.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_DRIVER
This environment variable sets the type for database. The default value is org.postgresql.Driver.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_HOST
This environment variable sets the host for database. The default value is 127.0.0.1.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_PORT
This environment variable sets the port for database. The default value is 5432.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_USERNAME
This environment variable sets the username for database. The default value is root.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_PASSWORD
This environment variable sets the password for database. The default value is root.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_DATABASE
This environment variable sets the database for database. The default value is dolphinscheduler.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DATABASE_PARAMS
This environment variable sets the database for database. The default value is characterEncoding=utf8.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server, api-server, alert-server.
DOLPHINSCHEDULER_ENV_PATH
This environment variable sets the runtime environment for task. The default value is /opt/dolphinscheduler/conf/env/dolphinscheduler_env.sh.
DOLPHINSCHEDULER_DATA_BASEDIR_PATH
User data directory path, self configuration, please make sure the directory exists and have read write permissions. The default value is /tmp/dolphinscheduler
DOLPHINSCHEDULER_OPTS
This environment variable sets java options. The default value is empty.
RESOURCE_STORAGE_TYPE
This environment variable sets resource storage type for dolphinscheduler like HDFS, S3, NONE. The default value is HDFS.
RESOURCE_UPLOAD_PATH
This environment variable sets resource store path on HDFS/S3 for resource storage. The default value is /dolphinscheduler.
FS_DEFAULT_FS
This environment variable sets fs.defaultFS for resource storage like file:///, hdfs://mycluster:8020 or s3a://dolphinscheduler. The default value is file:///.
FS_S3A_ENDPOINT
This environment variable sets s3 endpoint for resource storage. The default value is s3.xxx.amazonaws.com.
FS_S3A_ACCESS_KEY
This environment variable sets s3 access key for resource storage. The default value is xxxxxxx.
FS_S3A_SECRET_KEY
This environment variable sets s3 secret key for resource storage. The default value is xxxxxxx.
ZOOKEEPER_QUORUM
This environment variable sets zookeeper quorum for master-server and worker-serverr. The default value is 127.0.0.1:2181.
Note: You must be specify it when start a standalone dolphinscheduler server. Like master-server, worker-server.
ZOOKEEPER_ROOT
This environment variable sets zookeeper root directory for dolphinscheduler. The default value is /dolphinscheduler.
MASTER_EXEC_THREADS
This environment variable sets exec thread num for master-server. The default value is 100.
MASTER_EXEC_TASK_NUM
This environment variable sets exec task num for master-server. The default value is 20.
MASTER_HEARTBEAT_INTERVAL
This environment variable sets heartbeat interval for master-server. The default value is 10.
MASTER_TASK_COMMIT_RETRYTIMES
This environment variable sets task commit retry times for master-server. The default value is 5.
MASTER_TASK_COMMIT_INTERVAL
This environment variable sets task commit interval for master-server. The default value is 1000.
MASTER_MAX_CPULOAD_AVG
This environment variable sets max cpu load avg for master-server. The default value is 100.
MASTER_RESERVED_MEMORY
This environment variable sets reserved memory for master-server. The default value is 0.1.
MASTER_LISTEN_PORT
This environment variable sets port for master-server. The default value is 5678.
WORKER_EXEC_THREADS
This environment variable sets exec thread num for worker-server. The default value is 100.
WORKER_HEARTBEAT_INTERVAL
This environment variable sets heartbeat interval for worker-server. The default value is 10.
WORKER_MAX_CPULOAD_AVG
This environment variable sets max cpu load avg for worker-server. The default value is 100.
WORKER_RESERVED_MEMORY
This environment variable sets reserved memory for worker-server. The default value is 0.1.
WORKER_LISTEN_PORT
This environment variable sets port for worker-server. The default value is 1234.
WORKER_GROUPS
This environment variable sets group for worker-server. The default value is default.
WORKER_WEIGHT
This environment variable sets weight for worker-server. The default value is 100.
ALERT_LISTEN_HOST
This environment variable sets the host of alert-server for worker-server. The default value is 127.0.0.1.
ALERT_PLUGIN_DIR
This environment variable sets the alert plugin directory for alert-server. The default value is lib/plugin/alert.
Initialization scripts
If you would like to do additional initialization in an image derived from this one, add one or more environment variable under /root/start-init-conf.sh, and modify template files in /opt/dolphinscheduler/conf/*.tpl.
For example, to add an environment variable API_SERVER_PORT in /root/start-init-conf.sh:
export API_SERVER_PORT=5555
and to modify /opt/dolphinscheduler/conf/application-api.properties.tpl template file, add server port:
server.port=${API_SERVER_PORT}
/root/start-init-conf.sh will dynamically generate config file:
echo "generate app config"
ls ${DOLPHINSCHEDULER_HOME}/conf/ | grep ".tpl" | while read line; do
eval "cat << EOF
$(cat ${DOLPHINSCHEDULER_HOME}/conf/${line})
EOF
" > ${DOLPHINSCHEDULER_HOME}/conf/${line%.*}
done