单机部署(Standalone)

DolphinScheduler单机部署分为后端部署和前端部署两部分：

1、后端部署

1.1 : 基础软件安装(必装项请自行安装)

  • PostgreSQL (8.2.15+) or MySQL (5.6或者5.7系列) : 两者任选其一即可
  • JDK (1.8+) : 必装，请安装好后在/etc/profile下配置 JAVA_HOME 及 PATH 变量
  • ZooKeeper (3.4.6+) ：必装
  • Hadoop (2.6+) or MinIO ：选装， 如果需要用到资源上传功能，针对单机可以选择本地文件目录作为上传文件夹(此操作不需要部署Hadoop)；当然也可以选择上传到Hadoop or MinIO集群上
  1.  注意：DolphinScheduler本身不依赖Hadoop、Hive、Spark,仅是会调用他们的Client，用于对应任务的运行。

1.2 : 下载后端tar.gz包

  • 请下载最新版本的后端安装包至服务器部署目录,比如创建 /opt/dolphinscheduler 做为安装部署目录，下载地址： 下载 (以1.2.0版本为例)，下载后上传tar包到该目录中，并进行解压
  1. # 创建部署目录
  2. mkdir -p /opt/dolphinscheduler;
  3. cd /opt/dolphinscheduler;
  4. # 解压缩
  5. tar -zxvf apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-backend-bin.tar.gz -C /opt/dolphinscheduler;
  7. mv apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-backend-bin  dolphinscheduler-backend

1.3：创建部署用户并赋予目录操作权限

  • 创建部署用户，并且一定要配置sudo免密。以创建dolphinscheduler用户为例
  1. # add user dolphinscheduler
  2. useradd dolphinscheduler;
  4. # modify user password
  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. # 修改目录权限，使得部署用户对dolphinscheduler-backend目录有操作权限  
  12. chown -R dolphinscheduler:dolphinscheduler dolphinscheduler-backend

注意：

  • 因为任务执行服务是以 sudo -u {linux-user} 切换不同linux用户的方式来实现多租户运行作业，所以部署用户需要有 sudo 权限，而且是免密的。初学习者不理解的话，完全可以暂时忽略这一点
  • 如果发现/etc/sudoers文件中有”Default requiretty”这行，也请注释掉
  • 如果用到资源上传的话，还需要给该部署用户分配操作本地文件系统或者HDFS或者MinIO的权限

1.4 : 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

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

1.5 : 数据库初始化

  • 进入数据库，默认数据库是PostgreSQL，如选择MySQL的话，后续需要添加mysql-connector-java驱动包到DolphinScheduler的lib目录下
  1. mysql -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 目录下 application-dao.properties 中的下列配置

        1. vi conf/application-dao.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     需要修改ip，本机localhost即可
    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 变量

1.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 PATH=$HADOOP_HOME/bin:$SPARK_HOME2/bin:$PYTHON_HOME:$JAVA_HOME/bin:$HIVE_HOME/bin:$PATH:$FLINK_HOME/bin:$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

  • 修改一键部署脚本 install.sh中的各参数，特别注意以下参数的配置

  1.     # 这里填 mysql or postgresql
  2.     dbtype="mysql"
  4.     # 数据库连接地址
  5.     dbhost="localhost:3306"
  7.     # 数据库名
  8.     dbname="dolphinscheduler"
  10.     # 数据库用户名，此处需要修改为上面设置的{user}具体值
  11.     username="xxx"    
  13.     # 数据库密码, 如果有特殊字符，请使用\转义，需要修改为上面设置的{passowrd}具体值
  14.     passowrd="xxx"
  16.     #将DS安装到哪个目录，如: /opt/soft/dolphinscheduler，不同于现在的目录
  17.     installPath="/opt/soft/dolphinscheduler"
  19.     #使用哪个用户部署，使用1.3小节创建的用户
  20.     deployUser="dolphinscheduler"
  22.     #Zookeeper地址，单机本机是localhost:2181，记得把2181端口带上
  23.     zkQuorum="localhost:2181"
  25.     #在哪些机器上部署DS服务，本机选localhost
  26.     ips="localhost"
  28.     #master服务部署在哪台机器上
  29.     masters="localhost"
  31.     #worker服务部署在哪台机器上
  32.     workers="localhost"
  34.     #报警服务部署在哪台机器上
  35.     alertServer="localhost"
  37.     #后端api服务部署在在哪台机器上
  38.     apiServers="localhost"
  41.     # 邮件配置，以qq邮箱为例
  42.     # 邮件协议
  43.     mailProtocol="SMTP"
  45.     # 邮件服务地址
  46.     mailServerHost="smtp.exmail.qq.com"
  48.     # 邮件服务端口
  49.     mailServerPort="25"
  51.     # mailSender和mailUser配置成一样即可
  52.     # 发送者
  53.     mailSender="xxx@qq.com"
  55.     # 发送用户
  56.     mailUser="xxx@qq.com"
  58.     # 邮箱密码
  59.     mailPassword="xxx"
  61.     # TLS协议的邮箱设置为true，否则设置为false
  62.     starttlsEnable="true"
  64.     # 邮件服务地址值，参考上面 mailServerHost
  65.     sslTrust="smtp.exmail.qq.com"
  67.     # 开启SSL协议的邮箱配置为true，否则为false。注意: starttlsEnable和sslEnable不能同时为true
  68.     sslEnable="false"
  70.     # excel下载路径
  71.     xlsFilePath="/tmp/xls"
  73.     # 业务用到的比如sql等资源文件上传到哪里，可以设置：HDFS,S3,NONE，单机如果想使用本地文件系统，请配置为HDFS，因为HDFS支持本地文件系统；如果不需要资源上传功能请选择NONE。强调一点：使用本地文件系统不需要部署hadoop 
  74.     resUploadStartupType="HDFS"
  76.     # 这里以保存到本地文件系统为例
  77.     #注：但是如果你想上传到HDFS的话，NameNode启用了HA，则需要将core-site.xml和hdfs-site.xml放到conf目录下，本例即是放到/opt/dolphinscheduler/conf下面，并配置namenode cluster名称；如果NameNode不是HA,则修改为具体的ip或者主机名即可 
  78.     defaultFS="file:///data/dolphinscheduler"    #hdfs://{具体的ip/主机名}:8020
  81.     # 如果ResourceManager是HA，则配置为ResourceManager节点的主备ip或者hostname,比如"192.168.xx.xx,192.168.xx.xx"，否则如果是单ResourceManager或者根本没用到yarn,请配置yarnHaIps=""即可，我这里没用到yarn，配置为""
  82.     yarnHaIps=""
  84.     # 如果是单ResourceManager，则配置为ResourceManager节点ip或主机名，否则保持默认值即可。我这里没用到yarn，保持默认
  85.     singleYarnIp="ark1"
  87.     # 由于hdfs支持本地文件系统，需要确保本地文件夹存在且有读写权限
  88.     hdfsPath="/data/dolphinscheduler"

