Configurar janelas de manutenção

Nesta página, explicamos como definir janelas de manutenção para instâncias do Cloud Data Fusion.

As janelas de manutenção são compatíveis com instâncias do Cloud Data Fusion nas versões 6.8.0 e posteriores.

Sobre as janelas de manutenção

Uma janela de manutenção no Cloud Data Fusion é um período em que você permite que ele execute operações de manutenção, reduzindo o risco de interrupções do serviço durante os horários de pico de uso. Programar janelas de manutenção fora dos horários de pico ou dos horários em que sua atividade é menor minimiza o impacto nas instâncias do Cloud Data Fusion e nas execuções do pipeline.

A configuração de janelas de manutenção permite controlar quando as operações de manutenção ocorrem na instância:

  • Se a janela de manutenção estiver definida, as operações de manutenção serão realizadas pelo Cloud Data Fusion dentro dos períodos definidos.
  • Se a janela de manutenção não estiver definida, a manutenção poderá ser realizada a qualquer momento.

Sobre as operações de manutenção

Para garantir a segurança e a conformidade do sistema, o Cloud Data Fusion realiza operações de manutenção regulares. Essas operações incluem a aplicação de atualizações críticas e patches de segurança para reduzir vulnerabilidades e proteger os dados dos usuários. As janelas de manutenção programadas garantem que as atualizações sejam aplicadas com eficiência, preservando a integridade do sistema e minimizando a interrupção em instâncias e execuções de pipelines.

  • Ao configurar as janelas de manutenção, você precisa alocar pelo menos 12 horas por semana para as operações de manutenção. Cada janela precisa ter entre 4 e 12 horas.

  • Durante as horas da janela de manutenção, algumas operações podem ser afetadas. Recomendamos que você tenha janelas de manutenção fora dos horários de pico de uso. A operação de manutenção pode afetar o Cloud Data Fusion das seguintes maneiras:

    • A interface do Studio do Cloud Data Fusion pode estar temporariamente indisponível.
    • A execução do pipeline pode ser afetada, causando falhas.
    • Os serviços do Cloud Data Fusion podem estar temporariamente inativos, causando falha nas chamadas de API.
    • As instâncias podem não funcionar totalmente por até uma hora durante as horas da janela de manutenção. Recomendamos que você configure janelas de manutenção quando os pipelines não estiverem em execução ou não estiverem programados para execução.

Especificar janelas de manutenção ao criar uma instância

Console

Para definir a janela de manutenção ao criar uma instância, siga estas etapas:

  1. Acesse a página Instâncias do Cloud Data Fusion e clique em Criar instância.

    Crie uma instância

  2. Preencha o campo Nome da instância e a Edição. Para mais informações sobre cada campo, consulte Criar uma instância.
  3. Expanda a seção Opções avançadas.
  4. Expanda a seção Manutenção e siga estas etapas:
    1. Marque a caixa de seleção Ativar janela de manutenção.
    2. No campo Horário de início, insira um horário em um formato compatível.
    3. Na lista TimeZone, selecione um fuso horário.
    4. Nas listas Dias e Duração, selecione os dias da semana e a duração da janela. Para mais informações sobre essas configurações, consulte Sobre as operações de manutenção.
    5. Clique em Criar.

Para mais informações, consulte Configurar horários e recorrência da janela de manutenção (RRULE).

API REST

  1. Defina a configuração Instance usando a API instance.create:
{
  "name": string,
  "description": string,
  …
  …
  "maintenancePolicy": {
    "maintenanceWindow": {
      "recurringTimeWindow": {
        "window": {
            "startTime": "START_TIME",
            "endTime": "END_TIME"
        },
        "recurrence": "MAINTENANCE_RECURRENCE"
      }
    },
  }
}

Substitua:

  • START_TIME: horário de início da janela de horário, no formato RFC 3339 (em inglês).
  • END_TIME: o horário de término do período, no formato RFC 3339 (em inglês).

  • MAINTENANCE_RECURRENCE: um RRULE para a recorrência da janela de manutenção. O Cloud Data Fusion só é compatível com os seguintes formatos:

    • FREQ=WEEKLY;BYDAY=SU,MO,TU,WE,TH,FR,SA ou BYDAY=SU,MO,TU,WE,TH,FR,SA,MO;FREQ=WEEKLY. Especifica a recorrência semanal da janela nos dias selecionados, começando em startTime e pela duração especificada.

Para mais informações, consulte Configurar horários e recorrência da janela de manutenção (RRULE).

O exemplo a seguir cria uma instância com uma janela de manutenção de seis horas entre 10h e 16h (UTC) aos sábados e domingos todas as semanas. Para mais informações, consulte a documentação da API de instâncias.

// POST https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances?instanceID=example-instance

{
  "maintenancePolicy": {
      "maintenanceWindow": {
          "recurringTimeWindow": {
              "window": {
                  "startTime": "2024-01-01T10:00:00Z",
                  "endTime": "2024-01-01T16:00:00Z",
              },
              "recurrence": "FREQ=WEEKLY;BYDAY=SA,SU"
          }
      },
  }
}

Atualizar as janelas de manutenção de uma instância

Console

Para atualizar a janela de manutenção em uma instância atual no Console do Google Cloud, siga estas etapas:

  1. Acesse a página Instâncias do Cloud Data Fusion.

    Acessar instâncias

  2. Clique no nome da instância para ver os detalhes dela.
  3. Na página Detalhes da instância, navegue até o campo Janela de manutenção e clique em Editar.
  4. Os campos da janela de manutenção são abertos no modo de edição. Atualize os valores, conforme necessário:
    1. Marque a caixa de seleção Ativar janela de manutenção.
    2. No campo Horário de início, insira um horário em um formato compatível.
    3. Na lista TimeZone, selecione um fuso horário.
    4. Nas listas Dias e Duração, selecione os dias da semana e a duração da janela. Para mais informações sobre essas configurações, consulte Sobre as operações de manutenção.
  5. Clique em Salvar.

Para mais informações, consulte Configurar horários e recorrência da janela de manutenção (RRULE).

API REST

Para instâncias atuais, atualize as janelas de manutenção usando a solicitação de API instances.patch. Isso substitui a configuração da janela de manutenção atual, se presente. Caso contrário, uma nova configuração será definida, conforme mencionado no corpo da solicitação.

Crie uma solicitação de API da seguinte maneira:

  1. No parâmetro updateMask, especifique a máscara maintenance_policy.
  2. No corpo da solicitação, especifique a janela de manutenção na configuração da política de manutenção:
{
  "maintenancePolicy": {
    "maintenanceWindow": {
        "recurringTimeWindow": {
          "window": {
              "startTime": "START_TIME",
              "endTime": "END_TIME"
          },
          "recurrence": "MAINTENANCE_RECURRENCE"
        }
    },
  }
}

Para mais informações, consulte Configurar horários e recorrência da janela de manutenção (RRULE).

O exemplo a seguir atualiza a configuração da política de manutenção da instância com uma janela de manutenção de quatro horas entre as 11h e as 15h (UTC) na sexta-feira, no sábado e no domingo, toda semana.

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
"maintenancePolicy": {
  "maintenanceWindow": {
    "recurringTimeWindow": {
      "window": {
          "startTime": "2024-01-01T11:00:00Z",
          "endTime": "2024-01-01T15:00:00Z",
        },
      "recurrence": "FREQ=WEEKLY;BYDAY=FR,SA,SU"
    }
  },
}
}

Configurar os horários da janela de manutenção e a recorrência (RRULE)

Quando você configura os horários de início e término da janela de manutenção, os componentes de data dos carimbos de data/hora fornecidos são ignorados. Apenas a hora do dia e a duração entre o horário de início e de término são considerados. Os horários são armazenados em UTC, mas é possível usar UTC ou o deslocamento de fuso horário ao programar janelas de manutenção com a API.

Ao configurar a recorrência, lembre-se de que o RRULE segue os dias UTC. Portanto, faça os ajustes necessários caso seu fuso horário seja diferente. Por exemplo, se o fuso horário for PDT (UTC-7) e você quiser que uma janela de manutenção comece às 21h às quartas-feiras no seu fuso horário (que corresponde às 4h UTC às quintas-feiras), especifique TH em vez de WE na opção BYDAY do RRULE.

Excluir a janela de manutenção de uma instância

Console

Para excluir a janela de manutenção em uma instância atual no Console do Google Cloud, siga estas etapas:

  1. Acesse a página Instâncias do Cloud Data Fusion.

    Acessar instâncias

  2. Clique no nome da instância para ver os detalhes dela.
  3. Na página Detalhes da instância, navegue até o campo Janela de manutenção e clique em Editar.
  4. Para remover a janela de manutenção da instância, desmarque a caixa de seleção Ativar janela de manutenção.
  5. Clique em Salvar.

API REST

Para remover a janela de manutenção de uma instância, transmita um objeto de política de manutenção vazio no corpo da solicitação.

// PATCH https://datafusion.googleapis.com/v1/projects/example-project/locations/us-central1/instances/example-instance?updateMask=maintenance_policy

{
    "maintenancePolicy": {}
}

A seguir