Especificar janelas de manutenção

Airflow gerenciado (Geração 3) | Airflow gerenciado (Geração 2) | Airflow gerenciado (Geração 1 legada)

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 que o Airflow gerenciado execute operações de manutenção. Por exemplo, é possível garantir que as execuções de tarefas críticas não sejam interrompidas especificando janelas de manutenção fora dos horários de programação do DAG.

Com as janelas de manutenção, você tem controle sobre os períodos em que a manutenção pode ocorrer no seu ambiente:

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

  • Se você não definir janelas de manutenção para seu ambiente, o Airflow gerenciado vai realizar a manutenção a qualquer momento.

Como as janelas de manutenção funcionam

As janelas de manutenção funcionam da seguinte maneira:

  • As operações de manutenção exigem pelo menos 12 horas de tempo alocado em uma única semana.

  • É possível usar vários períodos, mas cada um deles precisa ter pelo menos 4 horas de duração.

  • O ambiente permanece disponível durante as janelas de manutenção. Alguns componentes do ambiente podem ficar temporariamente indisponíveis quando as operações de manutenção estão em andamento.

  • As 12 horas são necessárias para que o Airflow gerenciado tenha tempo suficiente para programar e realizar todas as operações de manutenção. Isso não significa que as operações de manutenção levem 12 horas completas ou que ocorram todas as semanas.

Ainda é possível executar seus DAGs durante as janelas de manutenção, desde que seja aceitável que algumas tarefas possam ser interrompidas e repetidas. Se você executar DAGs durante as janelas de manutenção, ative as repetições de tarefas. É possível configurar repetições de tarefas na configuração do Airflow, no DAG ou no nível da tarefa.

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

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

  • A alteração de alguns parâmetros do ambiente ou o upgrade para uma versão mais recente podem não ser possíveis temporariamente.

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

  • Algumas tarefas do Airflow podem ser interrompidas. Depois que a operação de manutenção for concluída, o Airflow vai programar repetições para essas tarefas (se não estiver configurado de outra forma).

Janelas de manutenção padrão

Por padrão, os ambientes do Airflow gerenciado (Geração 1 legada) não têm janelas de manutenção definidas se você os criar usando Google Cloud o console, a API ou o Terraform. Recomendamos especificar janelas de manutenção para seus ambientes novos e atuais.

Se você criar o ambiente usando a CLI gcloud, ele terá janelas de manutenção padrão das 00:00:00 às 04:00:00 (GMT) nas sextas, sábados e domingos de todas as semanas.

Manutenção fora das janelas de manutenção

O Airflow gerenciado pode realizar a manutenção fora das janelas de manutenção configuradas nos seguintes casos:

  • 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 normais.

  • Se o Airflow gerenciado não puder realizar operações de manutenção normais durante as janelas de manutenção por 30 dias, ele vai realizar operações de manutenção críticas fora das janelas de manutenção especificadas. Esse é um mecanismo de fallback para casos em que as janelas de manutenção estão mal configuradas e o Airflow gerenciado não consegue realizar a manutenção em um ambiente repetidamente.

Como usar janelas de manutenção

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

  1. Defina janelas de manutenção para seus ambientes do Airflow gerenciado.

  2. Programe a execução do DAG fora das janelas de manutenção especificadas usando start_date e schedule parâmetros em 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. Noconsoleno Cloud, acesse a página Ambientes. Google Cloud

    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 Airflow gerenciado é 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 01:00 e 07:00 (UTC) nas quartas, sábados e 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 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 Airflow gerenciado é 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 01:00 e 07:00 (UTC) nas quartas, sábados e domingos. A data de 1º de janeiro de 2023 é 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 do 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 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 Airflow gerenciado é 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 01:00 e 07:00 (UTC) nas quartas, sábados e 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