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 o ambiente para salvar snapshots automaticamente. Para mais informações, consulte Configurar snapshots programados.

Sobre os 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:

• Restaure o ambiente para um estado anterior. Crie backups do seu ambiente usando snapshots e, em seguida, carregue um deles para restaurar o ambiente. Por exemplo, é possível reverter uma operação de atualização que instala pacotes PyPI ou substitui as opções de configuração do Airflow, mesmo após a atualização do ambiente.

• Faça upgrades lado a lado e copie ambientes. Crie um snapshot de um ambiente atual, crie um novo ambiente que use a mesma versão do Cloud Composer ou uma versão mais recente e aplique o snapshot a esse novo ambiente. Esse procedimento é semelhante a migrar. Finalize as DAGs antes de fazer o snapshot para evitar execuções de DAG duplicadas.

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. Os snapshots do ambiente não sã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 no snapshots/ no bucket do 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 como você trabalha para salvar e o carregamento de snapshots no console do Google Cloud. Lembre-se disso e executar operações diretamente nos arquivos do bucket. Para mais informações, consulte Namespace de objetos.

Considerações de segurança para snapshots

Aviso: a chave fernet do seu ambiente está armazenada junto com o backup do banco de dados do Airflow. Isso significa que informações sensíveis informações como senhas e extras de conexão do Airflow podem ser descriptografadas de um snapshot do ambiente.

Para reduzir esse risco de segurança, armazene informações sensíveis usada por DAGs do Airflow, como chaves ou senhas, com o Secret Manager. Para mais informações, consulte Configurar o Secret Manager para seu ambiente.

Verifique as permissões de segurança do bucket do seu ambiente. Se você armazenar snapshots do ambiente em um bucket personalizado, verifique se as permissões de acesso estão 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 DAG histórico de execuções.
• 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 escala e desempenho do ambiente. O Cloud Composer não usa essas informações ao carregar instantâneos.

Quais dados são carregados de snapshots

O Cloud Composer carrega os seguintes dados dos snapshots:

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

• Pacotes PyPI personalizados (a menos que você pule a instalação deles).

  Cuidado: o Cloud Composer instala pacotes conforme especificados nos requisitos. Por exemplo, se um snapshot tiver example_package>=1.0 como requisito, uma versão diferente do pacote pode ser instalada ao carregar o snapshot.

• O conteúdo do banco de dados do Airflow, incluindo estados de tarefas executadas e o histórico de execuções de 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.

Embora o Cloud Composer armazene algumas informações sobre a configuração do ambiente em snapshots, ele não é usado 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 parâmetros.
• Configuração de rede do ambiente.
• Conteúdo do bucket do ambiente fora das pastas /dags, /data e /plugins.
• Identificadores de ambiente.

Todas as configurações aplicadas na infraestrutura do Cloud Composer sem usar a API Cloud Composer pode ser perdida 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 com falha, mas a mensagem de erro indica os dados foram carregados. Por exemplo, se pacotes PyPI estiverem instalados, mas as substituições de opções de configuração do Airflow não funcionaram, o erro indica isso.

Para uma operação parcialmente concluída, tente carregar o mesmo snapshot de novo. O Cloud Composer pula as etapas que foram bem-sucedidas de todas as tentativas anteriores. Por exemplo, se uma operação falhar no tempo limite, mas o banco de dados for carregado, a próxima tentativa não carregará o no banco de dados novamente.

Antes de começar

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

• Os snapshots não criam um ambiente. Se você quiser carregar um snapshot um ambiente para outro, primeiro é preciso criar um novo e carregar o snapshot nele.

• Não é possível carregar snapshots em ambientes com estado de erro. É 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 em uma versão mais recente do Cloud Composer ou Airflow. Por exemplo, não é possível carregar um snapshot do Cloud Composer 2.0.2 para 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ê 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 que dá suporte a 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.

• 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 é 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 de administrador de objetos do Storage tem essas permissões. Você pode aplicá-lo a um projeto ou a um bucket específico.

• A criação e o armazenamento de snapshots geram outros custos, para o 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 seu 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 do bucket, selecione Usar 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 do seu bucket do seu ambiente de execução. 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 de bucket salvar o snapshot.

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

Aviso: depois de carregar um snapshot, o histórico de execução do DAG é restaurado para o estado do snapshot. Isso pode levar a execuções de DAG duplicadas.

Considere a seguinte situação. Por exemplo: catch-up é ativado, e o Airflow executa um DAG em uma programação entre o momento em que o snapshot foi criado e quando ele foi carregado. Nesse caso, depois que você carrega o snapshot, o Airflow não tem informações sobre a execução do DAG que ocorreu. Portanto, ele executa o DAG novamente para o mesmo horário e data.

Como outro exemplo, considere um DAG executado diariamente. Você tira um snapshot, o Airflow executa esse DAG e, em seguida, você carrega o snapshot no mesmo dia. Nesse caso, o Airflow executa o DAG novamente, mesmo que a atualização esteja desativada.

Console

Para carregar um snapshot no ambiente do Cloud Composer 2:

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

   Acessar "Ambientes"

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

3. Clique em Carregar snapshot.

4. Na caixa de diálogo Carregar snapshot, clique em Procurar.

5. Selecione uma pasta que armazene o snapshot. O nome da pasta lista o ID do projeto, o local 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.

6. (Opcional) Para pular a instalação de pacotes PyPI personalizados do snapshot, selecione Pular instalação de pacotes PyPI. Se você carregar um snapshot de um ambiente com pacotes PyPI personalizados instalados, o Cloud Composer não vai instalar esses pacotes personalizados.

7. Clique em Carregar e aguarde até que o Cloud Composer carregue o snapshot.

gcloud

O comando gcloud beta composer environments snapshots load carrega um snapshot no ambiente.

• O argumento --snapshot-path especifica uma pasta em que o snapshot é localizado.

  O nome da pasta lista o ID do projeto, o ID local e o carimbo de data/hora em que o snapshot foi salvo. Por exemplo, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

• (Opcional) O argumento --skip-pypi-packages-installation ignora a a instalação de pacotes PyPI personalizados a partir do snapshot. Se você carregar um snapshot de um ambiente com pacotes PyPI personalizados instalados, o Cloud Composer não vai instalar esses pacotes personalizados.

gcloud beta composer environments snapshots load \
  DESTINATION_ENVIRONMENT_NAME \
  --location LOCATION \
  --snapshot-path "SNAPSHOT_PATH"

Substitua:

• DESTINATION_ENVIRONMENT_NAME pelo nome do ambiente em que você quer carregar o snapshot.
• LOCATION pela região em que o ambiente está localizado;
• SNAPSHOT_PATH pelo URI de um bucket, seguido pelo caminho para o snapshot.

Exemplo:

gcloud beta composer environments snapshots load \
  example-environment \
  --location us-central1 \
  --snapshot-path "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00"

API

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

2. No corpo da solicitação, no campo snapshotPath, especifique o URI de um bucket, seguido pelo caminho para o snapshot. O nome da pasta lista o ID do projeto, o local do ambiente e o carimbo de data/hora em que o snapshot foi salvo. Por exemplo, gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

3. (Opcional) No corpo da solicitação, no campo skipPypiPackagesInstallation, especifique se o Cloud Composer precisa pular a instalação de pacotes PyPI personalizados do snapshot. Se você carregar snapshot de um ambiente com instalação pacotes PyPI personalizados, o Cloud Composer não vai instalar esses pacotes personalizados.

   Este campo é opcional. Se você omitir esse campo, o Cloud Composer vai instalar os pacotes PyPI do snapshot.

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Substitua:

• SNAPSHOT_PATH pelo URI de uma pasta de bucket para armazenar o snapshot.

Exemplo:

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

{
  "snapshotPath": "gs://us-central1-example-916807e1-bucket/snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00",
  "skipPypiPackagesInstallation": "False"
}

Terraform

Não é possível salvar e carregar snapshots de ambiente usando o 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.

A seguir

• Configurar snapshots programados
• Criar ambientes
• Controle de acesso