Salvar e carregar snapshots do ambiente

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

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

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

Sobre snapshots de ambiente

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

Você pode usar os snapshots para:

Como os snapshots são armazenados

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

É possível criar vários snapshots do seu ambiente. Snapshots do ambiente não incrementais. É possível usar qualquer snapshot de forma independente.

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

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

Embora a IU do Cloud Storage exiba dados como pastas por conveniência, os buckets trabalham em uma estrutura de arquivos simples. Isso não muda a forma de salvar e carregar instantâneos no console do Google Cloud, mas lembre-se disso ao realizar operações diretamente nos arquivos do bucket. Para mais informações, consulte Namespace de objetos.

Considerações de segurança para snapshots

Para reduzir esse risco de segurança, é possível armazenar informações sensíveis usadas por DAGs do Airflow, como chaves ou senhas, no Secret Manager. Para mais informações, consulte Configurar o Secret Manager para seu ambiente.

Confira as permissões de segurança do bucket do seu ambiente. Se você para armazenar snapshots do ambiente em um bucket personalizado, as permissões de acesso do usuário estejam configuradas corretamente no projeto. Ao atribuir permissões, verifique se o serviço do ambiente tem permissões suficientes para salvar e carregar snapshots da do Google Cloud.

Quais dados são salvos em snapshots

O Cloud Composer salva os seguintes dados em snapshots:

  • Substituições da 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 o histórico de execuções do DAG.
  • Um backup das pastas /dags, /data e /plugins do bucket do ambiente.
  • Chave Fernet do ambiente.
  • Outras informações sobre a configuração do ambiente, como os parâmetros de escalonamento e desempenho. O Cloud Composer não usa essas informações ao carregar instantâneos.

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 os estados das 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 de fernet do snapshot é usada para recriptografar os dados do com a própria chave fernet do ambiente. A chave fernet do ambiente permanece inalterada.

O Cloud Composer armazena algumas informações sobre os do ambiente em snapshots, ela não é usada ao carregar snapshots. Os seguintes parâmetros do seu ambiente não mudam quando você carregar um snapshot:

  • Configuração do ambiente, como escalonamento e desempenho dele parâmetros.
  • Configuração de rede do ambiente.
  • Conteúdo do bucket do ambiente fora do /dags, /data e /plugins pastas.
  • 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 concluída, falhar ou ser parcialmente concluída:

  • Operações bem-sucedidas carregam todos os dados do snapshot.
  • As operações com falha não introduzem 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 forem instalados, mas as substituições de opção de configuração do Airflow não tiverem sucesso, a mensagem de erro indicará isso.

Para uma operação parcialmente concluída, tente carregar o mesmo snapshot novamente. O Cloud Composer pula etapas que foram concluídas na tentativa anterior. Por exemplo, se uma operação falhar em um tempo limite, mas o banco de dados for carregado, a próxima tentativa não vai carregar o banco de dados novamente.

Antes de começar

  • No Cloud Composer 1, só é possível salvar snapshots, não carregá-los. Você pode carregar snapshots de um ambiente do Cloud Composer 1 para o Cloud Composer 2 e ambientes de teste.

  • Os snapshots são compatíveis com o Cloud Composer 2 versão 2.0.9 e mais recentes. O Cloud Composer 1 oferece suporte para salvar snapshots do ambiente nas versões 1.18.5 ou mais recentes.

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

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

  • Só é possível carregar snapshots na mesma versão ou em uma versão mais recente do Cloud Composer ou do Airflow. Por exemplo, não é possível carregar snapshot do Cloud Composer 2.0.2 para um ambiente com 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ê atualiza seu ambiente para uma versão posterior do Cloud Composer, carregue um snapshot de uma versão anterior seu ambiente ainda mantém 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 compatível com snapshots é de 20 GB. Se o banco de dados do seu ambiente ocupar mais de 20 GB, reduz o tamanho do banco de dados do Airflow antes de salvar um instantâneo.

  • O número total de objetos nas pastas /dags, /plugins e /data no bucket do ambiente precisa ser menor que 100.000 para criar snapshots.

  • Se você usar o mecanismo XCom para transferir arquivos, certifique-se de [use de acordo com as diretrizes do Airflow][ext-airflow-xcom-backend]. A transferência de arquivos grandes ou um grande número de arquivos usando o XCom afeta Desempenho do banco de dados do Airflow e pode causar falhas no carregamento snapshots ou o upgrade do ambiente. Considere usar alternativas como para transferir grandes volumes de dados.

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

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

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

Salvar um snapshot do ambiente

O Cloud Composer salva snapshots do ambiente em uma subpasta, em relação à pasta especificada. O nome da pasta contém o ID do projeto, o local do ambiente, 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 do arquivo bucket, selecione Usar pasta de snapshot no bucket do ambiente (padrão).

    • Para armazenar o snapshot na pasta personalizada, selecione Usar a pasta personalizada em outro bucket, depois especificar um local.

  5. Clique em Salvar.

gcloud

O comando gcloud beta composer environments snapshots save salva um snapshot do seu 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 seu ambiente. Por exemplo, gs://us-central1-example-916807e1-bucket/snapshots. Também é possível 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 armazenamento será armazenado. o snapshot. Se você omitir esse argumento, o Cloud Composer salvará o snapshot na pasta /snapshots no bucket do 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 a 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 nem carregar snapshots do ambiente dele.

Carregar um snapshot do 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 ambientes do Cloud Composer 2. Por exemplo, quando você Migre seus ambientes para o Cloud Composer 2.

A seguir