公司的項目需要自動部署到服務器上,在網上查詢後,發現PM2自帶的發佈程序可以自動部署並運行。
0x01 環境條件
本地環境:window10的WSL ubuntu16.04
服務器環境:ubuntu18.04
使用PM2進行部署,可以先查看官方的文檔
這裏需要在本地和服務器環境上同時安裝好 PM2 、git ,本地PM2可以通過git向github、gitee等倉庫提交代碼,同時通知服務器的PM2拉取最新的代碼,並在拉取成功後運行代碼。
0x02 設置本地環境與服務器環境gitee倉庫ssh
本地環境
- 執行
ssh-keygen -t rsa -b 2048 -f pm2deploy -C "PM2 deploy ssh key"
執行後將得到本地環境生成的ssh key
- 執行
ssh-agent bash --login -i
- 執行
ssh-add pm2deploy
執行後將pm2deloy添加到ssh高速代理中去。
- 將公鑰添加入gitee或github中,
注意本地環境添加的是個人公鑰,而服務器環境需要添加在部署公鑰下
。
添加成功以後,本地shell執行git -T [email protected]
返回successfully後,則說明本地ssh已經部署完成。
添加config
如果你的公鑰和私鑰是有別名的,需要添加一個配置文件config
來說明網站和密鑰的對應關係
如果有多個 ssh 賬號需要配置,在 config 文件裏隔行分開寫就行
服務器環境
服務器環境同理,不同的是服務器環境添加的公鑰需要放在部署公鑰下
0x02 配置git
先將git origin 的地址修改成ssh的別名地址
vim /.git/config
修改origin 的中gitee.com 爲別名gitee,然後保存
注意這裏的別名是本地的別名gitee,但是git庫需要保持一致,所以在服務器上配置的別名也爲gitee,只需要配置別名即可,證書還是各有各的證書。
先到項目目錄用git將剛剛創建的項目拉取下來,拉取後,我們隨便部署一個測試的代碼,看是否能提交進gitee
這裏我使用的是node的官方測試代碼
傳輸成功後,我們開始配置PM2的配置文件
0x03 配置PM2
官方說明中只需要配置好這裏的ecosystem.config.js
配置文件,並且讓本地環境和服務器環境可以通過ssh訪問即可實現PM2自動部署
配置ssh
本地生成shh密鑰
將密鑰寫入本地config文件中
將公鑰寫入到服務器環境中的authorized_keys
中
配置ecosystem.config.js
使用 pm2 ecosystem
自動生成ecosystem.config.js
ecosystem.config.js:
module.exports = {
apps : [{
name: 'test',
script: 'test.js',
// Options reference: https://pm2.io/doc/en/runtime/reference/ecosystem-file/
// 遠程服務器上的PM2參數配置
args: 'one two', //參數
instances: 1, //實例數量
autorestart: true, //自動啓動:是
watch: false, //監視模式:否
max_memory_restart: '1G',//如果超過內存多少後,將重啓實例:1G
env: {
NODE_ENV: 'development'
},
env_production: {
NODE_ENV: 'production'
}
}],
deploy : {
production : {
user : '遠程主機用戶名',
host : '遠程主機的ssh-config中的別名',
port : '遠程主機ssh端口',
ref : 'origin/master',//遠程gitee上的分支
repo : 'git@[gitee別名]:[git庫地址]',
path : '遠程服務器上的部署路徑',
'post-deploy' : 'npm install && pm2 reload ecosystem.config.js --env production'//部署完成後的操作
}
}
};
配置完成後,執行 pm2 deploy production setup
初始化PM2的部署
以後更新,執行 pm2 deploy production update
,則更新新的代碼並運行了。
待定