merge from upstream/dev

`util` => 工具

### 开发环境搭建

- #### Node安装

Node包下载 (注意版本 8.9.4) `https://nodejs.org/download/release/v8.9.4/` 

- #### 前端项目构建

用命令行模式 `cd`  进入 `escheduler-ui`项目目录并执行 `npm install` 拉取项目依赖包

> 如果 `npm install` 速度非常慢 

> 可以转淘宝镜像命令行输入 `npm install -g cnpm --registry=https://registry.npm.taobao.org`

> 运行 `cnpm install` 

> #####  ！！！这里特别注意 项目如果在拉取依赖包的过程中报 " node-sass error " 错误，请在执行完后再次执行以下命令

```

npm install node-sass --unsafe-perm //单独安装node-sass依赖

```

- #### 开发环境运行

- `npm start` 项目开发环境 (启动后访问地址 http://localhost:8888/#/)

#### 前端项目发布

- `npm run build` 项目打包 (打包后根目录会创建一个名为dist文件夹，用于发布线上Nginx)

运行 `npm run build` 命令，生成打包文件（dist）包

再拷贝到服务器对应的目录下（前端服务静态页面存放目录）

访问地址 `http://localhost:8888/#/` 

#### Liunx下使用node启动并且守护进程

安装pm2 `npm install -g pm2`

在项目`escheduler-ui`根目录执行 `pm2 start npm -- run dev` 启动项目

#### 命令

- 启用 `pm2 start npm -- run dev`

- 停止 `pm2 stop npm`

- 删除 `pm2 delete npm`

- 状态 `pm2 list`

```

[root@localhost escheduler-ui]# pm2 start npm -- run dev

[PM2] Applying action restartProcessId on app [npm](ids: 0)

[PM2] [npm](0) ✓

[PM2] Process successfully started

┌──────────┬────┬─────────┬──────┬──────┬────────┬─────────┬────────┬─────┬──────────┬──────┬──────────┐

│ App name │ id │ version │ mode │ pid  │ status │ restart │ uptime │ cpu │ mem      │ user │ watching │

├──────────┼────┼─────────┼──────┼──────┼────────┼─────────┼────────┼─────┼──────────┼──────┼──────────┤

│ npm      │ 0  │ N/A     │ fork │ 6168 │ online │ 31      │ 0s     │ 0%  │ 5.6 MB   │ root │ disabled │

└──────────┴────┴─────────┴──────┴──────┴────────┴─────────┴────────┴─────┴──────────┴──────┴──────────┘

 Use `pm2 show <id|name>` to get more details about an app

```

### 系统功能模块

首页 => `http://localhost:8888/#/home`

# 前端部署文档

- ##### 1. 开发环境搭建

前端有3种部署方式，分别为自动化部署，手动部署和编译源码部署

- ##### 2. 自动化部署

## 1、准备工作

#### 准备一：下载安装包

- ##### 3. 手动部署

目前最新安装包版本是1.0.1，下载地址： [码云下载](https://gitee.com/easyscheduler/EasyScheduler/attach_files/)

- ##### 4. Liunx下使用node启动并且守护进程

下载escheduler-ui-1.0.1.tar.gz后，解压后会产生dist目录,进入dist目录

> cd dist  

#### 准备二：新建一个`.env`文件

### 1.开发环境搭建

- #### node安装

Node包下载 (注意版本 8.9.4) `https://nodejs.org/download/release/v8.9.4/` 

- #### 前端项目构建

用命令行模式 `cd`  进入 `escheduler-ui`项目目录并执行 `npm install` 拉取项目依赖包

> 如果 `npm install` 速度非常慢 

> 可以转淘宝镜像命令行输入 `npm install -g cnpm --registry=https://registry.npm.taobao.org`

> 运行 `cnpm install` 

> #####  ！！！这里特别注意 项目如果在拉取依赖包的过程中报 " node-sass error " 错误，请在执行完后再次执行以下命令

```

npm install node-sass --unsafe-perm //单独安装node-sass依赖

```

在项目`escheduler-ui`根目录`.env`添加代理的端口地址

在dist目录下新建一个`.env`文件，在文件里添加后端服务的ip地址和端口，用于跟后端交互，`.env`文件内容如下：

```

# 前端代理的接口地址（例）

API_BASE = http://192.168.220.204:12345

# 代理的接口地址（自行修改）

API_BASE = http://192.168.xx.xx:12345

# 如果您需要用ip访问项目可以把 "#" 号去掉（例）

#DEV_HOST = 192.168.6.132

#DEV_HOST = 192.168.xx.xx

```

运行

- `npm start` 项目开发环境 (启动后访问地址 http://localhost:8888/#/)

- `npm run build` 项目打包 (打包后根目录会创建一个名为dist文件夹，用于发布线上Nginx)

## 2、部署

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

### 2.1 自动化部署

### 2.自动化部署

在项目`escheduler-ui`根目录编辑安装文件`vi install(线上环境).sh`

在前端项目根目录dist下编辑安装文件`vi install(线上环境).sh`(执行时，最好修改install(线上环境).sh为install-ui.sh,跟后端部署区分)

更改前端访问端口和后端代理接口地址

esc_proxy="8888"

# 配置代理后端接口

esc_proxy_port="http://192.168.220.154:12345"

esc_proxy_port="http://192.168.xx.xx:12345"

```

前端自动部署基于`yum`操作，部署之前请先安装更新`yum

前端自动部署基于linux系统`yum`操作，部署之前请先安装更新`yum`

在项目`escheduler-ui`根目录执行`./install(线上环境).sh` 

在前端项目根目录dist下执行`./install(线上环境).sh` 或者改名后的 `./install-ui.sh`

### 3.手动部署

### 2.2 手动部署

安装epel源 `yum install epel-release -y`

安装Nginx `yum install nginx -y`

#### 命令

- 启用 `systemctl enable nginx`

- 重启 `systemctl restart nginx`

- 状态 `systemctl status nginx`

> ####  创建静态页面存放目录

```

mkdir /data2_4T/escheduler_front/escheduler/server

```

> ####  配置文件地址

> ####  nginx配置文件地址

```

/etc/nginx/conf.d/escheduler.conf

/etc/nginx/conf.d/default.conf

```

> ####  配置信息

> ####  配置信息(自行修改)

```

server {

    listen       8888;# 访问端口

    #charset koi8-r;

    #access_log  /var/log/nginx/host.access.log  main;

    location / {

        root   /data2_4T/escheduler_front/escheduler/server; # 静态文件目录

        root   /xx/dist; # 上面前端解压的dist目录地址(自行修改)

        index  index.html index.html;

    }

    location /escheduler {

        proxy_pass http://192.168.220.181:12345; # 接口地址

        proxy_pass http://192.168.xx.xx:12345; # 接口地址(自行修改)

        proxy_set_header Host $host;

        proxy_set_header X-Real-IP $remote_addr;

        proxy_set_header x_real_ipP $remote_addr;

systemctl restart nginx

```

#### nginx命令

#### 前端项目发布

前端在开发环境（dev）中运行 `npm run build` 命令，生成打包文件（dist）包

再拷贝到服务器 `/data2_4T/escheduler_front/escheduler/server`（服务器静态页面存放目录）

访问地址 `http://localhost:8888/#/` 

### 4.Liunx下使用node启动并且守护进程

安装pm2 `npm install -g pm2`

在项目`escheduler-ui`根目录执行 `pm2 start npm -- run dev` 启动项目

#### 命令

- 启用 `pm2 start npm -- run dev`

- 停止 `pm2 stop npm`

- 删除 `pm2 delete npm`

- 状态 `pm2 list`

```

- 启用 `systemctl enable nginx`

[root@localhost escheduler-ui]# pm2 start npm -- run dev

[PM2] Applying action restartProcessId on app [npm](ids: 0)

[PM2] [npm](0) ✓

[PM2] Process successfully started

┌──────────┬────┬─────────┬──────┬──────┬────────┬─────────┬────────┬─────┬──────────┬──────┬──────────┐

│ App name │ id │ version │ mode │ pid  │ status │ restart │ uptime │ cpu │ mem      │ user │ watching │

├──────────┼────┼─────────┼──────┼──────┼────────┼─────────┼────────┼─────┼──────────┼──────┼──────────┤

│ npm      │ 0  │ N/A     │ fork │ 6168 │ online │ 31      │ 0s     │ 0%  │ 5.6 MB   │ root │ disabled │

└──────────┴────┴─────────┴──────┴──────┴────────┴─────────┴────────┴─────┴──────────┴──────┴──────────┘

 Use `pm2 show <id|name>` to get more details about an app

- 重启 `systemctl restart nginx`

```

- 状态 `systemctl status nginx`

## 问题

## 前端常见问题

####  1. 上传文件大小限制

编辑配置文件 `vi /etc/nginx/nginx.conf`

```

# 后端部署文档

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

## 基础软件安装

## 1、准备工作

目前最新安装包版本是1.0.1，下载地址： [码云下载](https://gitee.com/easyscheduler/EasyScheduler/attach_files/) ，下载escheduler-backend-1.0.1.tar.gz后,解压后会产生escheduler-backend-1.0.1目录(后面简称escheduler-backend)

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

 * [Mysql](http://geek.analysys.cn/topic/124) (5.5+) :  必装

 * [JDK](https://www.oracle.com/technetwork/java/javase/downloads/index.html) (1.8+) :  必装

 注意：EasyScheduler本身不依赖Hadoop、Hive、Spark、PostgreSQL,仅是会调用他们的Client，用于对应任务的运行。

```

## 项目编译

#### 准备二: 创建部署用户

* 执行编译命令：

- 在所有需要部署调度的机器上创建部署用户，因为worker服务是以 sudo -u {linux-user} 方式来执行作业，所以部署用户需要有 sudo 权限，而且是免密的。

```

 mvn -U clean package assembly:assembly -Dmaven.test.skip=true

```部署账号

vi /etc/sudoers

# 例如部署用户是escheduler账号

escheduler  ALL=(ALL)       NOPASSWD: NOPASSWD: ALL

# 并且需要注释掉 Default requiretty 一行

#Default requiretty

```

* 查看目录

#### 准备三: ssh免密配置

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

正常编译完后，会在当前目录生成 target/escheduler-{version}/

- [将 **主机器** 和各个其它机器SSH打通](http://geek.analysys.cn/topic/113)

- 说明

```

bin : 基础服务启动脚本

conf : 项目配置文件

lib : 项目依赖jar包，包括各个模块jar和第三方jar

script : 集群启动、停止和服务监控启停脚本

sql : 项目依赖sql文件

install.sh : 一键部署脚本

```

#### 准备四：数据库初始化

* 创建database和账号

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

## 数据库初始化

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

* 创建database和账号

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

``` 

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

mysql> CREATE DATABASE escheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;

mysql> GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';

mysql> GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';

mysql> flush privileges;

    ```sql 

    CREATE DATABASE escheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;

    GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';

    GRANT ALL PRIVILEGES ON escheduler.* TO '{user}'@'localhost' IDENTIFIED BY '{password}';

    flush privileges;

    ```

* 创建表和导入基础数据

    说明：在escheduler-backend/sql/escheduler.sql和quartz.sql

```

说明：在 target/escheduler-{version}/sql/escheduler.sql和quartz.sql

    ```sql

    mysql -h {host} -u {user} -p{password} -D {db} < escheduler.sql

    mysql -h {host} -u {user} -p{password} -D {db} < quartz.sql

    ```

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

## 创建部署用户

- 在所有需要部署调度的机器上创建部署用户，因为worker服务是以 sudo -u {linux-user} 方式来执行作业，所以部署用户需要有 sudo 权限，而且是免密的。

```部署账号

vi /etc/sudoers

# 部署用户是 escheduler 账号

escheduler  ALL=(ALL)       NOPASSWD: NOPASSWD: ALL

# 并且需要注释掉 Default requiretty 一行

#Default requiretty

```

## ssh免密配置

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

- [将 **主机器** 和各个其它机器SSH打通](http://geek.analysys.cn/topic/113)

## 部署

### 1. 修改安装目录权限

- 安装目录如下：

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

```

    bin

    conf

    install.sh

    lib

    script

    sql

bin : 基础服务启动脚本

conf : 项目配置文件

lib : 项目依赖jar包，包括各个模块jar和第三方jar

script : 集群启动、停止和服务监控启停脚本

sql : 项目依赖sql文件

install.sh : 一键部署脚本

```

- 修改权限(deployUser修改为对应部署用户)

    `sudo chown -R deployUser:deployUser *`

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

### 2. 修改环境变量文件

    `sudo chown -R deployUser:deployUser escheduler-backend`

- 根据业务需求，修改conf/env/目录下的**escheduler_env.py**，**.escheduler_env.sh**两个文件中的环境变量

- 修改conf/env/目录下的`escheduler_env.py`，  `.escheduler_env.sh` 两个文件中的环境变量

### 3. 修改部署参数

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

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

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

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

### 4. 一键部署

## 2、部署

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

### 2.1 自动部署

- 安装zookeeper工具 

    `sh install.sh` 

- jps查看服务是否启动

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

```aidl

    MasterServer         ----- master服务

    ApiApplicationServer ----- api服务

    AlertServer          ----- alert服务

```

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

## 日志查看

日志统一存放于指定文件夹内

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

```日志路径

 logs/

    |—— escheduler-logger-server.log

```

## 启停服务

### 2.2 编译源码来部署

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

* 执行编译命令：

```

 mvn -U clean package assembly:assembly -Dmaven.test.skip=true

```

* 查看目录

正常编译完后，会在当前目录生成 target/escheduler-{version}/ ， 然后参考

### 2.3 系统常用启停服务

* 一键停止集群所有服务

sh ./bin/escheduler-daemon.sh start alert-server

sh ./bin/escheduler-daemon.sh stop alert-server

```

 No newline at end of file