Cloud Run のイベント ドリブン関数のスケジュールを設定する

このチュートリアルでは、Cloud Scheduler を使用して、Pub/Sub トピックをターゲットに設定し、Cloud Run のイベント ドリブン関数をトリガーする方法について説明します。Pub/Sub トピックのメッセージや Cloud Storage バケットの変更など、 Google Cloud プロジェクト内のイベントに応答して関数を直接トリガーする場合は、イベント ドリブン関数を使用します。

関数の HTTP エンドポイントをターゲットにして、HTTP 関数の実行スケジュールを設定することもできます。関数で URL エンドポイントを使用し、Webhook などの HTTP リクエストに応答する必要がある場合は、HTTP 関数を使用します。詳細については、Cloud Run 関数のタイプをご覧ください。

Cloud Run 関数の実行のスケジューリングは、Cloud Scheduler の一般的なユースケースです。このチュートリアルの内容は次のとおりです。

1. Pub/Sub トピックをサブスクライブする単純な Cloud Run 関数を作成する。
2. Pub/Sub トピックにメッセージを公開する Cloud Scheduler ジョブを作成する。
3. Cloud Scheduler ジョブを実行する。
4. Cloud Run 関数が Cloud Scheduler ジョブによってトリガーされたことを確認する。

費用

このドキュメントでは、課金対象である次の Google Cloudコンポーネントを使用します。

• Cloud Run functions
• Cloud Scheduler
• Pub/Sub

料金計算ツールを使うと、予想使用量に基づいて費用の見積もりを生成できます。

新規の Google Cloud ユーザーは無料トライアルをご利用いただける場合があります。

始める前に

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.

In the Google Cloud console, on the project selector page, select or create 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 role (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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler, Eventarc APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Cloud Run > Cloud Run Invoker role to the service account.

   To grant the role, find the Select a role list, then select Cloud Run > Cloud Run Invoker.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

In the Google Cloud console, on the project selector page, select or create 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 role (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.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Functions, Cloud Run Admin, Cloud Scheduler, Eventarc APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the Cloud Run > Cloud Run Invoker role to the service account.

   To grant the role, find the Select a role list, then select Cloud Run > Cloud Run Invoker.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

Cloud Run 関数（第 2 世代）では、基盤となる Cloud Run サービスを管理することで呼び出し権限を使用できるため、Cloud Run 起動元ロールを付与する必要があります。

1. デフォルトでは、Cloud Run functions は、自動的に作成されるデフォルトの Compute Engine サービス アカウントをランタイム サービス アカウントとして使用します。このサービス アカウントを使用して、このチュートリアルを試すことができます。ただし、組織のポリシーの構成によっては、デフォルトのサービス アカウントにプロジェクトの編集者のロールが自動的に付与されない場合があります。その場合、次のロールをサービス アカウントに付与する必要があります。
   1. Artifact Registry 書き込み（roles/artifactregistry.writer）
   2. ログ書き込み（roles/logging.logWriter）
   3. Storage オブジェクト閲覧者（roles/storage.objectViewer）

Cloud Run のイベント ドリブン関数を作成する

Google Cloud プロジェクト内のイベント（この場合は Pub/Sub トピックに公開されたメッセージ）に応答して直接トリガーされるイベント ドリブン関数を作成します。

1. Google Cloud コンソールで、[Cloud Run functions] ページに移動します。

   [Cloud Run 関数] に移動

2. [関数を作成] をクリックします。

3. [基本] セクションで、次の操作を行います。

   1. [環境] リストで [第 2 世代] を選択します。
   2. 関数の名前を入力します。
   3. [リージョン] リストでリージョンを選択します。

4. [トリガー] セクションで、次の操作を行います。

   1. [トリガーのタイプ] リストで [Cloud Pub/Sub] を選択します。
   2. [Cloud Pub/Sub トピック] リストで、既存のトピックを選択するか、[トピックを作成] をクリックして新しいトピックを作成します。後の手順で必要になるため、トピックの名前をメモしておきます。

   3. [その他のオプション] をクリックします。

      [Eventarc トリガー] パネルが開きます。

5. [Eventarc トリガー] パネルで、次の操作を行います。

   1. ファンクションの呼び出しに必要な ID トークンを Pub/Sub サービスが作成できるようにするよう求められたら、[付与] をクリックします。
   2. [サービス アカウント] リストで、以前に作成したサービス アカウントを選択します。
   3. 他の値はデフォルトを使用します。

   4. [トリガーを保存] をクリックします。

      [Eventarc トリガー] パネルが閉じます。

6. その他のデフォルト値はそのままにして、[次へ] をクリックします。

7. デフォルトのランタイム言語とサンプルコードは変更しないでください。このコードはクラウド サービスを使用せず、追加の権限を有効にする必要もありません。[デプロイ] をクリックします。

Cloud Scheduler ジョブを作成する

Pub/Sub ターゲットを使用して Cloud Scheduler ジョブを作成します。

1. Google Cloud コンソールで [Cloud Scheduler] ページに移動します。

   Cloud Scheduler に移動

2. [ジョブを作成] をクリックします。

3. ジョブの名前を入力します。

4. [リージョン] リストでリージョンを選択します。

5. ジョブの頻度を unix-cron 形式で指定します。

   30 16 * * 7
   

   詳細については、cron ジョブの形式とタイムゾーンをご覧ください。

6. [タイムゾーン] リストで、タイムゾーンを選択します。

7. [続行] をクリックします。

8. [ターゲット タイプ] リストで、Pub/Sub を選択します。

9. 先ほど作成した Pub/Sub トピックを選択します。

10. [メッセージ本文] フィールドに、Pub/Sub ターゲット トピックに送信する文字列を入力します。例: 「Hello world!」

11. [作成] をクリックします。

日曜日の 16:30 に Pub/Sub トピックにメッセージを送信する cron ジョブが作成されました。Cloud Run 関数は、このトピックにサブスクライブされています。

Cloud Scheduler ジョブを実行する

作成したジョブを実行できるようになりました。

1. Google Cloud コンソールで、[Cloud Scheduler] ページに移動します。

   Cloud Scheduler に移動

2. 作成したジョブのチェックボックスをオンにして、[強制実行] をクリックします。

   初めて呼び出すときは、プロジェクトで作成された最初のジョブの構成と実行に数分かかることがあります。

3. ジョブの実行後、[最後の実行のステータス] に Success が表示されます。

Cloud Run 関数で結果を確認する

Cloud Run 関数が cron ジョブによって正常にトリガーされ、実行されていることを確認できます。

1. Google Cloud コンソールで、Cloud Run functions ページに移動します。

   [Cloud Run 関数] に移動

2. ファンクション名をクリックします。

   [関数の詳細] ページが開き、[Invocations/Second] グラフに関数の最初の呼び出しが表示されます。

3. [Logs] タブをクリックします。

   Hello, YOUR_STRING! のようなログエントリが表示されます。

クリーンアップ

このチュートリアルで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、リソースを含むプロジェクトを削除するか、プロジェクトを維持して個々のリソースを削除します。

プロジェクトの削除

注意: プロジェクトを削除すると、次のような影響があります。

• プロジェクト内のすべてのものが削除されます。このドキュメントのタスクで既存のプロジェクトを使用した場合、それを削除すると、そのプロジェクトで行った他の作業もすべて削除されます。
• カスタム プロジェクト ID が失われます。このプロジェクトを作成したときに、将来使用するカスタム プロジェクト ID を作成した可能性があります。そのプロジェクト ID を使用した URL（たとえば、appspot.com）を保持するには、プロジェクト全体ではなくプロジェクト内の選択したリソースだけを削除します。

複数のアーキテクチャ、チュートリアル、クイックスタートを実施する予定がある場合は、プロジェクトを再利用すると、プロジェクトの割り当て上限を超えないようにすることができます。

1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

チュートリアル リソースの削除

1. Google Cloud コンソールで [Cloud Scheduler] ページに移動します。

   Cloud Scheduler に移動

2. ジョブの横のチェックボックスを選択します。

3. [ 削除] をクリックして、削除を確定します。

4. Google Cloud コンソールで、[Pub/Sub] ページに移動します。

   [Pub/Sub] に移動

5. トピックの横にあるチェックボックスをオンにします。

6. [ 削除] をクリックして、削除を確定します。

7. Google Cloud コンソールで、Cloud Run functions ページに移動します。

   [Cloud Run 関数] に移動

8. ファンクションの横にあるチェックボックスをオンにします。

9. [ 削除] をクリックして、削除を確定します。

10. Google Cloud コンソールで、[サービス アカウント] ページに移動します。

    [サービス アカウント] に移動

11. 作成したサービス アカウントの横にあるチェックボックスをオンにします。

12. [ 削除] をクリックして、削除を確定します。

次のステップ

• Cloud Scheduler を使用して、スケジュールに従って Cloud Run をトリガーする