后端部署文档

后端有2种部署方式，分别为自动化部署和编译源码部署

1、准备工作

请下载最新版本的安装包，下载地址： 码云下载 ，下载escheduler-backend-x.x.x.tar.gz(后端简称escheduler-backend),escheduler-ui-x.x.x.tar.gz(前端简称escheduler-ui)

准备一: 基础软件安装(必装项请自行安装)

  • Mysql (5.5+) : 必装
  • JDK (1.8+) : 必装
  • ZooKeeper(3.4.6+) ：必装
  • Hadoop(2.6+) ：选装， 如果需要使用到资源上传功能，MapReduce任务提交则需要配置Hadoop(上传的资源文件目前保存在Hdfs上)
  • Hive(1.2.1) : 选装，hive任务提交需要安装
  • Spark(1.x,2.x) : 选装，Spark任务提交需要安装
  • PostgreSQL(8.2.15+) : 选装，PostgreSQL PostgreSQL存储过程需要安装
  1.  注意：EasyScheduler本身不依赖Hadoop、Hive、Spark、PostgreSQL,仅是会调用他们的Client，用于对应任务的运行。

准备二: 创建部署用户

  • 在所有需要部署调度的机器上创建部署用户，因为worker服务是以 sudo -u {linux-user} 方式来执行作业，所以部署用户需要有 sudo 权限，而且是免密的。
  1. vi /etc/sudoers
  3. # 例如部署用户是escheduler账号
  4. escheduler  ALL=(ALL)       NOPASSWD: NOPASSWD: ALL
  6. # 并且需要注释掉 Default requiretty 一行
  7. #Default requiretty

准备三: ssh免密配置

在部署机器和其他安装机器上配置ssh免密登录，如果要在部署机上安装调度，需要配置本机免密登录自己

准备四：数据库初始化

  • 创建database和账号

    通过以下mysql命令进入mysql命令行服务：

mysql -h {host} -u {user} -p{password}

然后执行以下命令创建database和账号

  1.   CREATE DATABASE escheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
  2.   GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';
  3.   GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';
  4.   flush privileges;
  • 1.0.0和1.0.1版本创建表和导入基础数据 说明：在escheduler-backend/sql/escheduler.sql和quartz.sql
  1.   mysql -h {host} -u {user} -p{password} -D {db} < escheduler.sql
  3.   mysql -h {host} -u {user} -p{password} -D {db} < quartz.sql
  • 1.0.2之后版本(含1.0.2)创建表和导入基础数据 修改conf/dao/data_source.properties中的下列属性
  1.       spring.datasource.url
  2.       spring.datasource.username
  3.       spring.datasource.password

执行创建表和导入基础数据脚本

  1.   sh ./script/create_escheduler.sh

准备五: 修改部署目录权限及运行参数

我们先来大体了解下解压后escheduler-backend目录下的文件(夹)的作用

  1. bin : 基础服务启动脚本
  2. conf : 项目配置文件
  3. lib : 项目依赖jar包，包括各个模块jar和第三方jar
  4. script : 集群启动、停止和服务监控启停脚本
  5. sql : 项目依赖sql文件
  6. install.sh : 一键部署脚本

  • 修改权限(请将deployUser自行修改为对应部署用户)，使得部署用户对escheduler-backend目录有操作权限

    sudo chown -R deployUser:deployUser escheduler-backend

  • 修改conf/env/目录下的 .escheduler_env.sh 环境变量

  • 修改部署参数(根据自己服务器及业务情况):

    • 修改 install.sh中的各参数，替换成自身业务所需的值

      • monitorServerState 开关变量,在1.0.3版本中增加，控制是否启动自启动脚本(监控master,worker状态,如果掉线会自动启动)默认值为"false"表示不启动自启动脚本,如果需要启动改为"true"

      • hdfsStartupSate 开关变量，控制是否启动hdfs默认值为"false"表示不启动hdfs如果需要启动改为"true",启动hdfs需要自行创建hdfs根路径，也就是install.sh中的 hdfsPath

    • 如果使用hdfs相关功能，需要拷贝hdfs-site.xml和core-site.xml到conf目录下

2、部署

推荐自动化部署，有经验的小伙伴也可以使用源码部署

2.1 自动部署

  • 安装zookeeper工具

    pip install kazoo

  • 切换到部署用户，一键部署

    sh install.sh

  • 使用jps命令查看服务是否启动(jps为java JDK自带)

  1.     MasterServer         ----- master服务
  2.     WorkerServer         ----- worker服务
  3.     LoggerServer         ----- logger服务
  4.     ApiApplicationServer ----- api服务
  5.     AlertServer          ----- alert服务

如果有以上5个服务，说明自动部署成功

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

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

2.2 编译源码来部署

将源码包release版本下载后，解压进入根目录

  • 执行编译命令：
  1.  mvn -U clean package assembly:assembly -Dmaven.test.skip=true
  • 查看目录正常编译完后，会在当前目录生成 target/escheduler-{version}/ ， 然后参考

2.3 系统常用启停服务(服务用途请具体参见《系统架构设计》小节)

  • 一键停止集群所有服务

    sh ./bin/stop_all.sh

  • 一键开启集群所有服务

    sh ./bin/start_all.sh

  • 启停Master

  1. sh ./bin/escheduler-daemon.sh start master-server
  2. sh ./bin/escheduler-daemon.sh stop master-server
  • 启停Worker
  1. sh ./bin/escheduler-daemon.sh start worker-server
  2. sh ./bin/escheduler-daemon.sh stop worker-server
  • 启停Api
  1. sh ./bin/escheduler-daemon.sh start api-server
  2. sh ./bin/escheduler-daemon.sh stop api-server
  • 启停Logger
  1. sh ./bin/escheduler-daemon.sh start logger-server
  2. sh ./bin/escheduler-daemon.sh stop logger-server
  • 启停Alert
  1. sh ./bin/escheduler-daemon.sh start alert-server
  2. sh ./bin/escheduler-daemon.sh stop alert-server

3、数据库升级

数据库升级是在1.0.2版本增加的功能,执行以下命令即可自动升级数据库

  1. sh ./script/upgrade_escheduler.sh