Configurar snapshots programados

Cloud Composer 1 | Cloud Composer 2

Nesta página, explicamos como configurar seu ambiente para salvar snapshots de forma programada.

Para mais informações sobre como os snapshots do ambiente funcionam e como salvá-los manualmente, consulte Salvar e carregar snapshots.

Como os snapshots programados funcionam

Quando você ativa os snapshots programados, o Cloud Composer salva periodicamente os snapshots do ambiente em um bucket do Cloud Storage.

Se você criar snapshots manualmente, o Cloud Composer salvará esses snapshots no bucket do ambiente por padrão. Para snapshots programados, recomendamos salvar em um bucket separado. Dessa forma, é possível definir permissões e uma configuração de ciclo de vida para esse bucket. Um bucket pode conter snapshots de vários ambientes, e você também pode criar buckets que sejam redundantes geograficamente.

Antes de começar

  • O Cloud Composer é compatível com snapshots programados nas versões 2.0.32 e posteriores. Os snapshots do ambiente são compatíveis com as versões 2.0.9 e posteriores.

Crie um bucket para snapshots programados

Crie um bucket para snapshots programados. Pense em como você quer usar os snapshots do ambiente. Se ele fizer parte do seu plano de recuperação de desastres, use um bucket geograficamente redundante ou em uma região diferente para que você tenha acesso aos dados mesmo em caso de interrupção regional completa. Caso contrário, um bucket na mesma região do ambiente pode ser mais adequado e, nesse caso, você reduz os custos de transferência de dados entre regiões.

Configurar permissões para o bucket

Configure as seguintes permissões:

  • A conta de serviço do ambiente precisa ter permissões de leitura e gravação para o bucket. Por exemplo, o papel Administrador de objetos do Storage inclui essas permissões.

  • As contas de usuário não precisam de outras permissões para que o bucket carregue snapshots dele, a menos que você queira ver o conteúdo do bucket no console do Google Cloud. Nesse caso, uma conta de usuário precisa ter permissão de leitura no bucket.

Defina uma configuração de ciclo de vida para o bucket

Para economizar custos de armazenamento, configure uma regra que exclua snapshots do ambiente após determinado período.

Por exemplo, para excluir automaticamente snapshots com mais de 30 dias:

  1. Defina uma configuração do ciclo de vida do bucket.
  2. Especifique a ação Excluir objeto.
  3. Selecione Idade e 30 dias como a condição.

Ativar uma programação de snapshot para seu ambiente

Console

  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. Acesse a guia Configuração do ambiente.

  4. Em Configuração de recuperação > Programação de snapshot, clique em Editar. O painel Programação de snapshot é aberto.

  5. No painel Programação de snapshots, selecione Criar snapshots periodicamente, de acordo com a programação especificada.

  6. Na lista suspensa Programar frequência, selecione um período diário, semanal ou personalizado para os snapshots.

    É possível especificar uma programação personalizada com o formato unix-cron. Por exemplo, para salvar snapshots a cada 30 minutos, especifique */30 * * * *.

  7. No campo Local do snapshot, selecione a pasta do bucket em que você quer salvar os snapshots.

gcloud

Atualize a configuração do ambiente. Os argumentos a seguir definem parâmetros para snapshots programados:

  • --enable-scheduled-snapshot-creation ativa snapshots programados.
  • --snapshot-location especifica uma pasta do bucket em que você quer salvar snapshots.

  • --snapshot-creation-schedule especifica com que frequência os snapshots do ambiente precisam ser criados, no formato unix-cron. Por exemplo, para criar um snapshot a cada 30 minutos, especifique */30 * * * *.

  • --snapshot-schedule-timezone define um fuso horário para a programação. Esse valor é um ajuste de tempo e não considera as mudanças do horário de verão. Os valores válidos são de UTC-12 a UTC+12. Exemplos: UTC, UTC-01, UTC+03.

gcloud beta composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --enable-scheduled-snapshot-creation \
    --snapshot-location "gs://SNAPSHOTS_FOLDER" \
    --snapshot-creation-schedule "CRON_EXPRESSION" \
    --snapshot-schedule-timezone "TIME_ZONE"

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;
  • SNAPSHOTS_FOLDER pelo URI de uma pasta do bucket em que o snapshot será salvo.
  • CRON_EXPRESSION com a programação, no formato unix-cron.
  • TIME_ZONE com um fuso horário para a programação.

Exemplo (todos os dias às 4h, UTC+01):

gcloud beta composer environments update example-environment \
    --location us-central1 \
    --enable-scheduled-snapshot-creation \
    --snapshot-location "gs://example-bucket/environment_snapshots" \
    --snapshot-creation-schedule "0 4 * * *" \
    --snapshot-schedule-timezone "UTC+01"

API

Crie uma solicitação de API environments.patch.

Nesta solicitação:

  1. No parâmetro updateMask, especifique a máscara config.recoveryConfig.scheduledSnapshotsConfig para substituir a configuração dos snapshots programados.

  2. No corpo da solicitação, especifique a configuração dos snapshots:

    {
  "config": {
    "recoveryConfig": {
      "scheduledSnapshotsConfig": {
        "enabled": true,
        "snapshot_location": "gs://SNAPSHOTS_FOLDER",
        "snapshot_creation_schedule": "CRON_EXPRESSION",
        "time_zone": "TIME_ZONE"
      }
    }
  }
}

    Substitua:

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

    • CRON_EXPRESSION com a programação, no formato unix-cron.

    • TIME_ZONE com um fuso horário para a programação. Esse valor é uma ajuste de tempo e não considera as mudanças de horário de verão. Os valores válidos são de UTC-12 a UTC+12. Exemplos: UTC, UTC-01, UTC+03.

Exemplo (todos os dias às 4h, UTC+01):

// PATCH https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.recoveryConfig.scheduledSnapshotsConfig
  ```json
  {
    "config": {
      "recoveryConfig": {
        "scheduledSnapshotsConfig": {
          "enabled": true,
          "snapshot_location": "gs://example-bucket/environment_snapshots",
          "snapshot_creation_schedule": "0 4 * * *",
          "time_zone": "UTC+01"
        }
      }
    }
  }
  ```

Desativar snapshots programados

Se você desativar os snapshots programados, todos os snapshots atuais que já foram tirados não serão modificados nem removidos. Esses snapshots permanecem no local em que foram salvos.

Console

  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. Acesse a guia Configuração do ambiente.

  4. Em Configuração de recuperação > Programação de snapshot, clique em Editar. O painel Programação de snapshot é aberto.

  5. No painel Programação de snapshots, selecione Não criar snapshots automaticamente.

gcloud

Atualize a configuração do ambiente. O argumento --disable-scheduled-snapshot-creation desativa os snapshots programados.

gcloud beta composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --disable-scheduled-snapshot-creation

Substitua:

  • ENVIRONMENT_NAME pelo nome do ambiente
  • LOCATION pela região em que o ambiente está localizado;

Exemplo:

gcloud beta composer environments update example-environment \
    --location us-central1 \
    --disable-scheduled-snapshot-creation

API

Crie uma solicitação de API environments.patch.

Nesta solicitação:

  1. No parâmetro updateMask, especifique a máscara config.recoveryConfig.scheduledSnapshotsConfig.enabled para substituir o valor do campo enabled.

  2. No corpo da solicitação, especifique o novo valor:

    {
  "config": {
    "recoveryConfig": {
      "scheduledSnapshotsConfig": {
        "enabled": false
      }
    }
  }
}

Exemplo:

// PATCH https://composer.googleapis.com/v1beta1/projects/example-project/
// locations/us-central1/environments/example-environment?updateMask=
// config.recoveryConfig.scheduledSnapshotsConfig.enabled
  ```json
  {
    "config": {
      "recoveryConfig": {
        "scheduledSnapshotsConfig": {
          "enabled": false
        }
      }
    }
  }
  ```

A seguir