App de três camadas

Arquitetura

O app de três camadas é um aplicativo de tarefas simples projetado como um aplicativo básico de três camadas:

  • Back-end
    • Banco de dados – MySQL – Cloud SQL
    • Armazenamento em cache – Redis – Cloud Memorystore
  • Middleware/API
    • API hospedada no contêiner - Golang - Cloud Run
  • Front-end/UI
    • UI hospedada em contêiner: Nginx + HTML/JS/CSS - Cloud Run
  • Implantação
    • Implantação contínua - Cloud Build
    • Gerenciamento de secrets: Cloud Secret Manager

Primeiros passos

Clique no link a seguir para copiar o código-fonte no Cloud Shell. Uma vez lá, um único comando criará uma cópia de trabalho do aplicativo em seu projeto...

Abrir no Cloud Shell

Acessar o código-fonte no GitHub


Componentes do app de três camadas

A arquitetura do app de três camadas usa vários produtos. A seguir, listamos os componentes, além de mais informações sobre os componentes, incluindo links para vídeos relacionados, documentação do produto e tutoriais interativos.
Vídeo Documentos Instruções
Cloud SQL O Cloud SQL é um SQL gerenciado que oferece MySQL, SQL Server ou Postgres para a camada de banco de dados dos seus aplicativos.
Cloud Memorystore O Cloud Memorystore, Redis gerenciado, fornece a camada de armazenamento em cache para seus aplicativos.
Cloud Run O Cloud Run permite executar aplicativos em um contêiner, mas sem servidor, sem a necessidade de configurar o número de instâncias, processadores ou memória. Faça upload de um contêiner e receba um URL.
Cloud Build O Cloud Build é a ferramenta que empacota e implanta contêineres para que fiquem disponíveis como serviços do Cloud Run.
Secret Manager O Cloud Secret Manager armazena detalhes sensíveis sobre o aplicativo para o processo de build.

Scripts

O script de instalação usa um executável escrito em go e nas ferramentas de CLI do Terraform para pegar um projeto vazio e instalar o aplicativo nele. A saída deve ser um aplicativo em funcionamento e um URL para o endereço IP do balanceamento de carga.

./main.tf

Ativar serviços

Por padrão, os serviços do Google Cloud ficam desativados em um projeto. ToDo requer ativar os seguintes serviços:

  • Redes de serviços e Acesso VPC sem servidor: permite que o Cloud Run Comunicar-se com SQL e Redis na rede privada, mantendo esses servidores inacessível de chamadas externas provenientes da API.
  • Cloud Build: cria imagens de contêiner e faz a implantação no Cloud Run.
  • Cloud Memorystore: fornece uma camada de armazenamento em cache para o aplicativo.
  • Cloud Run: a ferramenta sem servidor que hospedará os contêineres. forneça URLs para acessar o aplicativo.
  • Cloud SQL: armazenamento de banco de dados para o aplicativo
  • Cloud Storage: usado pelo Cloud Build e para carregar o esquema na banco de dados
  • Cloud Secret Manager: usado para injetar os IPs do host para SQL e Redis no Cloud Build para Cloud Run.
  • Artifact Registry: armazena as imagens do Docker para uso com o 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
}

Definir permissões

O comando a seguir define papéis e permissões do IAM que permitem que o Cloud Build implante serviços.

  • Ativar a conta de serviço do Cloud Build para implantação no Cloud Run
  • Ative a conta de serviço do Cloud Build para definir o acesso VPN para o Cloud Run
  • Ativar a conta de serviço do Cloud Build para executar atividades da conta de serviço
  • Permitir que a conta de serviço do Cloud Build atue em nome da conta de serviço do Compute
  • Ativar a conta de serviço do Cloud Build para publicar no Cloud Run
  • Ative a conta de serviço do Cloud Build para consumir secrets
  • Ativar a conta de serviço do Cloud Build para armazenar contêineres no 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]
}

Criar rede para instância do SQL

O comando a seguir permite que o Cloud SQL seja acessível pelo Cloud Run:

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]
}

Criar conector de acesso à VPC

Conecta o Cloud Run ao banco de dados e ao armazenamento em cache

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]
}

Criar servidor Redis

Configura e inicializa uma instância do servidor 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]
}

Criar SQL Server

O comando a seguir configura e inicializa uma instância do 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}"
    }
}

Criar repositório do Artifact Registry

O comando a seguir armazena as imagens do Docker para uso com o 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]
}

Criar secrets

O comando a seguir armazena dados de host SQL e Redis no Cloud Secrets.

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]
}

Criar artefato para middleware

O comando abaixo cria a imagem Docker e a hospeda no 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
  ]
}

Implantar um contêiner de API no Cloud Run

O comando a seguir usa o Cloud Build para ativar um serviço no Cloud Run usando o contêiner que você acabou de criar.

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
    ]
} 

Abra o serviço da API Cloud Run para ser legível por todos.

Essa camada de API do aplicativo será chamada pelo navegador do usuário, mas pelo serviços padrão do Cloud Run não são públicos. Para que os usuários consumir esse serviço, precisamos abrir permissões nesses serviços acessíveis ao mundo.

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
}

Criar artefato para front-end

O comando abaixo cria a imagem Docker e a hospeda no 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
    ]
}

Implante o contêiner de front-end no Cloud Run

O próximo comando usa o Cloud Build para ativar um serviço no Cloud Run usando o contêiner que acabamos de criar

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]
}

Abrir o serviço de front-end do Cloud Run para leitura mundial

Este é o front-end do aplicativo, que renderizará o HTML/JS/CSS pela qual o usuário interage com o aplicativo (por padrão, os serviços do Cloud Run). não são públicos. Para que este aplicativo funcione, precisamos abrir que as permissões desses serviços sejam acessíveis ao mundo.

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

Inicializar esquema de banco de dados

Esse comando cria um bucket temporário do Cloud Storage para fazer upload do esquema para o 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

Criar contêiner da API

Esse código cria uma imagem do Docker para a camada de middleware.

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']  

Substituições

O código a seguir cria variáveis com valores padrão para que eles possam ser alterados no momento do deploy.

substitutions:
  _REGION: us-central1
  _BASENAME: todo

./code/frontend/clouldbuild.yaml

Massagear o conteúdo do código

O front-end é HTML/JS/CSS completamente estático. O aplicativo precisa apontar para o URL do serviço da API que acabamos de criar, mas os serviços do Cloud Run recebem um URL com fio. Este "script de massagem" captura esse URL aleatório e o injeta no código do JavaScript estático neste contêiner.

./code/frontend/massage.sh

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

Criar contêiner da API

O código a seguir cria uma imagem do Docker para a camada de middleware:

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

Enviar o contêiner da API para o Artifact Registry

Enviar o contêiner por push para o Artifact Registry possibilita que o Cloud Run receber a imagem e exibi-la.

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

Substituições

Crie uma variável com um padrão para que esses valores possam ser alterados no momento da implantação.

substitutions:
  _REGION: us-central1
  _BASENAME: todo

./code/frontend/massage.sh

Editar JavaScript

Esse comando injeta o endpoint do middleware no JavaScript do front-end.

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

Conclusão

Agora você tem um aplicativo de tarefas de três níveis simples em execução no Cloud Execute seu projeto. Você também tem todo o código para modificar ou e estenda essa solução para se adequar ao seu ambiente.