Gerenciar políticas de manutenção para uma instância do Looker (Google Cloud Core)

Uma vez por mês, o Looker (Google Cloud Core) programa períodos de manutenção durante os quais a instância é atualizada. Durante um período de manutenção, a instância é reiniciada e você não pode acessá-la temporariamente. É possível especificar uma janela de manutenção para a instância na forma de um dia da semana e horário em que a manutenção será realizada. Se você não especificar uma janela de manutenção preferencial, os upgrades serão realizados em até duas semanas após o lançamento de uma nova versão do Looker (Google Cloud Core). Também é possível especificar um período de negação de manutenção para bloquear a manutenção durante o período especificado.

Se você especificar um período de negação de manutenção durante o qual as instâncias do Looker (Google Cloud Core) estão sendo atualizadas para a próxima versão compatível do Looker, os recursos disponíveis na instância do Looker (Google Cloud Core) poderão ser diferentes das configurações que o Google Cloud console declara estar disponível na versão atualizada.

Esta página de documentação discute como encontrar informações sobre a manutenção programada, definir uma janela preferencial para manutenção, especificar um período de negação de manutenção e configurar notificações sobre as próximas atualizações de manutenção para uma instância do Looker (Google Cloud Core).

Canais de lançamento e políticas de manutenção

Se uma instância do Looker (Google Cloud Core) estiver inscrita em um canal de lançamento, as configurações de manutenção que você pode configurar dependem do canal de lançamento da instância:

  • Canal rápido: as janelas de manutenção e os períodos de negação de manutenção não são compatíveis. Se você se inscrever no canal rápido, todas as janelas de manutenção ou períodos de negação de manutenção definidos anteriormente para a instância serão removidos.
  • Canal normal: é possível especificar uma janela de manutenção preferencial e um período de negação de manutenção.
  • Sem canal: é possível especificar uma janela de manutenção preferencial e um período de negação de manutenção.

Papel necessário

Para receber as permissões necessárias para configurar as configurações de manutenção de uma instância do Looker (Google Cloud Core), peça ao administrador para conceder a você opapel do IAM de administrador do Looker (roles/looker.admin) no projeto em que a instância foi criada. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

Configurações de manutenção

O Looker (Google Cloud Core) permite configurar atualizações de manutenção usando um conjunto de configurações de manutenção.

É possível configurar a manutenção para que seja programada para momentos em que um breve período de inatividade afeta menos a instância. Você pode configurar o seguinte:

  • Janela de manutenção: o dia da semana e o horário em que o Looker (Google Cloud Core) programa a manutenção. As janelas de manutenção duram uma hora.

  • Período de negação de manutenção: um bloco de dias em que o Looker (Google Cloud Core) não programa manutenções. Os períodos de negação de manutenção podem ser de até 60 dias. É preciso oferecer pelo menos 14 dias de disponibilidade de manutenção entre dois períodos de negação de manutenção.

É possível atualizar as políticas de manutenção ao criar a instância do Looker (Google Cloud Core) ou editando a configuração de uma instância atual.

Definir uma janela preferencial para manutenção

Para especificar uma janela preferencial durante a qual o Looker (Google Cloud Core) vai programar a manutenção, selecione uma das seguintes opções:

Console

  1. No Google Cloud console, crie uma instância do Looker (Google Cloud Core) ou edite a configuração de uma instância do Looker (Google Cloud Core) atual.

  2. Em Janela de manutenção, na seção Manutenção preferencial, configure as seguintes configurações para a janela de manutenção:

    • Dia: o dia da semana em que a instância será atualizada

    • Janela de tempo: o horário aproximado do dia em que a manutenção da instância será iniciada

  3. Clique em Salvar.

Se você tiver inscrito a instância no canal de lançamento rápido, essa opção não estará disponível no Google Cloud console.

gcloud

Use o comando gcloud looker instances create se estiver criando a instância ou o comando gcloud looker instances update se estiver atualizando a instância e inclua os seguintes parâmetros:

--maintenance-window-day=MAINTENANCE_WINDOW_DAY
--maintenance-window-time=MAINTENANCE_WINDOW_TIME

