伪集群部署

伪集群部署目的是在单台机器部署 DolphinScheduler 服务，该模式下master、worker、api server 都在同一台机器上

如果你是新手，想要体验 DolphinScheduler 的功能，推荐使用Standalone方式体检。如果你想体验更完整的功能，或者更大的任务量，推荐使用伪集群部署。如果你是在生产中使用，推荐使用集群部署或者kubernetes

前置准备工作

伪分布式部署 DolphinScheduler 需要有外部软件的支持

  • JDK：下载JDK (1.8+)，并将 JAVA_HOME 配置到以及 PATH 变量中。如果你的环境中已存在，可以跳过这步。
  • 二进制包：在下载页面下载 DolphinScheduler 二进制包
  • 数据库：PostgreSQL (8.2.15+) 或者 MySQL (5.7+)，两者任选其一即可，如 MySQL 则需要 JDBC Driver 8.0.16
  • 注册中心：ZooKeeper (3.4.6+)，下载地址
  • 进程树分析
    • macOS安装pstree
    • Fedora/Red/Hat/CentOS/Ubuntu/Debian安装psmisc

注意: DolphinScheduler 本身不依赖 Hadoop、Hive、Spark，但如果你运行的任务需要依赖他们，就需要有对应的环境支持

准备 DolphinScheduler 启动环境

配置用户免密及权限

创建部署用户，并且一定要配置 sudo 免密。以创建 dolphinscheduler 用户为例

  1. # 创建用户需使用 root 登录
  2. useradd dolphinscheduler
  4. # 添加密码
  5. echo "dolphinscheduler" | passwd --stdin dolphinscheduler
  7. # 配置 sudo 免密
  8. sed -i '$adolphinscheduler  ALL=(ALL)  NOPASSWD: NOPASSWD: ALL' /etc/sudoers
  9. sed -i 's/Defaults    requirett/#Defaults    requirett/g' /etc/sudoers
  11. # 修改目录权限，使得部署用户对二进制包解压后的 apache-dolphinscheduler-*-bin 目录有操作权限
  12. chown -R dolphinscheduler:dolphinscheduler apache-dolphinscheduler-*-bin

注意:

  • 因为任务执行服务是以 sudo -u {linux-user} 切换不同 linux 用户的方式来实现多租户运行作业，所以部署用户需要有 sudo 权限，而且是免密的。初学习者不理解的话，完全可以暂时忽略这一点
  • 如果发现 /etc/sudoers 文件中有 “Defaults requirett” 这行，也请注释掉

配置机器SSH免密登陆

由于安装的时候需要向不同机器发送资源，所以要求各台机器间能实现SSH免密登陆。配置免密登陆的步骤如下

  1. su dolphinscheduler
  3. ssh-keygen -t rsa -P '' -f ~/.ssh/id_rsa
  4. cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
  5. chmod 600 ~/.ssh/authorized_keys

注意: 配置完成后，可以通过运行命令 ssh localhost 判断是否成功，如果不需要输入密码就能ssh登陆则证明成功

启动zookeeper

进入 zookeeper 的安装目录，将 zoo_sample.cfg 配置文件复制到 conf/zoo.cfg，并将 conf/zoo.cfg 中 dataDir 中的值改成 dataDir=./tmp/zookeeper

  1. # 启动 zookeeper
  2. ./bin/zkServer.sh start

修改相关配置

完成基础环境的准备后，需要根据你的机器环境修改配置文件。配置文件可以在目录 bin/env 中找到，他们分别是 并命名为 install_env.sh 和 dolphinscheduler_env.sh。

修改 install_env.sh 文件

文件 install_env.sh 描述了哪些机器将被安装 DolphinScheduler 以及每台机器对应安装哪些服务。您可以在路径 bin/env/install_env.sh 中找到此文件，配置详情如下。

  1. # ---------------------------------------------------------
  2. # INSTALL MACHINE
  3. # ---------------------------------------------------------
  4. # Due to the master, worker, and API server being deployed on a single node, the IP of the server is the machine IP or localhost
  5. ips="localhost"
  6. masters="localhost"
  7. workers="localhost:default"
  8. alertServer="localhost"
  9. apiServers="localhost"
  11. # DolphinScheduler installation path, it will auto-create if not exists
  12. installPath="~/dolphinscheduler"
  14. # Deploy user, use the user you create in section **Configure machine SSH password-free login**
  15. deployUser="dolphinscheduler"

修改 dolphinscheduler_env.sh 文件

文件 ./bin/env/dolphinscheduler_env.sh 描述了下列配置：

  • DolphinScheduler 的数据库配置，详细配置方法见初始化数据库
  • 一些任务类型外部依赖路径或库文件，如 JAVA_HOME 和 SPARK_HOME都是在这里定义的
  • 注册中心zookeeper
  • 服务端相关配置，比如缓存，时区设置等

如果您不使用某些任务类型，您可以忽略任务外部依赖项，但您必须根据您的环境更改 JAVA_HOME、注册中心和数据库相关配置。

  1. # JAVA_HOME, will use it to start DolphinScheduler server
  2. export JAVA_HOME=${JAVA_HOME:-/opt/soft/java}
  4. # Database related configuration, set database type, username and password
  5. export DATABASE=${DATABASE:-postgresql}
  6. export SPRING_PROFILES_ACTIVE=${DATABASE}
  7. export SPRING_DATASOURCE_DRIVER_CLASS_NAME=org.postgresql.Driver
  8. export SPRING_DATASOURCE_URL="jdbc:postgresql://127.0.0.1:5432/dolphinscheduler"
  9. export SPRING_DATASOURCE_USERNAME={user}
  10. export SPRING_DATASOURCE_PASSWORD={password}
  12. # DolphinScheduler server related configuration
  13. export SPRING_CACHE_TYPE=${SPRING_CACHE_TYPE:-none}
  14. export SPRING_JACKSON_TIME_ZONE=${SPRING_JACKSON_TIME_ZONE:-UTC}
  15. export MASTER_FETCH_COMMAND_NUM=${MASTER_FETCH_COMMAND_NUM:-10}
  17. # Registry center configuration, determines the type and link of the registry center
  18. export REGISTRY_TYPE=${REGISTRY_TYPE:-zookeeper}
  19. export REGISTRY_ZOOKEEPER_CONNECT_STRING=${REGISTRY_ZOOKEEPER_CONNECT_STRING:-localhost:2181}
  21. # Tasks related configurations, need to change the configuration if you use the related tasks.
  22. export HADOOP_HOME=${HADOOP_HOME:-/opt/soft/hadoop}
  23. export HADOOP_CONF_DIR=${HADOOP_CONF_DIR:-/opt/soft/hadoop/etc/hadoop}
  24. export SPARK_HOME1=${SPARK_HOME1:-/opt/soft/spark1}
  25. export SPARK_HOME2=${SPARK_HOME2:-/opt/soft/spark2}
  26. export PYTHON_HOME=${PYTHON_HOME:-/opt/soft/python}
  27. export HIVE_HOME=${HIVE_HOME:-/opt/soft/hive}
  28. export FLINK_HOME=${FLINK_HOME:-/opt/soft/flink}
  29. export DATAX_HOME=${DATAX_HOME:-/opt/soft/datax}
  31. export PATH=$HADOOP_HOME/bin:$SPARK_HOME1/bin:$SPARK_HOME2/bin:$PYTHON_HOME/bin:$JAVA_HOME/bin:$HIVE_HOME/bin:$FLINK_HOME/bin:$DATAX_HOME/bin:$PATH

初始化数据库

DolphinScheduler 元数据存储在关系型数据库中，目前支持 PostgreSQL 和 MySQL，如果使用 MySQL 则需要手动下载 mysql-connector-java 驱动 (8.0.16) 并移动到 DolphinScheduler 的 lib目录下（tools/libs/）。下面以 MySQL 为例，说明如何初始化数据库

