Solução de início rápido: aplicativo dinâmico da Web com Java

Last reviewed 2023-08-21 UTC

Este guia ajuda você a entender, implantar e usar a solução Jump Start do aplicativo dinâmico da Web com Java. Essa solução implanta um app da Web dinâmico chamado Ponto de venda. O ponto de venda é um app da Web escrito em Java que simula um ponto de venda real de uma loja de varejo. Depois de implantar o app da Web, teste a experiência do usuário na tela "Ponto de venda".

Implante o app da Web de ponto de venda no Google Cloud usando a implementação gerenciada pelo Google do Kubernetes, o Google Kubernetes Engine (GKE). Com o GKE, é possível escolher o nível de detalhamento do gerenciamento operacional da infraestrutura.

Essa solução fornece requisitos de alto nível para iniciar o design do software do seu aplicativo. Ao final deste guia, você conseguirá selecionar os componentes do Google Cloud necessários para uma implantação com custo, desempenho e escalonabilidade semelhantes.

Neste guia, pressupomos que você esteja familiarizado com os conceitos básicos do Java e de nuvem, mas não necessariamente do Google Cloud. Ter experiência com o Terraform é útil.

Objetivos

Este guia de solução ajuda você com estes tópicos:

  • Implante um aplicativo da Web acessível publicamente com o GKE concluindo as seguintes tarefas de alto nível:

    • Configure um cluster do GKE Autopilot que responda às necessidades de escalonamento, segurança e infraestrutura do cluster.
    • Configure um balanceador de carga do Google Cloud por meio dos serviços do Kubernetes para permitir o tráfego de entrada e saída no aplicativo da Web.
    • Conecte-se ao Spanner a partir de um pod do GKE seguindo as práticas de segurança recomendadas do Google Cloud.
    • Crie e reimplante com segurança.

  • Veja a implantação.

  • Use o Cloud Trace para entender e gerenciar problemas.

Produtos usados

A solução usa os seguintes produtos do Google Cloud:

  • Google Kubernetes Engine: um ambiente gerenciado para implantação, gerenciamento e escalonamento de aplicativos em contêineres usando a infraestrutura do Google.
  • Spanner: um banco de dados relacional totalmente gerenciado que permite que o aplicativo seja escalonado e garanta alta disponibilidade.
  • Nuvem privada virtual: uma rede global de nuvem privada virtual que abrange todas as regiões do Google Cloud e permite que você interconecte seus recursos da nuvem.

Para informações sobre como esses produtos são configurados e como eles interagem, consulte a próxima seção.

Arquitetura

O diagrama a seguir mostra a arquitetura dos recursos do Google Cloud que a solução implanta.

Diagrama da arquitetura

Componentes e configuração

A arquitetura inclui os seguintes componentes:

  1. Uma solicitação do cliente é enviada para o Cloud Load Balancing, que distribui o tráfego de entrada para uma nuvem privada virtual (VPC).
  2. O Google Cloud atribui um endereço IP externo à instância de VPC.
  3. A VPC fornece conectividade aos recursos de um cluster do GKE Autopilot. O cluster tem um serviço do Kubernetes do tipo LoadBalancer. Esse serviço roteia solicitações para os pods que executam três pods de serviço Java do Spring Boot.
  4. Os pods têm as seguintes características:
    1. O pod api-server hospeda o conteúdo estático do front-end do Vue.js e expõe uma API para o front-end. As chamadas para essas APIs acionam conexões com os serviços de inventário e pagamento conforme necessário.
    2. O pod de serviço inventory se conecta ao Spanner para armazenar e recuperar informações de inventário.
    3. O pod de serviço payment se conecta ao Spanner para armazenar detalhes de pagamento e gerar uma fatura de compra.
  5. A instância do Spanner hospeda dados de inventário e pagamento.

Custo

Para uma estimativa dos custos dos recursos do Google Cloud usados pelo aplicativo dinâmico da Web com a solução Java, consulte a estimativa pré-calculada na Calculadora de preços do Google Cloud.

Use a estimativa como um ponto de partida para calcular o custo da implantação. É possível modificar a estimativa para refletir as alterações de configuração planejadas para os recursos usados na solução.

