集群部署(Cluster)

1、基础软件安装(必装项请自行安装)

  • PostgreSQL (8.2.15+) or MySQL (5.7系列)：两者任选其一即可，如 MySQL 则需要 JDBC Driver 5.1.47+
  • JDK (1.8+)：必装，请安装好后在 /etc/profile 下配置 JAVA_HOME 及 PATH 变量
  • ZooKeeper (3.4.6+)：必装
  • pstree or psmisc：Mac OS必装pstree，Fedora/Red/Hat/CentOS/Ubuntu/Debian必装psmisc
  • Hadoop (2.6+) or MinIO：选装，如果需要用到资源上传功能，可以选择上传到 Hadoop or MinIO 上
  1.  注意：DolphinScheduler本身不依赖 Hadoop、Hive、Spark，仅是会调用他们的 Client，用于提交对应的任务

2、下载二进制tar.gz包

  • 请下载最新版本的后端安装包至服务器部署目录，比如创建 /opt/dolphinscheduler 做为安装部署目录，下载地址： 下载，下载后上传 tar 包到该目录中，并进行解压
  1. # 创建部署目录，部署目录请不要创建在 /root、/home 等高权限目录 
  2. mkdir -p /opt/dolphinscheduler
  3. cd /opt/dolphinscheduler
  5. # 解压缩
  6. tar -zxvf apache-dolphinscheduler-1.3.9-bin.tar.gz -C /opt/dolphinscheduler
  8. mv apache-dolphinscheduler-1.3.9-bin  dolphinscheduler-bin

3、创建部署用户和hosts映射

  • 在所有部署调度的机器上创建部署用户，并且一定要配置 sudo 免密。假如我们计划在 ds1,ds2,ds3,ds4 这 4 台机器上部署调度，首先需要在每台机器上都创建部署用户
  1. # 创建用户需使用root登录，设置部署用户名，请自行修改，后面以 dolphinscheduler 为例
  2. useradd dolphinscheduler
  4. # 设置用户密码，请自行修改，后面以 dolphinscheduler123 为例
  5. echo "dolphinscheduler123" | passwd --stdin dolphinscheduler
  7. # 配置 sudo 免密
  8. echo 'dolphinscheduler  ALL=(ALL)  NOPASSWD: NOPASSWD: ALL' >> /etc/sudoers
  9. sed -i 's/Defaults    requirett/#Defaults    requirett/g' /etc/sudoers

注意：

  • 因为是以 sudo -u {linux-user} 切换不同 linux 用户的方式来实现多租户运行作业，所以部署用户需要有 sudo 权限，而且是免密的
  • 如果发现 /etc/sudoers 文件中有 “Default requiretty” 这行，也请注释掉
  • 如果用到资源上传的话，还需要在 HDFS或者MinIO 上给该部署用户分配读写的权限

4、配置hosts映射和ssh打通及修改目录权限

  • 以第一台机器( hostname 为 ds1 )作为部署机，在 ds1 上配置所有待部署机器的 hosts，在 ds1 以 root 登录
  1. vi /etc/hosts
  3. # add ip hostname
  4. 192.168.xxx.xxx ds1
  5. 192.168.xxx.xxx ds2
  6. 192.168.xxx.xxx ds3
  7. 192.168.xxx.xxx ds4

注意：请删掉或者注释掉 127.0.0.1 这行

  • 同步 ds1 上的 /etc/hosts 到所有部署机器
  1. for ip in ds2 ds3;     # 请将此处 ds2 ds3 替换为自己要部署的机器的 hostname
  2. do
  3.   sudo scp -r /etc/hosts  $ip:/etc/          # 在运行中需要输入 root 密码
  4. done

备注：当然 通过 sshpass -p xxx sudo scp -r /etc/hosts $ip:/etc/ 就可以省去输入密码了

centos 下 sshpass的安装：

  1. 先安装 epel

    yum install -y epel-release

    yum repolist

  2. 安装完成 epel 之后，就可以按照 sshpass 了

    yum install -y sshpass

  • 在 ds1 上，切换到部署用户并配置 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

​ 注意：正常设置后，dolphinscheduler 用户在执行命令 ssh localhost 是不需要再输入密码

  • 在 ds1 上，配置部署用户 dolphinscheduler ssh 打通到其他待部署的机器
  1. su dolphinscheduler;
  2. for ip in ds2 ds3;     # 请将此处 ds2 ds3 替换为自己要部署的机器的 hostname
  3. do
  4.   ssh-copy-id  $ip   # 该操作执行过程中需要手动输入 dolphinscheduler 用户的密码
  5. done
  7. # 当然 通过 sshpass -p xxx ssh-copy-id $ip 就可以省去输入密码了
  • 在 ds1 上，修改目录权限，使得部署用户对 dolphinscheduler-bin 目录有操作权限
  1. sudo chown -R dolphinscheduler:dolphinscheduler dolphinscheduler-bin

