Requisito do App Engine

Antes, todos os bancos de dados do Firestore no modo Datastore eram vinculados a um app do App Engine. Quando vinculado, seu banco de dados exige um app ativo do App Engine no mesmo projeto. Sem o app do App Engine ativo, o acesso de leitura e gravação ao banco de dados é desativado.

Por padrão, os bancos de dados do modo Datastore agora são provisionados sem vinculação ao App Engine.

Se o banco de dados estiver vinculado a um App Engine, você poderá desvincular.

App Engine ativo

Um app do App Engine ativo significa que um app existe no mesmo projeto e que ele não está desativado. Não é necessário que o app tenha qualquer uso. O app e o banco de dados vinculados precisam estar na mesma região.

Se você desativar o app do App Engine, também vai desativar o acesso ao banco de dados do modo Datastore vinculado a ele.

É possível verificar o estado de desvinculação do App Engine usando a API REST:

curl  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
--header "Content-type: application/json" \
"https://firestore.googleapis.com/v1/projects/PROJECT_ID/databases/(default)"

Na resposta, confira o valor de appEngineIntegrationMode. Se o valor for DISABLED, seu banco de dados não estará vinculado a um app do App Engine.

É possível desvincular o banco de dados do modo Datastore do aplicativo do App Engine para remover o requisito de um aplicativo ativo do App Engine. Ao desvincular seu banco de dados, você pode desativar o App Engine sem afetar o acesso ao banco de dados.

A desvinculação é uma operação permanente.

Se você desvincular o banco de dados, não poderá usar o recurso Desativar gravações na página Datastore Admin. Se as gravações estiverem desativadas no momento, a desvinculação do banco de dados vai ativar as gravações.

Antes de desvincular seu banco de dados do App Engine, ative a API Firestore e atualize suas permissões do IAM.

Para desvincular seu banco de dados, acesse a página Datastore Admin e clique em Desvincular banco de dados do app. A operação de desvinculação pode levar até cinco minutos para entrar em vigor.

Acessar o Datastore Admin

Migrar recursos do Terraform App Engine

Se você já gerenciou bancos de dados no modo Datastore usando o recurso do Terraform google_app_engine_application, use o recurso google_firestore_database.

Para instruções gerais sobre como gerenciar bancos de dados do modo Datastore usando o Terraform, consulte Como automatizar a criação de bancos de dados.

Criar um recurso google_firestore_database

No arquivo de configuração do Terraform, crie um novo recurso google_firestore_database:

datastore.tf

resource "google_firestore_database" "database" {
  project     = "project"
  name        = "(default)"
  location_id = "location"
  
  type = "DATASTORE_MODE"
  
  app_engine_integration_mode = "DISABLED"

  // Optional, but recommended for safety
  delete_protection_state = "DELETE_PROTECTION_ENABLED"
}

Consulte Locais do Datastore para conferir a lista de locais disponíveis. Escolha o local correspondente ao do seu banco de dados atual.

Importar o banco de dados do modo Datastore

Primeiro, verifique se a API Firestore está ativada.

Em seguida, importe o banco de dados do modo Datastore para o estado do Terraform:

terraform import google_firestore_database.database "(default)"

Depois execute:

terraform plan

Inspecione a saída para garantir que a importação foi concluída corretamente. Se a saída mostrar alguma mudança de campo, verifique se essas mudanças são intencionais. Se a saída incluir uma linha semelhante a:

google_firestore_database.database must be replaced

Em seguida, inspecione o arquivo de configuração do Terraform para verificar se houve erros, principalmente nos campos project, location ou name, e execute terraform plan novamente. Todos os campos que exigem que o Terraform substitua seu banco de dados serão marcados com # forces replacement na saída do plano.

Quando você estiver satisfeito com a saída do plano do Terraform, execute:

terraform apply

Remover o recurso google_app_engine_application

Se você tiver um recurso google_app_engine_application no arquivo de configuração do Terraform, remova-o agora.

Depois, execute novamente:

terraform plan

A resposta será semelhante a esta:

Terraform will perform the following actions:

  # google_app_engine_application.app will be destroyed
  # (because google_app_engine_application.app is not in configuration)

Quando você estiver satisfeito com a saída do plano, execute

terraform apply

No momento, o Terraform não oferece suporte à exclusão de recursos do App Engine. Embora o Terraform mostre o recurso como destruído, ele não exclui o aplicativo do App Engine. No entanto, o aplicativo do App Engine não será mais gerenciado pelo Terraform.

Requisito da API Firestore

Antes, todos os bancos de dados do Firestore no modo Datastore eram vinculados a um app do App Engine. Agora, os bancos de dados do modo Datastore são provisionados desvinculados do App Engine por padrão. Além disso, todos os bancos de dados, existentes e recém-criados, agora têm os seguintes requisitos:

  • Para gerenciar o banco de dados no console Google Cloud e na CLI gcloud, a API Firestore precisa estar ativada no projeto. Isso é necessário para bancos de dados do Firestore no modo nativo e no modo Datastore.

  • Quando executadas no console Google Cloud ou na CLI gcloud, as operações administrativas abaixo exigem as seguintes permissões do IAM:

    • Criar banco de dados: datastore.databases.create
    • Ver metadados do banco de dados: datastore.databases.getMetadata
    • Editar metadados do banco de dados: datastore.databases.update

Se você não tiver ativado a API Firestore, um erro vai aparecer nas páginas Datastore do console Google Cloud , incluindo o seguinte aviso:

A API Firestore é obrigatória para administrar o banco de dados.

Esse erro também inclui um botão para ativar a API Firestore. Clique no botão para ativar a API.

Verifique também suas permissões do IAM para garantir que seu acesso ao banco de dados não seja afetado.

Verifique se as contas que acessam o banco de dados pelo console Google Cloud têm as permissões necessárias, listadas acima.

Papéis predefinidos, como Usuário do Datastore e Leitor do Datastore, incluem as permissões necessárias. Se você criou papéis personalizados do IAM, talvez seja necessário atualizá-los para incluir as permissões acima.

Se você já tiver definido um papel personalizado para o Datastore, ele pode não ter a permissão datastore.databases.getMetadata. Para garantir o acesso contínuo, atualize seus papéis personalizados com datastore.databases.getMetadata ou use um papel predefinido.

Como ativar a API usando o Terraform

Se quiser, também é possível ativar a API Firestore usando o Terraform:

resource "google_project_service" "firestore" {
  project = "project"
  service = "firestore.googleapis.com"
}

Se você tiver um recurso google_firestore_database, adicione uma dependência ao recurso google_project_service para garantir que a API seja ativada antes que o Terraform tente criar o banco de dados:

resource "google_firestore_database" "database" {
  // ...
  depends_on = [google_project_service.firestore]
}