Receba eventos através de mensagens Pub/Sub (CLI gcloud)

Receba eventos através de mensagens Pub/Sub (CLI gcloud)

Padrão

Pré-visualização

Este produto está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais de Serviço dos Termos Específicos do Serviço. Os produtos pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Este início rápido mostra como configurar um serviço do Google Kubernetes Engine (GKE) como destino para receber eventos de tópicos do Pub/Sub através do Eventarc.

Nota: o suporte do GKE como destino do Eventarc inclui os pontos finais públicos de serviços privados e públicos executados num cluster do GKE.

Neste início rápido, vai:

1. Conclua tarefas preparatórias, como ativar APIs e configurar uma conta de serviço.
2. Crie um cluster do GKE.
3. Inicialize os destinos do GKE no Eventarc.
4. Implemente um serviço do GKE que receba eventos.
5. Crie um acionador do Eventarc que associe um tópico do Pub/Sub ao serviço GKE.
6. Gere e veja um evento Pub/Sub.

Antes de começar

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

Create or select a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

• Create a Google Cloud project:

  gcloud projects create PROJECT_ID

  Replace PROJECT_ID with a name for the Google Cloud project you are creating.

• Select the Google Cloud project that you created:

  gcloud config set project PROJECT_ID

  Replace PROJECT_ID with your Google Cloud project name.

Verify that billing is enabled for your Google Cloud project.

1. Atualize os componentes da CLI do Google Cloud:

   gcloud components update

2. Ative as APIs Eventarc, Resource Manager e Google Kubernetes Engine:

   gcloud services enable eventarc.googleapis.com \
      cloudresourcemanager.googleapis.com \
      container.googleapis.com

3. Defina as variáveis de configuração usadas neste início rápido:

   PROJECT_ID=$(gcloud config get-value project)
   CLUSTER_NAME=events-cluster
   SERVICE_NAME=hello-gke
   LOCATION=us-central1

4. Se for o criador do projeto, é-lhe atribuída a função básica de proprietário (roles/owner). Por predefinição, esta função do Identity and Access Management (IAM) inclui as autorizações necessárias para acesso total à maioria dos Google Cloud recursos e pode ignorar este passo.

   Se não for o criador do projeto, as autorizações necessárias têm de ser concedidas no projeto ao principal adequado. Por exemplo, um principal pode ser uma Conta Google (para utilizadores finais) ou uma conta de serviço (para aplicações e cargas de trabalho de computação). Para mais informações, consulte a página Funções e autorizações do destino de eventos.

   Autorizações necessárias

   Para receber as autorizações de que precisa para concluir este início rápido, peça ao seu administrador que lhe conceda as seguintes funções da IAM no seu projeto:

   • Eventarc Admin (roles/eventarc.admin)
   • Administrador do Kubernetes Engine (roles/container.admin)
   • Aceder à vista de registos (roles/logging.viewAccessor)
   • Project IAM Admin (roles/resourcemanager.projectIamAdmin)
   • Publicador do Pub/Sub (roles/pubsub.publisher)
   • Administrador da conta de serviço (roles/iam.serviceAccountAdmin)
   • Utilizador da conta de serviço (roles/iam.serviceAccountUser)
   • Administrador de utilização de serviços (roles/serviceusage.serviceUsageAdmin)

   Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

   Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

5. Tome nota da conta de serviço predefinida do Compute Engine, uma vez que a vai anexar a um acionador do Eventarc para representar a identidade do acionador para fins de teste. Esta conta de serviço é criada automaticamente depois de ativar ou usar um Google Cloud serviço que usa o Compute Engine e com o seguinte formato de email:

   [e-mail]

   Substitua PROJECT_NUMBER pelo seu Google Cloud número do projeto. Pode encontrar o número do projeto na página Boas-vindas da Google Cloud consola ou executando o seguinte comando:

   gcloud projects describe PROJECT_ID --format='value(projectNumber)'

   Para ambientes de produção, recomendamos vivamente que crie uma nova conta de serviço e lhe conceda uma ou mais funções do IAM que contenham as autorizações mínimas necessárias e siga o princípio do privilégio mínimo.

   Nota:

   A iam.automaticIamGrantsForDefaultServiceAccounts restrição da política da organização impede que a função de editor seja concedida automaticamente às contas de serviço predefinidas. Se tiver criado a sua organização após 3 de maio de 2024, esta restrição é aplicada por predefinição.

   Recomendamos vivamente que aplique esta restrição para desativar a concessão automática de funções. Se desativar a concessão automática de funções, tem de decidir que funções conceder às contas de serviço predefinidas e, em seguida, conceder estas funções manualmente.

   Se a conta de serviço predefinida já tiver a função de editor, recomendamos que substitua a função de editor por funções menos permissivas.Para modificar as funções da conta de serviço em segurança, use o Simulador de políticas para ver o impacto da alteração e, em seguida, conceda e revogue as funções adequadas.