5、数据库初始化

  • 进入数据库，默认数据库是 PostgreSQL，如选择 MySQL 的话，后续需要添加 mysql-connector-java 驱动包到 DolphinScheduler 的 lib 目录下，这里以 MySQL 为例
  1. mysql -h192.168.xx.xx -P3306 -uroot -p
  • 进入数据库命令行窗口后，执行数据库初始化命令，设置访问账号和密码。注: {user} 和 {password} 需要替换为具体的数据库用户名和密码
  1.    mysql> CREATE DATABASE dolphinscheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
  2.    mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';
  3.    mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';
  4.    mysql> flush privileges;

  • 创建表和导入基础数据

    • 修改 conf 目录下 datasource.properties 中的下列配置
    1.   vi conf/datasource.properties
    • 如果选择 MySQL，请注释掉 PostgreSQL 相关配置(反之同理)，还需要手动添加 [mysql-connector-java 驱动 jar] 包到 lib 目录下，这里下载的是 mysql-connector-java-5.1.47.jar，然后正确配置数据库连接相关信息
    1.   # postgre
    2.   # spring.datasource.driver-class-name=org.postgresql.Driver
    3.   # spring.datasource.url=jdbc:postgresql://localhost:5432/dolphinscheduler
    4.   # mysql
    5.   spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    6.   spring.datasource.url=jdbc:mysql://xxx:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true     需要修改ip
    7.   spring.datasource.username=xxx                        需要修改为上面的{user}值
    8.   spring.datasource.password=xxx                        需要修改为上面的{password}值
    • 修改并保存完后，执行 script 目录下的创建表及导入基础数据脚本
    1. sh script/create-dolphinscheduler.sh

    注意: 如果执行上述脚本报 “/bin/java: No such file or directory” 错误，请在/etc/profile 下配置 JAVA_HOME 及 PATH 变量

6、修改运行参数

  • 修改 conf/env 目录下的 dolphinscheduler_env.sh 环境变量(以相关用到的软件都安装在 /opt/soft 下为例)
  1.     export HADOOP_HOME=/opt/soft/hadoop
  2.     export HADOOP_CONF_DIR=/opt/soft/hadoop/etc/hadoop
  3.     # export SPARK_HOME1=/opt/soft/spark1
  4.     export SPARK_HOME2=/opt/soft/spark2
  5.     export PYTHON_HOME=/opt/soft/python
  6.     export JAVA_HOME=/opt/soft/java
  7.     export HIVE_HOME=/opt/soft/hive
  8.     export FLINK_HOME=/opt/soft/flink
  9.     export DATAX_HOME=/opt/soft/datax/bin/datax.py
  10.     export PATH=$HADOOP_HOME/bin:$SPARK_HOME2/bin:$PYTHON_HOME:$JAVA_HOME/bin:$HIVE_HOME/bin:$FLINK_HOME/bin:$DATAX_HOME:$PATH

