Apache DolphinScheduler集羣部署方案

集羣部署(Cluster)

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 or MinIO上

 注意：DolphinScheduler本身不依賴Hadoop、Hive、Spark,僅是會調用他們的Client，用於對應任務的提交。

1.2 : 下載後端tar.gz包

• 請下載最新版本的後端安裝包至服務器部署目錄,比如創建 /opt/dolphinscheduler 做爲安裝部署目錄，下載地址： 下載 (以1.2.0版本爲例)，下載後上傳tar包到該目錄中，並進行解壓

# 創建部署目錄
mkdir -p /opt/dolphinscheduler;
cd /opt/dolphinscheduler;
# 解壓縮
tar -zxvf apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-backend-bin.tar.gz -C /opt/dolphinscheduler;

mv apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-backend-bin  dolphinscheduler-backend

1.3：創建部署用戶和hosts映射

• 在所有部署調度的機器上創建部署用戶，並且一定要配置sudo免密。假如我們計劃在ds1,ds2,ds3,ds4這4臺機器上部署調度，首先需要在每臺機器上都創建部署用戶

# 設置用戶名，請自行修改，後面以dolphinscheduler爲例
useradd dolphinscheduler;

# 設置用戶密碼，請自行修改，後面以dolphinscheduler123爲例
echo "dolphinscheduler123" | passwd --stdin dolphinscheduler

# 配置sudo免密
echo 'dolphinscheduler  ALL=(ALL)  NOPASSWD: NOPASSWD: ALL' >> /etc/sudoers

 注意：
 - 因爲是以 sudo -u {linux-user} 切換不同linux用戶的方式來實現多租戶運行作業，所以部署用戶需要有 sudo 權限，而且是免密的。
 - 如果發現/etc/sudoers文件中有"Default requiretty"這行，也請註釋掉
 - 如果用到資源上傳的話，還需要在`HDFS或者MinIO`上給該部署用戶分配讀寫的權限

1.4 : 配置hosts映射和ssh打通及修改目錄權限

• 以第一臺機器(hostname爲ds1)作爲部署機，在ds1上配置所有待部署機器的hosts, 在ds1以root登錄

  vi /etc/hosts
  
  #add ip hostname
  192.168.xxx.xxx ds1
  192.168.xxx.xxx ds2
  192.168.xxx.xxx ds3
  192.168.xxx.xxx ds4
  

  注意：請刪掉或者註釋掉127.0.0.1這行

• 同步ds1上的/etc/hosts到所有部署機器

  for ip in ds2 ds3;     #請將此處ds2 ds3替換爲自己要部署的機器的hostname
  do
      sudo scp -r /etc/hosts  $ip:/etc/          #在運行中需要輸入root密碼
  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本機免密登錄

su dolphinscheduler;

ssh-keygen -t rsa -P ‘’ -f ~/.ssh/id_rsa
cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys

​      注意：*正常設置後，dolphinscheduler用戶在執行命令`ssh localhost` 是不需要再輸入密碼的*



- 在ds1上，配置部署用戶dolphinscheduler ssh打通到其他待部署的機器

