Receber notificações de cluster

Autopilot Standard

---

Nesta página, mostramos como usar o Pub/Sub para receber notificações sobre os clusters do Google Kubernetes Engine (GKE).

Visão geral

Quando ocorrem determinados eventos relevantes para os clusters do GKE, como upgrades programados importantes ou boletins de segurança disponíveis, o GKE publica notificações sobre esses eventos como mensagens nos tópicos do Pub/Sub que você configura. É possível receber essas notificações em uma assinatura do Pub/Sub, integrar a serviços de terceiros e filtrar os tipos de notificação que você quer receber.

Para saber mais sobre os benefícios das notificações de cluster, como as notificações funcionam e por que a filtragem é importante, consulte Notificações de cluster. Você pode configurar notificações de cluster em clusters padrão novos e atuais e atualizar os clusters do Autopilot.

Antes de começar

Antes de começar, veja se você realizou as seguintes tarefas:

• Ative a API Google Kubernetes Engine.
Ativar a API Google Kubernetes Engine
• Se você quiser usar a CLI do Google Cloud para essa tarefa, instale e, em seguida, inicialize a CLI gcloud. Se você instalou a gcloud CLI anteriormente, instale a versão mais recente executando gcloud components update.
  Observação: para instalações atuais da gcloud CLI, defina as propriedades compute/region e compute/zone. Definindo os locais padrão, você evita erros como este na CLI gcloud: One of [--zone, --region] must be supplied: Please specify location.

• Crie um tópico do Pub/Sub no projeto.

Ativar notificações em um cluster novo

É possível ativar as notificações do cluster do GKE em um novo cluster Padrão usando a Google Cloud CLI ou o console do Google Cloud. Para ativar a notificação em clusters do Autopilot, é necessário primeiro criar um cluster do Autopilot e, em seguida, atualizar o cluster para usar as notificações dele.

gcloud

Para ativar as notificações de cluster em um novo cluster, execute o seguinte comando:

gcloud container clusters create CLUSTER_NAME \
    --region=COMPUTE_REGION \
    --notification-config=pubsub=ENABLED,pubsub-topic=projects/PROJECT_ID/topics/TOPIC_NAME,filter=NOTIFICATION_TYPE

Substitua:

• CLUSTER_NAME: o nome do novo cluster;
• COMPUTE_REGION: a região do Compute do novo cluster. Para clusters Standard zonais, use --zone=COMPUTE_ZONE.
• PROJECT_ID: é seu ID do projeto no Google Cloud.
• TOPIC_NAME: o nome do tópico do Pub/Sub.

• NOTIFICATION_TYPE: uma lista delimitada por barras verticais (|) dos tipos de notificação que você quer receber. Por exemplo, filter="UpgradeEvent|SecurityBulletinEvent" envia apenas notificações UpgradeEvent e SecurityBulletinEvent, ignorando todos os outros tipos.

  Observação: se você não especificar valores para filter, receberá todas as notificações aplicáveis à configuração do cluster.

Console

Para ativar as notificações de cluster em um novo cluster Standard, faça o seguinte:

1. Acesse a página Google Kubernetes Engine no console do Google Cloud.

   Acessar o Google Kubernetes Engine

2. Clique em Criar.

3. Na caixa de diálogo Criar cluster, ao lado de GKE Standard, clique em Configurar.

4. Na seção Cluster do painel de navegação, clique em Automação.

5. Marque a caixa de seleção Ativar notificações.

6. Na lista suspensa, selecione o tópico do Pub/Sub que você criou.

7. Para filtrar as notificações, marque a caixa de seleção Filtrar tipos de notificação e, em seguida, selecione os tipos de notificação que você quer receber.

   Observação: se você não selecionar os tipos de notificação para filtrar, receberá todas as notificações aplicáveis.

8. Continue configurando o cluster.

9. Clique em Criar.

Depois de ativar as notificações, escolha o tipo de assinatura para seu tópico.

Observação:O GKE não tem restrições sobre como você correlaciona os tópicos com os clusters, desde que os tópicos estejam no mesmo projeto. É possível criar um tópico para todos os clusters ou vários tópicos para grupos de clusters.

Ativar notificações em um cluster atual

É possível ativar as notificações do cluster do GKE em um cluster atual usando a Google Cloud CLI ou o console do Google Cloud.

gcloud

Para ativar as notificações de cluster em um cluster, execute o seguinte comando:

gcloud container clusters update CLUSTER_NAME \
    --region=COMPUTE_REGION \
    --notification-config=pubsub=ENABLED,pubsub-topic=projects/PROJECT_ID/topics/TOPIC_NAME,filter=NOTIFICATION_TYPE

Substitua:

• CLUSTER_NAME: o nome do cluster.
• COMPUTE_REGION: a região do Compute do novo cluster. Para clusters Standard zonais, use --zone=COMPUTE_ZONE.
• PROJECT_ID: é seu ID do projeto no Google Cloud.
• TOPIC_NAME: o nome do tópico do Pub/Sub.

• NOTIFICATION_TYPE: uma lista delimitada por barras verticais (|) dos tipos de notificação que você quer receber. Por exemplo, filter="UpgradeEvent|SecurityBulletinEvent" envia apenas notificações UpgradeEvent e SecurityBulletinEvent, ignorando todos os outros tipos.

  Observação: se você não especificar valores para filter, receberá todas as notificações aplicáveis à configuração do cluster.

Console

Para ativar as notificações em um cluster atual, faça o seguinte:

1. Acesse a página Google Kubernetes Engine no console do Google Cloud.

   Acessar o Google Kubernetes Engine

2. Clique no nome do cluster que você quer modificar.

3. Na seção Automação, ao lado de Notificações, clique em Editar notificações.

4. Na caixa de diálogo Editar notificações, marque a caixa de seleção Ativar notificações.

5. Na lista suspensa, selecione o tópico do Pub/Sub que você criou.

6. Para filtrar as notificações, marque a caixa de seleção Filtrar tipos de notificação e, em seguida, selecione os tipos de notificação que você quer receber.

   Observação: se você não selecionar os tipos de notificação para filtrar, receberá todas as notificações aplicáveis.

7. Clique em Salvar alterações.

Depois de ativar as notificações, escolha o tipo de assinatura para seu tópico.

Observação:O GKE não tem restrições sobre como você correlaciona os tópicos com os clusters, desde que os tópicos estejam no mesmo projeto. É possível criar um tópico para todos os clusters ou vários tópicos para grupos de clusters.

Filtre notificações de cluster

É possível filtrar as notificações por tipo de notificação para garantir que você receba as notificações que quiser.

Para filtrar as notificações, use os seguintes métodos:

• GKE: especifique valores para filter na sinalização --notification-config, conforme mostrado nos exemplos anteriores para ativar notificações de cluster.
• Pub/Sub: configure sua assinatura do Pub/Sub para filtrar mensagens ao criar uma assinatura.

Observação: recomendamos filtrar usando o GKE. Filtrar no GKE permite modificar os filtros a qualquer momento e elimina o custo de mensagens não entregues associados aos filtros do Pub/Sub. Para saber mais sobre as diferenças entre as opções de filtro, consulte Como filtrar notificações.

Modificar os filtros atuais no GKE

Para modificar os filtros de notificação do cluster do GKE, siga as instruções em Ativar notificações em um cluster e especifique os novos tipos de notificação para filtrar no comando gcloud ou selecione os novos tipos no console do Google Cloud.

Desativar filtros no GKE

É possível desativar os filtros de notificação do GKE e receber todos os tipos de notificação aplicáveis ao cluster usando a gcloud CLI ou o console do Google Cloud.

gcloud

Para desativar os filtros usando a gcloud CLI, execute o seguinte comando:

gcloud container clusters update CLUSTER_NAME \
  --region=COMPUTE_REGION \
  --notification-config=pubsub=ENABLED,pubsub-topic=projects/PROJECT_ID/topics/TOPIC_NAME

Console

Para desativar filtros usando o console do Google Cloud, faça o seguinte:

1. Acesse a página Google Kubernetes Engine no console do Google Cloud.

   Acessar o Google Kubernetes Engine

2. Clique no nome do cluster que você quer modificar.

3. Na seção Automação, ao lado de Notificações, clique em Editar notificações.

4. Na caixa de diálogo Editar notificações, desmarque a caixa de seleção Filtrar tipos de notificação.

5. Clique em Save changes.

Verifique a configuração das notificações do cluster

No modo Autopilot, é possível verificar as notificações do cluster da seguinte maneira:

1. Inicie um upgrade do plano de controle.
2. Aguarde o GKE atualizar automaticamente seus nós para a nova versão. O tempo necessário pode variar com base nas exclusões e janelas de manutenção configuradas.
3. Depois que o GKE faz upgrade dos nós, verifique sua assinatura do Pub/Sub.

No modo Standard, é possível verificar as notificações do cluster da seguinte maneira:

1. Faça upgrade de um pool de nós específico para uma nova versão. Se não quiser alterar a versão do GKE nos nós, faça o upgrade para a mesma versão atual nos nós.

   Cuidado: o upgrade manual de um pool de nós Standard ignora as janelas de manutenção configuradas e pode causar interrupções nas cargas de trabalho em execução.

2. Depois que o GKE faz upgrade dos nós, verifique sua assinatura do Pub/Sub.

Só é possível verificar manualmente a configuração do tipo de notificação UpgradeEvent. Se os filtros estiverem configurados para ignorar esse tipo, você não verá uma mensagem.

Desativar notificações de cluster

É possível desativar as notificações de cluster usando a gcloud CLI ou o console do Google Cloud.

gcloud

Para desativar as notificações usando a gcloud CLI, execute o seguinte comando:

gcloud container clusters update CLUSTER_NAME \
  --region=COMPUTE_REGION \
  --notification-config=pubsub=DISABLED

Console

Para desativar as notificações usando o console do Google Cloud, faça o seguinte:

1. Acesse a página Google Kubernetes Engine no console do Google Cloud.

   Acessar o Google Kubernetes Engine

2. Clique no nome do cluster que você quer modificar.

3. Na seção Automação, ao lado de Notificações, clique em Editar notificações.

4. Na caixa de diálogo Editar notificações, desmarque a caixa de seleção Ativar notificações.

5. Clique em Save changes.

Opcionalmente, exclua o tópico do Pub/Sub criado para as notificações.

A seguir

• Saiba mais sobre notificações de cluster.
• Saiba mais sobre Como configurar notificações do Pub/Sub.
• Saiba como configurar notificações de cluster para serviços de terceiros.