注: 这一步非常重要，例如 JAVA_HOME 和 PATH 是必须要配置的，没有用到的可以忽略或者注释掉

  • 将 JDK 软链到 /usr/bin/java 下(仍以 JAVA_HOME=/opt/soft/java 为例)
  1. sudo ln -s /opt/soft/java/bin/java /usr/bin/java
  • 修改一键部署配置文件 conf/config/install_config.conf 中的各参数，特别注意以下参数的配置
  1. # 这里填 mysql or postgresql
  2. dbtype="mysql"
  4. # 数据库连接地址
  5. dbhost="192.168.xx.xx:3306"
  7. # 数据库名
  8. dbname="dolphinscheduler"
  10. # 数据库用户名，此处需要修改为上面设置的 {user} 具体值
  11. username="xxx"
  13. # 数据库密码，如果有特殊字符，请使用 \ 转义，需要修改为上面设置的 {password} 具体值
  14. password="xxx"
  16. # Zookeeper 地址
  17. zkQuorum="192.168.xx.xx:2181,192.168.xx.xx:2181,192.168.xx.xx:2181"
  19. # 将 DS 安装到哪个目录，如: /opt/soft/dolphinscheduler，不同于现在的目录
  20. installPath="/opt/soft/dolphinscheduler"
  22. # 使用哪个用户部署，使用第 3 节创建的用户
  23. deployUser="dolphinscheduler"
  25. # 邮件配置，以 qq 邮箱为例
  26. # 邮件协议
  27. mailProtocol="SMTP"
  29. # 邮件服务地址
  30. mailServerHost="smtp.qq.com"
  32. # 邮件服务端口
  33. mailServerPort="25"
  35. # mailSender和 mailUser 配置成一样即可
  37. # 发送者
  38. mailSender="xxx@qq.com"
  40. # 发送用户
  41. mailUser="xxx@qq.com"
  43. # 邮箱密码
  44. mailPassword="xxx"
  46. # TLS 协议的邮箱设置为 true，否则设置为 false
  47. starttlsEnable="true"
  49. # 开启 SSL 协议的邮箱配置为 true，否则为 false。注意: starttlsEnable 和 sslEnable 不能同时为 true
  50. sslEnable="false"
  52. # 邮件服务地址值，参考上面 mailServerHost
  53. sslTrust="smtp.qq.com"
  55. # 业务用到的比如 sql 等资源文件上传到哪里，可以设置：HDFS,S3,NONE，单机如果想使用本地文件系统，请配置为 HDFS，因为 HDFS 支持本地文件系统；如果不需要资源上传功能请选择 NONE。强调一点：使用本地文件系统不需要部署 hadoop
  56. resourceStorageType="HDFS"
  58. # 如果上传资源保存想保存在 hadoop 上，hadoop 集群的 NameNode 启用了 HA 的话，需要将 hadoop 的配置文件 core-site.xml 和 hdfs-site.xml 放到安装路径的 conf 目录下，本例即是放到 /opt/soft/dolphinscheduler/conf 下面，并配置 namenode cluster 名称；如果 NameNode 不是 HA，则只需要将 mycluster 修改为具体的 ip 或者主机名即可
  59. defaultFS="hdfs://mycluster:8020"
  62. # 如果没有使用到 Yarn，保持以下默认值即可;如果 ResourceManager 是 HA，则配置为 ResourceManager 节点的主备 ip 或者 hostname，比如 "192.168.xx.xx,192.168.xx.xx";如果是单 ResourceManager 请配置 yarnHaIps="" 即可
  63. yarnHaIps="192.168.xx.xx,192.168.xx.xx"
  65. # 如果 ResourceManager 是 HA 或者没有使用到 Yarn 保持默认值即可；如果是单 ResourceManager，请配置真实的 ResourceManager 主机名或者 ip
  66. singleYarnIp="yarnIp1"
  68. # 资源上传根路径，主持 HDFS 和 S3，由于 hdfs支持本地文件系统，需要确保本地文件夹存在且有读写权限
  69. resourceUploadPath="/data/dolphinscheduler"
  71. # 具备权限创建 resourceUploadPath的用户
  72. hdfsRootUser="hdfs"
  75. # 在哪些机器上部署 DS 服务，本机选 localhost
  76. ips="ds1,ds2,ds3,ds4"
  78. # ssh 端口，默认22
  79. sshPort="22"
  81. # master 服务部署在哪台机器上
  82. masters="ds1,ds2"
  84. # worker 服务部署在哪台机器上，并指定此 worker 属于哪一个 worker 组，下面示例的 default 即为组名
  85. workers="ds3:default,ds4:default"
  87. # 报警服务部署在哪台机器上
  88. alertServer="ds2"
  90. # 后端 api 服务部署在在哪台机器上
  91. apiServers="ds1"

特别注意：如果需要用资源上传到 Hadoop 集群功能， 并且 Hadoop 集群的 NameNode 配置了 HA 的话 ，需要开启 HDFS 类型的资源上传，同时需要将 Hadoop 集群下的 core-site.xml 和 hdfs-site.xml 复制到 /opt/dolphinscheduler/conf，非 NameNode HA 跳过次步骤

7、一键部署

  • 切换到部署用户 dolphinscheduler，然后执行一键部署脚本
  1. sh install.sh

注意：第一次部署的话，在运行中第 3 步 3,stop server 出现 5 次以下信息，此信息可以忽略

  1. sh: bin/dolphinscheduler-daemon.sh: No such file or directory
  • 脚本完成后，会启动以下 5 个服务，使用 jps 命令查看服务是否启动( jps 为 JDK 自带)
  1.     MasterServer         ----- master服务
  2.     WorkerServer         ----- worker服务
  3.     LoggerServer         ----- logger服务
  4.     ApiApplicationServer ----- api服务
  5.     AlertServer          ----- alert服务

如果以上服务都正常启动，说明自动部署成功

部署成功后，可以进行日志查看，日志统一存放于 logs 文件夹内

  1.  logs/
  2.     ├── dolphinscheduler-alert-server.log
  3.     ├── dolphinscheduler-master-server.log
  4.     |—— dolphinscheduler-worker-server.log
  5.     |—— dolphinscheduler-api-server.log
  6.     |—— dolphinscheduler-logger-server.log

8、登录系统

9、启停服务

  • 一键停止集群所有服务
  1. sh ./bin/stop-all.sh
  • 一键开启集群所有服务
  1. sh ./bin/start-all.sh
  • 启停 Master
  1. sh ./bin/dolphinscheduler-daemon.sh start master-server
  2. sh ./bin/dolphinscheduler-daemon.sh stop master-server
  • 启停 Worker
  1. sh ./bin/dolphinscheduler-daemon.sh start worker-server
  2. sh ./bin/dolphinscheduler-daemon.sh stop worker-server
  • 启停 Api
  1. sh ./bin/dolphinscheduler-daemon.sh start api-server
  2. sh ./bin/dolphinscheduler-daemon.sh stop api-server
  • 启停 Logger
  1. sh ./bin/dolphinscheduler-daemon.sh start logger-server
  2. sh ./bin/dolphinscheduler-daemon.sh stop logger-server
  • 启停 Alert
  1. sh ./bin/dolphinscheduler-daemon.sh start alert-server
  2. sh ./bin/dolphinscheduler-daemon.sh stop alert-server

注：服务用途请具体参见《系统架构设计》小节

附录

  • 如果您需要使用到企业微信进行告警，请在安装完成后，修改 alert.properties 文件，然后重启 alert 服务即可
  1. # 设置企业微信告警功能是否开启：开启为 true，否则为 false
  2. enterprise.wechat.enable="true"
  1. # 设置 corpid，每个企业都拥有唯一的 corpid，获取此信息可在管理后台 “我的企业” － “企业信息” 下查看 “企业 ID”（需要有管理员权限）
  2. enterprise.wechat.corp.id="xxx"

集群部署(Cluster) - 图2

  1. # 设置 secret，secret 是企业应用里面用于保障数据安全的 “钥匙”，每一个应用都有一个独立的访问密钥
  2. enterprise.wechat.secret="xxx"

集群部署(Cluster) - 图3

  1. # 设置 agentid，每个应用都有唯一的 agentid。在管理后台 -> “应用与小程序” -> “应用”，点进某个应用，即可看到 agentid
  2. enterprise.wechat.agent.id="xxxx"

集群部署(Cluster) - 图4

  1. # 设置 userid，多个用逗号分隔。每个成员都有唯一的 userid，即所谓 “帐号”。在管理后台 -> “通讯录” -> 点进某个成员的详情页，可以看到
  2. enterprise.wechat.users=zhangsan,lisi

集群部署(Cluster) - 图5

  1. # 获取 access_token 的地址，使用如下例子无需修改
  2. enterprise.wechat.token.url=https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid={corpId}&corpsecret={secret}
  4. # 发送应用消息地址，使用如下例子无需改动
  5. enterprise.wechat.push.url=https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token={token}
  7. # 发送消息格式，无需改动
  8. enterprise.wechat.user.send.msg={\"touser\":\"{toUser}\",\"agentid\":\"{agentId}\",\"msgtype\":\"markdown\",\"markdown\":{\"content\":\"{msg}\"}}
  • 关于 dolphinscheduler 在运行过程中，ip 地址获取错误的问题：

master 服务、worker 服务在 zookeeper 注册时，会以 ip:port 的形式创建相关信息

如果 ip 地址获取错误，请检查网络信息，如 Linux 系统通过 ifconfig 命令查看网络信息，以下图为例：

集群部署(Cluster) - 图6

可以使用 dolphinscheduler 提供的三种策略，获取可用 ip：

  1. default: 优先获取内网网卡获取 ip 地址，其次获取外网网卡获取 ip 地址，在前两项失效情况下，使用第一块可用网卡的地址
  2. inner: 使用内网网卡获取 ip地址，如果获取失败抛出异常信息
  3. outer: 使用外网网卡获取 ip地址，如果获取失败抛出异常信息

配置方式是在 common.properties 中修改相关配置：

  1.  # network IP gets priority, default: inner outer
  2.  # dolphin.scheduler.network.priority.strategy=default

以上配置修改后重启服务生效

如果 ip 地址获取依然错误，请下载 dolphinscheduler-netutils.jar 到相应机器，执行以下命令以进一步排障，并反馈给社区开发人员：

  1. java -jar target/dolphinscheduler-netutils.jar
  • 配置 sudo 免密，用于解决默认配置 sudo 权限过大或不能申请 root 权限的使用问题

配置 dolphinscheduler OS 账号的 sudo 权限为部分普通用户范围内的一个普通用户管理者，限制指定用户在指定主机上运行某些命令，详细配置请看 sudo 权限管理 例如 sudo 权限管理配置 dolphinscheduler OS 账号只能操作用户 userA,userB,userC 的权限（其中用户 userA,userB,userC 用于多租户向大数据集群提交作业）

  1. echo 'dolphinscheduler  ALL=(userA,userB,userC)  NOPASSWD: NOPASSWD: ALL' >> /etc/sudoers
  2. sed -i 's/Defaults    requirett/#Defaults    requirett/g' /etc/sudoers