自动将生成式 AI Node.js Web 应用从版本控制部署到 Cloud Run

1. 概览

首次部署 Web 应用可能令人望而生畏。即使在首次部署后,如果该流程的工作量太大,您也可能会避免部署应用的新版本。借助持续部署,您可以轻松自动部署应用更改。

在本实验中,您将编写一个 Web 应用,并配置 Cloud Run,以便在应用的源代码发生更改时自动部署应用。然后,修改应用并重新部署。

学习内容

  • 使用 Cloud Shell Editor 编写 Web 应用
  • 将应用代码存储在 GitHub 中
  • 自动将应用部署到 Cloud Run
  • 使用 Vertex AI 将生成式 AI 添加到您的应用

2. 前提条件

  1. 如果您还没有 Google 账号,则必须先创建一个 Google 账号
    • 请使用个人账号,而不是工作账号或学校账号。工作账号和学校账号可能会受到限制,导致您无法启用本实验所需的 API。
  2. 如果您还没有 GitHub 账号,则必须创建 GitHub 账号

3. 项目设置

  1. 登录 Google Cloud 控制台
  2. 在 Cloud 控制台中启用结算功能
    • 完成本实验所需的 Cloud 资源费用应低于 1 美元。
    • 您可以按照本实验最后的步骤删除资源,以免产生更多费用。
    • 新用户符合参与 300 美元免费试用的条件。
    • 要参加“面向开发者的生成式 AI”活动?您可能会获得 1 美元抵用金
  3. 创建新项目或选择重复使用现有项目。
  4. 在 Cloud Billing 的我负责的项目中确认已启用结算功能
    • 如果新项目的 Billing account 列显示 Billing is disabled
      1. 点击 Actions 列中的三点状图标
      2. 点击更改结算信息
      3. 选择要使用的结算账号
    • 如果您要参加面向开发者的 Gen AI 活动,该账号的名称可能为 Google Cloud Platform 试用结算账号

4. 打开 Cloud Shell Editor

  1. 前往 Cloud Shell Editor
  2. 如果终端未显示在屏幕底部,请打开它:
    • 点击汉堡式菜单 汉堡式三线图标
    • 点击终端
    • 点击 New Terminal在 Cloud Shell Editor 中打开新终端
  3. 在终端中,使用以下命令设置项目:
    • 格式:
      gcloud config set project [PROJECT_ID]
      
    • 示例:
      gcloud config set project lab-project-id-example
      
    • 如果您不记得项目 ID,请执行以下操作:
      • 您可以使用以下命令列出所有项目 ID:
        gcloud projects list | awk '/PROJECT_ID/{print $2}'
        
      在 Cloud Shell Editor 终端中设置项目 ID
  4. 如果系统提示您进行授权,请点击授权继续。点击以授权 Cloud Shell
  5. 您应会看到以下消息:
    Updated property [core/project].
    
    如果您看到 WARNING 并收到 Do you want to continue (Y/N)? 询问,则可能输入的项目 ID 有误。按 N,按 Enter,然后尝试再次运行 gcloud config set project 命令。

5. 启用 API

在终端中,启用以下 API:

gcloud services enable \
  run.googleapis.com \
  cloudbuild.googleapis.com \
  aiplatform.googleapis.com

此命令可能需要几分钟才能完成,但最终应该会显示如下所示的成功消息:

Operation "operations/acf.p2-73d90d00-47ee-447a-b600" finished successfully.

6. 配置 Git

  1. 设置全局 Git 用户电子邮件地址:
    git config --global user.email "you@example.com"
    
  2. 设置全局 Git 用户名:
    git config --global user.name "Your Name"
    
  3. 将全局 Git 默认分支设置为 main
    git config --global init.defaultBranch main
    

7. 编写代码

