ワーカープールの CPU 自動スケーリングを構成する

Cloud Run ワーカープールで CPU 自動スケーリングを使用すると、平均 CPU 使用率に基づいてインスタンスをスケーリングし、パフォーマンスと費用を最適化できます。自動スケーリングは、デフォルトの CPU 使用率目標を使用して構成することも、カスタムの CPU 使用率目標とインスタンスの上限を指定することもできます。Cloud Run がインスタンス数を計算し、ワーカープールをスケーリングする方法については、CPU の自動スケーリングについてをご覧ください。

CPU 自動スケーリングを有効にせずにワーカープールをデプロイすると、Cloud Run はデフォルトで 1 つのインスタンスで手動スケーリングを使用します。

Cloud Run External Metrics Autoscaling(CREMA)を使用してワークロードをスケーリングしている場合は、手動スケーリングに切り替えます。

必要なロール

Cloud Run のワーカープールの構成とデプロイに必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。

Cloud Run に関連付けられている IAM ロールと権限のリストについては、Cloud Run IAM ロールと Cloud Run IAM 権限をご覧ください。Cloud Run ワーカープールがGoogle Cloud API(Cloud クライアント ライブラリなど)と連携している場合は、サービス ID の構成ガイドをご覧ください。ロールの付与の詳細については、デプロイ権限とアクセスの管理をご覧ください。

デフォルトの CPU ターゲットを構成する

デフォルトの CPU 自動スケーリングを有効にすると、Cloud Run は CPU 使用率 60% を目標に、ワーカープールを 1 ~ 100 インスタンスの間でスケーリングします。デフォルトの CPU 使用率の目標値 60% を維持しながら、必要に応じてインスタンスの最小数と最大数をカスタマイズできます。

既存のワーカープールのスケーリング モードまたはインスタンスの上限を更新しても、新しいリビジョンは作成されません。

Cloud Run ワーカープールのデフォルトの CPU 自動スケーリングを有効にするには、Google Cloud CLI、YAML、または REST API を使用します。

gcloud

  • デフォルトの CPU ターゲットを使用して新しいワーカープールをデプロイするには、--scaling=auto フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools deploy WORKER_POOL \
      --image=IMAGE_URL \
      --scaling=auto

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

    • WORKER_POOL: ワーカープールの名前。
    • IMAGE_URL: ワーカープールを含むコンテナ イメージへの参照(us-docker.pkg.dev/cloudrun/container/worker-pool:latest など)。
  • デフォルトの CPU ターゲットを使用するように既存のワーカープールを更新するには、--scaling=auto フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --scaling=auto

    WORKER_POOL は、ワーカープールの名前に置き換えます。

  • デフォルトの CPU ターゲットとカスタム インスタンスの上限を使用して既存のワーカープールを更新するには、--scaling=auto、--min、--max フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --scaling=auto \
      --min=MIN_INSTANCES \
      --max=MAX_INSTANCES

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

    • WORKER_POOL: ワーカープールの名前。
    • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
    • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。

YAML

  1. 新しいワーカープールを作成する場合は、この手順をスキップします。既存のワーカープールを更新する場合は、その YAML 構成をダウンロードします。

    gcloud run worker-pools describe WORKER_POOL --format export > worker-pool.yaml
  2. metadata.annotations の launch-stage アノテーションと scalingMode アノテーションを追加または更新し、run.googleapis.com/manualInstanceCount アノテーションが存在する場合は削除します。カスタム インスタンスの上限を設定するには、必要に応じて minScale アノテーションと maxScale アノテーションを追加します。

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
     name: WORKER_POOL
     annotations:
       run.googleapis.com/launch-stage: BETA
       run.googleapis.com/scalingMode: automatic
       run.googleapis.com/minScale: 'MIN_INSTANCES'
       run.googleapis.com/maxScale: 'MAX_INSTANCES'

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

    • WORKER_POOL: ワーカープールの名前。
    • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
    • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。
  3. 次のコマンドを使用して、ワーカープールを作成または更新します。

    gcloud run worker-pools replace worker-pool.yaml

    gcloud run worker-pools replace コマンドは、worker-pool.yaml ファイルが存在する場合、デフォルトでこのファイルを使用します。

REST API

既存のワーカープールでデフォルトの CPU ターゲットを構成するには、Cloud Run Admin API の workerPools.patch エンドポイントに次の PATCH HTTP リクエストを送信します。カスタム インスタンスの上限を設定するには、必要に応じて minInstanceCount フィールドと maxInstanceCount フィールド、およびそれらの update_mask パスを含めます。

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -X PATCH \
    -d '{"launchStage":"BETA","scaling":{"scalingMode":"AUTOMATIC","minInstanceCount":MIN_INSTANCES,"maxInstanceCount":MAX_INSTANCES}}' \
    https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools/WORKER_POOL?update_mask=launchStage,scaling.scalingMode,scaling.manualInstanceCount,scaling.minInstanceCount,scaling.maxInstanceCount

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

  • ACCESS_TOKEN: ワーカープールを更新する Identity and Access Management 権限を持つアカウントの有効なアクセス トークン。たとえば、Google Cloud CLI にログインしている場合は、gcloud auth print-access-token を実行してアクセス トークンを取得できます。
  • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
  • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。
  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: ワーカープールがデプロイされている Google Cloud リージョン(例: europe-west1)。
  • WORKER_POOL: ワーカープールの名前。

カスタム CPU ターゲットとインスタンスの上限を構成する

CPU 使用率のターゲット、インスタンス数の上限と下限、またはその両方をカスタマイズできます。省略した設定には、デフォルト値(CPU ターゲット 60%、最小インスタンス 1、最大インスタンス 100)が使用されます。既存のワーカープールで CPU 使用率のターゲットまたはインスタンスの上限を更新しても、新しいリビジョンは作成されません。

カスタム CPU ターゲットとインスタンスの上限は、Google Cloud CLI、YAML、または REST API を使用して構成できます。

gcloud

  • カスタム CPU ターゲットを使用して新しいワーカープールをデプロイするには、--scaling-cpu-target フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools deploy WORKER_POOL \
      --image=IMAGE_URL \
      --scaling-cpu-target=CPU_TARGET

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

    • WORKER_POOL: ワーカープールの名前。
    • IMAGE_URL: ワーカープールを含むコンテナ イメージへの参照(us-docker.pkg.dev/cloudrun/container/worker-pool:latest など)。
    • CPU_TARGET: CPU 使用率の目標値。0.1~0.90 の値を指定してください。
  • カスタム CPU ターゲットを使用して既存のワーカープールを更新するには、--scaling-cpu-target フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --scaling-cpu-target=CPU_TARGET

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

    • WORKER_POOL: ワーカープールの名前。
    • CPU_TARGET: CPU 使用率の目標値。0.1~0.90 の値を指定してください。
  • カスタム CPU ターゲットとインスタンスの上限を使用して既存のワーカープールを更新するには、--scaling-cpu-target、--min、--max フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --scaling-cpu-target=CPU_TARGET \
      --min=MIN_INSTANCES \
      --max=MAX_INSTANCES

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

    • WORKER_POOL: ワーカープールの名前。
    • CPU_TARGET: CPU 使用率の目標値。0.1~0.90 の値を指定してください。
    • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
    • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。

YAML

  1. 新しいワーカープールを作成する場合は、この手順をスキップします。既存のワーカープールを更新する場合は、その YAML 構成をダウンロードします。

    gcloud run worker-pools describe WORKER_POOL --format export > worker-pool.yaml
  2. metadata.annotations の launch-stage、scalingMode、scaling-cpu-target、minScale、maxScale アノテーションを追加または更新し、run.googleapis.com/manualInstanceCount アノテーションが存在する場合は削除します。デフォルト値のままにするカスタム アノテーション(scaling-cpu-target、minScale、maxScale)は省略できます。

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
     name: WORKER_POOL
     annotations:
       run.googleapis.com/launch-stage: BETA
       run.googleapis.com/scalingMode: automatic
       run.googleapis.com/scaling-cpu-target: 'CPU_TARGET'
       run.googleapis.com/minScale: 'MIN_INSTANCES'
       run.googleapis.com/maxScale: 'MAX_INSTANCES'

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

    • WORKER_POOL: ワーカープールの名前。
    • CPU_TARGET: CPU 使用率の目標値。0.1~0.90 の値を指定してください。
    • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
    • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。
  3. 次のコマンドを使用して、ワーカープールを作成または更新します。

    gcloud run worker-pools replace worker-pool.yaml

    gcloud run worker-pools replace コマンドは、worker-pool.yaml ファイルが存在する場合、デフォルトでこのファイルを使用します。

REST API

既存のワーカープールにカスタム CPU ターゲットとカスタム インスタンスの上限を構成するには、Cloud Run Admin API の workerPools.patch エンドポイントに次の PATCH HTTP リクエストを送信します。

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -X PATCH \
    -d '{"launchStage":"BETA","scaling":{"scalingMode":"AUTOMATIC","cpuScaling":{"cpuUtilization":CPU_TARGET},"minInstanceCount":MIN_INSTANCES,"maxInstanceCount":MAX_INSTANCES}}' \
    https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools/WORKER_POOL?update_mask=launchStage,scaling.scalingMode,scaling.manualInstanceCount,scaling.cpuScaling.cpuUtilization,scaling.minInstanceCount,scaling.maxInstanceCount

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

  • ACCESS_TOKEN: ワーカープールを更新する IAM 権限を持つアカウントの有効なアクセス トークン。たとえば、Google Cloud CLI にログインしている場合は、gcloud auth print-access-token を実行してアクセス トークンを取得できます。
  • CPU_TARGET: CPU 使用率の目標値。0.1~0.90 の値を指定してください。
  • 省略可: MIN_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最小数。1 以上でなければなりません。この値を省略すると、Cloud Run は最小値を 1 インスタンスに設定します。
  • 省略可: MAX_INSTANCES: ワーカープールで実行するコンテナ インスタンスの最大数。この値を省略すると、Cloud Run は最大インスタンス数を 100 に設定します。
  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: ワーカープールがデプロイされている Google Cloud リージョン(例: europe-west1)。
  • WORKER_POOL: ワーカープールの名前。

デフォルトの自動スケーリング設定を復元する

カスタム CPU 使用率の目標値またはカスタム インスタンスの上限をデフォルト値に復元すると、Cloud Run は CPU の自動スケーリングを有効にしたまま、デフォルトの目標値(CPU 使用率 60%、最小インスタンス数 1、最大インスタンス数 100)に戻ります。

デフォルトの自動スケーリング設定を復元するには、Google Cloud CLI、YAML、または REST API を使用します。

gcloud

  • デフォルトの CPU ターゲットを復元するには、--scaling-cpu-target=default フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --scaling-cpu-target=default

    WORKER_POOL は、ワーカープールの名前に置き換えます。

  • デフォルトのインスタンス上限を復元するには、--min=default フラグと --max=default フラグを指定して次のコマンドを実行します。

    gcloud beta run worker-pools update WORKER_POOL \
      --min=default \
      --max=default

    WORKER_POOL は、ワーカープールの名前に置き換えます。

YAML

  1. 新しいワーカープールを作成する場合は、この手順をスキップします。既存のワーカープールを更新する場合は、その YAML 構成をダウンロードします。

    gcloud run worker-pools describe WORKER_POOL --format export > worker-pool.yaml
  2. metadata.annotations から scaling-cpu-target、minScale、maxScale アノテーションを削除します。scalingMode: automatic アノテーションを更新します。

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
     name: WORKER_POOL
     annotations:
       run.googleapis.com/launch-stage: BETA
       run.googleapis.com/scalingMode: automatic

    WORKER_POOL は、ワーカープールの名前に置き換えます。

  3. 次のコマンドを使用して、ワーカープールを作成または更新します。

    gcloud run worker-pools replace worker-pool.yaml

    gcloud run worker-pools replace コマンドは、worker-pool.yaml ファイルが存在する場合、デフォルトでこのファイルを使用します。

REST API

既存のワーカープールのデフォルトの CPU ターゲットとデフォルトのインスタンス上限を復元するには、Cloud Run Admin API の workerPools.patch エンドポイントに次の PATCH HTTP リクエストを送信します。

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -X PATCH \
    -d '{"launchStage":"BETA","scaling":{"scalingMode":"AUTOMATIC","cpuScaling":{}}}' \
    https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools/WORKER_POOL?update_mask=launchStage,scaling.scalingMode,scaling.cpuScaling.cpuUtilization,scaling.minInstanceCount,scaling.maxInstanceCount

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

  • ACCESS_TOKEN: ワーカープールを更新する IAM 権限を持つアカウントの有効なアクセス トークン。たとえば、Google Cloud CLI にログインしている場合は、gcloud auth print-access-token を実行してアクセス トークンを取得できます。
  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: ワーカープールがデプロイされている Google Cloud リージョン(例: europe-west1)。
  • WORKER_POOL: ワーカープールの名前。

CPU 自動スケーリングを無効にする

CPU 自動スケーリングを無効にして、ワーカープールを手動スケーリングに戻すには、Google Cloud CLI、YAML、または REST API を使用して固定インスタンス数を指定します。

gcloud

既存のワーカープールで CPU 自動スケーリングを無効にするには、--scaling フラグを固定インスタンス数に設定して、次のコマンドを実行します。

gcloud beta run worker-pools update WORKER_POOL \
    --scaling=INSTANCE_COUNT

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

  • WORKER_POOL: ワーカープールの名前。
  • INSTANCE_COUNT: 手動スケーリング モードで実行するインスタンスの固定数。

YAML

  1. 新しいワーカープールを作成する場合は、この手順をスキップします。既存のワーカープールを更新する場合は、その YAML 構成をダウンロードします。

    gcloud run worker-pools describe WORKER_POOL --format export > worker-pool.yaml
  2. scalingMode を manual に設定し、manualInstanceCount を指定します。scaling-cpu-target、minScale、maxScale が存在する場合は削除します。

    apiVersion: run.googleapis.com/v1
    kind: WorkerPool
    metadata:
     name: WORKER_POOL
     annotations:
       run.googleapis.com/scalingMode: manual
       run.googleapis.com/manualInstanceCount: "INSTANCE_COUNT"

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

    • WORKER_POOL: ワーカープールの名前。
    • INSTANCE_COUNT: 手動スケーリング モードで実行するインスタンスの固定数。
  3. 次のコマンドを使用して、ワーカープールを作成または更新します。

    gcloud run worker-pools replace worker-pool.yaml

    gcloud run worker-pools replace コマンドは、worker-pool.yaml ファイルが存在する場合、デフォルトでこのファイルを使用します。

REST API

既存のワーカープールで CPU 自動スケーリングを無効にするには、次の PATCH HTTP リクエストを Cloud Run Admin API の workerPools.patch エンドポイントに送信します。

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -X PATCH \
    -d '{"scaling":{"scalingMode":"MANUAL","manualInstanceCount":INSTANCE_COUNT}}' \
    https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/workerPools/WORKER_POOL?update_mask=scaling.scalingMode,scaling.manualInstanceCount,scaling.cpuScaling,scaling.minInstanceCount,scaling.maxInstanceCount

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

  • ACCESS_TOKEN: ワーカープールを更新する IAM 権限を持つアカウントの有効なアクセス トークン。たとえば、Google Cloud CLI にログインしている場合は、gcloud auth print-access-token を実行してアクセス トークンを取得できます。
  • INSTANCE_COUNT: 手動スケーリング モードで実行するインスタンスの固定数。
  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • REGION: ワーカープールがデプロイされている Google Cloud リージョン(例: europe-west1)。
  • WORKER_POOL: ワーカープールの名前。

CPU 自動スケーリング設定を表示する

ワーカープールの CPU 自動スケーリング構成を表示するには、gcloud beta run worker-pools describe コマンドを実行します。

gcloud beta run worker-pools describe WORKER_POOL

WORKER_POOL は、ワーカープールの名前に置き換えます。

CPU の自動スケーリングについて

デフォルトでは、CPU 自動スケーリングは平均 CPU 使用率 60%(run.googleapis.com/container/cpu/utilizations)を目標とし、ワーカープールを 1 ~ 100 インスタンスの間でスケーリングします。

CPU 自動スケーリングを有効にすると、Cloud Run は、実行中のすべてのインスタンスで過去 1 分間の 1 秒あたりの平均 CPU 使用率を計算し、その値をインスタンスあたりの CPU 数で割って、ワーカープールに必要なインスタンス数を計算します。その結果を CPU ターゲットで割ります。

\[ \text{Instances} = \left\lceil \dfrac{\left( \frac{\text{Average CPU usage per second over the past minute}}{\text{Number of CPUs per instance}} \right)}{\text{CPU target}} \right\rceil \]

Cloud Run は、次の動作を使用してワーカープール インスタンスの数を調整します。

  • 切り上げ: Cloud Run は、測定された CPU 使用率とターゲットから必要なインスタンス数を計算します。実行中のインスタンス数から計算するのではなく、結果を次のインスタンス全体に切り上げます。この丸めにより、使用率が目標を下回っている間にワーカープールがスケールアップされることがあります。たとえば、4.1 個のインスタンスが必要なワーカープールは、5 個のインスタンスを実行します。
  • プールレベルのスケーリングとインスタンス分割: Cloud Run は、ワーカープール全体のインスタンスの合計数を計算し、構成されたインスタンス分割に基づいて、それらのインスタンスをアクティブなリビジョンに分散します。
  • 5 分間のスケールダウン安定化: Cloud Run は、スケールダウン時に 5 分間(300 秒)の安定化ウィンドウを使用します。インスタンスの頻繁な変動を防ぐため、Cloud Run はインスタンス数を過去 5 分間の最大推奨値に維持します。

CPU 使用率の目標値を選択する

デフォルトの CPU 使用率目標(60%)を使用することも、ワークロード プロファイルとレイテンシ許容度に基づいて、次のガイドラインに沿って 10%~ 90% のカスタム目標を構成することもできます。

  • CPU の目標値を高くする(80% ~ 90%): 安定して予測可能なバックグラウンド ワークロードや、レイテンシの影響を受けにくいバッチ処理タスクには、目標値を高く設定します。ターゲットを高くすると、リソースの使用率が最大化され、インフラストラクチャの費用が削減されますが、急激なワークロードの増加に対応するための余裕が少なくなり、CPU スロットリングが発生したり、新しいインスタンスの起動中に処理レイテンシが増加したりする可能性があります。
  • CPU ターゲットを低くする(20% ~ 40%): CPU 需要が急増する、または予測できないワークロード、処理レイテンシの要件が厳しいワークロード、コンテナの起動時間が長いワークロードには、低いターゲットを使用します。ターゲットを低く設定すると、より多くのインスタンスを早期にプロビジョニングして、アクティビティの急増を吸収するバッファが提供され、パフォーマンスの低下を防ぐことができます。トレードオフとして、通常の負荷条件で実行されるインスタンスが増えるため、費用が高くなります。

デフォルトのターゲットから開始し、Cloud Monitoring で run.googleapis.com/container/instance_count 指標をモニタリングして、負荷テストとパフォーマンスの観察に基づいてターゲットを調整することをおすすめします。

次のステップ