語言› Node.js

在 Node.js 中使用 Google Cloud Build 進行 CI/CD

使用加密的 .env.vault 檔案在 Google Cloud Build 中執行 Node.js CI/CD

請在此指南中找到完整的 GitHub 程式碼範例。

初始設定

安裝 gcloud cli。

brew install --cask google-cloud-sdk

登入 gcloud。

gcloud auth login

設定您的專案。您可以在 Google Cloud 儀表板上查詢此資訊。

gcloud config set project PROJECT_ID

使用 Google Cloud 初始化您的專案。

gcloud init && git config credential.helper gcloud.sh

建立存放庫。

gcloud source repos create hello-gcloud

建立 build.js 檔案。這是一個非常簡單的建置腳本，會輸出「Hello World」。

build.js

// build.js
console.log(`Hello ${process.env.HELLO}`)

建立 package.json 檔案。

package.json

{
  "scripts": {
    "build": "node build.js"
  }
}

建立 cloudbuild.yml 檔案。

cloudbuild.yml

# cloudbuild.yml
steps:
- name: node
  entrypoint: npm
  args: ['install']
- name: node
  entrypoint: npm
  env:
    - 'DOTENV_KEY=${_DOTENV_KEY}'
  args: ['run', 'build']

將程式碼提交並推送至 Google Cloud。

git push google

推送後，Google Cloud Build 建置將會顯示 'Hello undefined'，因為它還沒有存取環境變數的方式。接下來我們來處理這個問題。

要完全連線 Google Cloud Build 還需要更多步驟，我們上面沒有討論。老實說，這有點混亂。如果可以，我們建議您使用 GitHub Actions。但是一旦您開始使用 Google Cloud Build，它就能很好地運行。

安裝 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 來設定每個環境的機密。

dotenv.org

然後建置您加密的 .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

在 Google Cloud Build 上設定 DOTENV_KEY。

console.cloud.google.com

建置 CI

將這些變更安全地提交到程式碼並重新執行建置。

就是這樣！重新執行時，您的 .env.vault 檔案將會解密，並且其 CI 機密將會作為環境變數注入 — 恰好及時。

console.cloud.google.com

當您在記錄中看到 'Loading env from encrypted .env.vault' 時，您就會知道事情已正確運作。如果未設定 DOTENV_KEY（例如在您的本機機器上開發時），它將會回復為標準的 dotenv 功能。

您已成功使用新的 .env.vault 標準來加密和部署您的機密。這比將您的機密散佈在多個協力廠商平台和工具中安全得多。每當您需要新增或變更機密時，只需重新建置您的 .env.vault 檔案並重新部署即可。