如需使用 Node.js 编写应用,请执行以下操作:

  1. 前往主目录:
    cd ~
    
  2. 创建 codelab-genai 目录:
    mkdir codelab-genai
    
  3. 导航到 codelab-genai 目录:
    cd codelab-genai
    
  4. 创建 index.js 文件:
    touch index.js
    
  5. 创建 package.json 文件:
    npm init es6 -y
    
  6. express 添加为依赖项
    npm install express
    
  7. 添加了 .gitignore 文件以防止提交 node_modules
    echo node_modules/ >> .gitignore
    
  8. 在 Cloud Shell Editor 中打开 index.js 文件:
    cloudshell edit index.js
    
    现在,屏幕顶部应该会显示一个空文件。您可以在此处修改此 index.js 文件。显示该代码位于屏幕顶部
  9. 复制以下代码并将其粘贴到打开的 index.js 文件中:
    import express from 'express';
    
    const app = express();
    app.get('/', async (req, res) => {
        res.send('Hello world!');
    });
    
    const port = process.env.PORT || 8080;
    app.listen(port, () => {
        console.log(`codelab-genai: listening on port ${port}`);
    });
    
    几秒钟后,Cloud Shell 编辑器会自动保存您的代码。此代码使用我们的“Hello world!”问候语响应 HTTP 请求。

应用的初始代码已完成,可以存储在版本控制系统中。

8. 创建代码库

  1. 返回屏幕底部的 Cloud Shell 终端。
  2. 确保您仍位于正确的目录中:
    cd ~/codelab-genai
    
  3. 初始化 Git 代码库
    git init -b main
    
  4. 登录 GitHub CLI
    gh auth login
    
    Enter 接受默认选项,然后按照 GitHub CLI 工具中的说明操作,包括:
    1. 您想登录哪个账号? GitHub.com
    2. 您首选在此主机上执行 Git 操作时使用哪种协议? HTTPS
    3. 使用 GitHub 凭据对 Git 进行身份验证?Y(如果此选项未显示,请跳过。)
    4. 您想如何对 GitHub CLI 进行身份验证? Login with a web browser
    5. 复制您的动态验证码
    6. 打开 https://github.com/login/device
    7. 粘贴您的动态验证码
    8. 点击授权 GitHub
    9. 完成登录
  5. 确认您已登录:
    gh api user -q ".login"
    
    如果您已成功登录,此命令应输出您的 GitHub 用户名。
  6. 创建 GITHUB_USERNAME 变量
    GITHUB_USERNAME=$(gh api user -q ".login")
    
  7. 确认您已创建环境变量:
    echo ${GITHUB_USERNAME}
    
    如果您已成功创建该变量,此命令应输出您的 GitHub 用户名。
  8. 创建一个名为 codelab-genai 的空 GitHub 代码库:
    gh repo create codelab-genai --private
    
    如果您收到以下错误:
    GraphQL: Name already exists on this account (createRepository)
    
    这样,您就已经有了名为 codelab-genai 的代码库。您可以通过以下两种方式继续学习本教程:
  9. codelab-genai 代码库添加为远程代码库 origin
    git remote add origin https://github.com/${GITHUB_USERNAME}/codelab-genai
    

9. 分享您的代码

  1. 确认您位于正确的目录中:
    cd ~/codelab-genai
    
  2. 将当前目录中的所有文件添加到此提交中:
    git add .
    
  3. 创建第一个提交:
    git commit -m "add http server"
    
  4. 将提交推送到 origin 代码库的 main 分支:
    git push -u origin main
    

您可以运行以下命令,然后访问生成的网址,以在 GitHub 上查看应用代码:

echo -e "\n\nTo see your code, visit this URL:\n \
    https://github.com/${GITHUB_USERNAME}/codelab-genai/blob/main/index.js \n\n"

10. 设置自动部署

  1. 让 Cloud Shell Editor 标签页保持打开状态。我们稍后会返回此标签页。
  2. 在新的标签页中,访问 Cloud Run 页面
  3. 在控制台中选择正确的 Google Cloud 项目 Google Cloud 控制台项目下拉菜单
  4. 点击关联代码库
  5. 点击使用 Cloud Build 进行设置
    1. 选择 GitHub 作为代码库提供程序
      • 如果您尚未在浏览器中登录 GitHub 账号,请使用您的凭据登录。
    2. 点击身份验证,然后点击继续
    3. 登录后,您会在 Cloud Run 页面上看到一条消息,其中指出未针对您的任何代码库安装 GitHub 应用
    4. 点击 INSTALL GOOGLE CLOUD BUILD 按钮。
      • 在“Installation Setup”(安装设置)页面上,选择 Only select repositories(仅选择代码库),然后选择您通过 CLI 创建的 codelab-genai 代码库。
      • 点击安装
      • 注意:如果您有大量 GitHub 代码库,则可能需要几分钟才能加载完毕。
    5. 选择 your-user-name/codelab-genai 作为代码库
      • 如果没有看到该代码库,请点击管理关联的代码库链接。
    6. 分支保留为 ^main$
    7. 点击 Go、Node.js、Python、Java、.NET Core、Ruby 或 PHP(通过 Google Cloud Buildpack)
      • 将其他字段(Build context directoryEntrypointFunction target)保持不变。
    8. 点击保存
  6. 向下滚动到身份验证
  7. 点击允许未经身份验证的调用
  8. 点击创建 (CREATE)

