Especificar janelas de manutenção

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Nesta página, você aprenderá como definir janelas de manutenção para seus ambientes.

Sobre as janelas de manutenção

Uma janela de manutenção é um período em que você permite o Cloud Composer para executar operações de manutenção. Por exemplo, pode garantir que as execuções de tarefas críticas não sejam interrompidas por especificar janelas de manutenção fora dos horários de programação do DAG.

Com as janelas de manutenção, você controla os períodos em que manutenção do seu ambiente:

• Se você definir janelas de manutenção personalizadas para seu ambiente, o Cloud Composer vai fazer a manutenção durante esses períodos definidos.

• Se você não definir janelas de manutenção para seu ambiente, O Cloud Composer realiza manutenção a qualquer momento.

Observação: sempre configure janelas de manutenção nas interfaces do Cloud Composer, como o console do Google Cloud, o SDK do Google Cloud, o Terraform e a API Cloud Composer. Evite configurar janelas de manutenção no nível do cluster do seu ambiente, a menos que você seja orientado a fazer isso pela equipe de atendimento ao cliente do Cloud.

Cuidado: em situações de emergência, por exemplo, ao corrigir uma vulnerabilidade de segurança crítica, algumas operações de manutenção podem ser realizadas fora das janelas de manutenção regulares.

O que acontece durante as janelas de manutenção

Ao especificar janelas de manutenção, você disponibiliza pelo menos 12 horas em uma única semana para operações de manutenção:

• Seu ambiente permanece disponível durante as janelas de manutenção. Alguns componentes do seu ambiente podem ficar temporariamente indisponíveis durante a manutenção estão em andamento.

• Essas 12 horas são necessárias para que o Cloud Composer tenha tempo suficiente programar e realizar todas as operações de manutenção. Isso não significa que as operações de manutenção levam 12 horas ou acontecem toda semana.

Ainda é possível executar seus DAGs durante as janelas de manutenção, desde que seja aceitável que algumas tarefas sejam interrompidas e tentadas novamente. Se você executar DAGs durante as janelas de manutenção, ative as tentativas de repetição de tarefas. É possível configurar novas tentativas de tarefas no nível da configuração do Airflow, do DAG ou da tarefa.

As operações de manutenção têm os seguintes efeitos no seu ambiente:

• A interface do Airflow pode estar temporariamente indisponível.

• Alterar alguns parâmetros do seu ambiente ou fazer upgrade para uma versão posterior temporariamente.

• Consultas SQL diretas ao banco de dados do Airflow podem levar mais tempo do que o normal e podem exigir novas tentativas.

• Algumas tarefas do Airflow podem ser interrompidas. Depois que a operação de manutenção é concluída, o Airflow programa novas tentativas para essas tarefas (se não tiver sido configurado de outra forma).

Janelas de manutenção padrão

Por padrão, os ambientes do Cloud Composer 1 não têm manutenção definida se você os criar usando o console do Google Cloud, a API ou o Terraform. Qa recomendamos especificar as janelas de manutenção para os ambientes novos e atuais.

Se você criar o ambiente usando a CLI gcloud, ele terá janelas de manutenção padrão de 00:00:00 às 04:00:00 (GMT) na sexta-feira, sábado e domingo de todas as semanas.

Como usar janelas de manutenção

As operações de manutenção podem afetar a execução dos DAGs e do Airflow tarefas. Portanto, recomendamos que você faça o seguinte:

1. Defina janelas de manutenção para seus ambientes do Cloud Composer.

2. Programe as execuções do DAG fora das janelas de manutenção especificadas usando Parâmetros start_date e schedule_interval no seus DAGs.

Especificar janelas de manutenção para novos ambientes

É possível especificar janelas de manutenção ao criar um ambiente. Para mais informações, consulte Criar ambientes.

Especificar janelas de manutenção para ambientes atuais

Console

Para definir ou alterar janelas de manutenção de um ambiente atual, atualize o ambiente:

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

   Acessar "Ambientes"

2. Selecione o ambiente.

3. Acesse a guia Configuração do ambiente.

4. Ao lado da entrada Janelas de manutenção, clique em Editar.

5. Na caixa de diálogo Janelas de manutenção, marque a caixa de seleção Definir horários personalizados para janelas de manutenção.

6. Defina o Horário de início, o Fuso horário, os Dias e a Duração para que o horário combinado para a programação especificada seja de pelo menos 12 horas em uma janela de 7 dias. Por exemplo, um período de quatro horas toda segunda, quarta e sexta-feira fornece o tempo necessário.

7. Clique em Salvar e aguarde até que o ambiente seja atualizado.

gcloud

Quando você atualiza um ambiente, os seguintes argumentos definem os parâmetros das janelas de manutenção:

• --maintenance-window-start define o horário de início de uma janela de manutenção.
• --maintenance-window-end define o horário de término de uma janela de manutenção.
• --maintenance-window-recurrence define a recorrência da janela de manutenção.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --maintenance-window-start 'DATETIME_START' \
    --maintenance-window-end 'DATETIME_END' \
    --maintenance-window-recurrence 'MAINTENANCE_RECURRENCE'

Substitua:

• ENVIRONMENT_NAME pelo nome do ambiente;
• DATETIME_START pela data e hora de início no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada.
• DATETIME_END pela data e hora de término no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada. A data e a hora especificadas precisam ser posteriores à data de início.

• MAINTENANCE_RECURRENCE por um RFC 5545 RRULE para a recorrência de janelas de manutenção. O Cloud Composer é compatível com dois formatos:

• O formato FREQ=DAILY especifica uma recorrência diária.

• O formato FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA especifica uma recorrência nos dias da semana selecionados.

O exemplo a seguir especifica uma janela de manutenção de seis horas entre a 1h e 07:00 (UTC) às quartas-feiras, aos sábados e aos domingos. A data de 1º de janeiro de 2023 é ignorada.

gcloud composer environments update example-environment \
  --location us-central1 \
  --maintenance-window-start '2023-01-01T01:00:00Z' \
  --maintenance-window-end '2023-01-01T07:00:00Z' \
  --maintenance-window-recurrence 'FREQ=WEEKLY;BYDAY=SU,WE,SA'

API

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

2. Nesta solicitação:

   1. No parâmetro updateMask, especifique a máscara config.maintenanceWindow.

   2. No corpo da solicitação, especifique os parâmetros das janelas de manutenção.

{
  "config": {
    "maintenanceWindow": {
      "startTime": "DATETIME_START",
      "endTime": "DATETIME_END",
      "recurrence": "MAINTENANCE_RECURRENCE"
    }
  }
}

Substitua:

• DATETIME_START pela data e hora de início no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada.
• DATETIME_END pela data e hora de término no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada. A data e hora especificadas precisam ser posteriores à data de início.

• MAINTENANCE_RECURRENCE por um RFC 5545 RRULE para a recorrência de janelas de manutenção. O Cloud Composer é compatível com dois formatos:

  • O formato FREQ=DAILY especifica uma recorrência diária.
  • O formato FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA especifica uma recorrência nos dias da semana selecionados.

O exemplo a seguir especifica uma janela de manutenção de seis horas entre a 1h e 07:00 (UTC) às quartas-feiras, sábados e domingos. O dia 1o de janeiro de 2023 a data é ignorada.

  // PATCH https://composer.googleapis.com/v1/projects/example-project/
  // locations/us-central1/environments/example-environment?updateMask=
  // config.maintenanceWindow

  {
    "config": {
      "maintenanceWindow": {
        "startTime": "2023-01-01T01:00:00Z",
        "endTime": "2023-01-01T07:00:00Z",
        "recurrence": "FREQ=WEEKLY;BYDAY=SU,WE,SA"
      }
    }
  }

Terraform

O bloco maintenance_window especifica as janelas de manutenção para seu ambiente:

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "ENVIRONMENT_NAME"
  region = "LOCATION"

  config {
    maintenance_window {
      start_time = "DATETIME_START"
      end_time = "DATETIME_END"
      recurrence = "MAINTENANCE_RECURRENCE"
    }
  }
}

Substitua:

• ENVIRONMENT_NAME pelo nome do ambiente
• LOCATION pela região em que o ambiente está localizado;
• DATETIME_START pela data e hora de início no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada.
• DATETIME_END pela data e hora de término no formato de entrada de data/hora. Somente a hora especificada do dia é usada, a data especificada é ignorada. A data e hora especificadas precisam ser posteriores à data de início.

• MAINTENANCE_RECURRENCE por um RFC 5545 RRULE para a recorrência de janelas de manutenção. O Cloud Composer é compatível com dois formatos:

  • O formato FREQ=DAILY especifica uma recorrência diária.
  • O formato FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA especifica uma recorrência nos dias da semana selecionados.

O exemplo a seguir especifica uma janela de manutenção de seis horas entre a 1h e 07:00 (UTC) às quartas-feiras, aos sábados e aos domingos. A data de 1º de janeiro de 2023 é ignorada.

resource "google_composer_environment" "example" {
  provider = google-beta
  name = "example-environment"
  region = "us-central1"

  config {
    maintenance_window {
      start_time = "2023-01-01T01:00:00Z"
      end_time = "2023-01-01T07:00:00Z"
      recurrence = "FREQ=WEEKLY;BYDAY=SU,WE,SA"
    }
  }
}

A seguir

• Como criar ambientes
• Como atualizar ambientes
• Limpar o banco de dados do Airflow