ラベルを構成する

Cloud Run ラベルは、Cloud Run ジョブに適用される Key-Value ペアです。このページでは、Cloud Run ジョブのラベルを設定、変更、削除する方法について説明します。

たとえば、次のような用途が考えられます。

  • 費用の割り当てと請求の内訳に使用する
  • 個々のチームやコストセンターで使用されているリソースを特定する
  • デプロイ環境(本番、ステージング、検証、テスト)を区別する
  • 所有者、状態のラベルを特定する
  • Logging でログをフィルタする

ラベルの使用ルール

Cloud Run ジョブで設定されたラベルを使用する場合、次のルールが適用されます。

Cloud Run で使用できるのは、有効な Google Cloud ラベルのみです。

必要なロール

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

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

ラベルを設定または変更する

Google Cloud CLI または YAML を使用して、Cloud Run ジョブにラベルを設定できます。

gcloud

  1. 新しいジョブにラベルを設定するには:

    gcloud run jobs create JOB_NAME --image IMAGE_URL --labels KEY=VALUE

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

    • JOB_NAME は、ジョブの名前に置き換えます。
    • KEY は、ラベルキーの名前に置き換えます。
    • VALUE は、キーの値に置き換えます。
    • IMAGE_URL は、コンテナ イメージへの参照(us-docker.pkg.dev/cloudrun/container/job:latest など)に置き換えます。
  2. 既存のジョブにラベルを設定するには:

    gcloud run jobs update JOB_NAME --labels KEY=VALUE
  3. 複数のラベルを更新するには、Key-Value ペアのカンマ区切りリストを指定します。

    gcloud run jobs update JOB_NAME --labels KEY1=VALUE1,KEY2=VALUE2 

YAML

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

    gcloud run jobs describe JOB_NAME --format export > job.yaml
  2. 2 か所で labels 属性を更新します。

    apiVersion: run.googleapis.com/v1
    kind: Job
    metadata:
      labels:
        LABEL: VALUE
    spec:
      template:
        metadata:
          labels:
            LABEL: VALUE

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

    • LABEL は、ラベルの名前に置き換えます。
    • VALUE は、目的の値に置き換えます。

    環境変数やメモリ上限など他の構成を指定することもできます。

  3. 既存のジョブ構成を更新します。

    gcloud run jobs replace job.yaml

ラベル別にジョブを一覧表示する

Google Cloud CLI フィルタを使用して、ラベル別にジョブを一覧表示できます。

  gcloud run jobs list --filter metadata.labels.LABEL=VALUE
  

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

  • LABEL は、ラベルの名前に置き換えます。
  • VALUE は、フィルタ後のリストに含める値に置き換えます。

ジョブのラベルを削除する

ジョブからラベルをすべて消去するには:

gcloud run jobs update JOB --clear-labels

サービスから特定のラベルを削除するには、キーのカンマ区切りリストを指定します。

gcloud run jobs update JOB --remove-labels LABEL

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

  • JOB は、Cloud Run ジョブの名前に置き換えます。
  • LABEL は、ラベルの名前に置き換えます。