构建完成(需要几分钟时间)后,运行以下命令并访问生成的网址,查看正在运行的应用:

echo -e "\n\nOnce the build finishes, visit your live application:\n \
    "$( \
        gcloud run services list | \
        grep codelab-genai | \
        awk '/URL/{print $2}' | \
        head -1 \
    )" \n\n"

11. 更改您的代码

返回 Cloud Shell Editor

如果 Cloud Shell Editor 仍处于打开状态,则可以跳过以下步骤。

  1. 前往 Cloud Shell Editor
  2. 如果终端未显示在屏幕底部,请打开它:
    • 点击汉堡式菜单 汉堡式三线图标
    • 点击终端
    • 点击 New Terminal在 Cloud Shell Editor 中打开新终端
  3. 在终端中,使用以下命令设置项目:
    • 格式:
      gcloud config set project [PROJECT_ID]
      
    • 示例:
      gcloud config set project lab-project-id-example
      
    • 如果您不记得项目 ID,请执行以下操作:
      • 您可以使用以下命令列出所有项目 ID:
        gcloud projects list | awk '/PROJECT_ID/{print $2}'
        
      在 Cloud Shell Editor 终端中设置项目 ID
  4. 如果系统提示您进行授权,请点击授权继续。点击以授权 Cloud Shell
  5. 您应会看到以下消息:
    Updated property [core/project].
    
    如果您看到 WARNING 并收到 Do you want to continue (Y/N)? 询问,则可能输入的项目 ID 有误。按 N,按 Enter,然后尝试再次运行 gcloud config set project 命令。

将 Vertex AI 添加到您的应用

  1. 返回屏幕底部的 Cloud Shell 终端。
  2. 确保您仍位于正确的目录中:
    cd ~/codelab-genai
    
  3. 安装 Node.js Vertex AI SDK:
    npm install @google-cloud/vertexai
    
  4. 安装 Node.js Google Auth SDK:
    npm install google-auth-library
    
  5. 在 Cloud Shell Editor 中重新打开 index.js
    cloudshell edit ~/codelab-genai/index.js
    
  6. index.js 文件中的代码替换为以下代码:
    import express from 'express';
    const app = express();
    
    import { VertexAI } from '@google-cloud/vertexai';
    
    import { GoogleAuth } from 'google-auth-library';
    const auth = new GoogleAuth();
    
    app.get('/', async (req, res) => {
        const project = await auth.getProjectId();
    
        const vertex = new VertexAI({ project: project });
        const generativeModel = vertex.getGenerativeModel({
            model: 'gemini-1.5-flash'
        });
    
        const animal = req.query.animal || 'dog';
        const prompt = `Give me 10 fun facts about ${animal}. Return this as html without backticks.`
        const resp = await generativeModel.generateContent(prompt);
        const html = resp.response.candidates[0].content.parts[0].text;
        res.send(html);
    });
    
    const port = parseInt(process.env.PORT) || 8080;
    app.listen(port, () => {
        console.log(`codelab-genai: listening on port ${port}`);
    });
    

12. 重新部署

  1. 确保您仍在 Cloud Shell 中的正确目录中:
    cd ~/codelab-genai
    
  2. 运行以下命令,将应用的新版本提交到本地 Git 代码库:
    git add .
    git commit -m "add latest changes"
    
  3. 将更改推送到 GitHub:
    git push
    
  4. 构建完成后,运行以下命令并访问已部署的应用:
    echo -e "\n\nOnce the build finishes, visit your live application:\n \
        "$( \
            gcloud run services list | \
            grep codelab-genai | \
            awk '/URL/{print $2}' | \
            head -1 \
        )" \n\n"
    

构建过程可能需要几分钟才能完成,之后您才能看到所做的更改。

您可以在此处查看所有修订版本的历史记录:https://console.cloud.google.com/run/detail/us-central1/codelab-genai/revisions

13. (可选)审核您的 Vertex AI 使用情况

与其他 Google Cloud 服务一样,您可以审核 Vertex AI 操作。审核日志可帮助您回答“哪些用户何时在何处执行了什么操作”的问题。Vertex AI 的管理员审核日志默认处于启用状态。如需审核生成内容的请求,您必须启用数据访问审核日志

  1. 在 Google Cloud 控制台中,前往审核日志页面:

    如果您使用搜索栏查找此页面,请选择子标题为 IAM 和管理的结果。
  2. 确保您创建 Cloud Run 应用时使用的 Google Cloud 项目就是该现有项目。
  3. 数据访问审核日志配置表中,从“服务”列中选择 Vertex AI API
  4. 日志类型标签页中,选择数据访问审核日志类型 Admin readData read
  5. 点击保存

启用该功能后,您将能够查看应用每次调用的审核日志。如需查看包含调用详细信息的审核日志,请执行以下操作:

  1. 返回已部署的应用,然后刷新页面以触发日志。
  2. 在 Google Cloud 控制台中,前往日志浏览器页面:

  3. 在查询窗口中,输入以下内容:
    LOG_ID("cloudaudit.googleapis.com%2Fdata_access")
    protoPayload.serviceName="aiplatform.googleapis.com"
    
  4. 点击运行查询

审核日志会记录 Vertex AI API 的使用情况,但您无法通过审核日志查看与工作负载相关的数据,例如提示或回答详情。

14. (可选)提高 AI 工作负载的可观测性

审核日志不会捕获与工作负载相关的信息。为了提高工作负载的可观察性,您必须明确记录此类信息。您可以使用自己偏好的日志记录框架来实现此目的。以下步骤演示了如何使用原生 Node.js 日志记录机制执行此操作。

  1. 在 Cloud Shell Editor 中重新打开 index.js
    cloudshell edit ~/codelab-genai/index.js
    
  2. 在对 await generativeModel.generateContent(prompt) 的调用(第 19 行)后面,添加以下代码行:
        console.log(JSON.stringify({
            severity: 'DEBUG',
            message: 'Content is generated',
            prompt: prompt,
            response: resp.response,
        }));
    
    此代码使用结构化日志记录格式将有关生成的内容的信息写入 stdout。Cloud Run 中的日志记录代理会捕获输出到 stdout 的内容,并此格式写入 Cloud Logging。
  3. 重新打开 Cloud Shell,然后输入以下命令,确保您位于正确的目录中:
    cd ~/codelab-genai
    
  4. 提交更改:
    git commit -am "observe generated content"
    
  5. 将更改推送到 GitHub,以触发修改后的版本的重新部署:
    git push
    

新版本部署后,您可以观察与调用 Vertex AI 相关的调试信息。

如需查看应用日志,请执行以下操作:

  1. 在 Google Cloud 控制台中,前往日志浏览器页面:

  2. 在查询窗口中,输入以下内容:
    LOG_ID("run.googleapis.com%2Fstdout")
    severity=DEBUG
    
  3. 点击运行查询

查询结果会显示包含问题和 Vertex AI 回答的日志,其中包括可用于监控安全做法的“安全评分”

15. (可选)清理

虽然 Cloud Run 不会对未在使用中的服务计费,但您可能仍然需要为将容器映像存储在 Artifact Registry 中而产生的相关费用付费。您可以删除 Cloud 项目,以避免产生费用。删除 Cloud 项目后,系统即会停止对该项目中使用的所有资源计费。

如需删除项目,请执行以下操作:

gcloud projects delete $GOOGLE_CLOUD_PROJECT

您可能还希望从 Cloud Shell 磁盘中删除不必要的资源。您可以:

  1. 删除 Codelab 项目目录:
    rm -rf ~/codelab-genai
    
  2. 警告!此操作无法撤消!如果您想删除 Cloud Shell 中的所有内容以释放空间,可以删除整个主目录。请务必将您要保留的所有内容保存到其他位置。
    sudo rm -rf $HOME
    

16. 恭喜

在本实验中,您编写了一个 Web 应用,并配置了 Cloud Run,以便在应用的源代码发生更改时自动部署应用。然后,您修改了应用并重新部署了应用。

如果您喜欢本实验,可以使用其他编程语言或框架再次尝试:

如果您有兴趣参与用户体验 (UX) 调研,以便改进您目前使用的 Google 产品,请点击此处报名

以下是继续学习的几种方法: