Gerenciar janelas de manutenção de clusters do AlloyDB para PostgreSQL

A configuração de janelas de manutenção e períodos de negação permite controlar quando as atualizações automáticas ocorrem nos clusters do AlloyDB para PostgreSQL para evitar interrupções durante os horários de pico de tráfego. Nos clusters primários e secundários, é possível definir, visualizar ou limpar janelas de manutenção, monitorar os próximos eventos de manutenção programados e configurar ou remover períodos de negação. Também é possível ativar as notificações por e-mail para eventos de manutenção programada.

Para uma visão geral de como a manutenção funciona, consulte Visão geral da manutenção. Também é possível aprender a gerenciar atualizações de manutenção do AlloyDB usando um cluster de teste.

Antes de começar

Para garantir que a manutenção e as atualizações possam criar slots de replicação temporários para sincronização de estado, verifique se o número total de slots de replicação é pelo menos um a menos que o limite de max_wal_senders. Para mais informações sobre como configurar essa flag, consulte Configurar as instâncias de origem.

Definir uma janela de manutenção em um cluster

Console

  1. Acesse a página Clusters.

    Acessar Clusters

  2. Clique em um cluster na coluna Nome do Recurso.

  3. Na página Visão geral, em Manutenção, clique em Editar.

  4. Em Janela de manutenção, selecione o dia da semana para essa janela de manutenção.

    A opção padrão é Qualquer janela. Quando você cria um cluster, ele recebe essa janela de manutenção padrão.

  5. Selecione a hora do dia para essa janela de manutenção.

  6. Clique em Atualizar para salvar as mudanças.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para definir uma janela de manutenção em um cluster, execute o comando gcloud alloydb clusters update com as flags --maintenance-window-day e --maintenance-window-hour:

gcloud alloydb clusters update CLUSTER_ID \
  --region LOCATION_ID \
  --maintenance-window-day DAY_OF_WEEK \
  --maintenance-window-hour HOUR_OF_DAY

Substitua:

  • CLUSTER_ID: o cluster em que a janela de manutenção será definida.

  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

  • DAY_OF_WEEK: o dia da semana, no fuso horário do Tempo Universal Coordenado (UTC), para essa janela de manutenção. Os valores válidos são MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY e SUNDAY.

    O valor padrão é Qualquer janela. Quando você cria um cluster, ele recebe essa janela de manutenção padrão.

  • HOUR_OF_DAY: um número inteiro entre 0 e 23 que representa a hora do dia, no fuso horário UTC, para essa janela de manutenção.

Se você fizer alterações na configuração da janela de manutenção enquanto o cluster estiver em manutenção ou programado para manutenção, as alterações não entrarão em vigor até que a manutenção atual ou programada seja concluída.

Limpar uma janela de manutenção

Console

  1. Acesse a página Clusters.

    Acessar Clusters

  2. Clique em um cluster na coluna Nome do Recurso.

  3. Na página Visão geral, em Manutenção, clique em Editar.

  4. Em Janela de manutenção, selecione Qualquer janela.

  5. Clique em Atualizar para salvar as mudanças.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para limpar a janela de manutenção de um cluster, execute o comando gcloud alloydb clusters update com a flag --maintenance-window-any:

gcloud alloydb clusters update CLUSTER_ID \
  --region LOCATION_ID \
  --maintenance-window-any

Substitua:

  • CLUSTER_ID: o cluster em que a janela de manutenção será definida.

  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

Ver a janela de manutenção de um cluster

Console

  1. Acesse a página Clusters.

    Acessar Clusters

  2. Clique em um cluster na coluna Nome do Recurso.

  3. Na página Visão geral, em Manutenção, confira os detalhes da janela de manutenção do cluster.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para analisar a janela de manutenção atual em um cluster, execute o comando gcloud alloydb clusters describe:

gcloud alloydb clusters describe CLUSTER_ID \
  --region LOCATION_ID

Substitua:

  • CLUSTER_ID: o cluster em que a janela de manutenção será definida.

  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

Se o cluster tiver uma janela de manutenção definida, a saída do comando incluirá linhas semelhantes às seguintes:

maintenanceUpdatePolicy:
  maintenanceWindows:
  - day: TUESDAY
    startTime:
      hours: 23

Se a saída não incluir uma seção maintenanceUpdatePolicy, o cluster não terá uma janela de manutenção definida.

Ver as próximas manutenções em um cluster

Console

  1. Acesse a página Clusters.

    Acessar Clusters

  2. Localize o cluster e confira a coluna Manutenção para ver informações sobre a próxima janela de manutenção.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para ver a manutenção futura planejada para um cluster que tem uma janela de manutenção definida, execute o comando gcloud alloydb clusters describe:

gcloud alloydb clusters describe CLUSTER_ID \
  --region LOCATION_ID

Substitua:

  • CLUSTER_ID: o cluster em que a janela de manutenção será definida.

  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

Se o cluster tiver um evento de manutenção planejado no futuro, a saída do comando incluirá linhas semelhantes às seguintes:

maintenanceSchedule:
  startTime: 2024-07-03T09:46:40Z

O carimbo de data/hora formatado em UTC especifica o momento em que o AlloyDB planeja começar a atualizar o software de sistema de todos os nós neste cluster.

Ativar as notificações de manutenção

As notificações de manutenção ficam desativadas por padrão. Ao ativar o recebimento de notificações por e-mail sobre os próximos eventos de manutenção do AlloyDB, lembre-se do seguinte:

  • Você vai receber uma notificação automática sobre o evento assim que ele for agendado. Os eventos de manutenção são programados com pelo menos uma semana de antecedência.
  • As notificações de manutenção são ativadas no nível do projeto do Google Cloud . Não é possível receber notificações sobre um subconjunto de clusters em um projeto.
  • Só é possível ativar as notificações para você. Cada usuário precisa aceitar separadamente para receber notificações de manutenção.

Para mais informações, consulte Visão geral da manutenção.

Para receber uma notificação automática por e-mail sempre que um evento de manutenção for programado ou cancelado para um cluster com uma janela de manutenção definida, siga estas etapas usando o console do Google Cloud :

  1. Acesse a página Clusters.

    Acessar Clusters

  2. Clique em um cluster na coluna Nome do Recurso.

  3. Na página Visão geral, em Manutenção, clique em Editar na linha Notifications:.

  4. Clique em Comunicação.

  5. Na linha do AlloyDB, em Janela de manutenção, selecione o botão de alternância na coluna E-mail.

Configurar um período de manutenção de negação

Para evitar operações de manutenção durante um período específico, configure um período de manutenção de negação. É possível definir a negação de manutenção em um cluster que executa a versão mais recente do AlloyDB. Um período de manutenção de negação pode variar de 1 a 30 dias.

Os clusters com instâncias em versões anteriores nem sempre são compatíveis com a configuração de períodos de negação. Se você precisar definir um período de bloqueio em um cluster que não esteja suficientemente atualizado, realize a manutenção de autoatendimento para atualizar o cluster.

Os períodos de bloqueio atuais não impedem a manutenção de autoatendimento.

Definir períodos de manutenção de negação

Para configurar um período de manutenção de negação, defina a data de início, a data de término e a hora em que o intervalo começa e termina.

As datas de início e término precisam estar no seguinte formato:

  • YYYY-MM-DD: indica uma data específica.

As datas de início e término e o horário estão no fuso horário UTC.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para adicionar um período de manutenção de negação a um cluster do AlloyDB, execute o comando gcloud alloydb clusters update com as flags --deny-maintenance-period-start-date, --deny-maintenance-period-end-date e --deny-maintenance-period-time:

gcloud alloydb clusters update CLUSTER_ID \
   --region LOCATION_ID \
   --deny-maintenance-period-start-date START_DATE \
   --deny-maintenance-period-end-date END_DATE \
   --deny-maintenance-period-time TIME

Substitua:

  • CLUSTER_ID: o cluster a ser configurado para o período sem manutenção.
  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.
  • START_DATE: a data de início do período sem manutenção no formato UTC YYYY-MM-DD.
  • END_DATE: o fim do período sem manutenção no formato UTC YYYY-MM-DD.
  • TIME: o horário do período sem manutenção no formato UTC HH:MM. As horas são representadas no formato de 24 horas, em que os valores variam de 00:00 a 23:59, por exemplo, 16:45.

REST v1

Este exemplo adiciona um período de manutenção de negação a um cluster. Para uma lista completa de parâmetros dessa chamada, consulte Método: projects.locations.clusters.patch.

Antes de usar os dados da solicitação, faça as seguintes substituições:

  • CLUSTER_ID: o cluster a ser configurado para o período sem manutenção.
  • PROJECT_ID: o ID do projeto em que o cluster está localizado.
  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.
  • START_YEAR: o ano em que o período sem manutenção começa no formato YYYY.
  • START_MONTH: o mês em que o período sem manutenção começa no formato MM. Um zero à esquerda para meses de um único dígito é opcional. Por exemplo, 2 e 02 são válidos para fevereiro.
  • START_DAY: o dia em que o período sem manutenção começa no formato DD. Um zero à esquerda para dias de um único dígito é opcional. Por exemplo, 1 e 01 são válidos para o primeiro dia do mês.
  • END_YEAR: o ano em que o período sem manutenção termina no formato YYYY.
  • END_MONTH: o mês em que o período sem manutenção termina no formato MM.
  • END_DAY: o dia em que o período sem manutenção termina no formato DD.
  • HOURS: a hora do período sem manutenção no formato de 24 horas, por exemplo, 16. Um zero à esquerda para horas de um único dígito é opcional. Por exemplo, 2 e 02 são válidos.
  • MINUTES: o minuto do período sem manutenção que aceita valores de 0 a 59, por exemplo, 45. Um zero à esquerda para minutos de um dígito é opcional: 7 e 07 são válidos.

Para adicionar um período de manutenção de negação, use a seguinte solicitação PATCH:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?update_mask=maintenance_update_policy.deny_maintenance_periods

O parâmetro de consulta maintenance_update_policy.deny_maintenance_periods instrui a API a atualizar o campo denyMaintenancePeriods no bloco maintenanceUpdatePolicy.

O corpo JSON da solicitação é parecido com este:

{
 "maintenanceUpdatePolicy": {
   "denyMaintenancePeriods": [
     {
       "startDate": {
         "year": START_YEAR,
         "month": START_MONTH,
         "day": START_DAY
       },
       "endDate": {
         "year": END_YEAR,
         "month": END_MONTH,
         "day": END_DAY
       },
       "time": {
         "hours": HOURS,
         "minutes": MINUTES
       }
     }
   ]
 }
}

Negar manutenção futura

Os períodos de manutenção de negação têm precedência sobre a manutenção programada. Se houver um conflito de horário, o período de manutenção de negação vai substituir a janela de manutenção programada.

Definir um período de negação que entre em conflito com um evento de manutenção programado não cancela imediatamente a manutenção nem limpa a programação. O AlloyDB mostra a manutenção programada como futura, mas cancela a janela de manutenção programada quando o horário programado começa.

Para ajudar a aplicar atualizações críticas, o sistema normalmente não permite definir um período de negação para pular mais de um evento de manutenção e, em casos raros, pode aplicar manutenção de emergência fora das preferências de manutenção configuradas.

Remover um período de manutenção de negação de um cluster

É possível remover um período de manutenção de negação a qualquer momento.

gcloud

Para usar a CLI gcloud, você pode instalar e inicializar a Google Cloud CLI ou usar o Cloud Shell.

Para remover um período de manutenção de negação de um cluster do AlloyDB, execute o comando gcloud alloydb clusters update com a flag --remove-deny-maintenance-period:

gcloud alloydb clusters update CLUSTER_ID --region LOCATION_ID  --remove-deny-maintenance-period

Substitua:

  • CLUSTER_ID: o cluster do qual o período de manutenção de negação será removido.
  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

REST v1

Este exemplo remove um período de manutenção de negação de um cluster do AlloyDB. Para uma lista completa de parâmetros dessa chamada, consulte Método: projects.locations.clusters.patch.

Antes de usar os dados da solicitação, faça as seguintes substituições:

  • CLUSTER_ID: o ID do cluster ao qual você está adicionando um período de manutenção de negação.
  • PROJECT_ID: o ID do projeto em que o cluster está localizado.
  • LOCATION_ID: a região do Google Cloud em que o cluster está localizado, por exemplo, us-central1.

Para remover um período de manutenção de negação, use a seguinte solicitação PATCH:

PATCH https://alloydb.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION_ID/clusters/CLUSTER_ID?update_mask=maintenance_update_policy.deny_maintenance_periods

O parâmetro de consulta maintenance_update_policy.deny_maintenance_periods instrui a API a atualizar o campo denyMaintenancePeriods no bloco maintenanceUpdatePolicy.

O corpo JSON da solicitação é parecido com este:

{}

A seguir