三层式应用

架构

Three Tier 应用是一款简单的待办事项应用,其架构为原版 3 层级应用:

  • 后端
    • 数据库 - MySQL - Cloud SQL
    • 缓存 - Redis - Cloud Memorystore
  • 中间件/API <ph type="x-smartling-placeholder">
      </ph>
    • 容器托管 API - Golang - Cloud Run
  • 前端/界面 <ph type="x-smartling-placeholder">
      </ph>
    • 容器托管界面 - Nginx + HTML/JS/CSS - Cloud Run
  • 部署 <ph type="x-smartling-placeholder">
      </ph>
    • 持续部署 - Cloud Build
    • Secret 管理 - Cloud Secret Manager

开始使用

点击以下链接,获取 Cloud Shell 中的源代码副本。一次 只需一个命令,即可启动 项目...

在 Cloud Shell 中打开

在 GitHub 上查看源代码


三层式应用组件

三层式应用架构使用多种产品。 下面列出了这些组件,并详细介绍了 包括指向相关视频、产品文档和 互动演示。
视频 文档 演示
Cloud SQL Cloud SQL 是托管式 SQL,可为应用的数据库层提供 MySQL、SQL Server 或 Postgres。
Cloud Memorystore Cloud Memorystore 是托管式 Redis 服务,可为您的应用提供缓存层。
Cloud Run Cloud Run 可让您在容器中运行应用,但以无服务器方式配置,而无需配置实例数、处理器数或内存数。上传容器并获取网址。
Cloud Build Cloud Build 是工具,可将容器打包并部署为 Cloud Run 服务。
Secret Manager Cloud Secret Manager 会在构建流程中存储与应用的敏感细节信息。

脚本

安装脚本使用以 go 和 Terraform CLI 工具编写的可执行文件 选取一个空项目并在其中安装应用。输出应为 以及负载均衡 IP 地址的网址。

./main.tf

启用服务

默认情况下,Google Cloud 服务在项目中处于停用状态。待办事项要求 您可以启用以下服务:

  • 服务网络和Serverless VPC Access - 让 Cloud Run 能够 在专用网络上与 SQL 和 Redis 通信,同时保留这些服务器 无法从 API 的外部调用进行访问。
  • Cloud Build - 创建容器映像并部署到 Cloud Run
  • Cloud Memorystore - 为应用提供缓存层。
  • Cloud Run - 用于托管容器的无服务器工具;以及 提供用于访问应用程序的网址。
  • Cloud SQL - 可供应用的数据库存储空间
  • Cloud Storage - 供 Cloud Build 使用,以及在 数据库
  • Cloud Secret Manager - 用于为 SQL 和 Redis 注入主机 IP Cloud Build 和 Cloud Run
  • Artifact Registry - 存储 Docker 映像以用于 Cloud Build。
variable "gcp_service_list" {
    description = "The list of apis necessary for the project"
    type        = list(string)
    default = [
        "compute.googleapis.com",
        "cloudapis.googleapis.com",
        "vpcaccess.googleapis.com",
        "servicenetworking.googleapis.com",
        "cloudbuild.googleapis.com",
        "sql-component.googleapis.com",
        "sqladmin.googleapis.com",
        "storage.googleapis.com",
        "secretmanager.googleapis.com",
        "run.googleapis.com",
        "artifactregistry.googleapis.com",
        "redis.googleapis.com"
    ]
}

resource "google_project_service" "all" {
    for_each                   = toset(var.gcp_service_list)
    project                    = var.project_number
    service                    = each.key
    disable_on_destroy = false
}

设置权限

以下命令可设置允许 Cloud Build 部署服务的 IAM 角色和权限。

  • 启用 Cloud Build 服务账号以部署到 Cloud Run
  • 启用 Cloud Build 服务账号以为 Cloud Run 设置 VPN 访问权限
  • 启用 Cloud Build 服务账号以执行服务账号活动
  • 允许 Cloud Build 服务账号代表计算服务账号执行操作
  • 启用 Cloud Build 服务账号以发布到 Cloud Run
  • 启用 Cloud Build 服务账号以使用密钥
  • 启用 Cloud Build 服务账号以在 Artifact Registry 中存储容器
variable "build_roles_list" {
    description = "The list of roles that build needs for"
    type        = list(string)
    default = [
        "roles/run.developer",
        "roles/vpaccess.user",
        "roles/iam.serviceAccountUser",
        "roles/run.admin",
        "roles/secretmanager.secretAccessor",
        "roles/artifactregistry.admin",
    ]
}
resource "google_project_iam_member" "allbuild" {
    for_each   = toset(var.build_roles_list)
    project    = var.project_number
    role       = each.key
    member     = "serviceAccount:${local.sabuild}"
    depends_on = [google_project_service.all]
}

为 SQL 实例创建网络

以下命令允许从 Cloud Run 访问 Cloud SQL:

resource "google_compute_global_address" "google_managed_services_vpn_connector" {
    name          = "google-managed-services-vpn-connector"
    purpose       = "VPC_PEERING"
    address_type  = "INTERNAL"
    prefix_length = 16
    network       = local.defaultnetwork
    project       = var.project_id
    depends_on    = [google_project_service.all]
}
resource "google_service_networking_connection" "vpcpeerings" {
    network                 = local.defaultnetwork
    service                 = "servicenetworking.googleapis.com"
    reserved_peering_ranges = [google_compute_global_address.google_managed_services_vpn_connector.name]
}

创建 VPC 访问连接器

将 Cloud Run 连接到数据库和缓存

resource "google_vpc_access_connector" "connector" {
    provider      = google-beta
    project       = var.project_id
    name          = "vpc-connector"
    ip_cidr_range = "10.8.0.0/28"
    network       = "default"
    region        = var.region
    depends_on    = [google_compute_global_address.google_managed_services_vpn_connector, google_project_service.all]
}

创建 Redis 服务器

配置并初始化 Redis 服务器实例。

resource "google_redis_instance" "todo_cache" {
    authorized_network      = local.defaultnetwork
    connect_mode            = "DIRECT_PEERING"
    location_id             = var.zone
    memory_size_gb          = 1
    name                    = "${var.basename}-cache"
    project                 = var.project_id
    redis_version           = "REDIS_6_X"
    region                  = var.region
    reserved_ip_range       = "10.137.125.88/29"
    tier                    = "BASIC"
    transit_encryption_mode = "DISABLED"
    depends_on              = [google_project_service.all]
}

创建 SQL Server

以下命令可配置并初始化 SQL Server 实例。

resource "google_sql_database_instance" "todo_database" {
    name="${var.basename}-db-${random_id.id.hex}"
    database_version = "MYSQL_5_7"
    region           = var.region
    project          = var.project_id
    settings {
        tier                  = "db-g1-small"
        disk_autoresize       = true
        disk_autoresize_limit = 0
        disk_size             = 10
        disk_type             = "PD_SSD"
        ip_configuration {
            ipv4_enabled    = false
            private_network = local.defaultnetwork
        }
        location_preference {
            zone = var.zone
        }
    }
    deletion_protection = false
    depends_on = [
        google_project_service.all,
        google_service_networking_connection.vpcpeerings
    ]
    # This handles loading the schema after the database installs.
    provisioner "local-exec" {
        working_dir = "${path.module}/code/database"
        command     = "./load_schema.sh ${var.project_id} ${google_sql_database_instance.todo_database.name}"
    }
}

创建 Artifact Registry 代码库

以下命令可存储 Docker 映像以用于 Cloud Run。

resource "google_artifact_registry_repository" "todo_app" {
    provider      = google-beta
    format        = "DOCKER"
    location      = var.region
    project       = var.project_id
    repository_id = "${var.basename}-app"
    depends_on    = [google_project_service.all]
}

创建 Secret

以下命令将 Redis 和 SQL 主机数据存储在 Cloud Secret 中。

resource "google_secret_manager_secret" "redishost" {
    project = var.project_number
    replication {
        automatic = true
    }
    secret_id  = "redishost"
    depends_on = [google_project_service.all]
}
resource "google_secret_manager_secret_version" "redishost" {
    enabled     = true
    secret      = "projects/${var.project_number}/secrets/redishost"
    secret_data = google_redis_instance.todo_cache.host
    depends_on  = [google_project_service.all, google_redis_instance.todo_cache, google_secret_manager_secret.redishost]
}
resource "google_secret_manager_secret" "sqlhost" {
    project = var.project_number
    replication {
        automatic = true
    }
    secret_id  = "sqlhost"
    depends_on = [google_project_service.all]
}
resource "google_secret_manager_secret_version" "sqlhost" {
    enabled     = true
    secret      = "projects/${var.project_number}/secrets/sqlhost"
    secret_data = google_sql_database_instance.todo_database.private_ip_address
    depends_on  = [google_project_service.all, google_sql_database_instance.todo_database, google_secret_manager_secret.sqlhost]
}

为中间件创建工件

以下命令会创建 Docker 映像,并将其托管在 Artifact Registry 上: ./code/frontend/clouldbuild.yaml

resource "null_resource" "cloudbuild_api" {
  provisioner "local-exec" {
    working_dir = "${path.module}/code/middleware"
    command     = "gcloud builds submit . --substitutions=_REGION=${var.region},_BASENAME=${var.basename}"
  }
  depends_on = [
    google_artifact_registry_repository.todo_app,
    google_secret_manager_secret_version.redishost,
    google_secret_manager_secret_version.sqlhost,
    google_project_service.all
  ]
}

将 API 容器部署到 Cloud Run

以下命令通过 Cloud Build 使用您刚刚构建的容器在 Cloud Run 上启动服务。

resource "google_cloud_run_service" "api" {
    name     = "${var.basename}-api"
    location = var.region
    project  = var.project_id

    template {
        spec {
            containers {
                image = "${var.region}-docker.pkg.dev/${var.project_id}/${var.basename}-app/api"
                env {
                    name = "REDISHOST"
                    value_from {
                        secret_key_ref {
                            name = google_secret_manager_secret.redishost.secret_id
                            key  = "latest"
                        }
                    }
                }
                env {
                    name = "todo_host"
                    value_from {
                        secret_key_ref {
                        name = google_secret_manager_secret.sqlhost.secret_id
                        key  = "latest"
                        }
                    }
                }
                env {
                    name  = "todo_user"
                    value = "todo_user"
                }
                env {
                    name  = "todo_pass"
                    value = "todo_pass"
                }
                env {
                    name  = "todo_name"
                    value = "todo"
                }
                env {
                    name  = "REDISPORT"
                    value = "6379"
                }
            }
        }
        metadata {
            annotations = {
                "autoscaling.knative.dev/maxScale"        = "1000"
                "run.googleapis.com/cloudsql-instances"   = google_sql_database_instance.todo_database.connection_name
                "run.googleapis.com/client-name"          = "terraform"
                "run.googleapis.com/vpc-access-egress"    = "all"
                "run.googleapis.com/vpc-access-connector" = google_vpc_access_connector.connector.id
            }
        }
    }
    autogenerate_revision_name = true
    depends_on = [
        null_resource.cloudbuild_api,
        google_project_iam_member.secretmanager_secretAccessor
    ]
} 

提供开放型 Cloud Run API 服务,以供所有人读取。

应用的此 API 层将由用户的浏览器调用,但 默认的 Cloud Run 服务不是公开的。为了让用户能够 使用此服务,我们必须开放这些服务的权限 供全球用户使用

resource "google_cloud_run_service_iam_policy" "noauth_api" {
    location    = google_cloud_run_service.api.location
    project     = google_cloud_run_service.api.project
    service     = google_cloud_run_service.api.name
    policy_data = data.google_iam_policy.noauth.policy_data
}

为前端创建制品

以下命令会创建 Docker 映像,并将其托管在 Artifact Registry 上: ./code/frontend/clouldbuild.yaml

resource "null_resource" "cloudbuild_fe" {
    provisioner "local-exec" {
        working_dir = "${path.module}/code/frontend"
        command     = "gcloud builds submit . --substitutions=_REGION=${var.region},_BASENAME=${var.basename}"
    }
    depends_on = [
        google_artifact_registry_repository.todo_app,
        google_cloud_run_service.api
    ]
}

将前端容器部署到 Cloud Run

下一条命令通过 Cloud Build,使用我们刚刚构建的容器在 Cloud Run 上启动服务

resource "google_cloud_run_service" "fe" {
    name     = "${var.basename}-fe"
    location = var.region
    project  = var.project_id
    template {
        spec {
            containers {
                image = "${var.region}-docker.pkg.dev/${var.project_id}/${var.basename}-app/fe"
                ports {
                    container_port = 80
                }
            }
        }
    }
    depends_on = [null_resource.cloudbuild_fe]
}

开放式 Cloud Run 前端服务,可供所有人读取

这是应用的前端,用于呈现 HTML/JS/CSS 用户与应用交互的方式 - 默认情况下为 Cloud Run 服务 未公开。为了让此应用正常运行,我们必须 这些服务的权限,以便全世界的用户。

resource "google_cloud_run_service_iam_policy" "noauth_fe" {
    location    = google_cloud_run_service.fe.location
    project     = google_cloud_run_service.fe.project
    service     = google_cloud_run_service.fe.name
    policy_data = data.google_iam_policy.noauth.policy_data
}

./code/database/load_schema.sh

初始化数据库架构

此命令会创建一个临时 Cloud Storage 存储桶,用于将架构上传到 Cloud SQL。

PROJECT=$1
SQLNAME=$2

SQLSERVICEACCOUNT=$(gcloud sql instances describe $SQLNAME --format="value(serviceAccountEmailAddress)" | xargs)
gcloud storage buckets create gs://$PROJECT-temp
gcloud storage cp schema.sql gs://$PROJECT-temp/schema.sql
gcloud storage buckets add-iam-policy-binding gs://$PROJECT-temp/ --member=serviceAccount:$SQLSERVICEACCOUNT --role=roles/storage.objectViewer
gcloud sql import sql $SQLNAME gs://$PROJECT-temp/schema.sql -q
gcloud storage rm gs://$PROJECT-temp --recursive

./code/middleware/clouldbuild.yaml

Build API 容器

此代码用于为中间件层创建一个 Docker 映像。

name: 'gcr.io/cloud-builders/docker'
args: [ 'build', '-t', '$_REGION-docker.pkg.dev/$PROJECT_ID/$_BASENAME-app/api', '.' ]
  ```
#### Push API container to Artifact Registry
Pushing the container to Artifact Registry makes it possible for Cloud Run to 
get the image and serve it.

``` yaml
name: 'gcr.io/cloud-builders/docker'
args: ['push', '$_REGION-docker.pkg.dev/$PROJECT_ID/$_BASENAME-app/api']  

替换内容

以下代码使用默认值创建变量,以便在部署时可以更改这些值。

substitutions:
  _REGION: us-central1
  _BASENAME: todo

./code/frontend/clouldbuild.yaml

按摩码内容

前端完全是静态的 HTML/JS/CSS。应用需要指向 API 服务,但系统会向 Cloud Run 服务分配一个网址, 字符串。这个“按摩脚本”捕获该随机网址并将其注入代码 这个容器中的静态 JS 代码

./code/frontend/massage.sh

name: 'gcr.io/google.com/cloudsdktool/cloud-sdk'
entrypoint: bash
args: [ './massage.sh', '$_REGION' ]

Build API 容器

以下代码会为中间件层创建一个 Docker 映像:

name: 'gcr.io/cloud-builders/docker'
args: [ 'build', '-t', '$_REGION-docker.pkg.dev/$PROJECT_ID/$_BASENAME-app/fe', '.' ]

将 API 容器推送到 Artifact Registry

将容器推送到 Artifact Registry 后,Cloud Run 即可执行以下操作: 获取和传送图片

name: 'gcr.io/cloud-builders/docker'
args: ['push', '$_REGION-docker.pkg.dev/$PROJECT_ID/$_BASENAME-app/fe']

替换内容

创建一个具有默认值的变量,以便在部署时可以更改这些值。

substitutions:
  _REGION: us-central1
  _BASENAME: todo

./code/frontend/massage.sh

修改 JavaScript

此命令将中间件的端点注入前端的 JavaScript。

API=$(gcloud run services describe todo-api --region=$1 --format="value(status.url)")
stripped=$(echo ${API/https:\/\//})
sed -i"" -e "s/127.0.0.1:9000/$stripped/" www/js/main.js

总结

现在您有一个简单的 3 层待办事项应用,在 Cloud 上运行 在项目中运行。您还拥有需要修改 扩展此解决方案以适应您的环境。