语言 › 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 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 文件并重新部署即可。