使用pm2自动化部署node项目

1、pm2简介

pm2（process manager）是一个进程管理工具，维护一个进程列表，可以用它来管理你的node进程，负责所有正在运行的进程，并查看node进程的状态，也支持性能监控，负载均衡等功能。

1.1、使用pm2管理的node程序的好处

1. 监听文件变化，自动重启程序
2. 支持性能监控
3. 负载均衡
4. 程序崩溃自动重启
5. 服务器重新启动时自动重新启动
6. 自动化部署项目

2、pm2安装与使用

2.1、全局安装

npm install pm2 -g 

 

2.2、常用命令

• 启动一个node程序　

pm2 start start.js   

 

• 启动进程并指定应用的程序名

pm2 start app.js --name application1

• 集群模式启动

 

// -i 表示 number-instances 实例数量
// max 表示 pm2将自动检测可用cpu的数量 可以自己指定数量
pm2 start start.js -i max

 

• 添加进程监视

// 在文件改变的时候会重新启动程序
pm2 start app.js --name start --watch

 

• 列出所有进程

  pm2 list
  pm2 ls // 简写

• 从进程列表中删除进程

  // pm2 delete [appname] | id
  pm2 delete app  // 指定进程名删除
  pm2 delete 0    // 指定进程id删除

• 删除进程列表中所有进程

  pm2 delete all

 

• 查看某个进程具体情况

  pm2 describe app

 

 

• 查看进程的资源消耗情况

  pm2 monit

 

 

• 重启进程

   pm2 restart app // 重启指定名称的进程
   pm2 restart all // 重启所有进程

• 查看进程日志

   pm2 logs app    // 查看该名称进程的日志
   pm2 logs all    // 查看所有进程的日志

• 设置pm2开机自启

开启启动设置，此处是centos系统，其他系统替换最后一个选项（可选项：ubuntu, centos, redhat, gentoo, systemd, darwin, amazon）

   pm2 startup centos 

然后按照提示需要输入的命令进行输入

最后保存设置

pm2 save

3、通过pm2配置文件来自动部署项目

确保服务器安装了pm2，没有安装的话先安装

npm install pm2 -g

 

3.1 在项目根目录下新建一个 deploy.yaml 文件

# deploy.yaml
apps:
  - script: ./start.js       # 入口文件
    name: 'app'              # 程序名称
    env:                     # 环境变量
      common_variable: true
    env_production:
      node_env: production

deploy:                     # 部署脚本
  production:               # 生产环境
    user: lentoo            # 服务器的用户名
    host: 192.168.2.166     # 服务器的ip地址
    port: 22                # ssh端口
    ref: origin/master      # 要拉取的git分支
    ssh_options: stricthostkeychecking=no # ssh 公钥检查
    repo: https://github.com/**.git # 远程仓库地址
    path: /home              # 拉取到服务器某个目录下
    pre-deploy: git fetch --all # 部署前执行
    post-deploy: npm install &&  pm2 reload deploy.yaml --env production # 部署后执行
    env:
      node_env: production

3.2、配置git的ssh免密认证

1. 在服务器中生成rsa公钥和私钥，当前是 centos7 下进行

2. 前提服务器要安装git，没有安装的先安装git，已安装的跳过

   yum –y install git

3. 生成秘钥

    ssh-keygen -t rsa -c "[e-mail]"

   在~/.ssh目录下有 id_rsa和 id_rsa.pub两个文件，其中id_rsa.pub文件里存放的即是公钥key。

4. 登录到github，点击右上方的头像，选择settings ，点击add ssh key，把id_rsa.pub的内容复制到里面即可。

 

 

3.3 使用pm2部署项目

每次部署前先将本地的代码提交到远程git仓库

• 首次部署

pm2 deploy deploy.yaml production setup 

部署完成后，既可登陆服务器查看配置的目录下是否从git上拉取了项目

• 再次部署

pm2 deploy deploy.yaml production upddate

3.4 该部署流程同样适用前端项目

如vue-cli的项目，自动部署到服务器，自动执行npm run build 命令，生成的dist目录，指定到nginx的静态文件目录下。

4、可能会遇到的坑

• 在window系统下 vscode的命令行程序，以及powershell执行部署的命令时，出现部署失败

pm2 deploy deploy.yaml production setup  

 

解决方案：使用git命令行来执行