6. Conceda a função de subscritor do Pub/Sub (roles/pubsub.subscriber) no projeto à conta de serviço predefinida do Compute Engine para que o acionador do Eventarc possa obter eventos do Pub/Sub.

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/pubsub.subscriber

7. Se ativou o agente do serviço Cloud Pub/Sub a 8 de abril de 2021 ou antes, para suportar pedidos de envio autenticados do Pub/Sub, conceda a função de criador de tokens de conta de serviço (roles/iam.serviceAccountTokenCreator) ao agente do serviço. Caso contrário, esta função é concedida por predefinição:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member=serviceAccount:[e-mail] \
       --role=roles/iam.serviceAccountTokenCreator

Crie um cluster do GKE

Um cluster do GKE consiste em, pelo menos, uma máquina do painel de controlo do cluster e várias máquinas de trabalho denominadas nós. Os nós são instâncias de máquinas virtuais (VMs) do Compute Engine que executam os processos do Kubernetes necessários para os tornar parte do cluster. Implementa aplicações em clusters e as aplicações são executadas nos nós.

Crie um cluster do Autopilot com o nome events-cluster:

gcloud container clusters create-auto $CLUSTER_NAME \
    --region $LOCATION

A criação do cluster pode demorar vários minutos a ser concluída. Depois de criar o cluster, o resultado deve ser semelhante ao seguinte:

Creating cluster events-cluster...done.
Created [https://container.googleapis.com/v1/projects/MY_PROJECT/zones/us-central1/clusters/events-cluster].
[...]
STATUS: RUNNING

Esta ação cria um cluster do GKE denominado events-cluster num projeto com um Google Cloud ID do projeto de MY_PROJECT.

Ative os destinos do GKE

Para cada acionador que segmenta um serviço do GKE, o Eventarc cria um componente de encaminhamento de eventos que extrai eventos do Pub/Sub e encaminha-os para o destino. Para criar o componente e gerir recursos no cluster do GKE, conceda autorizações ao agente de serviço do Eventarc:

1. Ative os destinos do GKE para o Eventarc:

   gcloud eventarc gke-destinations init

2. No comando para associar as funções necessárias, introduza y.

   As seguintes funções estão associadas à conta de serviço:

   • compute.viewer
   • container.developer
   • iam.serviceAccountAdmin

Crie um destino de serviço do GKE

Implemente um serviço do GKE que receba e registe eventos através de uma imagem pré-criada, us-docker.pkg.dev/cloudrun/container/hello:

1. O Kubernetes usa um ficheiro YAML denominado kubeconfig para armazenar informações de autenticação de clusters para o kubectl. Atualize o ficheiro kubeconfig com as credenciais e as informações do ponto final para apontar kubectl para o cluster do GKE:

   gcloud container clusters get-credentials $CLUSTER_NAME \
       --region $LOCATION
   

2. Crie uma implementação do Kubernetes:

   kubectl create deployment $SERVICE_NAME \
       --image=us-docker.pkg.dev/cloudrun/container/hello
   

3. Exponha-o como um serviço do Kubernetes:

   kubectl expose deployment $SERVICE_NAME \
       --type ClusterIP \
       --port 80 \
       --target-port 8080
   

Crie um acionador do Eventarc

Quando uma mensagem é publicada no tópico Pub/Sub, o acionador do Eventarc envia mensagens para o serviço GKE.hello-gke

1. Crie um acionador do GKE para ouvir mensagens do Pub/Sub:

   Novo tópico do Pub/Sub

   gcloud eventarc triggers create gke-trigger-pubsub \
       --location="$LOCATION" \
       --destination-gke-cluster=$CLUSTER_NAME \
       --destination-gke-location=$LOCATION \
       --destination-gke-namespace=default \
       --destination-gke-service=$SERVICE_NAME \
       --destination-gke-path=/ \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]"
   

   Esta ação cria um novo tópico Pub/Sub e um acionador para o mesmo denominado gke-trigger-pubsub.

   Tópico do Pub/Sub existente

   gcloud eventarc triggers create gke-trigger-pubsub \
       --location="$LOCATION" \
       --destination-gke-cluster=$CLUSTER_NAME \
       --destination-gke-location=$LOCATION \
       --destination-gke-namespace=default \
       --destination-gke-service=$SERVICE_NAME \
       --destination-gke-path=/ \
       --event-filters="type=google.cloud.pubsub.topic.v1.messagePublished" \
       --service-account="[e-mail]" \
       --transport-topic=projects/PROJECT_ID/topics/TOPIC_ID
   

   Substitua o seguinte:

   • PROJECT_ID: o ID do seu Google Cloud projeto
   • TOPIC_ID: o ID do tópico do Pub/Sub existente. Isto cria um acionador denominado gke-trigger-pubsub para o tópico do Pub/Sub existente.

