快速起步解决方案:借助 Cloud Functions 函数处理 AI/机器学习图片

Last reviewed 2023-08-29 UTC

本指南可帮助您了解、部署和使用借助 Cloud Functions 函数处理 AI/机器学习图片快速起步解决方案。此解决方案使用预训练的机器学习模型来分析用户提供的图片并生成图片注释。

部署此解决方案会创建一种图片处理服务,该服务可帮助您执行以下操作:

  • 处理不安全或有害的用户生成的内容。
  • 将纸质文档的文本数字化。
  • 检测图片中的对象并对其进行分类。

本文档面向熟悉后端服务开发、AI/机器学习功能以及基本云计算概念的开发者。虽然并非必需,但 Terraform 体验非常有用。

目标

  • 了解如何使用无服务器架构创建可扩缩的图片处理服务。
  • 了解图片处理服务如何使用预训练的机器学习模型进行图片分析。
  • 部署图片处理服务,并通过 REST API 调用或在对图片上传事件作出响应时调用该服务。
  • 查看配置和安全设置,了解如何根据不同需求调整图片处理服务。

使用的产品

此解决方案使用以下 Google Cloud 产品:

  • Cloud Vision API:一个为图片注释提供强大的预训练机器学习模型的 API。此解决方案使用 Cloud Vision API 来分析图片,并获取图片注释数据。
  • Cloud Storage:一种企业级服务,为各种数据类型提供费用低廉、不受限制的对象存储。可从 Google Cloud 内部和外部访问数据,并以地理位置冗余方式复制数据。 此解决方案使用 Cloud Storage 来存储输入图片和生成的图片注释数据。
  • Cloud Functions 函数:一种轻量级无服务器计算服务,可让您创建单一用途的独立函数来对 Google Cloud 事件作出响应,而无需管理服务器或运行时环境。此解决方案使用 Cloud Functions 函数来托管图片处理服务的端点。

如需了解这些产品的配置方式和交互方式,请查看下一部分。

架构

此解决方案包含一个示例图片处理服务,该服务使用预训练的机器学习模型分析输入图片并为图片生成注释。下图显示了解决方案中使用的 Google Cloud 资源的架构。

“借助 Cloud Functions 函数处理 AI/机器学习图片”这一解决方案所需的基础架构。

该服务可通过两种方式调用:通过“REST API 调用”直接调用,或在对图片上传作出响应时间接调用。

请求流程

图片处理服务的请求处理流程取决于用户如何调用该服务。以下步骤按前面的架构图所示进行了编号。

当用户通过“REST API 调用”直接调用图片处理服务时:

  1. 用户向图片处理服务的 REST API 端点(部署为 Cloud Functions 函数)发出请求。该请求将图片指定为 URI 或 base64 编码的数据流。
  2. Cloud Functions 函数会调用 Cloud Vision API,以便为指定图片生成注释。图片注释数据在该函数对用户作出响应时以 JSON 格式返回。

当用户在对图片上传作出响应时间接调用图片处理服务时:

  1. 用户将图片上传到 Cloud Storage 存储桶以供输入。
  2. 每次上传图片都会生成一个 Cloud Storage 事件,该事件会触发 Cloud Functions 函数,以处理上传的图片。
  3. Cloud Functions 函数会调用 Cloud Vision API,以便为指定图片生成注释。
  4. Cloud Functions 函数会将图片注释数据作为 JSON 文件写入另一个 Cloud Storage 存储桶以供输出。

费用

如需估算“借助 Cloud Functions 函数处理 AI/机器学习图片”这一解决方案所使用的 Google Cloud 资源的费用,请参阅 Google Cloud 价格计算器中预先计算的估算值。

使用估算值作为起点来计算部署费用。您可以修改估算值,以反映您计划对解决方案中使用的资源进行的任何配置更改。

系统会基于某些因素(包括以下因素)做出预先计算的估算:

  • 部署资源的 Google Cloud 位置。
  • 资源的使用时间。

  • 存储在 Cloud Storage 中的数据量。

  • 图片处理服务的调用次数。

部署解决方案

本部分将引导您完成解决方案部署过程。