注：如果打算用到资源中心功能，请执行以下命令：

  1.     sudo mkdir /data/dolphinscheduler
  2.     sudo chown -R dolphinscheduler:dolphinscheduler /data/dolphinscheduler

1.7 : 安装python的Zookeeper工具kazoo

  • 安装python的 Zookeeper 工具 ，此步骤仅在一键部署时候用到
  1. #安装pip
  2. sudo yum -y install python-pip;  #ubuntu请使用 sudo apt-get install python-pip
  3. sudo pip install kazoo;

注意：如果yum没找到python-pip，也可以通过下面方式安装

  1. sudo curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
  2. sudo python get-pip.py  # 如果是python3，使用sudo python3 get-pip.py 
  3. #然后
  4. sudo pip install kazoo;

  • 切换到部署用户，执行一键部署脚本

    sh install.sh

    1. 注意：
    2. 第一次部署的话，在运行中第3步`3,stop server`出现5次以下信息，此信息可以忽略
    3. sh: bin/dolphinscheduler-daemon.sh: No such file or directory

  • 脚本完成后，会启动以下5个服务，使用jps命令查看服务是否启动(jps为java 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

2、前端部署

请下载最新版本的前端安装包至服务器部署目录，下载地址： 下载 (以1.2.0版本为例)，下载后上传tar包到该目录中，并进行解压

  1. cd /opt/dolphinscheduler;
  3. tar -zxvf apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-front-bin.tar.gz -C /opt/dolphinscheduler;
  5. mv apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-front-bin dolphinscheduler-ui

以下两种部署方式任选其一种即可，推荐自动化部署

2.1 自动化部署

  • 进入dolphinscheduler-ui目录下执行(注意：自动化部署会自动下载 nginx)

    1. cd dolphinscheduler-ui;
    2. sh ./install-dolphinscheduler-ui.sh;
    • 执行后，会在运行中请键入前端端口，默认端口是8888，如果选择默认，请键入y，或者键入其他端口
    • 然后会让键入跟前端ui交互的api-server的ip
    • 接着是让键入跟前端ui交互的api-server的port
    • 接着是操作系统选择
    • 等待部署完成

  • 部署完，为防止资源过大无法上传到资源中心,建议修改nginx上传大小参数，具体如下

    • 添加nginx配置 client_max_body_size 1024m，在http方法体内添加即可
    1. vi /etc/nginx/nginx.conf
    3. # add param
    4. client_max_body_size 1024m;
    • 然后重启Nginx服务
    1. systemctl restart nginx

  • 访问前端页面地址: http://localhost:8888 ，出现前端登录页面，前端web也安装完成了

    默认用户名密码：admin/dolphinscheduler123

    单机部署(Standalone) - 图1

2.2 手动部署

  1. vi /etc/nginx/nginx.conf
  3. server {
  4.     listen       8888;# 访问端口(自行修改)
  5.     server_name  localhost;
  6.     #charset koi8-r;
  7.     #access_log  /var/log/nginx/host.access.log  main;
  8.     location / {
  9.         root   /opt/soft/dolphinscheduler-ui/dist;      # 前端解压的dist目录地址(自行修改)
  10.         index  index.html index.html;
  11.     }
  12.     location /dolphinscheduler {
  13.         proxy_pass http://localhost:12345;    # 接口地址(自行修改)
  14.         proxy_set_header Host $host;
  15.         proxy_set_header X-Real-IP $remote_addr;
  16.         proxy_set_header x_real_ipP $remote_addr;
  17.         proxy_set_header remote_addr $remote_addr;
  18.         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  19.         proxy_http_version 1.1;
  20.         proxy_connect_timeout 4s;
  21.         proxy_read_timeout 30s;
  22.         proxy_send_timeout 12s;
  23.         proxy_set_header Upgrade $http_upgrade;
  24.         proxy_set_header Connection "upgrade";
  25.     }
  26.     #error_page  404              /404.html;
  27.     # redirect server error pages to the static page /50x.html
  28.     #
  29.     error_page   500 502 503 504  /50x.html;
  30.     location = /50x.html {
  31.         root   /usr/share/nginx/html;
  32.     }
  33. }

  • 然后重启Nginx服务

    1. systemctl restart nginx

  • 访问前端页面地址: http://localhost:8888 ，出现前端登录页面，前端web也安装完成了

    默认用户名密码：admin/dolphinscheduler123

    单机部署(Standalone) - 图2

3、启停服务

  • 一键停止集群所有服务

    sh ./bin/stop-all.sh

  • 一键开启集群所有服务

    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

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