Cloud Run functions ターゲットのロールと権限

このドキュメントでは、Eventarc を使用して Google Cloud やその他のソースから Cloud Run functions にイベントを転送する際に必要な Identity and Access Management(IAM)のロールと権限を付与する方法について説明します。

  1. トリガーを作成して関数をデプロイするプリンシパルに、プロジェクト全体の権限とデプロイ権限を付与します。

    1. Eventarc 管理者ロールを使用すると、トリガーの作成時にサービス アカウントを指定するなど、すべての Eventarc リソースを完全に制御できます。

    2. サービス アカウント ユーザーのロールを使用すると、プリンシパルがサービス アカウントの権限を借用してサービス アカウントを使用できます。これには、トリガー サービス アカウント、関数ランタイム サービス アカウント、ビルド サービス アカウントが含まれます。

    3. 関数のデプロイ方法に応じて、Cloud Run ソース デベロッパーロールと Service Usage コンシューマーロール(gcloud run CLI または Cloud Run Admin API を使用してデプロイする場合)、または Cloud Functions デベロッパーロールまたは Cloud Functions 管理者ロール(gcloud functions CLI または Cloud Functions v2 API を使用してデプロイする場合)を使用すると、関数を作成して更新できます。

  2. トリガー サービス アカウントに Eventarc トリガー権限を付与する: Eventarc イベント受信者ロールを使用すると、Eventarc トリガーはイベント プロバイダからイベントを受信できます。Cloud Pub/Sub から直接イベントを転送する場合は、このロールを付与する必要はありません。

  3. トリガー サービス アカウントに Cloud Run functions の呼び出し権限を付与する: Cloud Run 起動元ロールを使用すると、Eventarc トリガーによって認証済みの Cloud Run functions の関数を呼び出すことができます。

  4. Google サービス エージェントに権限を付与する:

    1. Eventarc サービス エージェントのロールを使用すると、Eventarc サービス エージェントは基盤となるトランスポート リソースを管理し、イベントソースを検証できます。このロールは、Eventarc リソースを初めて作成するときにデフォルトで付与されますが、削除された場合は復元する必要があります。

    2. gcloud functions CLI または Cloud Functions v2 API を使用して関数をデプロイする場合、Cloud Functions サービス エージェントのロールにより、Cloud Functions サービス エージェントは Eventarc トリガーと基盤となる Cloud Run サービスを作成して管理できます。このロールは、Cloud Functions API を有効にするとデフォルトで付与されますが、削除された場合は復元する必要があります。

    3. Cloud Storage からの直接イベントのトリガーを作成する場合は、Cloud Storage サービス エージェントに Pub/Sub パブリッシャーのロールを付与します。

    4. 2021 年 4 月 8 日以前に Cloud Pub/Sub サービス エージェントを有効にした場合は、Pub/Sub サービス エージェントにサービス アカウント トークン作成者のロールを付与します。

IAM ロールの付与の詳細については、アクセスの管理をご覧ください。必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

プロジェクト全体の権限とデプロイ権限を付与する

プロジェクト作成者にはオーナーロール(roles/owner)が付与されます。デフォルトでは、このロールには、ほとんどのGoogle Cloud リソースに対する完全アクセスに必要な権限が含まれています。それ以外の場合は、適切なリソースの管理者が適切なプリンシパル(メンバー)に必要なロールを付与する必要があります。

プリンシパルは Google アカウント(エンドユーザーの場合)やサービス アカウント(アプリケーションとコンピューティング ワークロードの場合)になることもあります。各プリンシパルには、一意の識別子(通常はメールアドレス)があります。

  1. Eventarc 管理者ロール(roles/eventarc.admin)を使用すると、すべての Eventarc リソースを完全に制御できます。

    プロジェクトに対するロールを付与します。

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

    次のように置き換えます。

    • PROJECT_ID: 実際の Google Cloud プロジェクト ID。

    • PRINCIPAL: トリガー作成者の識別子。通常、PRINCIPAL_TYPE:ID の形式で指定します。例: user:my-user@example.com。有効な PRINCIPAL_TYPE 値の一覧については、ポリシー バインディングのリファレンスをご覧ください。

  2. サービス アカウント ユーザーロール(roles/iam.serviceAccountUser)を使用すると、プリンシパルはサービス アカウントとして操作を実行できます。

    ユーザー管理のサービス アカウントを Eventarc トリガーに関連付けるには、このロールが必要です。また、Cloud Run 関数をデプロイするときにランタイム サービス アカウントとして機能させる場合や、ソースからデプロイするときにビルド サービス アカウントとして機能させる場合にも必要です。詳細については、サービス アカウントの認証に必要なロールをご覧ください。

    プロジェクトに対するロールを付与して、プリンシパルに複数のサービス アカウントの権限借用を許可します。あるいは、サービス アカウントにロールを付与して、プリンシパルに特定のサービス アカウントの権限借用を許可します。

    プロジェクトに対するロールを付与します。

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

    または、サービス アカウントにロールを付与します。

    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

    次のように置き換えます。

    • SERVICE_ACCOUNT_PROJECT_ID: サービス アカウントを含む Google Cloudプロジェクト ID。

    • SERVICE_ACCOUNT_NAME: サービス アカウントの名前。

  3. デプロイ方法に基づいて、Cloud Run functions の関数をデプロイするために必要なロールを付与します。

Eventarc トリガーの権限を付与する

すべての Eventarc トリガーは、トリガーの作成時に IAM サービス アカウントに関連付けられます。トリガーがデフォルトの ID として使用するユーザー管理のサービス アカウントを指定できます。トリガーの作成時にサービス アカウントを指定しない場合、トリガーの ID に Compute Engine のデフォルトのサービス アカウントが使用されます。

トリガーを柔軟に管理できるように、独自のユーザー管理サービス アカウントを作成することをおすすめします。

  1. サービス アカウントを作成し、その名前をメモします。

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

    次のように置き換えます。

    • SERVICE_ACCOUNT_NAME: サービス アカウントの名前。この名前は、サービス アカウントを識別するメールアドレスに表示されます。

    • DESCRIPTION: サービス アカウントの説明(省略可)。

    • DISPLAY_NAME: Google Cloud コンソールに表示するサービス アカウント名。

  2. トリガーがイベントを受信できるように、プロジェクトの Eventarc イベント受信者のロール(roles/eventarc.eventReceiver)を Eventarc トリガーに関連付けられたサービス アカウントに付与します。

    Cloud Pub/Sub から直接イベントを転送する場合は、Eventarc イベント受信者のロールを付与する必要はありません。

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

    SERVICE_ACCOUNT_NAME は、前の手順でメモしたサービス アカウントの名前に置き換えます。

Cloud Run functions の呼び出し権限を付与する

デフォルトでは、Cloud Run functions には認証が必要です。つまり、リクエストで認証情報を提供しないと、関数を呼び出すことができません。ドメイン制限付き共有の組織のポリシーがあるプロジェクトの場合は、公開(未認証)アクセスではなく、認証済みのターゲット関数を使用します。

  1. 認証済みの Cloud Run 関数にイベントを転送する場合は、基盤となる Cloud Run サービスに対する Cloud Run 起動元ロール(roles/run.invoker)を、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

    次のように置き換えます。

    • FUNCTION_NAME: Cloud Run functions の関数の名前。

    • REGION: 関数がデプロイされているリージョン。

  2. 必要に応じて、 Google Cloud プロジェクト内のすべての Cloud Run サービス、関数、ジョブにロールを付与できます。詳細については、プロジェクト内のすべてのサービスとジョブへのアクセスを制御するをご覧ください。

Cloud Run 起動元ロールを付与せずに認証済みの Cloud Run 関数のトリガーを作成すると、トリガーは正常に作成され、アクティブになります。ただし、トリガーは期待どおりに機能せず、次のようなメッセージがログに記録されます。

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

Google サービス エージェントに権限を付与する

一部の Google Cloud サービスには、サービスがリソースにアクセスできるようにするサービス エージェントがあります。API にサービス エージェントが必要な場合は、API を有効にして使用した後、サービス エージェントが作成されます。

  1. Eventarc サービス エージェントのロール(roles/eventarc.serviceAgent)が Eventarc サービス エージェントから削除された場合、Eventarc が基盤となるトランスポート リソースを管理し、イベントソースを検証できるように、プロジェクトにロールを付与します。それ以外の場合、このロールは、Eventarc リソースを初めて作成するときにデフォルトで付与されます。

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

    PROJECT_NUMBER は、使用する Google Cloudプロジェクト番号に置き換えます。プロジェクト番号は、 Google Cloud コンソールの [ようこそ] ページで確認できます。また、次のコマンドでも確認できます。

    gcloud projects describe PROJECT_ID --format='value(projectNumber)'
  2. gcloud functions deploy または Cloud Functions v2 API を使用して関数をデプロイし、Cloud Functions サービス エージェント ロール(roles/cloudfunctions.serviceAgent)が Cloud Functions サービス エージェントから削除されている場合、サービス エージェントが Eventarc トリガーと基盤となる Cloud Run サービスを作成して管理できるように、プロジェクトにロールを付与します。それ以外の場合、このロールは、Cloud Functions API を有効にするとデフォルトで付与されます。

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

    このロールは非推奨であり、Cloud Functions API を使用して作成された関数にのみ適用されます。Cloud Run を使用して作成された関数の場合は、Cloud Run のロールと権限のページをご覧ください。

  3. Cloud Storage からの直接イベントのトリガーを作成する場合、トピックへのメッセージのパブリッシュをサポートするには、Pub/Sub パブリッシャーのロール(roles/pubsub.publisher)をプロジェクトの 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. 2021 年 4 月 8 日以前に Cloud Pub/Sub サービス エージェントを有効にしていて、承認済みの Pub/Sub push リクエストをサポートするには、Pub/Sub サービス エージェントのプロジェクトにサービス アカウント トークン作成者のロール(roles/iam.serviceAccountTokenCreator)を付与します。それ以外の場合、このロールはデフォルトで付与されます。

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

次のステップ