2. Confirme que o acionador foi criado com êxito. O acionador pode demorar até dois minutos a ficar totalmente funcional.

    gcloud eventarc triggers list
   

   O resultado deve ser semelhante ao seguinte:

   NAME: gke-trigger-pubsub
   TYPE: google.cloud.pubsub.topic.v1.messagePublished
   DESTINATION: GKE: hello-gke
   ACTIVE: Yes
   LOCATION: us-central1
   

Gerar e ver um evento

Pode gerar um evento para acionar o serviço GKE publicando uma mensagem no tópico Pub/Sub. Em seguida, pode ver a mensagem nos registos do pod.

1. Encontre e defina o tópico Pub/Sub como uma variável de ambiente:

   TOPIC=$(gcloud eventarc triggers describe gke-trigger-pubsub \
       --location=us-central1 \
       --format='value(transport.pubsub.topic)')

2. Envie uma mensagem para o tópico Pub/Sub para gerar um evento:

   gcloud pubsub topics publish $TOPIC --message="Hello World"

   O serviço GKE regista a mensagem do evento.

3. Para ver a mensagem do evento:

   1. Encontre o ID do pod:

      kubectl get pods

      O resultado deve ser semelhante ao seguinte:

      NAME                                         READY   STATUS             RESTARTS   AGE
      hello-gke-645964f578-2mjjt                   1/1     Running            0          35s

      Copie o NAME do pod para usar no passo seguinte.

   2. Verifique os registos do pod:

      kubectl logs NAME

      Substitua NAME pelo nome do grupo de anúncios que copiou.

   3. Procure uma entrada de registo semelhante a:

      2022/02/24 22:23:49 Hello from Cloud Run! The container started successfully and is listening for HTTP requests on $PORT
      {"severity":"INFO","eventType":"google.cloud.pubsub.topic.v1.messagePublished","message":"Received event of type google.cloud.pubsub.topic.v1.messagePublished. Event data: Hello World"[...]}
      

Limpar

Quando terminar as tarefas descritas neste documento, pode evitar a faturação contínua eliminando os recursos que criou.

Pode:

1. Elimine o acionador do Eventarc.

   Esta ação também elimina o tópico Pub/Sub associado.

2. Elimine o cluster do GKE.

Em alternativa, pode eliminar o seu Google Cloud projeto para evitar incorrer em custos. A eliminação do seu Google Cloud projeto interrompe a faturação de todos os recursos usados nesse projeto.

Atenção: a eliminação de um projeto tem os seguintes efeitos:

• Tudo no projeto é eliminado. Se usou um projeto existente para as tarefas neste documento, quando o elimina, também elimina qualquer outro trabalho que tenha feito no projeto.
• Os IDs dos projetos personalizados são perdidos. Quando criou este projeto, pode ter criado um ID do projeto personalizado que quer usar no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, elimine os recursos selecionados no projeto em vez de eliminar o projeto inteiro.

Delete a Google Cloud project:

gcloud projects delete PROJECT_ID

Se planeia explorar vários tutoriais e inícios rápidos, a reutilização de projetos pode ajudar a evitar exceder os limites de quota de projetos.

O que se segue?

Receba eventos através dos registos de auditoria do Cloud (CLI do Google Cloud)