A estimativa pré-calculada tem como base suposições específicas, incluindo o seguinte:

  • Os locais do Google Cloud em que os recursos são implantados.
  • A quantidade de tempo em que os recursos são usados.

implantar a solução

Esta seção orienta você no processo de implantação da solução.

Criar ou escolher um projeto do Google Cloud

Ao implantar a solução, escolha o projeto do Google Cloud em que os recursos serão implantados. Ao decidir entre usar um projeto existente ou criar um, considere os seguintes fatores:

  • Se você criar um projeto para a solução, quando não precisar mais da implantação, será possível excluir o projeto e evitar o faturamento contínuo. Se você usar um projeto existente, será preciso excluir a implantação quando não precisar mais dela.
  • Usar um novo projeto pode ajudar a evitar conflitos com recursos provisionados anteriormente, como recursos usados em cargas de trabalho de produção.

Se você quiser implantar a solução em um novo projeto, crie o projeto antes de iniciar a implantação.

Para criar um projeto, siga estas etapas:

  1. No console do Google Cloud, acesse a página do seletor de projetos.

    Acessar o seletor de projetos

  2. Para começar a criar um projeto do Google Cloud, clique em Criar projeto.

  3. Escolha o nome do projeto. Anote o código do projeto gerado.

  4. Edite os outros campos conforme necessário.

  5. Para criar o projeto, clique em Criar.

Receber as permissões de IAM necessárias

Para iniciar o processo de implantação, você precisa das permissões do Identity and Access Management (IAM) listadas na tabela a seguir. Se você tem o papel básico roles/owner no projeto em que planeja implantar a solução, você já tem todas as permissões necessárias. Se você não tiver o papel roles/owner, peça ao administrador para conceder essas permissões (ou as que incluem essas permissões) a você.

Permissão do IAM necessária Papel predefinido que inclui as permissões necessárias

serviceusage.services.enable

 Administrador do Service Usage
(roles/serviceusage.serviceUsageAdmin)

iam.serviceAccounts.create

 Administrador da conta de serviço
(roles/iam.serviceAccountAdmin)

resourcemanager.projects.setIamPolicy

 Administrador de projetos do IAM
(roles/resourcemanager.projectIamAdmin)
config.deployments.create
config.deployments.list		 Administrador do Cloud Infrastructure Manager
(roles/config.admin)

Conta de serviço criada para a solução

Se você iniciar o processo de implantação pelo console, o Google criará uma conta de serviço para implantar a solução em seu nome (e excluir a implantação mais tarde, se você quiser). Essa conta de serviço recebe determinadas permissões do IAM temporariamente, ou seja, as permissões são revogadas automaticamente após a conclusão das operações de implantação e exclusão da solução. O Google recomenda que, após a exclusão da implantação, você exclua a conta de serviço, conforme descrito mais adiante neste guia.

Ver os papéis atribuídos à conta de serviço

Esses papéis são listados aqui caso um administrador do projeto ou da organização do Google Cloud precise dessas informações.

Escolher um método de implantação

Para ajudá-lo a implantar essa solução com esforço mínimo, é fornecida uma configuração do Terraform no GitHub. A configuração do Terraform define todos os recursos do Google Cloud necessários para a solução.

É possível implantar a solução usando um dos seguintes métodos:

  • Pelo console: use esse método se quiser testar a solução com a configuração padrão e ver como ela funciona. O Cloud Build implanta todos os recursos necessários para a solução. Quando você não precisar mais da solução implantada, será possível excluí-la no console. Todos os recursos criados depois da implantação da solução talvez precisem ser excluídos separadamente.

    Para usar esse método de implantação, siga as instruções em Implantar no console.

  • Com a CLI do Terraform: use esse método se quiser personalizar a solução ou automatizar o provisionamento e o gerenciamento dos recursos usando a abordagem de infraestrutura como código (IaC). Faça o download da configuração do Terraform no GitHub, personalize o código conforme necessário e implante a solução usando a CLI do Terraform. Depois de implantar a solução, é possível continuar a usar o Terraform para gerenciá-la.

    Para usar esse método de implantação, siga as instruções em Implantar usando a CLI do Terraform.

Implantar pelo console

