Salvar e carregar snapshots do ambiente

Cloud Composer 1 | Cloud Composer 2

Nesta página, explicamos como salvar e carregar o estado do ambiente usando snapshots de ambiente.

É possível configurar o ambiente para salvar snapshots automaticamente. Para mais informações, consulte Configurar snapshots programados.

Sobre snapshots de ambiente

Os snapshots do ambiente armazenam o estado do ambiente. É possível salvar e carregar snapshots de ambiente sob demanda.

É possível usar snapshots para:

Como os snapshots são armazenados

Um snapshot de ambiente é um conjunto de arquivos que descrevem o estado do seu ambiente e armazenam o backup dos dados dele.

É possível criar vários snapshots do ambiente. Os snapshots de ambiente não são incrementais. É possível usar qualquer snapshot independente de outros.

O Cloud Composer não exclui snapshots quando você exclui o ambiente.

Por padrão, o Cloud Composer armazena snapshots na pasta snapshots/ do bucket do ambiente. Também é possível especificar um local personalizado ao criar um snapshot.

Enquanto a IU do Cloud Storage exibe dados como pastas por conveniência, os buckets funcionam em uma estrutura de arquivos simples. Isso não muda a forma como você trabalha para salvar e carregar snapshots no console do Google Cloud, mas lembre-se disso ao realizar operações diretamente nos arquivos do bucket. Para mais informações, consulte Namespace do objeto.

Considerações de segurança para snapshots

Para reduzir esse risco de segurança, armazene no Secret Manager as informações confidenciais usadas pelos DAGs do Airflow, como chaves ou senhas. Para mais informações, consulte Configurar o Secret Manager para o ambiente.

Confira as permissões de segurança do bucket do ambiente. Se você armazenar snapshots de ambiente em um bucket personalizado, verifique se as permissões de acesso para ele estão configuradas corretamente no projeto. Ao atribuir permissões, verifique se a conta de serviço do ambiente tem permissões suficientes para salvar e carregar snapshots do bucket.

Quais dados são salvos em snapshots

O Cloud Composer salva os seguintes dados em snapshots:

  • Substituições de configuração do Airflow.
  • Variáveis de ambiente.
  • Lista de pacotes PyPI personalizados, como requisitos.
  • Um backup do banco de dados do Airflow, incluindo estados de tarefas executadas e histórico de execuções do DAG.
  • Um backup das pastas /dags, /data e /plugins do bucket do ambiente.
  • A chave fernet do ambiente.
  • Outras informações sobre a configuração do ambiente, como os parâmetros de escalonamento e desempenho dele. O Cloud Composer não usa essas informações ao carregar snapshots.

Quais dados são carregados dos snapshots

O Cloud Composer carrega os seguintes dados dos snapshots:

  • Substituições de configuração do Airflow.
  • Variáveis de ambiente.

  • Pacotes PyPI personalizados (a menos que você opte por pular a instalação).

  • O conteúdo do banco de dados do Airflow, incluindo estados de tarefas executadas e histórico de execuções do DAG.

  • O conteúdo das pastas /dags, /data e /plugins do snapshot é carregado no bucket do ambiente.

  • A chave fernet do snapshot é usada para recriptografar os dados dele com a própria chave de fernet do ambiente. A chave de fernet do ambiente permanece inalterada.

O Cloud Composer armazena algumas informações sobre a configuração do ambiente em snapshots, mas elas não são usadas ao carregar snapshots. Os seguintes parâmetros do seu ambiente não mudam quando você carrega um snapshot:

  • Configuração do ambiente, como escalonamento e parâmetros de desempenho.
  • Configuração de rede do ambiente.
  • Conteúdo do bucket do ambiente fora das pastas /dags, /data e /plugins.
  • Rótulos de ambiente.

Todas as configurações aplicadas na infraestrutura do Cloud Composer sem usar a API Cloud Composer podem ser perdidas ao carregar um snapshot.

Sobre operações parcialmente concluídas

Quando você carrega um snapshot, a operação pode ser bem-sucedida, com falha ou parcialmente concluída:

  • Operações bem-sucedidas carregam todos os dados do snapshot.
  • As operações com falha não causam mudanças.
  • Operações parcialmente concluídas carregam um subconjunto de dados do snapshot. Essas operações são relatadas como falhas, mas a mensagem de erro indica quais dados foram carregados. Por exemplo, se os pacotes PyPI estiverem instalados, mas as substituições de opções de configuração do Airflow não tiverem sido bem-sucedidas, a mensagem de erro vai indicar isso.

Para uma operação parcialmente concluída, tente carregar o mesmo snapshot novamente. O Cloud Composer ignora as etapas que foram bem-sucedidas na tentativa anterior. Por exemplo, se uma operação falhar no tempo limite, mas o banco de dados tiver sido carregado com sucesso, a próxima tentativa não carregará o banco de dados novamente.

Antes de começar

  • No Cloud Composer 1, é possível salvar snapshots, mas não carregá-los. É possível carregar snapshots de um ambiente do Cloud Composer 1 para os ambientes do Cloud Composer 2.

  • Os snapshots são compatíveis com o Cloud Composer 2 versão 2.0.9 e posterior. O Cloud Composer 1 é compatível com o salvamento de snapshots de ambiente para as versões 1.18.5 ou posteriores à 1.18.5.

  • Os snapshots não criam um ambiente. Se você quiser carregar um snapshot de um ambiente para outro, primeiro crie um novo ambiente e carregue o snapshot nele.

  • Não é possível carregar snapshots em ambientes com estado de erro. Não é possível corrigir esses ambientes carregando um snapshot. Ainda é possível carregar um snapshot atual em um novo ambiente.

  • Só é possível carregar snapshots na mesma versão ou posterior do Cloud Composer ou do Airflow. Por exemplo, não é possível carregar um snapshot do Cloud Composer 2.0.2 em um ambiente com o Cloud Composer 2.0.1. Como outro exemplo, não é possível carregar um snapshot do Airflow 2.2.3 para o Airflow 2.1.4.

  • Os snapshots não alteram a versão do Cloud Composer. Se você fizer upgrade do ambiente para uma versão posterior do Cloud Composer e carregar um snapshot de uma versão anterior, o ambiente ainda manterá a versão atual do Cloud Composer. Por exemplo, carregar um snapshot do Cloud Composer 2.0.1 para o Cloud Composer 2.0.2 não reverte o ambiente para o Cloud Composer 2.0.1.

  • O tamanho máximo do banco de dados do Airflow que aceita snapshots é de 20 GB. Se o banco de dados do ambiente ocupar mais de 20 GB, reduza o tamanho do banco de dados do Airflow antes de salvar um snapshot.

  • O comprimento máximo do nome de um objeto no bucket do ambiente não pode ser mais que 1.024 símbolos. Caso contrário, não é possível criar snapshots.

  • Se você salvar snapshots em um local fora do bucket do seu ambiente, a conta de serviço do seu ambiente precisará ter permissões de leitura e gravação para o local especificado. Por exemplo, o papel Administrador de objetos do Storage tem essas permissões. É possível aplicá-lo a um projeto ou a um bucket específico.

  • A criação e o armazenamento de snapshots produzem outros custos, relacionados ao Cloud Storage. Para saber mais informações, consulte Preços.

Salvar um snapshot do ambiente

O Cloud Composer salva snapshots de ambiente em uma subpasta relacionada à pasta especificada. O nome da pasta contém o ID do projeto, o local e o nome do ambiente e o carimbo de data/hora em que o snapshot foi salvo. Por exemplo, /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

Console

Para criar um snapshot do seu ambiente:

  1. No console do Google Cloud, acesse a página Ambientes.

    Acessar "Ambientes"

  2. Na lista de ambientes, clique no nome do ambiente. A página Detalhes do ambiente é aberta.

  3. Clique em Salvar snapshot.

  4. Na caixa de diálogo Salvar snapshot, selecione onde armazenar o snapshot:

    • Para armazenar o snapshot na pasta /snapshots no bucket do ambiente, selecione Usar a pasta de snapshot no bucket do ambiente (padrão).

    • Para armazenar o snapshot na pasta personalizada, selecione Usar pasta personalizada em outro bucket e especifique um local.

  5. Clique em Salvar.

gcloud

O comando gcloud beta composer environments snapshots save salva um snapshot do ambiente.

  • O argumento snapshot-location especifica uma pasta em que o snapshot é salvo. Por padrão, os snapshots são salvos na pasta /snapshots no bucket do ambiente. Por exemplo, gs://us-central1-example-916807e1-bucket/snapshots. Você também pode especificar qualquer outra pasta.

Para salvar um snapshot do seu ambiente, execute:

gcloud beta composer environments snapshots save \
  ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-location "SNAPSHOTS_FOLDER"

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;
  • (Opcional) SNAPSHOTS_FOLDER pelo URI de uma pasta do bucket em que o snapshot será armazenado. Se você omitir esse argumento, o Cloud Composer salvará o snapshot na pasta /snapshots no bucket do seu ambiente.

O exemplo a seguir usa o local padrão:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1

O exemplo a seguir é salvo em uma pasta personalizada:

gcloud beta composer environments snapshots save \
  example-environment \
  --location us-central1 \
  --snapshot-location "gs://example-bucket/environment_snapshots"

API

  1. Crie uma solicitação de API environments.saveSnapshot.

  2. No corpo da solicitação, no campo snapshotLocation, especifique a pasta em que você quer salvar o snapshot.

{
  "snapshotLocation": "SNAPSHOTS_FOLDER"
}

Substitua:

  • SNAPSHOTS_FOLDER pelo URI de uma pasta do bucket em que o snapshot será salvo.

Exemplo:

// POST https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment:saveSnapshot

{
  "snapshotLocation": "gs://us-central1-example-916807e1-bucket/snapshots"
}

Terraform

Não é possível salvar e carregar snapshots de ambiente do Terraform.

Salvar e carregar snapshots são ações executadas em um ambiente, e os snapshots resultantes não fazem parte da definição de um ambiente. Como o Terraform gerencia apenas a configuração do ambiente do Cloud Composer, não é possível salvar ou carregar snapshots dele.

Carregar um snapshot de ambiente

No Cloud Composer 1, é possível salvar snapshots, mas não carregá-los. É possível carregar snapshots de um ambiente do Cloud Composer 1 para os ambientes do Cloud Composer 2. Por exemplo, quando você migrar seus ambientes para o Cloud Composer 2.

A seguir