Papéis e permissões para destinos do Cloud Run functions

Neste documento, mostramos como conceder papéis e permissões do Identity and Access Management (IAM) para dar suporte ao roteamento de eventos do Google Cloud e de outras origens para o Cloud Run functions usando o Eventarc.

  1. Conceda permissões de implantação e em todo o projeto ao principal que cria gatilhos e implanta funções:

    1. O papel de Administrador do Eventarc oferece controle total sobre todos os recursos do Eventarc, incluindo a especificação de uma conta de serviço para o gatilho quando ele é criado.

    2. O papel Usuário da conta de serviço permite que um principal represente e use uma conta de serviço, incluindo a conta de serviço do gatilho e as contas de serviço de ambiente de execução ou de build da função.

    3. Dependendo de como você implanta a função, os papéis de Desenvolvedor de origem do Cloud Run e Consumidor do Service Usage (ao implantar com a CLI gcloud run ou a API Cloud Run Admin) ou o papel de Desenvolvedor do Cloud Functions ou Administrador do Cloud Functions (ao implantar com a CLI gcloud functions ou a API Cloud Functions v2) permitem criar e atualizar funções.

  2. Conceda ao gatilho do Eventarc permissões com relação à conta de serviço do gatilho: o papel Receptor de eventos do Eventarc permite que o gatilho do Eventarc receba eventos de provedores de eventos. Você não precisa conceder o papel ao fazer o roteamento de eventos diretos do Cloud Pub/Sub.

  3. Conceda permissões de invocação do Cloud Run functions à conta de serviço do gatilho: o papel Invocador do Cloud Run permite que o gatilho do Eventarc invoque uma função autenticada do Cloud Run.

  4. Conceda permissões com relação aos agentes de serviço do Google:

    1. O papel Agente de serviço do Eventarc permite que o agente de serviço do Eventarc gerencie recursos de transporte subjacentes e valide origens de eventos. Esse papel é concedido por padrão quando você cria um recurso do Eventarc pela primeira vez, mas é necessário restaurá-lo se ele for removido.

    2. Se você estiver implantando funções com a CLI gcloud functions ou a API Cloud Functions v2, o papel Agente de serviço do Cloud Functions permite que o agente de serviço do Cloud Functions crie e gerencie gatilhos do Eventarc e serviços subjacentes do Cloud Run. Esse papel é concedido por padrão quando você ativa a API Cloud Functions, mas é preciso restaurá-lo se ele for removido.

    3. Se você estiver criando um gatilho para eventos diretos do Cloud Storage, conceda o papel Publicador do Pub/Sub ao agente de serviço do Cloud Storage.

    4. Se você tiver ativado o agente de serviço do Cloud Pub/Sub em 8 de abril de 2021 ou antes dessa data, conceda o papel Criador de token da conta de serviço ao agente de serviço do Pub/Sub.

Para mais informações sobre como conceder papéis do IAM, consulte Gerenciar o acesso. Também é possível receber as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

Conceder permissões em todo o projeto e de implantação

O criador do projeto recebe o papel básico de proprietário (roles/owner). Por padrão, esse papel inclui as permissões necessárias para o acesso total à maioria dos recursos doGoogle Cloud . Em outros casos, os papéis obrigatórios precisam ser concedidos por um administrador no recurso apropriado para o principal apropriado, também conhecido como membro.

Por exemplo, um principal pode ser uma Conta do Google (para usuários finais) ou uma conta de serviço (para aplicativos e cargas de trabalho de computação). Cada principal tem o próprio identificador, que normalmente é um endereço de e-mail.

  1. O papel de administrador do Eventarc (roles/eventarc.admin) oferece controle total sobre todos os recursos do Eventarc.

    Conceda o papel no projeto:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=PRINCIPAL \
      --role=roles/eventarc.admin

    Substitua:

    • PROJECT_ID: o ID do projeto Google Cloud .

    • PRINCIPAL: um identificador para o criador do gatilho, que geralmente tem o seguinte formato: PRINCIPAL_TYPE:ID. Por exemplo, user:my-user@example.com. Para conferir uma lista completa dos possíveis valores de PRINCIPAL_TYPE, consulte a Referência de vinculação de políticas.

  2. O papel de usuário da conta de serviço (roles/iam.serviceAccountUser) permite que um principal execute operações como uma conta de serviço.

    Você precisa desse papel para associar uma conta de serviço gerenciado pelo usuário a um gatilho do Eventarc. Ele também é necessário para que você possa atuar como a conta de serviço do ambiente de execução ao implantar uma função do Cloud Run e como a conta de serviço de build ao implantar a partir da origem. Para mais informações, consulte Papéis para a autenticação da conta de serviço.

    Conceda o papel no projeto para permitir que o principal represente várias contas de serviço ou conceda o papel na conta de serviço para permitir que ele represente apenas uma conta de serviço específica.

    Conceda o papel no projeto:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=PRINCIPAL \
      --role=roles/iam.serviceAccountUser

    Também é possível conceder o papel na conta de serviço:

    gcloud iam service-accounts add-iam-policy-binding \
      projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT_NAME@SERVICE_ACCOUNT_PROJECT_ID.iam.gserviceaccount.com \
      --member=PRINCIPAL \
      --role=roles/iam.serviceAccountUser

    Substitua:

    • SERVICE_ACCOUNT_PROJECT_ID: o ID do projeto do Google Cloud que contém a conta de serviço.

    • SERVICE_ACCOUNT_NAME: o nome da conta de serviço.

  3. Conceda os papéis necessários para implantar a função do Cloud Run com base em como você a implanta:

Conceder permissões ao gatilho do Eventarc

