Configurar notificações de cluster para serviços de terceiros

Notificações do Slack

Para configurar as notificações do Slack, crie um aplicativo do Slack, ative os Webhooks de entrada para o aplicativo e instale-o em um espaço de trabalho do Slack.

Crie o aplicativo Slack

1. Participe de um espaço de trabalho do Slack registrando-se com seu e-mail ou usando um convite enviado por um administrador do espaço de trabalho.

2. Faça login no Slack usando o nome do seu espaço de trabalho e as credenciais da sua conta do Slack.

3. Criar um novo aplicativo do Slack

   1. Na caixa de diálogo Criar um aplicativo, clique em Do zero.
   2. Especifique o campo App Name e escolha seu espaço de trabalho do Slack.
   3. Clique em Create App.
   4. Em Adicionar recursos e funcionalidades, clique em Webhooks de entrada.
   5. Clique no botão Ativar Webhooks de entrada.
   6. Na seção Webhook URLs for your Workspace, clique em Add New Webhook to Workspace.
   7. Na página de autorização, selecione um canal para receber notificações.
   8. Clique em Permitir.
   9. Um webhook do aplicativo Slack é exibido na seção URLs do webhook para seu espaço de trabalho. Salve o URL para mais tarde.

Escrever a Cloud Run function

Quando o GKE publica uma notificação de cluster em um tópico do Pub/Sub, o evento aciona o Cloud Run functions para que envie uma notificação do Slack.

1. Crie um novo diretório com o nome gke_slack e altere o diretório nele:

   mkdir ~/gke_slack && cd $_
   

2. Crie os seguintes arquivos no diretório gke_slack:

   index.js

   const functions = require('@google-cloud/functions-framework');
   const { IncomingWebhook } = require('@slack/webhook');
   
   const url = process.env.SLACK_WEBHOOK;
   
   const webhook = new IncomingWebhook(url);
   
   // Optionally filter what notification types to forward to Slack.
   // If empty, all types will be allowed.
   const allowedTypeURLs = [];
   
   // Register a CloudEvent callback with the Functions Framework that will
   // be executed when the Pub/Sub trigger topic receives a message.
   functions.cloudEvent('slackNotifier', pubSubEvent => {
       const data = decode(pubSubEvent.data.message.data);
   
       // Send message to Slack.
       if (isAllowedType(pubSubEvent.data.message.attributes)) {
           const message = createSlackMessage(data, pubSubEvent.data.message.attributes);
           webhook.send(message);
       }
   });
   
   // decode decodes a pubsub event message from base64.
   const decode = (data) => {
       return Buffer.from(data, 'base64').toString();
   }
   
   // isAllowedType can be used to filter out messages that don't match the
   // allowed type URLs. If allowedTypeURLs is empty, it allows all types.
   const isAllowedType = (attributes) => {
       if (allowedTypeURLs.length == 0) {
           return true;
       }
       for (var x in allowedTypeURLs) {
           if (attributes['type_url'] == allowedTypeURLs[x]) {
               return true;
           }
       }
       return false;
   }
   
   // createSlackMessage creates a message from a data object.
   const createSlackMessage = (data, attributes) => {
       // Write the message data and attributes.
       text = `${data}`
       for (var key in attributes) {
           if (attributes.hasOwnProperty(key)) {
               text = text + `\n\t\`${key}: ${attributes[key]}\``
           }
       }
       const message = {
           text: text,
           mrkdwn: true,
       };
       return message;
   }
   

   SLACK_WEBHOOK é uma variável de ambiente do Cloud Run functions que especifica o URL do webhook, criado para seu aplicativo Slack. Você define a variável de ambiente ao implantar a função.

   O webhook detecta e recebe mensagens do Cloud Run functions. Quando o GKE envia uma notificação de cluster para o Pub/Sub (o evento), a função envia uma mensagem (o gatilho) para o URL do webhook, que, por sua vez, envia a mensagem para o espaço de trabalho do Slack configurado.

   É possível expandir a mensagem na função createSlackMessage para incluir muito mais, incluindo formatação de texto e imagens. A função isAllowedType é fornecida para ativar a filtragem básica de notificações pelo URL de tipo. É possível especificar quais tipos de URLs permitir em allowedTypeURLs. Essa função não será necessária se você já filtrou notificações, no GKE ou na sua assinatura do Pub/Sub.

   package.json

   {
     "name": "gke-slack",
     "version": "0.0.1",
     "description": "Slack integration for GKE, using Cloud Run functions",
     "main": "index.js",
     "dependencies": {
       "@slack/webhook": "6.1.0",
       "@google-cloud/functions-framework": "^3.0.0"
     }
   }
   

   package.json descreve os seguintes atributos do programa:

   • Nome, versão e descrição
   • Arquivos principais do ambiente de execução
   • Dependências

   É possível adicionar mais dependências, requisitos e outras informações conforme necessário.

Agora, você tem os arquivos index.js e package.json no diretório gke_slack.

Implantar a Cloud Run function

É possível implantar a Cloud Run function usando a CLI do Google Cloud ou o console do Google Cloud.

gcloud functions deploy slackNotifier \
  --gen2 \
  --trigger-topic=TOPIC_NAME \
  --runtime=nodejs14 \
  --entry-point=slackNotifier \
  --region=REGION \
  --source=. \
  --set-env-vars="SLACK_WEBHOOK=WEBHOOK_URL"

Deploying function…
availableMemoryMb: 256
entryPoint: slackNotifier
environmentVariables:
  SLACK_WEBHOOK: https://hooks.slack.com/services/…
eventTrigger:
  eventType: google.pubsub.topic.publish
  failurePolicy: {}
  resource: projects/PROJECT_ID/topics/TOPIC_NAME
  service: pubsub.googleapis.com
labels:
  deployment-tool: cli-gcloud
name: projects/PROJECT_ID/locations/us-central1/functions/slackNotifier
runtime: nodejs10
serviceAccountEmail: PROJECT_ID@appspot.gserviceaccount.com
sourceUploadUrl: https://storage.googleapis.com/…
status: ACTIVE
timeout: 60s
updateTime: 'YYYY-MM-DDThh:mm:ssZ'
versionId: '1'

Depois de concluir a implantação da Cloud Run function, você receberá uma notificação do Slack sempre que o GKE enviar uma notificação do cluster.

Verifique notificações do Slack

Se você usou um cluster do Autopilot, verifique as notificações 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 atualizar seus nós, procure uma mensagem no Slack.

Se você usou um cluster do Standard, verifique as notificações 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.

2. Depois que o GKE fizer upgrade dos nós, verifique se há uma mensagem no Slack.

A notificação do Slack é semelhante a esta:

Master is upgrading to version 1.20.10-gke.301.
    cluster_location: us-central1
    cluster_name: pubsub-cluster
    payload: {"resourceType":"MASTER", "operation":"operation-1632775054313-45128f4f", "operationStartTime":"2021-09-27T20:37:34.313742491Z", "currentVersion":"1.20.9-gke.1001", "targetVersion":"1.20.10-gke.301"}
    project_id: 729788050015
    type_url: type.googleapis.com/google.container.v1beta1.UpgradeEvent