创建或选择 Google Cloud 项目

部署解决方案时,您需要选择部署资源的 Google Cloud 项目。在决定是使用现有项目还是创建新项目时,请考虑以下因素:

  • 如果您为解决方案创建了项目,那么当您不再需要部署时,可以删除该项目以避免继续计费。如果您使用的是现有项目,则必须删除不再需要的部署。
  • 使用新项目有助于避免与先前预配的资源(例如用于生产工作负载的资源)发生冲突。

如果要在新项目中部署解决方案,请在开始部署之前创建项目。

如需创建项目,请完成以下步骤:

  1. 在 Google Cloud Console 中,转到项目选择器页面。

    转到“项目选择器”

  2. 要开始创建 Google Cloud 项目,请点击创建项目

  3. 为您的项目命名。记下生成的项目 ID。

  4. 根据需要修改其他字段。

  5. 如需创建项目,请点击创建

获取所需的 IAM 权限

如需开始部署过程,您需要下表中列出的 Identity and Access Management (IAM) 权限。如果您拥有计划在其中部署解决方案的项目的 roles/owner 基本角色,则您已经拥有所有必要的权限。如果您没有 roles/owner 角色,请让管理员授予您这些权限(或包含这些权限的角色)。

所需的 IAM 权限 包含所需权限的预定义角色

serviceusage.services.enable

Service Usage Admin
(roles/serviceusage.serviceUsageAdmin)

iam.serviceAccounts.create

Service Account Admin
(roles/iam.serviceAccountAdmin)

resourcemanager.projects.setIamPolicy

Project IAM Admin
(roles/resourcemanager.projectIamAdmin)
config.deployments.create
config.deployments.list
Cloud Infrastructure Manager Admin
(roles/config.admin)

为解决方案创建的服务账号

如果您通过控制台启动部署过程,则 Google 会创建一个服务账号,用于代表您部署解决方案(以及稍后删除部署)。系统会临时为此服务账号分配某些 IAM 权限;也就是说,在解决方案部署和删除操作完成后,会自动撤消这些权限。Google 建议您在删除部署后删除服务账号,如本指南后面部分所述。

查看分配给服务账号的角色

此处列出了这些角色,以防 Google Cloud 项目或组织的管理员需要此信息。

  • roles/serviceusage.serviceUsageAdmin
  • roles/iam.serviceAccountAdmin
  • roles/resourcemanager.projectIamAdmin
  • roles/cloudfunctions.admin
  • roles/run.admin
  • roles/storage.admin
  • roles/pubsublite.admin
  • roles/iam.securityAdmin
  • roles/logging.admin
  • roles/artifactregistry.reader
  • roles/cloudbuild.builds.editor
  • roles/compute.admin
  • roles/iam.serviceAccountUser

选择部署方法

为了减少您部署此解决方案所需的工作量,GitHub 中提供了 Terraform 配置。Terraform 配置定义了解决方案需要的所有 Google Cloud 资源。

您可以使用以下任一方法来部署解决方案:

  • 通过控制台:如果您要试用采用默认配置的解决方案并了解其工作原理,请使用此方法。Cloud Build 会部署此解决方案需要的所有资源。如果您不再需要部署的解决方案,可以通过控制台将其删除。您在部署解决方案后创建的任何资源都可能需要单独删除。

    如需使用此部署方法,请按照通过控制台进行部署中的说明操作。

  • 使用 Terraform CLI:如果您要自定义解决方案,或者要使用基础架构即代码 (IaC) 方法自动预配和管理资源,请使用此方法。从 GitHub 下载 Terraform 配置,根据需要选择性地自定义代码,然后使用 Terraform CLI 部署解决方案。部署解决方案后,您可以继续使用 Terraform 来管理解决方案。

    如需使用此部署方法,请按照使用 Terraform CLI 进行部署中的说明操作。

通过控制台进行部署