Conclua as etapas a seguir para implantar a solução pré-configurada.

  1. No catálogo do Google Cloud Jump Start Solutions, acesse a solução Aplicativo dinâmico da Web com Java.

    Acesse o aplicativo dinâmico da Web com a solução Java

  2. Revise as informações fornecidas na página, como o custo estimado da solução e o tempo estimado de implantação.

  3. Quando estiver tudo pronto para começar a implantar a solução, clique em Implantar.

    Veja um guia interativo passo a passo.

  4. Conclua estas etapas no guia interativo.

    Anote o nome inserido para a implantação. Ele será necessário depois de excluir a implantação.

    Quando você clica em Implantar, a página Implantações da solução é exibida. O campo Status nesta página mostra Implantação.

  5. Aguarde a solução ser implantada.

    Se a implantação falhar, o campo Status vai mostrar Falha. Use o registro do Cloud Build para diagnosticar os erros. Para mais informações, consulte Erros ao implantar no console.

    Depois que a implantação for concluída, o campo Status mudará para Implantado.

  6. Para ver e usar o app da Web de ponto de venda implantado, siga as instruções em Ver seu aplicativo da Web dinâmico implantado usando Java.

  7. Para ver os recursos do Google Cloud implantados e as configurações deles, faça um tour interativo.

    Iniciar o tour

Quando você não precisar mais da solução, poderá excluí-la para evitar o faturamento contínuo dos recursos do Google Cloud. Para mais informações, consulte Excluir a implantação da solução.

Implantar usando a CLI do Terraform

Nesta seção, descrevemos como personalizar a solução ou automatizar o provisionamento e o gerenciamento dela usando a CLI do Terraform. As soluções que você implanta usando a CLI do Terraform não são exibidas na página Implantações da solução no console do Google Cloud.

Configurar o cliente do Terraform

É possível executar o Terraform no Cloud Shell ou no seu host local. Neste guia, descrevemos como executar o Terraform no Cloud Shell, que tem o Terraform pré-instalado e configurado para autenticação com o Google Cloud.

O código do Terraform para esta solução está disponível em um repositório do GitHub.

  1. Clone o repositório do GitHub no Cloud Shell.

    Abrir no Cloud Shell

    Você verá um prompt para confirmar o download do repositório do GitHub para o Cloud Shell.

  2. Clique em Confirmar.

    O Cloud Shell é iniciado em uma guia separada do navegador, e o código do Terraform é transferido por download para o diretório $HOME/cloudshell_open do seu ambiente do Cloud Shell.

  3. No Cloud Shell, verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Esse é o diretório que contém os arquivos de configuração do Terraform para a solução. Se você precisar mudar para esse diretório, execute o seguinte comando:

    cd $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra

  4. Inicialize o Terraform executando o seguinte comando:

    terraform init

    Aguarde até ver a seguinte mensagem:

    Terraform has been successfully initialized!

Configurar as variáveis do Terraform

O código do Terraform que você salvou inclui variáveis que podem ser usadas para personalizar a implantação com base nos seus requisitos. Por exemplo, é possível especificar o projeto do Google Cloud e a região em que você quer que a solução seja implantada.

  1. Verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Se não estiver, acesse esse diretório.

  2. No mesmo diretório, crie um arquivo de texto chamado terraform.tfvars.

  3. No arquivo terraform.tfvars, copie o snippet de código a seguir e defina valores para as variáveis necessárias.

    • Siga as instruções fornecidas como comentários no snippet de código.
    • Esse snippet de código inclui apenas as variáveis para as quais você precisa definir valores. A configuração do Terraform inclui outras variáveis que têm valores padrão. Para revisar todas as variáveis e os valores padrão, consulte o arquivo variables.tf disponível no diretório $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra.
    • Verifique se cada valor definido no arquivo terraform.tfvars corresponde ao tipo da variável, conforme declarado no arquivo variables.tf. Por exemplo, se o tipo definido para uma variável no arquivo variables.tf for bool, especifique true ou false como o valor dessa variável no arquivo 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"

    Para informações sobre os valores que podem ser atribuídos às variáveis obrigatórias, consulte:

Validar e revisar a configuração do Terraform

  1. Verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Se não estiver, acesse esse diretório.

  2. Verifique se a configuração do Terraform não tem erros:

    terraform validate

    Se o comando retornar algum erro, faça as correções necessárias na configuração e execute o comando terraform validate novamente. Repita essa etapa até o comando retornar a seguinte mensagem:

    Success! The configuration is valid.

  3. Analise os recursos definidos na configuração:

    terraform plan

  4. Se você não tiver criado o arquivo terraform.tfvars conforme descrito anteriormente, o Terraform solicitará que você insira valores das variáveis que não têm valores padrão. Insira os valores obrigatórios.

    A saída do comando terraform plan é uma lista dos recursos provisionados pelo Terraform quando você aplica a configuração.

    Se você quiser fazer alterações, edite a configuração e execute os comandos terraform validate e terraform plan novamente.

Provisionar os recursos

Quando nenhuma outra alteração for necessária na configuração, implante os recursos:

  1. Verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Se não estiver, acesse esse diretório.

  2. Aplique a configuração do Terraform:

    terraform apply

  3. Se você não tiver criado o arquivo terraform.tfvars conforme descrito anteriormente, o Terraform solicitará que você insira valores das variáveis que não têm valores padrão. Insira os valores obrigatórios.

    O Terraform exibe uma lista dos recursos que serão criados.

  4. Quando for solicitado que você execute as ações, digite yes.

    O Terraform exibe mensagens mostrando o progresso da implantação.

    Se não for possível concluir a implantação, o Terraform exibirá os erros que causaram a falha. Analise as mensagens de erro e atualize a configuração para corrigi-los. Em seguida, execute o comando terraform apply novamente. Para receber ajuda com a solução de problemas do Terraform, consulte Erros ao implantar a solução usando a CLI do Terraform.

    Depois que todos os recursos forem criados, o Terraform exibirá a seguinte mensagem:

    Apply complete!

  5. Para ver e usar o app da Web de ponto de venda implantado, siga as instruções em Ver seu aplicativo da Web dinâmico implantado usando Java.

    Após a conclusão da implantação, a saída será semelhante a esta:

    pos_application_url = "http://34.27.130.180/"

    O pos_application_url é o endereço IP do front-end do aplicativo. O GKE atribui esse endereço IP ao endpoint público do balanceador de carga que expõe seu aplicativo à Internet.

  6. Para ver os recursos do Google Cloud implantados e as configurações deles, faça um tour interativo.

    Iniciar o tour

Quando você não precisar mais da solução, poderá excluí-la para evitar o faturamento contínuo dos recursos do Google Cloud. Para mais informações, consulte Excluir a implantação da solução.

Conhecer seu app dinâmico da Web implantado

Você implantou o aplicativo dinâmico do ponto de venda na Web. Acesse o site do ponto de venda, analise o site e veja como a solução funciona no console do Google Cloud. Esteja ciente de que pode levar alguns minutos após a implantação do aplicativo para que o site apareça no endereço fornecido.

O que é o aplicativo da web do Ponto de venda?

Esta solução Jump Start usa um exemplo de app da Web dinâmico chamado Point of Sale para demonstrar como a infraestrutura do Google Cloud GKE pode ajudar os desenvolvedores Java a criar, implantar e gerenciar apps da Web com recursos estáticos e conteúdo dinâmico. O ponto de venda é um app da Web que imita um terminal de finalização de compra realizado na loja de varejo.

O front-end do aplicativo é usado por um representante de vendas para verificar itens de um cliente em uma loja de varejo. Nessa tela, o representante de vendas pode realizar as seguintes ações:

  • Adicionar itens ao carrinho e prosseguir para o pagamento.
  • Limpar o carrinho ou remover itens.
  • Veja um comprovante de pagamento. Quando o usuário paga, o app da Web exibe uma fatura com o resultado da transação.

interface do ponto de venda

Outros casos extremos também são abordados. Por exemplo, se o usuário tentar pagar sem elementos no carrinho, o app da Web exibirá uma mensagem de erro.

Para ver os recursos do Google Cloud implantados e as configurações deles, faça um tour interativo.

Iniciar o tour

Explorar o front-end

Para iniciar o front-end do aplicativo da Web implantado no ponto de venda:

  1. Acesse a página Serviços no console do Google Cloud.

    Acessar Serviços

  2. Clique no endereço IP do Endpoints do balanceador de carga api-server-lb. O front-end do seu app da Web do ponto de venda é aberto em uma nova janela do navegador.

Agora você pode interagir com o app da Web do ponto de venda da mesma forma que os usuários o veriam, incluindo adicionar produtos, pagar ou ver a fatura.

Gerar carga no app da Web

Para examinar como o GKE responde a aumentos normais de tráfego no seu aplicativo da Web, envie solicitações rastreadas para o aplicativo da Web. As etapas a seguir usam hey para enviar automaticamente várias solicitações. hey vem pré-instalado no Cloud Shell:

  1. No Cloud Shell, verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Se não estiver, acesse esse diretório.

  2. Envie 150 solicitações para o aplicativo da Web:

    export LB_IP_ADDRESS=$(gcloud compute addresses list --filter=name:jss-pos-1 --format='value(address)')
hey -n 150 \
 -m POST \
 -H 'Content-Type: application/json' \
 -d '{"paidAmount":14.59865,"type":"CASH","items":[{"itemId":"19a89a67-3958-46cf-9776-c29983871c93","itemCount":1},{"itemId":"729d0dd6-950e-4098-8f70-e7144076e899","itemCount":1}]}' \
  http://$LB_IP_ADDRESS/api/pay

    O script atribui o endereço IP do front-end do app da Web dinâmico à variável LB_IP_ADDRESS.

    O resultado será assim:

    Summary:
  Total:        8.7963 secs
  Slowest:      6.0000 secs
  Fastest:      0.7981 secs
  Average:      2.7593 secs
  Requests/sec: 17.0527

  Total data:   132600 bytes
  Size/request: 884 bytes

Response time histogram:
  0.798 [1]     |■
  1.318 [24]    |■■■■■■■■■■■■■■■■■■■■■■■
  1.838 [42]    |■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
  2.359 [26]    |■■■■■■■■■■■■■■■■■■■■■■■■■
  2.879 [7]     |■■■■■■■
  3.399 [0]     |
  3.919 [7]     |■■■■■■■
  4.439 [11]    |■■■■■■■■■■
  4.960 [6]     |■■■■■■
  5.480 [9]     |■■■■■■■■■
  6.000 [17]    |■■■■■■■■■■■■■■■■

Latency distribution:
  10% in 1.1932 secs
  25% in 1.5938 secs
  50% in 1.9906 secs
  75% in 4.3013 secs
  90% in 5.5936 secs
  95% in 5.8922 secs
  99% in 6.0000 secs

Details (average, fastest, slowest):
  DNS+dialup:   0.0016 secs, 0.7981 secs, 6.0000 secs
  DNS-lookup:   0.0000 secs, 0.0000 secs, 0.0000 secs
  req write:    0.0004 secs, 0.0000 secs, 0.0036 secs
  resp wait:    2.7565 secs, 0.7980 secs, 5.9930 secs
  resp read:    0.0001 secs, 0.0000 secs, 0.0002 secs

Status code distribution:
  [200] 150 responses

    O campo Status code distribution mostra a confirmação de 150 respostas. Isso significa que o script executou 150 pagamentos bem-sucedidos.

Excluir a implantação da solução

Quando você não precisar mais da implantação da solução, exclua a implantação para evitar o faturamento contínuo dos recursos criados.

Excluir usando o console

Use este procedimento se você tiver implantado a solução pelo console.

  1. No console do Google Cloud, acesse a página Implantações da solução.

    Acessar implantações de solução

  2. Selecione o projeto que contém a implantação que você quer excluir.

  3. Localize a implantação que você quer excluir.

  4. Clique em Ações e selecione Excluir.

  5. Digite o nome da implantação e clique em Confirmar.

    O campo Status mostra Excluindo.

    Se a exclusão falhar, consulte as orientações de solução de problemas em Erro ao excluir uma implantação.

Quando você não precisar mais do projeto do Google Cloud usado na solução, exclua-o. Para mais informações, consulte Opcional: excluir o projeto.

Excluir usando a CLI do Terraform

Use este procedimento se você implantou a solução usando a CLI do Terraform.

  1. No Cloud Shell, verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-java-dynamic-point-of-sale/infra. Se não estiver, acesse esse diretório.

  2. Remova os recursos provisionados pelo Terraform:

    terraform destroy

    O Terraform exibe uma lista dos recursos que serão destruídos.

  3. Quando for solicitado que você execute as ações, digite yes.

    O Terraform exibe as mensagens que mostram o progresso. Depois que todos os recursos forem excluídos, o Terraform exibirá a seguinte mensagem:

    Destroy complete!

    Se a exclusão falhar, consulte as orientações de solução de problemas em Erro ao excluir uma implantação.