对于mysql 5.6 / 5.7：

  1. mysql -uroot -p
  3. mysql> CREATE DATABASE dolphinscheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
  5. # 修改 {user} 和 {password} 为你希望的用户名和密码
  6. mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';
  7. mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';
  9. mysql> flush privileges;

对于mysql 8：

  1. mysql -uroot -p
  3. mysql> CREATE DATABASE dolphinscheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
  5. # 修改 {user} 和 {password} 为你希望的用户名和密码
  6. mysql> CREATE USER '{user}'@'%' IDENTIFIED BY '{password}';
  7. mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'%';
  8. mysql> CREATE USER '{user}'@'localhost' IDENTIFIED BY '{password}';
  9. mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'localhost';
  10. mysql> FLUSH PRIVILEGES;

然后修改./bin/env/dolphinscheduler_env.sh，将username和password改成你在上一步中设置的用户名{user}和密码{password}

  1. export DATABASE=${DATABASE:-mysql}
  2. export SPRING_PROFILES_ACTIVE=${DATABASE}
  3. export SPRING_DATASOURCE_DRIVER_CLASS_NAME=com.mysql.cj.jdbc.Driver
  4. export SPRING_DATASOURCE_URL="jdbc:mysql://127.0.0.1:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8&useSSL=false"
  5. export SPRING_DATASOURCE_USERNAME={user}
  6. export SPRING_DATASOURCE_PASSWORD={password}

完成上述步骤后，您已经为 DolphinScheduler 创建一个新数据库，现在你可以通过快速的 Shell 脚本来初始化数据库

  1. sh tools/bin/upgrade-schema.sh

启动 DolphinScheduler

使用上面创建的部署用户运行以下命令完成部署，部署后的运行日志将存放在 logs 文件夹内

  1. sh ./bin/install.sh

注意: 第一次部署的话，可能出现 5 次sh: bin/dolphinscheduler-daemon.sh: No such file or directory相关信息，次为非重要信息直接忽略即可

登录 DolphinScheduler

浏览器访问地址 http://localhost:12345/dolphinscheduler 即可登录系统UI。默认的用户名和密码是 admin/dolphinscheduler123

启停服务

  1. # 一键停止集群所有服务
  2. sh ./bin/stop-all.sh
  4. # 一键开启集群所有服务
  5. sh ./bin/start-all.sh
  7. # 启停 Master
  8. sh ./bin/dolphinscheduler-daemon.sh stop master-server
  9. sh ./bin/dolphinscheduler-daemon.sh start master-server
  11. # 启停 Worker
  12. sh ./bin/dolphinscheduler-daemon.sh start worker-server
  13. sh ./bin/dolphinscheduler-daemon.sh stop worker-server
  15. # 启停 Api
  16. sh ./bin/dolphinscheduler-daemon.sh start api-server
  17. sh ./bin/dolphinscheduler-daemon.sh stop api-server
  19. # 启停 Alert
  20. sh ./bin/dolphinscheduler-daemon.sh start alert-server
  21. sh ./bin/dolphinscheduler-daemon.sh stop alert-server

注意1:: 每个服务在路径 <server-name>/conf/dolphinscheduler_env.sh 中都有 dolphinscheduler_env.sh 文件，这是可以为微 服务需求提供便利。意味着您可以基于不同的环境变量来启动各个服务，只需要在对应服务中配置 bin/env/dolphinscheduler_env.sh 然后通过 <server-name>/bin/start.sh 命令启动即可。但是如果您使用命令 /bin/dolphinscheduler-daemon.sh start <server-name> 启动服务器，它将会用文件 bin/env/dolphinscheduler_env.sh 覆盖 <server-name>/conf/dolphinscheduler_env.sh 然后启动服务，目的是为了减少用户修改配置的成本.

注意2:：服务用途请具体参见《系统架构设计》小节。Python gateway service 默认与 api-server 一起启动，如果您不想启动 Python gateway service 请通过更改 api-server 配置文件 api-server/conf/application.yaml 中的 python-gateway.enabled : false 来禁用它。