Cada gatilho do Eventarc é associado a uma conta de serviço do IAM no momento da criação. É possível especificar uma conta de serviço gerenciado pelo usuário a ser usada pelo gatilho como uma identidade padrão. Se você não especificar uma conta de serviço durante a criação do gatilho, ele usará a conta de serviço padrão do Compute Engine como identidade.

Recomendamos que você crie sua própria conta de serviço gerenciada pelo usuário a fim de ter mais controle e flexibilidade ao gerenciar o gatilho.

  1. Crie uma conta de serviço e anote o nome dela:

    gcloud iam service-accounts create SERVICE_ACCOUNT_NAME \
      --description="DESCRIPTION" \
      --display-name="DISPLAY_NAME"

    Substitua:

    • SERVICE_ACCOUNT_NAME: o nome da conta de serviço. Esse nome aparece no endereço de e-mail que identifica a conta de serviço.

    • DESCRIPTION: uma descrição opcional da conta de serviço.

    • DISPLAY_NAME: um nome de conta de serviço a ser exibido no console do Google Cloud .

  2. Conceda o papel de receptor de eventos do Eventarc (roles/eventarc.eventReceiver) no projeto à conta de serviço associada ao gatilho do Eventarc para que ele possa receber eventos de provedores de eventos.

    Não é necessário conceder o papel de receptor de eventos do Eventarc ao fazer o roteamento de eventos diretos do Cloud Pub/Sub.

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
      --role=roles/eventarc.eventReceiver

    Substitua SERVICE_ACCOUNT_NAME pelo nome da conta de serviço que você anotou na etapa anterior.

Conceder permissões de invocação de funções do Cloud Run

Por padrão, o Cloud Run functions exige autenticação, o que significa que não é possível invocá-lo sem fornecer credenciais de autenticação na solicitação. Para projetos com políticas da organização de compartilhamento restrito de domínio, use uma função de destino autenticada em vez de uma que permita acesso público (não autenticado).

  1. Se você estiver roteando eventos para uma função autenticada do Cloud Run, conceda o papel de invocador do Cloud Run (roles/run.invoker) no serviço subjacente do Cloud Run à conta de serviço associada ao gatilho do Eventarc:

    gcloud run services add-iam-policy-binding FUNCTION_NAME \
      --region=REGION \
      --member=serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
      --role=roles/run.invoker

    Substitua:

    • FUNCTION_NAME: o nome da função do Cloud Run.

    • REGION: a região em que a função está implantada.

  2. Se quiser, conceda o papel em todos os serviços, funções e jobs do Cloud Run em um projeto do Google Cloud . Para mais informações, consulte Controlar o acesso em todos os serviços e jobs de um projeto.

Se você criar um gatilho para uma função do Cloud Run autenticada sem conceder o papel de invocador do Cloud Run, o gatilho será criado com sucesso e estará ativo. No entanto, o acionador não funcionará conforme o esperado e uma mensagem semelhante à seguinte aparecerá nos registros:

The request was not authenticated. Either allow unauthenticated invocations or set the proper Authorization header.

Conceder permissões aos agentes de serviço do Google

Alguns serviços do Google Cloud têm agentes de serviço que permitem que os serviços acessem seus recursos. Se uma API exigir um agente de serviço, o Google criará esse agente depois que você ativar e começar a usar a API.

  1. Se o papel de agente de serviço do Eventarc (roles/eventarc.serviceAgent) tiver sido removido do agente de serviço do Eventarc, conceda o papel no projeto para que o Eventarc possa gerenciar os recursos de transporte subjacentes e validar as origens de eventos. Caso contrário, esse papel será concedido por padrão quando você criar um recurso do Eventarc pela primeira vez:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-eventarc.iam.gserviceaccount.com \
      --role=roles/eventarc.serviceAgent

    Substitua PROJECT_NUMBER pelo número do projeto do Google Cloud. Encontre o número do projeto na página Boas-vindas do console do Google Cloud ou executando o seguinte comando:

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'
  2. Se você estiver implantando funções com gcloud functions deploy ou a API Cloud Functions v2 e o papel de agente de serviço do Cloud Functions (roles/cloudfunctions.serviceAgent) tiver sido removido do agente de serviço do Cloud Functions, conceda o papel no projeto para que o agente de serviço possa criar e gerenciar gatilhos do Eventarc e serviços do Cloud Run subjacentes. Caso contrário, esse papel é concedido por padrão quando você ativa a API Cloud Functions:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:service-PROJECT_NUMBER@gcf-admin-robot.iam.gserviceaccount.com \
      --role=roles/cloudfunctions.serviceAgent

    Esse papel foi descontinuado e se aplica apenas a funções criadas com a API Cloud Functions. Para funções criadas usando o Cloud Run, consulte a página Papéis e permissões do Cloud Run.

  3. Se você estiver criando um gatilho para eventos diretos do Cloud Storage, a fim de dar suporte à publicação de mensagens em um tópico, conceda o papel de Publicador do Pub/Sub (roles/pubsub.publisher) no projeto para o agente de serviço do Cloud Storage:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:service-PROJECT_NUMBER@gs-project-accounts.iam.gserviceaccount.com \
      --role=roles/pubsub.publisher
  4. Se você tiver ativado o agente de serviço do Cloud Pub/Sub em 8 de abril de 2021 ou antes dessa data, a fim de dar suporte a solicitações de push autenticadas do Pub/Sub, conceda o papel de criador de tokens da conta de serviço (roles/iam.serviceAccountTokenCreator) no projeto ao agente de serviço do Pub/Sub. Caso contrário, esse papel será concedido por padrão:

    gcloud projects add-iam-policy-binding PROJECT_ID \
      --member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-pubsub.iam.gserviceaccount.com \
      --role=roles/iam.serviceAccountTokenCreator

A seguir