Substitua:

  • MAINTENANCE_WINDOW_DAY: o dia da semana em que a instância será atualizada. Precisa ser uma destas opções: friday, monday, saturday, sunday, thursday, tuesday, wednesday.
  • MAINTENANCE_WINDOW_TIME: o horário de início da janela de manutenção no formato UTC de 24 horas (por exemplo, 13:00, 17:45).

Se você tiver inscrito uma instância do Looker (Google Cloud Core) no canal rápido do recurso de pré-lançamento dos canais de lançamento, não será possível definir uma janela de manutenção para essa instância.

Depois de especificar uma janela de manutenção, as alterações na configuração vão levar até uma semana para entrar em vigor.

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

Se você quiser adiar a manutenção programada para um horário posterior, poderá mudar o período de negação de manutenção da instância. Um período de negação de manutenção pode durar até 60 dias.

É preciso oferecer pelo menos 14 dias de disponibilidade de manutenção entre dois períodos de negação de manutenção.

Para especificar uma janela preferencial durante a qual o Looker (Google Cloud Core) não vai realizar a manutenção, selecione uma das seguintes opções:

Console

  1. No Google Cloud console, crie uma instância do Looker (Google Cloud Core) ou edite a configuração de uma instância do Looker (Google Cloud Core) atual.

  2. Na seção Período de negação de manutenção, configure as seguintes configurações para o período de negação de manutenção:

  • Data de início: escolha a data de início do período em que a manutenção não ocorrerá.

  • Data de término: escolha a data de término do período em que a manutenção não ocorrerá.

  • Horário de início/término: defina o horário específico em que o período de negação de manutenção começa (na data especificada para Data de início) e termina (na data especificada para Data de término).

  1. Clique em Salvar.

Se você tiver inscrito a instância no canal de lançamento rápido, essa opção não estará disponível no Google Cloud console.

gcloud

Use o comando gcloud looker instances create se estiver criando a instância ou o comando gcloud looker instances update se estiver atualizando a instância e inclua os seguintes parâmetros:

--deny-maintenance-period-end-date=DENY_MAINTENANCE_PERIOD_END_DATE
      --deny-maintenance-period-start-date=DENY_MAINTENANCE_PERIOD_START_DATE
      --deny-maintenance-period-time=DENY_MAINTENANCE_PERIOD_TIME

Substitua:

  • DENY_MAINTENANCE_PERIOD_START_DATE: a data de início do período de negação no formato YYYY-MM-DD.
  • DENY_MAINTENANCE_PERIOD_END_DATE: a data de término do período de negação no formato YYYY-MM-DD.
  • DENY_MAINTENANCE_PERIOD_TIME: o horário de início e término no formato UTC de 24 horas (por exemplo, 13:00, 17:45).

Se você tiver inscrito uma instância do Looker (Google Cloud Core) no canal rápido do recurso de pré-lançamento dos canais de lançamento, não será possível definir um período de negação de manutenção para essa instância.

Exemplo de manutenção

Como exemplo, você pode definir as configurações de manutenção da instância de produção da seguinte maneira:

  • Janela de manutenção: domingos entre 0h e 1h ET
  • Período de negação de manutenção: 1º de dezembro às 22h até 15 de janeiro às 22h

Notificações de manutenções futuras

Você pode receber uma notificação sobre uma manutenção futura no e-mail até uma semana antes da data programada. Se quiser definir um filtro de e-mail para notificações, o título do e-mail precisará ser [Notificação avançada de manutenção do Looker (Google Cloud Core)] Sua instância está programada para manutenção.

As notificações de manutenção não são enviadas por padrão. Se você quiser receber uma notificação sobre uma atualização de manutenção futura, conclua estas duas etapas:

  1. Defina uma janela de manutenção.
  2. Ative as notificações de manutenção no nível do projeto ou configure alertas baseados em registros.
  3. Para receber uma notificação sobre a manutenção programada, é necessário concluir as duas etapas pelo menos sete dias antes da próxima atualização de manutenção programada para a instância do Looker (Google Cloud Core).

As notificações configuradas pelo Google Cloud console são enviadas para o endereço de e-mail associado à sua Conta do Google. É possível usar um alias de e-mail personalizado (como um alias de e-mail de equipe).

Se a instância do Looker (Google Cloud Core) usar SAML ou OpenID Connect (OIDC) para autenticação ou se você quiser encaminhar notificações para canais de comunicação de terceiros, como Slack, PagerDuty ou webhooks personalizados, você pode configurar alertas baseados em registros.

É possível ativar as notificações de manutenção de todas as instâncias do Looker (Google Cloud Core) que tiverem janelas de manutenção em um projeto específico. Você receberá uma notificação por instância.

Ativar as notificações de manutenção

Para ativar as notificações de manutenção no Google Cloud console, siga estas etapas:

  1. Acesse a página Comunicação no Google Cloud console:

    Comunicação

  2. Selecione a guia Notificações de produtos.

  3. Selecione seu projeto no menu suspenso.

  4. Na linha do Looker (Google Cloud Core), defina a alternância de e-mail como ATIVADA.

Configurar alertas baseados em registros para eventos de manutenção

Se você fizer a autenticação no Google Cloud console usando a federação de identidade da força de trabalho, o Google Cloud console não poderá enviar notificações de manutenção para suas contas federadas. Além disso, talvez você queira encaminhar notificações para serviços como Slack, PagerDuty ou webhooks personalizados. Para receber notificações nesses cenários, é possível configurar políticas de alertas baseadas em registros no Cloud Logging.

Quando o Looker (Google Cloud Core) programa, inicia, conclui ou cancela uma atualização de manutenção, ele grava uma entrada de registro de atividades no Logging. É possível criar políticas de alertas que correspondam a essas entradas de registro e enviar notificações para os canais de notificação configurados.

Para criar um alerta baseado em registros para um evento de manutenção, siga as instruções em Criar uma política de alertas baseada em registros usando a Análise de registros documentação para criar uma política de alertas. Para exemplos de consultas a serem usadas na política, consulte Consultas de registro de manutenção.

Consultas de registro de manutenção

Use as consultas a seguir para criar alertas baseados em registros para diferentes estágios do ciclo de vida da manutenção.

Substitua LOOKER_INSTANCE_NAME pelo nome da instância do Looker (Google Cloud Core).

  • Notificação antecipada (programada): notifica quando a manutenção está programada para a instância.

    log_id("maintenance.googleapis.com/activity_log") AND
    resource.type = "gce_instance" AND
    labels.activity_type_name = "LookerRolloutAdvanced" AND
    labels.instance_id = "LOOKER_INSTANCE_NAME"
    
  • Notificação iniciada: notifica quando a manutenção começa na sua instância.

    log_id("maintenance.googleapis.com/activity_log") AND
    resource.type = "gce_instance" AND
    labels.activity_type_name = "LookerRolloutInProgress" AND
    labels.is_completed = "false" AND
    labels.is_failed = "false" AND
    labels.instance_id = "LOOKER_INSTANCE_NAME"
    
  • Notificação concluída (sucesso): notifica quando a manutenção é concluída com sucesso.

    log_id("maintenance.googleapis.com/activity_log") AND
    resource.type = "gce_instance" AND
    labels.activity_type_name = "LookerRolloutInProgress" AND
    labels.is_completed = "true" AND
    labels.is_failed = "false" AND
    labels.instance_id = "LOOKER_INSTANCE_NAME"
    
  • Notificação com falha ou cancelada: notifica se a manutenção falhar ou for cancelada.

    log_id("maintenance.googleapis.com/activity_log") AND
    resource.type = "gce_instance" AND
    (labels.is_failed = "true" OR labels.activity_type_name = "LookerRolloutCanceled") AND
    labels.instance_id = "LOOKER_INSTANCE_NAME"
    

Encontrar a manutenção programada

Se a manutenção tiver sido programada para sua instância, será possível visualizá-la seguindo estas etapas:

  1. Acesse a página Looker (Google Cloud Core) no Google Cloud console.

  2. Selecione o nome da instância em que você quer visualizar a manutenção programada.

  3. Ao visualizar os detalhes da configuração da instância, na página Detalhes, é possível conferir as seguintes informações: