Cloud Run でシェルジョブをビルドして作成する

サンプルジョブの作成

シェル スクリプトを実行する Cloud Run ジョブを作成するには:

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

   mkdir jobs
   cd jobs
   

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

   
   # Use the official Ubuntu image from Docker Hub as
   # a base image
   FROM ubuntu:22.04
   
   # Execute next commands in the directory /workspace
   WORKDIR /workspace
   
   # Copy over the script to the /workspace directory
   COPY script.sh .
   
   # Just in case the script doesn't have the executable bit set
   RUN chmod +x ./script.sh
   
   # Run the script when starting the container
   CMD [ "./script.sh" ]
   

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

   #!/bin/bash
   set -euo pipefail
   
   # In production, consider printing commands as they are executed.
   # This helps with debugging if things go wrong and you only
   # have the logs.
   #
   # Add -x:
   # `set -euox pipefail`
   
   CLOUD_RUN_TASK_INDEX=${CLOUD_RUN_TASK_INDEX:=0}
   CLOUD_RUN_TASK_ATTEMPT=${CLOUD_RUN_TASK_ATTEMPT:=0}
   
   echo "Starting Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT}..."
   
   # SLEEP_MS and FAIL_RATE should be a decimal
   # numbers. parse and format the input using
   # printf.
   #
   # printf validates the input since it
   # quits on invalid input, as shown here:
   #
   #   $: printf '%.1f' "abc"
   #   bash: printf: abc: invalid number
   #
   SLEEP_MS=$(printf '%.1f' "${SLEEP_MS:=0}")
   FAIL_RATE=$(printf '%.1f' "${FAIL_RATE:=0}")
   
   # Wait for a specific amount of time to simulate
   # performing some work
   SLEEP_SEC=$(echo print\("${SLEEP_MS}"/1000\) | perl)
   sleep "$SLEEP_SEC" # sleep accepts seconds, not milliseconds
   
   # Fail the task with a likelihood of $FAIL_RATE
   
   # Bash does not do floating point arithmetic. Use perl
   # to convert into integer and multiply by 100.
   FAIL_RATE_INT=$(echo print\("int(${FAIL_RATE:=0}*100"\)\) | perl)
   
   # Generate a random number between 0 and 100
   RAND=$(( RANDOM % 100))
   if (( RAND < FAIL_RATE_INT )); then
       echo "Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT} failed."
       exit 1
   else
       echo "Completed Task #${CLOUD_RUN_TASK_INDEX}."
   fi
   

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

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

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

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

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

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

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

このクイックスタートでは、コンテナをビルドして 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 など）に置き換えます。