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 do ambiente.

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

Sobre os snapshots do ambiente

Os snapshots do ambiente armazenam o estado do ambiente. Salve e carregue snapshots do ambiente sob demanda.

Eles podem ser usados para:

• Restaure o ambiente para um estado anterior. Crie backups do ambiente usando snapshots e 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.

• Realize upgrades e ambientes de cópia lado a lado. Crie um snapshot de um ambiente atual, crie um novo ambiente que use uma versão igual ou posterior do Cloud Composer e aplique o snapshot a esse novo ambiente. Este procedimento é semelhante à migração. Pause os DAGs antes de criar o snapshot para evitar execuções duplicadas de DAGs.

Como os snapshots são armazenados

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

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

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

Por padrão, o Cloud Composer armazena snapshots na pasta snapshots/ no 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 altera a maneira como você trabalha ao salvar e carregar snapshots no console do Google Cloud, mas lembre-se disso ao executar operações diretamente nos arquivos do bucket. Para mais informações, consulte Namespace de objeto.

Considerações de segurança para snapshots

Aviso: a chave fernet do ambiente é armazenada com o backup do banco de dados do Airflow. Isso significa que informações confidenciais (como senhas extras de conexão do Airflow e senhas) podem ser descriptografadas em um snapshot do ambiente.

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

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

Quais dados são salvos nos 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 parâmetros de escalonamento e desempenho. 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);

  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 poderá ser instalada ao carregá-lo.

• O conteúdo do banco de dados do Airflow, incluindo 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 fernet do snapshot é usada para recriptografar os dados do snapshot com a própria chave fernet do ambiente. A chave fernet do ambiente permanece inalterada.

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

• Configuração do ambiente, como escala do ambiente 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 introduzem alterações.
• 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 quais dados foram carregados. Por exemplo, se os pacotes PyPI estiverem instalados, mas as substituições da opção de configuração do Airflow não tiverem êxito, a mensagem de erro indicará isso.

Para uma operação parcialmente concluída, tente carregar o mesmo snapshot novamente. O Cloud Composer pula as etapas que foram bem-sucedidas na tentativa anterior. Por exemplo, se uma operação falhou durante o tempo limite, mas o banco de dados foi carregado, a próxima tentativa não o carregará 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 permite salvar snapshots do ambiente para versões >= 1.18.5.

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

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

• Só é possível carregar snapshots na mesma versão ou na versão 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. Em 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 compatível com 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 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 bucket do ambiente, a conta de serviço do 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 produz custos extras, que estão relacionados ao Cloud Storage. Para saber mais informações, consulte Preços.

Salvar um snapshot do ambiente

O Cloud Composer salva os snapshots de ambiente em uma subpasta relativa à 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 de quando o snapshot foi salvo. Por exemplo, /snapshots/example-project_us-central1_example-environment_2022-01-05T18-59-00.

Console

Para criar um snapshot do 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 no bucket do ambiente, selecione Usar pasta de snapshots no bucket de 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. Também é possível especificar qualquer outra pasta.

Para salvar um snapshot do 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 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 salva 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 do ambiente do Terraform.

Salvar e carregar snapshots são ações realizadas em um ambiente. 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 a partir dele.

Carregar um snapshot do ambiente

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

Considere a seguinte situação: Por exemplo, o comando catch-up está 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 de carregar o snapshot, o Airflow não terá informações sobre a execução do DAG que ocorreu novamente. Por isso, o Airflow executa o DAG novamente para o mesmo tempo e dados.

Como outro exemplo, considere um DAG executado em uma programação diária. Você tira um snapshot, o Airflow executa esse DAG e, depois, carregue 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, siga estas etapas:

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 pelo snapshot, selecione Pular a instalação de pacotes PyPI. Se você carregar um snapshot de um ambiente com pacotes PyPI personalizados instalados, o Cloud Composer não os instalará.

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 seu ambiente.

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

  O nome da pasta lista o ID do projeto, a localização do ambiente e o carimbo de data/hora de quando 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 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 os instalará.

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 do 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 do 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 a partir do snapshot. Se você carregar um snapshot de um ambiente com pacotes PyPI personalizados instalados, o Cloud Composer não os instalará.

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

{
  "snapshotPath": "SNAPSHOT_PATH"
}

Substitua:

• SNAPSHOT_PATH pelo URI de uma pasta de bucket em que o snapshot será armazenado.

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 do ambiente usando o Terraform.

Salvar e carregar snapshots são ações realizadas em um ambiente. 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 a partir dele.

A seguir

• Configurar snapshots programados
• Criar ambientes
• Controle de acesso