Quando você não precisar mais do projeto do Google Cloud usado na solução, exclua-o. Para mais informações, consulte Opcional: excluir o projeto.

Excluir o projeto

Se você tiver implantado a solução em um novo projeto do Google Cloud e não for mais usar o projeto, exclua-o seguindo estas etapas:

  1. No Console do Google Cloud, acesse a página Gerenciar recursos.

    Acessar "Gerenciar recursos"

  2. Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir.
  3. No prompt, digite o ID do projeto e clique em Encerrar.

Se você decidir manter o projeto, exclua a conta de serviço criada para essa solução, conforme descrito na próxima seção.

Opcional: excluir a conta de serviço

Se você excluiu o projeto usado para a solução, pule esta seção.

Como mencionado anteriormente neste guia, quando você implantou a solução, uma conta de serviço foi criada em seu nome. A conta de serviço recebeu determinadas permissões do IAM temporariamente, ou seja, as permissões foram revogadas automaticamente após a conclusão das operações de implantação e exclusão da solução, mas a conta de serviço não foi excluída. O Google recomenda que você exclua essa conta de serviço.

  • Se você implantou a solução no console do Google Cloud, acesse a página Implantações da solução. Se você já estiver nessa página, atualize o navegador. Um processo é acionado em segundo plano para excluir a conta de serviço. Nenhuma outra ação é necessária.

  • Se você implantou a solução usando a CLI do Terraform, conclua as etapas a seguir:

    1. No Console do Google Cloud, acesse a página Contas de serviço.

      Acessar Contas de serviço

    2. Selecione o projeto usado para a solução.

    3. Selecione a conta de serviço que você quer excluir.

      O ID de e-mail da conta de serviço que foi criada para a solução está no seguinte formato:

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

      O ID de e-mail contém os seguintes valores:

      • DEPLOYMENT_NAME: o nome da implantação.
      • NNN: um número aleatório de três dígitos.
      • PROJECT_ID é o ID do projeto em que você implantou a solução.

    4. Clique em Excluir.

Solucionar erros

As ações que podem ser realizadas para diagnosticar e resolver erros dependem do método de implantação e da complexidade dele.

Erros ao implantar usando o console

Se a implantação falhar quando você usar o console, faça o seguinte:

  1. Acesse a página Implantações da solução.

    Se a implantação falhou, o campo Status mostra Falha.

  2. Para ver os detalhes dos erros que causaram a falha, faça o seguinte:

    1. Clique em Ações.

    2. Selecione Ver registros do Cloud Build.

  3. Analise o registro do Cloud Build e tome as medidas apropriadas para resolver o problema que causou a falha.

Erros ao implantar usando a CLI do Terraform

Se a implantação falhar quando você usar o Terraform, a saída do comando terraform apply incluirá mensagens de erro que podem ser analisadas para diagnosticar o problema.

Os exemplos nas seções a seguir mostram erros de implantação que podem ser encontrados ao usar o Terraform.

Erro de API não ativada

Se você criar um projeto e tentar implantar imediatamente a solução no novo projeto, a implantação poderá falhar e apresentar um erro como este:

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.

Se esse erro ocorrer, aguarde alguns minutos e execute o comando terraform apply novamente.

Não é possível atribuir o erro do endereço solicitado

Quando você executa o comando terraform apply, pode ocorrer um erro cannot assign requested address, com uma mensagem como esta:

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

Se esse erro ocorrer, execute o comando terraform apply novamente.

Erro ao excluir uma implantação

Em alguns casos, as tentativas de excluir uma implantação podem falhar:

  • Depois de implantar uma solução no console, se você alterar qualquer recurso provisionado por ela e tentar excluir a implantação, a exclusão poderá falhar. O campo Status na página Implantações da solução mostra Com falha e o registro do Cloud Build mostra a causa do erro.
  • Depois de implantar uma solução usando a CLI do Terraform, se você alterar qualquer recurso usando uma interface diferente do Terraform (por exemplo, o console) e, em seguida, tentar excluir a implantação, a exclusão poderá falhar. As mensagens na saída do comando terraform destroy mostram a causa do erro.

Revise os registros de erro e as mensagens, identifique e exclua os recursos que causaram o erro e tente excluir a implantação novamente.

Se uma implantação baseada em console não for excluída e não for possível diagnosticar o erro usando o registro do Cloud Build, será possível excluir a implantação usando a CLI do Terraform, conforme descrito na próxima seção.

Excluir uma implantação com base no console usando a CLI do Terraform

Nesta seção, descrevemos como excluir uma implantação baseada em console em caso de erros ao tentar excluí-la no console. Nesta abordagem, faça o download da configuração do Terraform para a implantação que você quer excluir e use a CLI do Terraform para excluir a implantação.

  1. Identifique a região em que o código, os registros e outros dados do Terraform da implantação são armazenados. Essa região pode ser diferente da região selecionada durante a implantação da solução.

    1. No console do Google Cloud, acesse a página Implantações de soluções.

      Acessar implantações de solução

    2. Selecione o projeto que contém a implantação que você quer excluir.

    3. Na lista de implantações, identifique a linha da implantação que você quer excluir.

    4. Clique em Consultar todo o conteúdo da linha.

    5. Na coluna Local, observe o segundo local, conforme destacado no exemplo a seguir:

      Localização do código de implantação, registros e outros artefatos.

  2. No Console do Google Cloud, ative o Cloud Shell.

    Ativar o Cloud Shell

    Na parte inferior do Console do Google Cloud, uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

  3. Crie variáveis de ambiente para o ID do projeto, a região e o nome da implantação que você quer excluir:

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

    Nesses comandos, substitua o seguinte:

    • REGION: o local que você anotou anteriormente neste procedimento.
    • PROJECT_ID: o ID do projeto em que você implantou a solução.
    • DEPLOYMENT_NAME: o nome da implantação que você quer excluir.

  4. Encontre o ID da revisão mais recente da implantação que você quer excluir:

    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

    O resultado será assim:

    projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME/revisions/r-0

  5. Encontre o local do Cloud Storage na configuração do Terraform para a implantação:

    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

    Veja a seguir um exemplo da saída desse comando:

    gs://PROJECT_ID-REGION-blueprint-config/DEPLOYMENT_NAME/r-0/apply_results/content

  6. Faça o download da configuração do Terraform do Cloud Storage para o Cloud Shell:

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

    Aguarde até que a mensagem Operation completed seja exibida, conforme mostrado no exemplo a seguir:

    Operation completed over 45 objects/268.5 KiB

  7. Inicialize o Terraform:

    terraform init

    Aguarde até ver a seguinte mensagem:

    Terraform has been successfully initialized!

  8. Remova os recursos implantados:

    terraform destroy

    O Terraform exibe uma lista dos recursos que serão destruídos.

    Se forem exibidos avisos sobre variáveis não declaradas, ignore-os.

  9. Quando for solicitado que você execute as ações, digite yes.

    O Terraform exibe as mensagens que mostram o progresso. Depois que todos os recursos forem excluídos, o Terraform exibirá a seguinte mensagem:

    Destroy complete!

  10. Exclua o artefato de implantação:

    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. Aguarde alguns segundos e verifique se o artefato de implantação foi excluído:

    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

    Se a saída mostrar null, aguarde alguns segundos e execute o comando novamente.

    Depois que o artefato de implantação for excluído, uma mensagem, como mostrado no exemplo a seguir, será exibida:

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

Enviar feedback

As Soluções de início rápido são apenas para fins informativos e não são produtos oficialmente compatíveis. O Google pode alterar ou remover soluções sem aviso prévio.

Para resolver erros, analise os registros do Cloud Build e a saída do Terraform.

Para enviar feedback, faça o seguinte:

  • Para ver a documentação, os tutoriais no console ou a solução, use o botão Enviar feedback na página.
  • Para código não modificado do Terraform, crie problemas no repositório do GitHub. Os problemas do GitHub são analisados com base no melhor esforço e não se destinam a perguntas gerais de uso.

A seguir

Para saber mais sobre como implantar aplicativos Java com produtos e recursos do Google Cloud, consulte: