Cloud Run での Node.js ジョブのビルドと作成

サンプルジョブの作成

Node.js でジョブを作成するには:

1. jobs という名前の新しいディレクトリを作成し、そのディレクトリに移動します。

   mkdir jobs
   cd jobs
   

2. package.json ファイルを作成し、次の内容を追加します。

   {
       "name": "jobs",
       "version": "1.0.0",
       "description": "Node.js sample for Cloud Run jobs",
       "main": "index.js",
       "scripts": {
           "start": "node index.js"
       },
       "engines": {
           "node": ">=16.0.0"
       },
       "author": "Google LLC",
       "license": "Apache-2.0"
   }
   

3. 同じディレクトリに、実際のジョブコードを記述する index.js ファイルを作成します。ここに次のサンプル行をコピーします。

   // Retrieve Job-defined env vars
   const {CLOUD_RUN_TASK_INDEX = 0, CLOUD_RUN_TASK_ATTEMPT = 0} = process.env;
   // Retrieve User-defined env vars
   const {SLEEP_MS, FAIL_RATE} = process.env;
   
   // Define main script
   const main = async () => {
     console.log(
       `Starting Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT}...`
     );
     // Simulate work
     if (SLEEP_MS) {
       await sleep(SLEEP_MS);
     }
     // Simulate errors
     if (FAIL_RATE) {
       try {
         randomFailure(FAIL_RATE);
       } catch (err) {
         err.message = `Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT} failed.\n\n${err.message}`;
         throw err;
       }
     }
     console.log(`Completed Task #${CLOUD_RUN_TASK_INDEX}.`);
   };
   
   // Wait for a specific amount of time
   const sleep = ms => {
     return new Promise(resolve => setTimeout(resolve, ms));
   };
   
   // Throw an error based on fail rate
   const randomFailure = rate => {
     rate = parseFloat(rate);
     if (!rate || rate < 0 || rate > 1) {
       console.warn(
         `Invalid FAIL_RATE env var value: ${rate}. Must be a float between 0 and 1 inclusive.`
       );
       return;
     }
   
     const randomFailure = Math.random();
     if (randomFailure < rate) {
       throw new Error('Task failed.');
     }
   };
   
   // Start script
   main().catch(err => {
     console.error(err);
     process.exit(1); // Retry Job Task by exiting the process
   });

   Cloud Run ジョブを使用すると、実行するタスクの数を指定できます。次のサンプルコードは、組み込みの CLOUD_RUN_TASK_INDEX 環境変数を使用する方法を示しています。各タスクが、コンテナの 1 つの実行中のコピーを表します。タスクは通常、並行して実行されます。各タスクが独立してデータのサブセットを処理できる場合は、複数のタスクを使用すると便利です。

   各タスクはインデックスを認識し、CLOUD_RUN_TASK_INDEX 環境変数に格納されます。組み込みの CLOUD_RUN_TASK_COUNT 環境変数には、ジョブの実行時に --tasks パラメータを介して指定されたタスクの数が含まれています。

   このコードは、組み込みの CLOUD_RUN_TASK_ATTEMPT 環境変数を使用してタスクを再試行する方法を示しています。この変数はタスクの再試行回数を表します。最初の再試行が行われると、この変数に 0 が設定され、--max-retries になるまで再試行のたびに値が 1 ずつ増加します。

   このコードでは、再試行のテストやエラーログの生成も行うことができるため、問題の発生箇所を確認できます。

4. Procfile 作成し、次の内容を追加します。

   # Define the application's entrypoint to override default, `npm start`
   # https://github.com/GoogleCloudPlatform/buildpacks/issues/160
   web: node index.js
   

コードが完成し、コンテナにパッケージ化できるようになりました。

ジョブコンテナをビルドして Artifact Registry に送信し、Cloud Run にデプロイする

重要: 以下の説明では、このクイックスタートで使用するプロジェクトのオーナーロールまたは編集者ロールが付与されていることを前提としています。ロールが付与されていない場合は、Cloud Run ソース デベロッパー ロールで、ソースから Cloud Run リソースをデプロイするために必要な権限を確認してください。

このクイックスタートでは、コンテナをビルドして Artifact Registry にアップロードし、ジョブを Cloud Run にデプロイするソースからのデプロイを使用します。

gcloud run jobs deploy job-quickstart \
    --source . \
    --tasks 50 \
    --set-env-vars SLEEP_MS=10000 \
    --set-env-vars FAIL_RATE=0.1 \
    --max-retries 5 \
    --region REGION \
    --project=PROJECT_ID

ここで、PROJECT_ID はプロジェクト ID、REGION はリージョンです（例: us-central1）。パラメータの値は、テスト目的で使用する任意の値に変更できます。SLEEP_MS は作業をシミュレートし、FAIL_RATE でタスクの X% を失敗させます。これにより、並列処理をテストし、失敗したタスクを再試行できます。

Cloud Run でジョブを実行する

作成したジョブを実行するには:

gcloud run jobs execute job-quickstart --region REGION

REGION は、ジョブを作成してデプロイしたときに使用したリージョン（us-central1 など）に置き換えます。