Solução Jump Start: implantar um aplicativo Java usando o Compute Engine

Last reviewed 2023-09-29 UTC

Este guia ajuda você a entender a solução de início rápido para implantar um aplicativo Java usando o Compute Engine. Esta solução demonstra como implantar um aplicativo Java (xWiki) usando as VMs do Compute Engine. Este guia é destinado a desenvolvedores e operadores familiarizados com Java (ou outras linguagens de programação de uso geral), bancos de dados e outras ferramentas de desenvolvedor, mas que não estão familiarizados com o Google Cloud.

A solução implanta o aplicativo XWiki para demonstrar como usá-la. Este aplicativo é executado e usa o Cloud SQL para o banco de dados.

Use a arquitetura desta solução como um exemplo de como implantar diferentes tipos de aplicativos no Google Cloud que tenham as seguintes características:

É um aplicativo da Web
Requer escalonamento automático horizontal com base no tráfego
Acessível publicamente pela Internet
Tem um back-end de banco de dados com requisitos de alta disponibilidade

Produtos usados

Veja a seguir um resumo dos produtos do Google Cloud que essa solução usa:

Compute Engine: um serviço de computação seguro e personalizável que permite criar e executar máquinas virtuais na infraestrutura do Google.
Cloud SQL: um serviço baseado em nuvem para bancos de dados MySQL, PostgreSQL e SQL Server totalmente gerenciado na infraestrutura do Google Cloud.
Cloud Load Balancing: um serviço que fornece balanceamento de carga escalonável e de alto desempenho no Google Cloud.
Filestore: o Filestore é um sistema de arquivos totalmente gerenciado e de baixa latência para VMs e clusters com foco em oferecer alta disponibilidade e capacidade.
Cloud Storage: um serviço pronto para empresas que oferece armazenamento de objetos de baixo custo e sem limite para diversos tipos de dados. Os dados podem ser acessados de dentro e de fora do Google Cloud e são replicados de modo geograficamente redundante.

Arquitetura

O diagrama a seguir mostra a arquitetura da solução:

Diagrama da arquitetura de aplicativo Java implantado no Compute Engine

Componentes e configuração

A arquitetura inclui os seguintes componentes:

As solicitações do usuário são encaminhadas para o Cloud Load Balancing.
A solicitação entra na rede de nuvem privada virtual (VPC).
As solicitações são filtradas pelas regras do Cloud Next Generation Firewall. Se elas corresponderem às regras de encaminhamento, as solicitações serão encaminhadas para um back-end com base no URL da solicitação.
O aplicativo Java é executado em um back-end de tempo de execução de computação. Nesta solução, o back-end é um grupo gerenciado de instâncias (MIG, na sigla em inglês) com o escalonamento automático ativado. Assim, à medida que a carga de solicitação aumenta, o MIG escalona automaticamente o número de instâncias do Compute Engine que processam solicitações e ativa o balanceamento de carga em todas as instâncias.
O Cloud SQL para MySQL é usado como o back-end de banco de dados relacional para o aplicativo Java com um primário e um secundário para redundância.
O Compute Engine também pode acessar arquivos armazenados no Cloud Storage ou no Filestore, conforme necessário. O Cloud Storage é usado para armazenar conteúdo estático relacionado ao aplicativo. O Filestore é usado para armazenar as páginas do XWiki em uma estrutura de sistema de arquivos.

Custo

Para uma estimativa dos custos dos recursos do Google Cloud usados pelo aplicativo "Implantar um Java" usando a solução Compute Engine, 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

Este guia de solução usa o XWiki para orientar você pelo processo completo de implantação de um aplicativo da Web acessível publicamente usando o Google Cloud.

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:

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

Acessar o seletor de projetos
Para começar a criar um projeto do Google Cloud, clique em Criar projeto.
Escolha o nome do projeto. Anote o código do projeto gerado.
Edite os outros campos conforme necessário.
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.

roles/compute.admin
roles/cloudsql.admin
roles/logging.admin
roles/monitoring.admin
roles/resourcemanager.projectIamAdmin
roles/secretmanager.admin
roles/iam.serviceAccountAdmin
roles/servicenetworking.networksAdmin
roles/serviceusage.serviceUsageAdmin
roles/storage.admin
roles/storage.hmacKeyAdmin
roles/file.editor
roles/iam.serviceAccountUser

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.

No catálogo do Google Cloud Jump Start Solutions, acesse a solução Implantar um aplicativo Java usando o Compute Engine.

Acessar "Implantar um aplicativo Java usando a solução do Compute Engine"
Revise as informações fornecidas na página, como o custo estimado da solução e o tempo estimado de implantação.
Quando estiver tudo pronto para começar a implantar a solução, clique em Implantar.

Veja um guia interativo passo a passo.
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.
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.
Para visualizar e usar a solução, clique no menu more_vertAções e selecione Explorar esta solução.

Quando você não precisar mais da solução, exclua a implantação para evitar o faturamento contínuo dos recursos do Google Cloud. Para mais informações, consulte Excluir a implantaçã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.

Clone o repositório do GitHub no Cloud Shell.

Você verá um prompt para confirmar o download do repositório do GitHub para o Cloud Shell.
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.
No Cloud Shell, verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-deploy-java-multizone/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-deploy-java-multizone/infra
```
Inicialize o Terraform executando o seguinte comando:
```
terraform init
```
Aguarde até ver a seguinte mensagem:
```
Terraform has been successfully initialized!
```

Validar e revisar a configuração do Terraform

Verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-deploy-java-multizone/infra. Se não estiver, acesse esse diretório.
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.
```
Analise os recursos definidos na configuração:
```
terraform plan
```
O Terraform solicita que você insira valores para as 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:

Verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-deploy-java-multizone/infra. Se não estiver, acesse esse diretório.
Aplique a configuração do Terraform:
```
terraform apply
```
O Terraform solicita que você insira valores para as 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.
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!
```
A saída adicional a seguir é exibida:
- xwiki_entrypoint_url: o URL para acessar a página inicial do aplicativo XWiki.
- xwiki_mig_self_link: o ID do grupo de instâncias gerenciadas que gerencia as VMs do Compute Engine.
- neos_walkthrough_url: o URL para acessar o tutorial.
Para ver seu front-end de amostra, acesse a página wiki_entrypoint_url.

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

Excluir a implantação

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

Excluir usando o console

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

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

Acessar implantações de solução
Selecione o projeto que contém a implantação que você quer excluir.
Localize a implantação que você quer excluir.
Clique em Ações e selecione Excluir.
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.

No Cloud Shell, verifique se o diretório de trabalho atual é $HOME/cloudshell_open/terraform-example-deploy-java-multizone/infra. Se não estiver, acesse esse diretório.
Remova os recursos provisionados pelo Terraform:
```
terraform destroy
```
O Terraform exibe uma lista dos recursos que serão destruídos.
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:

No Console do Google Cloud, acesse a página Gerenciar recursos.
Acessar "Gerenciar recursos"
Na lista de projetos, selecione o projeto que você quer excluir e clique em Excluir.
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

Erros ao implantar usando o console

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

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

Se a implantação falhou, o campo Status mostra Falha.
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.
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.

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.

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:
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.
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.

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

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

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
```

Inicialize o Terraform:

terraform init

Aguarde até ver a seguinte mensagem:

Terraform has been successfully initialized!

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.
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!
```

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"

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.

Para problemas com produtos usados na solução, entre em contato com o Cloud Customer Care.