Receber notificações de cluster

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.

Antes de começar

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

  • Verifique se você ativou a API do Google Kubernetes Engine.
  • Ativar a API Google Kubernetes Engine
  • Verifique se o SDK do Cloud está instalado.
  • Defina as configurações padrão da ferramenta de linha de comando gcloud do seu projeto usando um dos seguintes métodos:
    • Use gcloud init se quiser orientações para definir os padrões do projeto.
    • Use gcloud config para definir individualmente a região, a zona e o ID do projeto.

    gcloud init

    1. Execute gcloud init e siga as instruções:

      gcloud init

      Se você estiver usando SSH em um servidor remoto, utilize a sinalização --console-only para impedir que o comando inicie um navegador:

      gcloud init --console-only
    2. Siga as instruções para autorizar a ferramenta gcloud a usar sua conta do Google Cloud.
    3. Crie uma nova configuração ou selecione uma atual.
    4. Escolha um projeto do Google Cloud.
    5. Escolha uma zona padrão do Compute Engine.
    6. Escolha uma região padrão do Compute Engine.

    gcloud config

    1. Defina o ID do projeto padrão:
      gcloud config set project PROJECT_ID
    2. Defina a região padrão do Compute Engine (por exemplo, us-central1):
      gcloud config set compute/region COMPUTE_REGION
    3. Defina a zona padrão do Compute Engine (por exemplo, us-central1-c):
      gcloud config set compute/zone COMPUTE_ZONE
    4. Atualize gcloud para a versão mais recente:
      gcloud components update

    Ao definir locais padrão, é possível evitar erros na ferramenta gcloud como o seguinte: One of [--zone, --region] must be supplied: Please specify location.

Ative notificações de cluster em um novo cluster

É possível ativar as notificações de cluster do GKE em um novo cluster usando a ferramenta de linha de comando gcloud ou o Console do Google Cloud.

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

Console

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

1. Acesse a página **Google Kubernetes Engine** no Console do Cloud. Acessar o Google Kubernetes Engine 1. Clique em **Criar**.
  1. Na caixa de diálogo Criar cluster, ao lado de GKE Standard, clique em Configurar.
  2. Na seção Cluster do painel de navegação, clique em Automação.
  3. Marque a caixa de seleção Ativar notificações.
  4. Na lista suspensa, selecione o tópico do Pub/Sub que você criou.
  5. 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.

  6. Continue a configurar o cluster como quiser.

  7. Clique em Criar.

Depois de ativar as notificações, crie uma assinatura do Pub/Sub para seu tópico.

Ative notificações de cluster em um cluster

Ative as notificações do cluster do GKE em um cluster usando a ferramenta de linha de comando gcloud ou o Console do 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 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.

Console

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

  1. Acesse a página do Google Kubernetes Engine no Console do 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.

  7. Clique em Save changes.

Depois de ativar as notificações, crie uma assinatura do Pub/Sub para seu tópico.

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.

Modifique filtros 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 Cloud.

Desative 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 ferramenta gcloud ou o Console do Cloud.

gcloud

Para desativar os filtros usando a ferramenta gcloud, 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 Cloud, faça o seguinte:

  1. Acesse a página do Google Kubernetes Engine no Console do 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

Para verificar se as notificações estão configuradas corretamente para o cluster, inicie um upgrade do pool de nós para ver se uma mensagem UpgradeEvent é enviada. 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.

É possível fazer upgrade manual de um pool de nós específico usando a ferramenta gcloud ou o Console do Cloud. Para instruções, consulte Como fazer upgrade manual de um cluster ou pool de nós. 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.

Depois de iniciar o upgrade, verifique se há uma mensagem de notificação na sua assinatura do Pub/Sub.

Desative notificações de cluster

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

gcloud

Para desativar as notificações usando a ferramenta gcloud, 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 Cloud, faça o seguinte:

  1. Acesse a página do Google Kubernetes Engine no Console do 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