快速起步解决方案：大型数据共享 Golang Web 应用

Last reviewed 2023-06-27 UTC

本指南可帮助您了解、部署和使用大型数据共享 Golang Web 应用快速起步解决方案。此解决方案演示了如何构建能够传送大量文件的应用。

如果您想使用 Java 而不是 Go，请参阅大型数据共享 Java Web 应用快速起步解决方案。

本文档适用于对构建 Web 应用具有一定背景的开发者。本文档假定您熟悉 Go 编程语言和基本的云技术概念，但不一定熟悉 Google Cloud。拥有 Terraform 经验会很有帮助。

目标

了解大型数据共享用户模式。
在基于云的对象存储服务中存储和传送对象。
部署使用分布式分发网络来传送多个对象的应用。
在每一层中保护对象，以获得最低访问权限。

使用的产品

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

Cloud CDN（内容分发网络）：在全球范围内快速可靠地分发 Web 内容和视频。
Cloud Storage：一种企业级服务，为各种数据类型提供费用低廉、不受限制的对象存储。可从 Google Cloud 内部和外部访问数据，并以地理位置冗余方式复制数据。
Cloud Run：这是一项全代管式服务，可让您构建和部署无服务器容器化应用。Google Cloud 负责处理扩缩任务和其他基础架构任务，以便您可以专注于代码的业务逻辑。
Cloud Load Balancing：在 Google Cloud 上提供高性能、可伸缩负载均衡的服务。
Firestore：可伸缩的全代管式无服务器文档数据库。

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

架构

此解决方案部署了一个可直接使用且已完全实现的图片共享应用。下图展示了此解决方案部署的 Google Cloud 资源的架构：

使用 Cloud CDN 传送文件的图片共享应用的架构图。

请求流程

以下是图片共享应用的请求处理流程。流程中的步骤在前面的架构图中进行了编号。

系统使用负载均衡器将用户的文件上传请求路由到前端。
前端将这些请求路由到使用 Cloud Run 的后端。
后端将文件存储在 Cloud Storage 中以及有关 Firestore 中的文件的元数据。
如果 Cloud CDN 缓存命中，则用户查看文件的请求将路由到 Cloud CDN。
如果 Cloud CDN 缓存未命中，则用户查看文件的请求将路由到 Cloud Storage。

组件和配置

该架构包括以下组件：

由 Cloud Run 上运行的前端和后端组成的图片共享 Web 应用。应用前端使用 Angular。应用后端是使用 Go 编写的。
使用 Cloud Load Balancing 创建的负载均衡器会将传入的请求路由到相应的资源。
存储图片文件的 Cloud Storage 存储桶。
Cloud CDN 会缓存 Cloud Storage 存储桶中的图片，并加快内容传送速度。
用于存储文件元数据的 Firestore 数据库。

费用

如需估算大型数据共享 Golang Web 应用解决方案使用的 Google Cloud 资源的费用，请参阅 Google Cloud 价格计算器中预先计算的估算值。

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

系统会基于某些因素（包括以下因素）做出预先计算的估算：

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

部署解决方案

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

创建或选择 Google Cloud 项目

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

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

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

如需创建项目，请完成以下步骤：

In the Google Cloud console, go to the project selector page.

Go to project selector
Click Create project.
Name your project. Make a note of your generated project ID.
Edit the other fields as needed.
Click Create.

获取所需的 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 Config Manager Admin (`roles/config.admin`)

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

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

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

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

roles/storage.admin
roles/datastore.owner
roles/appengine.appAdmin
roles/compute.admin
roles/compute.networkAdmin
roles/cloudtrace.admin
roles/iam.serviceAccountUser
roles/run.admin
roles/monitoring.admin
roles/vpcaccess.admin

选择部署方法

您可以使用以下方法部署此解决方案：

从控制台：如果要按原样试用解决方案并查看其运作方式，请使用此方法。Cloud Build 会部署此解决方案所需的所有资源。如果您不再需要已部署的解决方案，可以使用控制台将其删除。您在部署解决方案后创建的任何资源都可能需要单独删除。

如需使用此部署方法，请按照从控制台部署中的说明操作。
使用 Terraform：如果要自定义解决方案，或者要使用基础架构即代码 (IaC) 方法自动预配和管理资源，请使用此方法。从 GitHub 下载 Terraform 配置，根据需要可以选择自定义代码，然后使用 Terraform 部署解决方案。部署解决方案后，您可以继续使用 Terraform 来管理此解决方案。

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

从控制台进行部署

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

在 Google Cloud 快速起步解决方案目录中，转到大型数据共享 Golang Web 应用解决方案。

转到大型数据共享 Golang Web 应用解决方案
查看页面上提供的信息，例如解决方案的预计费用和预计部署时间。
准备好开始部署解决方案后，请点击部署。

此时会显示分步交互式指南。
完成交互式指南中的步骤。

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

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

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

部署完成后，状态字段将更改为已部署。
1. 如需查看和使用解决方案，请返回控制台中的解决方案部署页面。
  1. 点击操作菜单。
  2. 选择查看 Web 应用以打开图片分享应用。

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

使用 Terraform 进行部署

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

设置 Terraform 客户端

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

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

将 GitHub 代码库克隆到 Cloud Shell。

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

Cloud Shell 会在单独的浏览器标签页中启动，而 Terraform 代码会下载到 Cloud Shell 环境的 $HOME/cloudshell_open 目录中。
在 Cloud Shell 中，检查当前工作目录是否为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。这是包含此解决方案的 Terraform 配置文件的目录。如果您需要切换到该目录，请运行以下命令：
```
cd $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra
```
通过运行以下命令来初始化 Terraform：
```
terraform init
```
等待系统显示以下消息：
```
Terraform has been successfully initialized!
```

配置 Terraform 变量

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

确保当前工作目录为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。如果不是，请转到该目录。
在同一目录中，创建一个名为 terraform.tfvars 的文本文件。
在 terraform.tfvars 文件中，复制以下代码段，并为所需的变量设置值。
- 按照代码段中作为注释提供的说明进行操作。
- 此代码段仅包含您必须为其设置值的变量。Terraform 配置包括具有默认值的其他变量。如需查看所有变量和默认值，请参阅 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra 目录中提供的 variables.tf 文件。
- 确保您在 terraform.tfvars 文件中设置的每个值都与 variables.tf 文件中声明的变量类型匹配。例如，如果为 variables.tf 文件中的变量定义的类型为 bool，则必须将 true 或 false 指定为该变量在 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"
```
如需了解 project_id，请参阅识别项目

验证并查看 Terraform 配置

确保当前工作目录为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。如果不是，请转到该目录。
验证 Terraform 配置没有错误：
```
terraform validate
```
如果该命令返回任何错误，请在配置中进行所需的更正，然后再次运行 terraform validate 命令。重复此步骤，直到命令返回以下消息：
```
Success! The configuration is valid.
```
查看配置中定义的资源：
```
terraform plan
```
如果您未按照上文所述创建 terraform.tfvars 文件，则 Terraform 会提示您为没有默认值的变量输入值。输入必需的值。

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

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

预配资源

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

确保当前工作目录为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。如果不是，请转到该目录。
应用 Terraform 配置：
```
terraform apply
```
如果您未按照上文所述创建 terraform.tfvars 文件，则 Terraform 会提示您为没有默认值的变量输入值。输入必需的值。

Terraform 会显示将创建的资源列表。
当系统提示您执行操作时，请输入 yes。

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

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

创建完所有资源后，Terraform 会显示以下消息：
```
Apply complete!
```
```
Outputs:
bucket_name = "BUCKET_NAME"
lb_external_ip = "IP_ADDRESS"
neos_walkthrough_url = "https://console.cloud.google.com/products/solutions/deployments?walkthrough_id=solutions-in-console--large-data-sharing--large-data-sharing--golang-_tour"
```
如需查看和使用示例应用，请在浏览器中打开 lb_external_ip。

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

自定义解决方案

本部分提供的信息可供 Terraform 开发者修改大型数据共享 Golang Web 应用解决方案，以满足其自己的技术和业务要求。仅当您使用 Terraform 部署解决方案时，本部分中的指导才具有相关性。

验证当前工作目录是否为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。如果不是，请转到该目录：
```
cd $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra
```

打开 main.tf 并进行所需的更改，如下表中的示例所示：

参数	`main.tf` 中的 Terraform 参数
应用后端的 CPU 限制	参数：`cloud_run_server.limits.cpu` `main.tf` 中的相关代码段： module "cloud_run_server" { … limits = { cpu = "2000m" … }
应用后端的内存限制	参数：`cloud_run_server.limits.memory` `main.tf` 中的相关代码段： module "cloud_run_server" { … limits = { … memory = "2Gi" …
应用前端的 CPU 限制	参数：`cloud_run_client.limits.cpu` `main.tf` 中的相关代码段： module "cloud_run_client" { … limits = { cpu = "1000m" … }
应用前端的内存限制	参数：`cloud_run_client.limits.memory` `main.tf` 中的相关代码段： module "cloud_run_client" { … limits = { … memory = "512Mi" …

按照与上一部分相同的步骤验证和预配资源：
1. 验证并查看 Terraform 配置。
2. 预配资源。

删除部署

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

删除项目

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

在 Google Cloud 控制台中，进入管理资源页面：
打开“管理资源”
在项目列表中，选择要删除的项目，然后点击删除。
在提示符处，输入项目 ID，然后点击关停。

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

通过控制台删除

如果您通过控制台删除解决方案部署，则 Firestore 数据库不会被删除。如需删除此数据库，请删除项目（如前所述）。

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

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

转到“解决方案部署”
选择您要删除的部署所在的项目。
找到您要删除的部署。
点击操作，然后选择删除。
输入部署的名称，然后点击确认。

状态字段显示正在删除。

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

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

使用 Terraform 进行删除

如果您使用 Terraform 删除解决方案部署，则 Firestore 数据库将不会被删除。如需删除此数据库，请删除项目（如前所述）。

如果您使用 Terraform 部署了解决方案，请按照以下程序操作。

在 Cloud Shell 中，确保当前工作目录为 $HOME/cloudshell_open/terraform-large-data-sharing-golang-webapp/infra。如果不是，请转到该目录。
移除 Terraform 预配的资源：
```
terraform destroy
```
Terraform 会显示将被销毁的资源列表。
当系统提示您执行操作时，请输入 yes。

Terraform 会显示显示进度的消息。删除所有资源后，Terraform 将显示以下消息：
```
Destroy complete!
```
如果删除失败，请参阅删除部署时出错中的问题排查指南。

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

可选：删除服务帐号

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

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

如果您是从 Google Cloud 控制台部署解决方案，请转到解决方案部署页面。访问该页面会触发后端中的流程来删除服务帐号。无需进一步操作。
如果您使用 Terraform 部署了解决方案，请完成以下步骤：
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. 选择查看 Cloud Build 日志。
查看 Cloud Build 日志，并采取适当的措施来解决导致失败的问题。

使用 Terraform 部署解决方案时出错

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

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

错误：Error creating Database: googleapi: Error 409: Database already exists. Please use another database_id

默认情况下，Terraform 部署会假定您的项目中尚不存在 Firestore 数据库。如果您的数据库已存在，请使用以下标志再次运行部署，以跳过数据库创建：

$ terraform apply -var "init=false"

错误：Error creating Index: googleapi: Error 409: index already exists

此错误表示此项目中先前已部署此解决方案。选择另一个项目，或删除之前由示例应用创建的 Firestore 索引。

“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 命令。

删除部署时出错

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

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

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

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

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

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

确定部署的 Terraform 代码、日志和其他数据的存储区域。此区域可能与您在部署解决方案时选择的区域不同。
1. 在 Google Cloud 控制台中，转到解决方案部署页面。
  
  转到“解决方案部署”
2. 选择您要删除的部署所在的项目。
3. 在部署列表中，找到要删除的部署所在的行。
4. 点击 查看所有行内容。
5. 在位置列中，记下第二个位置，如以下示例中突出显示部分所示：
In the Google Cloud console, activate Cloud Shell.

Activate Cloud Shell

At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
为要删除的部署的项目 ID、区域和名称创建环境变量：
```
export REGION="REGION"
export PROJECT_ID="PROJECT_ID"
export DEPLOYMENT_NAME="DEPLOYMENT_NAME"
```
在这些命令中，替换以下内容：
- REGION：您先前在此过程中记下的位置。
- PROJECT_ID：您在其中部署解决方案的项目的 ID。
- DEPLOYMENT_NAME：您要删除的部署的名称。

获取您要删除的最新修订版本部署的 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

获取该部署的 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

将 Terraform 配置从 Cloud Storage 下载到 Cloud Shell：
```
gsutil cp -r $CONTENT_PATH $HOME
cd $HOME/content
```
等到系统显示 Operation completed 消息，如以下示例所示：
```
Operation completed over 45 objects/268.5 KiB
```

初始化 Terraform：

terraform init

等待系统显示以下消息：

Terraform has been successfully initialized!

移除已部署的资源：
```
terraform destroy
```
Terraform 会显示将被销毁的资源列表。

如果显示的警告与未声明变量有关，请忽略这些警告。
当系统提示您执行操作时，请输入 yes。

Terraform 会显示显示进度的消息。删除所有资源后，Terraform 将显示以下消息：
```
Destroy complete!
```

删除部署工件：

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"

等待几秒钟，然后验证部署工件是否已删除：

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 问题会尽量得到查看，且不适用于一般使用问题。

如有关于解决方案中所使用产品的问题，请与 Cloud Customer Care 联系。

后续步骤

了解 Sharechat 如何使用 Cloud CDN 随时随地向用户分发高品质、低延迟的内容。
请参阅 Cloud CDN 概览。
了解 Cloud CDN 的最佳做法。