```shell
su dolphinscheduler;
for ip in ds2 ds3;     #請將此處ds2 ds3替換爲自己要部署的機器的hostname
do
    ssh-copy-id  $ip   #該操作執行過程中需要手動輸入dolphinscheduler用戶的密碼
done
# 當然 通過 sshpass -p xxx ssh-copy-id $ip 就可以省去輸入密碼了

• 在ds1上，修改目錄權限，使得部署用戶對dolphinscheduler-backend目錄有操作權限

  sudo chown -R dolphinscheduler:dolphinscheduler dolphinscheduler-backend
  

1.5 : 數據庫初始化

• 進入數據庫，默認數據庫是PostgreSQL，如選擇Mysql的話，後續需要添加mysql-connector-java驅動包到DolphinScheduler的lib目錄下，這裏以mysql爲例

mysql -uroot -p

• 進入數據庫命令行窗口後，執行數據庫初始化命令，設置訪問賬號和密碼。注: {user} 和 {password} 需要替換爲具體的數據庫用戶名和密碼

   mysql> CREATE DATABASE dolphinscheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
   mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';
   mysql> GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';
   mysql> flush privileges;

• 創建表和導入基礎數據

  • 修改 conf 目錄下 application-dao.properties 中的下列配置

    vi conf/application-dao.properties 
  

  • 如果選擇 Mysql，請註釋掉 PostgreSQL 相關配置(反之同理), 還需要手動添加 [ mysql-connector-java 驅動 jar ] 包到 lib 目錄下，這裏下載的是mysql-connector-java-5.1.47.jar，然後正確配置數據庫連接相關信息

    #postgre
    #spring.datasource.driver-class-name=org.postgresql.Driver
    #spring.datasource.url=jdbc:postgresql://localhost:5432/dolphinscheduler
    # mysql
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.datasource.url=jdbc:mysql://xxx:3306/dolphinscheduler?useUnicode=true&characterEncoding=UTF-8     需要修改ip
    spring.datasource.username=xxx						需要修改爲上面的{user}值
    spring.datasource.password=xxx						需要修改爲上面的{password}值
  

  • 修改並保存完後，執行 script 目錄下的創建表及導入基礎數據腳本

  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下爲例)

  export HADOOP_HOME=/opt/soft/hadoop
  export HADOOP_CONF_DIR=/opt/soft/hadoop/etc/hadoop
  #export SPARK_HOME1=/opt/soft/spark1
  export SPARK_HOME2=/opt/soft/spark2
  export PYTHON_HOME=/opt/soft/python
  export JAVA_HOME=/opt/soft/java
  export HIVE_HOME=/opt/soft/hive
  export FLINK_HOME=/opt/soft/flink
  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 爲例)

  sudo ln -s /opt/soft/java/bin/java /usr/bin/java
  

• 修改一鍵部署腳本 install.sh中的各參數，特別注意以下參數的配置

  # 這裏填 mysql or postgresql
  dbtype="mysql"
  
  # 數據庫連接地址
  dbhost="192.168.xx.xx:3306"
  
  # 數據庫名
  dbname="dolphinscheduler"
  
  # 數據庫用戶名，此處需要修改爲上面設置的{user}具體值
  username="xxx"    
  
  # 數據庫密碼, 如果有特殊字符，請使用\轉義，需要修改爲上面設置的{passowrd}具體值
  passowrd="xxx"
  
  #將DS安裝到哪個目錄，如: /opt/soft/dolphinscheduler，不同於現在的目錄
  installPath="/opt/soft/dolphinscheduler"
  
  #使用哪個用戶部署，使用1.3小節創建的用戶
  deployUser="dolphinscheduler"
  
  #zookeeper地址
  zkQuorum="192.168.xx.xx:2181,192.168.xx.xx:2181,192.168.xx.xx:2181"
  
  #在哪些機器上部署DS服務
  ips="ds1,ds2,ds3,ds4"
  
  #master服務部署在哪臺機器上
  masters="ds1,ds2"
  
  #worker服務部署在哪臺機器上
  workers="ds3,ds4"
  
  #報警服務部署在哪臺機器上
  alertServer="ds2"
  
  #後端api服務部署在在哪臺機器上
  apiServers="ds1"
  
  
  # 郵件配置，以qq郵箱爲例
  # 郵件協議
  mailProtocol="SMTP"
  
  # 郵件服務地址
  mailServerHost="smtp.exmail.qq.com"
  
  # 郵件服務端口
  mailServerPort="25"
  
  # mailSender和mailUser配置成一樣即可
  # 發送者
  mailSender="[email protected]"
  
  # 發送用戶
  mailUser="[email protected]"
  
  # 郵箱密碼
  mailPassword="xxx"
  
  # TLS協議的郵箱設置爲true，否則設置爲false
  starttlsEnable="true"
  
  # 郵件服務地址值，參考上面 mailServerHost
  sslTrust="smtp.exmail.qq.com"
  
  # 開啓SSL協議的郵箱配置爲true，否則爲false。注意: starttlsEnable和sslEnable不能同時爲true
  sslEnable="false"
  
  # excel下載路徑
  xlsFilePath="/tmp/xls"
  
  # 業務用到的比如sql等資源文件上傳到哪裏，可以設置：HDFS,S3,NONE。如果想上傳到HDFS，請配置爲HDFS；如果不需要資源上傳功能請選擇NONE。
  resUploadStartupType="HDFS"
  
  #如果上傳資源保存想保存在hadoop上，hadoop集羣的NameNode啓用了HA的話，需要將core-site.xml和hdfs-site.xml放到conf目錄下，本例即是放到/opt/dolphinscheduler/conf下面，並配置namenode cluster名稱；如果NameNode不是HA,則只需要將mycluster修改爲具體的ip或者主機名即可 
  defaultFS="hdfs://mycluster:8020"
  
  
  # 如果ResourceManager是HA，則配置爲ResourceManager節點的主備ip或者hostname,比如"192.168.xx.xx,192.168.xx.xx"，否則如果是單ResourceManager或者根本沒用到yarn,請配置yarnHaIps=""即可，我這裏沒用到yarn，配置爲""
  yarnHaIps=""
  
  # 如果是單ResourceManager，則配置爲ResourceManager節點ip或主機名，否則保持默認值即可。我這裏沒用到yarn，保持默認
  singleYarnIp="ark1"
  

  特別注意：

  • 如果需要用資源上傳到Hadoop集羣功能， 並且Hadoop集羣的NameNode 配置了 HA的話 ，需要開啓 HDFS類型的資源上傳，同時需要將Hadoop集羣下的core-site.xml和hdfs-site.xml複製到/opt/dolphinscheduler/conf，非NameNode HA跳過次步驟

1.7 : 安裝python的zookeeper工具kazoo

• 安裝python的 zookeeper 工具 ，此步驟僅在一鍵部署時候用到

#安裝pip
sudo yum -y install python-pip;  #ubuntu請使用 sudo apt-get install python-pip
sudo pip install kazoo;

注意：如果yum沒找到python-pip，也可以通過下面方式安裝

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

• 切換到部署用戶dolphinscheduler，然後執行一鍵部署腳本

  sh install.sh

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

• 腳本完成後，會啓動以下5個服務，使用jps命令查看服務是否啓動(jps爲java JDK自帶)

    MasterServer         ----- master服務
    WorkerServer         ----- worker服務
    LoggerServer         ----- logger服務
    ApiApplicationServer ----- api服務
    AlertServer          ----- alert服務

如果以上服務都正常啓動，說明自動部署成功

部署成功後，可以進行日誌查看，日誌統一存放於logs文件夾內

 logs/
    ├── dolphinscheduler-alert-server.log
    ├── dolphinscheduler-master-server.log
    |—— dolphinscheduler-worker-server.log
    |—— dolphinscheduler-api-server.log
    |—— dolphinscheduler-logger-server.log

2、前端部署

請下載最新版本的前端安裝包至服務器部署目錄，下載地址： 下載 (以1.2.0版本爲例)，下載後上傳tar包到該目錄中，並進行解壓

cd /opt/dolphinscheduler;

tar -zxvf apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-front-bin.tar.gz -C /opt/dolphinscheduler;

mv apache-dolphinscheduler-incubating-1.2.0-dolphinscheduler-front-bin dolphinscheduler-ui

以下兩種部署方式任選其一種即可，推薦自動化部署

2.1 自動化部署

• 進入dolphinscheduler-ui目錄下執行(注意：自動化部署會自動下載 nginx)

  cd dolphinscheduler-ui;
  sh ./install-dolphinscheduler-ui.sh;
  

  • 執行後，會在運行中請鍵入前端端口，默認端口是8888，如果選擇默認，請鍵入y，或者鍵入其他端口
  • 然後會讓鍵入跟前端ui交互的api-server的ip
  • 接着是讓鍵入跟前端ui交互的api-server的port
  • 接着是操作系統選擇
  • 等待部署完成

• 部署完，爲防止資源過大無法上傳到資源中心,建議修改nginx上傳大小參數，具體如下

  • 添加nginx配置 client_max_body_size 1024m，在http方法體內添加即可

  vi /etc/nginx/nginx.conf
  
  # add param
  client_max_body_size 1024m;
  

  • 然後重啓Nginx服務

  systemctl restart nginx
  

• 訪問前端頁面地址: http://localhost:8888 ，出現前端登錄頁面，前端web也安裝完成了

2.2 手動部署

• 自行安裝nginx，去官網下載: http://nginx.org/en/download.html 或者 yum install nginx -y

• 修改nginx配置文件(注意自行修改的幾處)

vi /etc/nginx/nginx.conf

server {
    listen       8888;# 訪問端口(自行修改)
    server_name  localhost;
    #charset koi8-r;
    #access_log  /var/log/nginx/host.access.log  main;
    location / {
        root   /opt/soft/dolphinscheduler-ui/dist;      # 前端解壓的dist目錄地址(自行修改)
        index  index.html index.html;
    }
    location /dolphinscheduler {
        proxy_pass http://localhost:12345;    # 接口地址(自行修改)
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header x_real_ipP $remote_addr;
        proxy_set_header remote_addr $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_http_version 1.1;
        proxy_connect_timeout 4s;
        proxy_read_timeout 30s;
        proxy_send_timeout 12s;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
    }
    #error_page  404              /404.html;
    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }
}

• 然後重啓Nginx服務

  systemctl restart nginx
  

• 訪問前端頁面地址: http://localhost:8888 ，出現前端登錄頁面，前端web也安裝完成了

  <p align="center">
     <img src="/img/login.png" width="60%" />
   </p>
  

3、啓停服務

• 一鍵停止集羣所有服務

  sh ./bin/stop-all.sh

• 一鍵開啓集羣所有服務

  sh ./bin/start-all.sh

• 啓停Master

sh ./bin/dolphinscheduler-daemon.sh start master-server
sh ./bin/dolphinscheduler-daemon.sh stop master-server

• 啓停Worker

sh ./bin/dolphinscheduler-daemon.sh start worker-server
sh ./bin/dolphinscheduler-daemon.sh stop worker-server

• 啓停Api

sh ./bin/dolphinscheduler-daemon.sh start api-server
sh ./bin/dolphinscheduler-daemon.sh stop api-server

• 啓停Logger

sh ./bin/dolphinscheduler-daemon.sh start logger-server
sh ./bin/dolphinscheduler-daemon.sh stop logger-server

• 啓停Alert

sh ./bin/dolphinscheduler-daemon.sh start alert-server
sh ./bin/dolphinscheduler-daemon.sh stop alert-server

注：服務用途請具體參見《系統架構設計》小節