在 Node.js 中使用 Jenkins 進行 CI/CD
在 Jenkins 上使用加密的 .env.vault 檔案執行 Node.js CI/CD
初始設定
建立一個 Jenkinsfile
檔案。
Jenkins
pipeline {
agent any
stages {
stage('Build') {
steps {
sh 'npm install'
sh 'npm run build'
}
}
}
}
如果您使用的是 Windows,請將 sh
命令替換為 powershell
。
建立一個 build.js
檔案。這是一個非常簡單的建置腳本,會輸出 'Hello World'。
build.js
// build.js
console.log(`Hello ${process.env.HELLO}`)
建立一個 package.json
檔案。
package.json
{
"scripts": {
"build": "node build.js"
}
}
將其推送至 Jenkins。
安裝 dotenv
安裝 dotenv
。
npm install dotenv --save # Requires dotenv >= 16.1.0
在專案的根目錄中建立一個 .env
檔案。
.env
# .env
HELLO="World"
盡可能在應用程式的早期,匯入並設定 dotenv。
build.js
// build.js
require('dotenv').config()
console.log(process.env) // remove this after you've confirmed it is working
console.log(`Hello ${process.env.HELLO}`)
嘗試在本地執行它。
node build.js
{
...
HELLO: 'World'
}
Hello World
完美。process.env
現在具有您在 .env
檔案中定義的鍵和值。
這涵蓋了 CI 的本地模擬。接下來讓我們解決實際的 CI 環境。
建立 .env.vault
推送您最新的 .env
檔案變更並編輯您的 CI 機密。 深入瞭解同步
npx dotenv-vault@latest push
npx dotenv-vault@latest open ci
使用 UI 設定每個環境的機密。
然後建立您加密的 .env.vault
檔案。
npx dotenv-vault@latest build
它的內容應該如下所示。
.env.vault
#/-------------------.env.vault---------------------/
#/ cloud-agnostic vaulting standard /
#/ [how it works](https://dotenv.org/env-vault) /
#/--------------------------------------------------/
# development
DOTENV_VAULT_DEVELOPMENT="/HqNgQWsf6Oh6XB9pI/CGkdgCe6d4/vWZHgP50RRoDTzkzPQk/xOaQs="
DOTENV_VAULT_DEVELOPMENT_VERSION=2
# ci
DOTENV_VAULT_CI="x26PuIKQ/xZ5eKrYomKngM+dO/9v1vxhwslE/zjHdg3l+H6q6PheB5GVDVIbZg=="
DOTENV_VAULT_CI_VERSION=2
設定 DOTENV_KEY
取得您的 CI DOTENV_KEY
。
npx dotenv-vault@latest keys ci
# outputs: dotenv://:[email protected]/vault/.env.vault?environment=ci
在 Jenkins 上設定 DOTENV_KEY
。
有多種可選方式可以使用 Jenkins 執行此操作 - 作為建置步驟的一部分、作為節點屬性或作為全域設定。選擇最適合您情況的方式。
將解密金鑰應用於建置步驟將使其僅在該特定步驟中生效,在設定為節點屬性時在節點活動期間生效,以及作為全域設定時在每個動作中生效。
您可以在建置步驟中透過 Blue Ocean 介面或 Jenkinsfile 設定,在儀表板/管理 Jenkins/節點/NODE_NAME 中作為節點屬性設定,以及在儀表板/管理 Jenkins/設定系統中作為全域設定。
一旦您選擇了偏好的位置,請將 DOTENV_KEY 作為金鑰,並將您先前取得的解密金鑰儲存為值欄位。
建立 CI
將這些變更安全地提交至程式碼並重新執行建置。
就是這樣!在重新執行時,您的 .env.vault
檔案將被解密,並且其 CI 機密將作為環境變數注入 - 恰好及時。
當您在日誌中看到 'Loading env from encrypted .env.vault'
時,您就會知道事情已正確運作。如果未設定 DOTENV_KEY
(例如,在本地機器上開發時),它將回復為標準的 dotenv 功能。
您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將您的機密分散在多個第三方平台和工具中安全得多。每當您需要新增或變更機密時,只需重建您的 .env.vault 檔案並重新部署即可。