完成以下步骤以部署预配置的解决方案。

  1. 在 Google Cloud 快速起步解决方案目录中,转到借助 Cloud Functions 函数处理 AI/机器学习图片这一解决方案。

    转到“借助 Cloud Functions 函数处理 AI/机器学习图片”这一解决方案

  2. 查看页面上提供的信息,例如解决方案的预计费用和预计部署时间。

  3. 准备好开始部署解决方案后,请点击部署

    此时会显示分步交互式指南。

  4. 完成交互式指南中的步骤。

    请记下您输入的部署名称。在稍后删除部署时需要此名称。

    点击部署后,系统会显示解决方案部署页面。此页面的状态字段显示正在部署

  5. 等待解决方案部署。

    如果部署失败,状态字段将显示失败。您可以使用 Cloud Build 日志来诊断错误。如需了解详情,请参阅通过控制台部署时出错

    部署完成后,状态字段将更改为已部署

  6. 如需查看已部署的 Google Cloud 资源及其配置,请进入交互式导览。

    开始导览

接下来,如需亲自试用此解决方案,请参阅探索此解决方案

如果您不再需要此解决方案,可以将部署删除,以免继续为 Google Cloud 资源计费。如需了解详情,请参阅删除部署

使用 Terraform CLI 进行部署

本部分介绍如何使用 Terraform CLI 自定义解决方案或自动预配和管理解决方案。使用 Terraform CLI 部署的解决方案不会显示在 Google Cloud 控制台的解决方案部署页面中。

设置 Terraform 客户端

您可以在 Cloud Shell 或本地主机上运行 Terraform。本指南介绍如何在 Cloud Shell 中运行 Terraform,其中预安装了 Terraform 并将其配置为向 Google Cloud 进行身份验证。

GitHub 代码库中提供了此解决方案的 Terraform 代码。

  1. 将 GitHub 代码库克隆到 Cloud Shell。

    在 Cloud Shell 中打开

    系统会显示一条提示,要求您确认将 GitHub 代码库下载到 Cloud Shell。

  2. 点击确认

    Cloud Shell 会在单独的浏览器标签页中启动,而 Terraform 代码会下载到 Cloud Shell 环境的 $HOME/cloudshell_open 目录中。

  3. 在 Cloud Shell 中,检查当前工作目录是否为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。这是包含此解决方案的 Terraform 配置文件的目录。如果您需要切换到该目录,请运行以下命令:

    cd $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra
    
  4. 通过运行以下命令来初始化 Terraform:

    terraform init
    

    等待系统显示以下消息:

    Terraform has been successfully initialized!
    

配置 Terraform 变量

您下载的 Terraform 代码包含可用于根据需要自定义部署的变量。例如,您可以指定 Google Cloud 项目以及要在其中部署解决方案的区域。

  1. 确保当前工作目录为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。如果不是,请转到该目录。

  2. 在同一目录中,创建一个名为 terraform.tfvars 的文本文件。

  3. terraform.tfvars 文件中,复制以下代码段,并为所需的变量设置值。

    • 按照代码段中作为注释提供的说明进行操作。
    • 此代码段仅包含您必须为其设置值的变量。Terraform 配置包括具有默认值的其他变量。如需查看所有变量和默认值,请参阅 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra 目录中提供的 variables.tf 文件。
    • 确保您在 terraform.tfvars 文件中设置的每个值都与 variables.tf 文件中声明的变量类型匹配。例如,如果为 variables.tf 文件中的变量定义的类型为 bool,则必须将 truefalse 指定为该变量在 terraform.tfvars 文件中的值。
    # This is an example of the terraform.tfvars file.
    # The values in this file must match the variable types declared in variables.tf.
    # The values in this file override any defaults in variables.tf.
    
    # ID of the project in which you want to deploy the solution
    project_id = "PROJECT_ID"
    

验证并查看 Terraform 配置

  1. 确保当前工作目录为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。如果不是,请转到该目录。

  2. 验证 Terraform 配置没有错误:

    terraform validate
    

    如果该命令返回任何错误,请在配置中进行所需的更正,然后再次运行 terraform validate 命令。重复此步骤,直到命令返回以下消息:

    Success! The configuration is valid.
    
  3. 查看配置中定义的资源:

    terraform plan
    
  4. 如果您未按照上文所述创建 terraform.tfvars 文件,则 Terraform 会提示您为没有默认值的变量输入值。输入必需的值。

    terraform plan 命令的输出是在应用配置时 Terraform 预配的资源列表。

    如果要进行任何更改,请修改配置,然后再次运行 terraform validateterraform plan 命令。

预配资源

如果 Terraform 配置中不需要进一步更改,请部署资源。

  1. 确保当前工作目录为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。如果不是,请转到该目录。

  2. 应用 Terraform 配置:

    terraform apply
    
  3. 如果您未按照上文所述创建 terraform.tfvars 文件,则 Terraform 会提示您为没有默认值的变量输入值。输入必需的值。

    Terraform 会显示将创建的资源列表。

  4. 当系统提示您执行操作时,请输入 yes

    Terraform 展示一些显示部署进度的消息。

    如果无法完成部署,则 Terraform 会显示导致失败的错误。查看错误消息,并更新配置以修复错误。然后,再次运行 terraform apply 命令。如需有关排查 Terraform 错误的帮助,请参阅使用 Terraform CLI 部署解决方案时出错

    创建完所有资源后,Terraform 会显示以下消息:

    Apply complete!
    

    Terraform 输出还包括图片处理服务的入口点网址、用于上传图片的输入 Cloud Storage 存储桶的名称,以及包含图片注释数据的输出 Cloud Storage 存储桶的名称,具体如以下示例输出中所示:

    vision_annotations_gcs = "gs://vision-annotations-1234567890"
    vision_input_gcs = "gs://vision-input-1234567890"
    vision_prediction_url = [
      "https://annotate-http-abcde1wxyz-wn.a.run.app",
      "ingressIndex:0",
      "ingressValue:ALLOW_ALL",
      "isAuthenticated:false",
    ]
    
  5. 如需查看已部署的 Google Cloud 资源及其配置,请进入交互式导览。

    开始导览

接下来,您可以探索此解决方案,了解其工作原理。

如果您不再需要此解决方案,可以将部署删除,以免继续为 Google Cloud 资源计费。如需了解详情,请参阅删除部署

探索此解决方案

在本部分中,您可以尝试使用此解决方案来查看其实际效果。您可以通过两种方式调用图片处理服务:直接调用其 REST API,或将图片上传到输入 Cloud Storage 存储桶。

通过 REST API 调用服务

如果您希望在请求-响应流程中同步处理图片,请使用图片处理服务的 REST API。

此解决方案部署的 annotate-http 函数是图片处理服务的 REST API 的入口点。您可以在控制台中找到此函数的网址;如果您是使用 Terraform CLI 进行部署,则可以在输出变量 vision_prediction_url 中找到此函数的网址。此入口点网址公开了一个名为 /annotate 的端点,用于发出图片处理请求。/annotate 端点支持具有以下参数的 GETPOST 请求:

参数 说明
image (仅限 POST 请求)图片内容,它们采用二进制格式上传或指定为 base64 编码的图片数据。
image_uri 指向图片的 URI。
features (可选)要请求的 Vision API 注释功能的逗号分隔列表。

可能的特征值是:
  • CROP_HINTS
  • DOCUMENT_TEXT_DETECTION
  • FACE_DETECTION
  • IMAGE_PROPERTIES
  • LABEL_DETECTION
  • LANDMARK_DETECTION
  • LOGO_DETECTION
  • OBJECT_LOCALIZATION
  • PRODUCT_SEARCH
  • SAFE_SEARCH_DETECTION
  • TEXT_DETECTION
  • WEB_DETECTION

如需指定要分析的图片,请仅包含 imageimage_uri 这两个参数之一。如果同时指定这两个参数,则使用 image_uri

例如,如需对使用互联网 URI 的图片执行对象检测,您可以使用 curl 发送如下 GET 请求:

curl "YOUR_ENTRYPOINT_URL/annotate?features=OBJECT_LOCALIZATION&image_uri=YOUR_IMAGE_URI"

或者,要直接使用本地图片文件指定图片内容,您可以使用如下 POST 请求:

curl -X POST -F image=@YOUR_IMAGE_FILENAME -F features=OBJECT_LOCALIZATION "YOUR_ENTRYPOINT_URL/annotate"

响应包含 JSON API 格式的 Vision API 的图片注释。

通过将图片上传到 Cloud Storage 来调用服务

如果要异步处理图片或者批量上传图片,请使用图片处理服务的 Cloud Storage 触发器,该触发器会自动调用服务,以便对图片上传作出响应。

按照以下步骤使用 Cloud Storage 触发器分析图片:

  1. 在控制台中,转到 Cloud Storage 存储桶页面。

    转到 Cloud Storage

  2. 点击输入存储桶的名称 (vision-input-ID),以转到其存储桶详情页面。

  3. 对象标签页中,点击上传文件

  4. 选择要分析的图片文件。

  5. 上传完成后,返回到 Cloud Storage 存储桶页面。

    转到 Cloud Storage

  6. 点击注释输出存储桶的名称 (vision-annotations-ID) 以转到其存储桶详情页面。

  7. 对象标签页包含相对于您上传的每个图片而言单独的 JSON 文件。JSON 文件包含每个图片的注释数据。

自定义解决方案

本部分提供的信息可供 Terraform 开发者用于修改“借助 Cloud Functions 函数处理 AI/机器学习图片”这一解决方案,以满足其自己的技术和业务要求。仅当您使用 Terraform CLI 部署解决方案时,本部分中的指导才具有相关性。

此解决方案的 Terraform 配置提供了以下可用于自定义图片处理服务的变量:

变量 说明 默认值
region 要在其中部署 Cloud Functions 函数和其他解决方案资源的 Google Cloud 区域。如需了解详情,请参阅 Cloud Functions 函数位置 us-west4
gcf_max_instance_count 该服务的 Cloud Functions 函数实例数上限。 这有助于控制该服务的扩缩行为。如需了解详情,请参阅使用实例数上限 10
gcf_timeout_seconds 向该服务发出请求时的超时时间(以秒为单位)。这将控制该服务的响应时间。如需了解详情,请参阅函数超时 120
gcf_http_ingress_type_index 控制该服务是否可以由 Google Cloud 项目之外的资源调用。如需了解详情,请参阅入站流量设置

可能的值包括:
  • 0(全部允许)
  • 1(仅允许内部)
  • 2(允许内部和 Cloud Load Balancing)
0(全部允许)
gcf_require_http_authentication 控制是否需要进行身份验证才能向该服务发出请求。如需了解详情,请参阅进行身份验证以便调用 false
gcf_annotation_features 该服务默认包含的 Vision API 注释功能逗号分隔列表。该列表可以替换各个请求。

可能的特征值是:
  • CROP_HINTS
  • DOCUMENT_TEXT_DETECTION
  • FACE_DETECTION
  • IMAGE_PROPERTIES
  • LABEL_DETECTION
  • LANDMARK_DETECTION
  • LOGO_DETECTION
  • OBJECT_LOCALIZATION
  • PRODUCT_SEARCH
  • SAFE_SEARCH_DETECTION
  • TEXT_DETECTION
  • WEB_DETECTION
FACE_DETECTION,PRODUCT_SEARCH,SAFE_SEARCH_DETECTION

如需自定义解决方案,请在 Cloud Shell 中完成以下步骤:

  1. 确保当前工作目录为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。 如果不是,请转到该目录。

  2. 打开 terraform.tfvars 文件并进行所需的更改,为上一张表格中列出的变量指定适当的值。

  3. 验证并查看 Terraform 配置

  4. 预配资源

设计建议

在通过更改提供的 Terraform 变量的值或修改 Terraform 配置本身来对此解决方案做出修改时,请参阅本部分中的资源,以帮助您开发符合安全性、可靠性、费用和性能等方面的要求的架构。

请注意以下几点:

  • 在进行任何设计更改之前,请评估费用影响并考虑与其他功能的潜在权衡。您可以使用 Google Cloud 价格计算器评估设计更改的费用影响。
  • 要在解决方案中实现设计更改,您需要具备 Terraform 编码方面的专业知识,以及解决方案中使用的 Google Cloud 服务的高级知识。
  • 如果您修改了 Google 提供的 Terraform 配置,然后遇到错误,请在 GitHub 中创建问题。GitHub 问题会尽量得到查看,且不适用于一般使用问题。
  • 如需详细了解如何在 Google Cloud 中设计和设置生产级环境,请参阅 Google Cloud 中的着陆区设计Google Cloud 设置核对清单

安全

默认情况下,图片处理服务允许来自互联网的请求,并且不需要针对请求进行身份验证。在生产环境中,您可能需要限制对该服务的访问权限。

您可以通过修改 gcf_http_ingress_type_index Terraform 变量来控制允许向服务发出请求的位置。请保持谨慎,切勿无意间使解决方案的服务端点能够在互联网上公开访问。如需了解详情,请参阅 Cloud Functions 函数文档中的配置网络设置

通过修改 gcf_require_http_authentication Terraform 变量,您可以要求针对图片处理服务的 REST API 的请求进行身份验证。这有助于对该服务的个人访问权限进行控制。如果您需要进行身份验证,则该服务的调用者必须提供凭据才能发出请求。如需了解详情,请参阅 Cloud Functions 函数文档中的进行身份验证以便调用

如需了解更多安全建议,请参阅 Google Cloud 架构框架指南中关于安全性、隐私权和合规性的内容。

可靠性

当用户将图片上传到输入 Cloud Storage 存储桶时,他们生成的注释输出可能会出现不同程度的延时。默认情况下,用户必须轮询输出存储桶,以确定注释何时可用。要让您的应用在图片处理完成后立即可靠地采取行动,您可以订阅输出存储桶中的 Cloud Storage 事件。例如,您可以部署另一个 Cloud Functions 函数来处理注释数据;如需了解详情,请参阅 Cloud Functions 函数文档中的 Cloud Storage 触发器

如需更多建议,请参阅以下指南,以帮助优化此解决方案中使用的产品的可靠性:

性能

图片处理服务的吞吐量直接受 Cloud Functions 函数扩缩能力影响。Cloud Functions 函数通过创建函数实例来自动扩缩,从而处理传入流量负载,最高可达到可配置实例数上限。您可以通过更改实例数上限或完全移除该限制来控制函数的扩缩,进而控制图片处理服务的吞吐量。使用 gcf_max_instance_count Terraform 变量更改限制。如需了解详情,请参阅 Cloud Functions 函数文档中的使用最大实例数自动扩缩行为

此外,您还可以通过遵循以下最佳实践来帮助优化性能:

费用

请遵循以下指南中的建议,以帮助优化解决方案的费用:

删除部署

如果不再需要解决方案部署,为避免继续为创建的资源计费,请删除部署。

通过控制台删除

如果您通过控制台部署了解决方案,请按以下流程操作。

  1. 在 Google Cloud 控制台中,转到解决方案部署页面。

    转到“解决方案部署”

  2. 选择您要删除的部署所在的项目。

  3. 找到您要删除的部署。

  4. 点击 操作,然后选择删除

  5. 输入部署的名称,然后点击确认

    状态字段显示正在删除

    如果删除失败,请参阅删除部署时出错中的问题排查指南。

如果您不再需要用于此解决方案的 Google Cloud 项目,则可以删除该项目。如需了解详情,请参阅可选:删除项目

使用 Terraform CLI 进行删除

如果您使用 Terraform CLI 部署了解决方案,请按照以下步骤操作。

  1. 在 Cloud Shell 中,确保当前工作目录为 $HOME/cloudshell_open/terraform-ml-image-annotation-gcf/infra。如果不是,请转到该目录。

  2. 移除 Terraform 预配的资源:

    terraform destroy
    

    Terraform 会显示将被销毁的资源列表。

  3. 当系统提示您执行操作时,请输入 yes

    Terraform 会显示显示进度的消息。删除所有资源后,Terraform 将显示以下消息:

    Destroy complete!
    

    如果删除失败,请参阅删除部署时出错中的问题排查指南。

如果您不再需要用于此解决方案的 Google Cloud 项目,则可以删除该项目。如需了解详情,请参阅可选:删除项目

可选:删除项目

如果您在新的 Google Cloud 项目中部署了解决方案,但不再需要该项目,请完成以下步骤来将其删除:

  1. 在 Google Cloud 控制台中,进入管理资源页面:

    打开“管理资源”

  2. 在项目列表中,选择要删除的项目,然后点击删除
  3. 在提示符处,输入项目 ID,然后点击关停

如果您决定保留项目,请删除为此解决方案创建的服务账号,如下一部分所述。

可选:删除服务账号

如果删除了用于解决方案的项目,请跳过此部分。

如本指南前面部分所述,当您部署解决方案时,系统代表您创建了一个服务账号。系统为服务账号临时分配了某些 IAM 权限;也就是说,在解决方案的部署和删除操作完成后,系统会自动撤消这些权限,但不会删除服务账号。Google 建议您删除此服务账号。

  • 如果您通过 Google Cloud 控制台部署了解决方案,请进入解决方案部署页面。(如果您已进入该页面,请刷新浏览器。)系统会在后台触发进程来删除服务账号。无需进一步操作。

  • 如果您使用 Terraform CLI 部署了解决方案,请完成以下步骤:

    1. 在 Google Cloud 控制台中,转到服务账号页面。

      转到“服务账号”

    2. 选择您用于解决方案的项目。

    3. 选择要删除的服务账号。

      为解决方案创建的服务账号的电子邮件 ID 采用以下格式:

      goog-sc-DEPLOYMENT_NAME-NNN@PROJECT_ID.iam.gserviceaccount.com
      

      电子邮件 ID 包含以下值:

      • DEPLOYMENT_NAME:部署的名称。
      • NNN:随机 3 位数。
      • PROJECT_ID:部署了解决方案的项目的 ID。
    4. 点击删除

排查错误

可以诊断和解决错误的操作取决于部署方法和错误的复杂程度。

通过控制台进行部署时发生错误

如果您使用控制台时部署失败,请执行以下操作:

  1. 转到解决方案部署页面。

    如果部署失败,状态字段将显示失败

  2. 查看导致失败的错误的详细信息:

    1. 点击 操作

    2. 选择查看 Cloud Build 日志

  3. 查看 Cloud Build 日志,并采取适当的措施来解决导致失败的问题。

使用 Terraform CLI 进行部署时发生错误

如果在使用 Terraform 时部署失败,terraform apply 命令的输出将包含错误消息,您可以查看这些错误消息以诊断问题。

以下部分中的示例显示了您在使用 Terraform 时可能会遇到的部署错误。

未启用 API

如果您创建了一个项目,然后立即尝试在新项目中部署此解决方案,则部署可能会失败,并显示如下错误:

Error: Error creating Network: googleapi: Error 403: Compute Engine API has not
been used in project PROJECT_ID before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/compute.googleapis.com/overview?project=PROJECT_ID
then retry. If you enabled this API recently, wait a few minutes for the action
to propagate to our systems and retry.

如果发生此错误,请等待几分钟,然后再次运行 terraform apply 命令。

如果“未启用 API”错误仍然存在,请点击错误消息中的链接以启用 API。等待 API 启用,然后再次运行 terraform apply 命令。

无法分配请求的地址

运行 terraform apply 命令时,可能会发生 cannot assign requested address 错误,并显示如下消息:

Error: Error creating service account:
 Post "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts:
 dial tcp [2001:db8:ffff:ffff::5f]:443:
 connect: cannot assign requested address

如果发生此错误,请再次运行 terraform apply 命令。

删除部署时出错

在某些情况下,尝试删除部署可能会失败:

  • 通过控制台部署解决方案后,如果您更改此解决方案预配的任何资源,然后尝试删除部署,则删除操作可能会失败。解决方案部署页面上的状态字段会显示失败,并且 Cloud Build 日志会显示错误原因。
  • 使用 Terraform CLI 部署解决方案后,如果您使用非 Terraform 界面(例如控制台)更改任何资源,然后尝试删除部署,则删除操作可能会失败。terraform destroy 命令输出中的消息会显示错误的原因。

查看错误日志和消息,找出并删除导致错误的资源,然后再次尝试删除部署。

如果基于控制台的部署未删除,并且您无法使用 Cloud Build 日志诊断错误,则可以使用 Terraform CLI 删除该部署,如下一部分所述。

使用 Terraform CLI 删除基于控制台的部署

本部分介绍在尝试通过控制台删除基于控制台的部署出错时如何删除该部署。在此方法中,您可以下载要删除的部署的 Terraform 配置,然后使用 Terraform CLI 删除部署。

  1. 确定部署的 Terraform 代码、日志和其他数据的存储区域。此区域可能与您在部署解决方案时选择的区域不同。

    1. 在 Google Cloud 控制台中,转到解决方案部署页面。

      转到“解决方案部署”

    2. 选择您要删除的部署所在的项目。

    3. 在部署列表中,找到要删除的部署所在的行。

    4. 点击 查看所有行内容

    5. 位置列中,记下第二个位置,如以下示例中突出显示部分所示:

      部署代码、日志和其他工件的位置。

  2. 在 Google Cloud 控制台中,激活 Cloud Shell。

    激活 Cloud Shell

    Cloud Shell 会话随即会在 Google Cloud 控制台的底部启动,并显示命令行提示符。Cloud Shell 是一个已安装 Google Cloud CLI 且已为当前项目设置值的 Shell 环境。该会话可能需要几秒钟时间来完成初始化。

  3. 为要删除的部署的项目 ID、区域和名称创建环境变量:

    export REGION="REGION"
    export PROJECT_ID="PROJECT_ID"
    export DEPLOYMENT_NAME="DEPLOYMENT_NAME"
    

    在这些命令中,替换以下内容:

    • REGION:您先前在此过程中记下的位置。
    • PROJECT_ID:您在其中部署解决方案的项目的 ID。
    • DEPLOYMENT_NAME:您要删除的部署的名称。
  4. 获取您要删除的最新修订版本部署的 ID:

    export REVISION_ID=$(curl \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
        | jq .latestRevision -r)
        echo $REVISION_ID
    

    输出类似于以下内容:

    projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME/revisions/r-0
    
  5. 获取该部署的 Terraform 配置的 Cloud Storage 位置:

    export CONTENT_PATH=$(curl \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/${REVISION_ID}" \
        | jq .applyResults.content -r)
        echo $CONTENT_PATH
    

    以下是此命令的输出示例:

    gs://PROJECT_ID-REGION-blueprint-config/DEPLOYMENT_NAME/r-0/apply_results/content
    
  6. 将 Terraform 配置从 Cloud Storage 下载到 Cloud Shell:

    gsutil cp -r $CONTENT_PATH $HOME
    cd $HOME/content/infra
    

    等到系统显示 Operation completed 消息,如以下示例所示:

    Operation completed over 45 objects/268.5 KiB
    
  7. 初始化 Terraform:

    terraform init
    

    等待系统显示以下消息:

    Terraform has been successfully initialized!
    
  8. 移除已部署的资源:

    terraform destroy
    

    Terraform 会显示将被销毁的资源列表。

    如果显示的警告与未声明变量有关,请忽略这些警告。

  9. 当系统提示您执行操作时,请输入 yes

    Terraform 会显示显示进度的消息。删除所有资源后,Terraform 将显示以下消息:

    Destroy complete!
    
  10. 删除部署工件:

    curl -X DELETE \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}?force=true&delete_policy=abandon"
    
  11. 等待几秒钟,然后验证部署工件是否已删除:

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
        | jq .error.message
    

    如果输出显示 null,请等待几秒钟,然后再次运行该命令。

    删除部署工件后,系统会显示一条如以下示例所示的消息:

    Resource 'projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME' was not found
    

提交反馈

快速起步解决方案仅供参考,并非官方支持的产品。Google 可能会在不事先通知的情况下更改或移除解决方案。

如需排查错误,请查看 Cloud Build 日志和 Terraform 输出。

如需提交反馈,请执行以下操作:

  • 对于文档、控制台教程或解决方案,请使用页面上的发送反馈按钮。
  • 对于未经修改的 Terraform 代码,请在 GitHub 代码库中创建问题。 GitHub 问题会尽量得到查看,且不适用于一般使用问题。

后续步骤