ラベルの作成と管理

Cloud Dataproc のクラスタおよびジョブリソースにユーザーラベルを適用すると、リソースおよび関連オペレーションをグループ分けでき、後からフィルタリングや一覧表示もできます。リソースの作成時、クラスタの作成時、またはジョブの送信時にラベルをリソースに関連付けます。リソースがラベルに関連付けられると、そのラベルはリソースで実行されるオペレーション(クラスタの作成、更新、パッチ適用、削除やジョブの送信、更新、キャンセル、削除)に伝播されて、クラスタ、ジョブ、オペレーションをラベルでフィルタリングおよび一覧表示できます。

また、仮想マシンのインスタンスやディスクなど、クラスタ リソースに関連付けられた Compute Engine リソースにラベルを追加することもできます。

ラベルとは

ラベルとは、Google Cloud Platform Cloud Dataproc のクラスタおよびジョブの整理に役立つ Key-Value ペアです。各リソースにラベルを付けて、そのラベルに基づいてリソースをフィルタリングできます。ラベルに関する情報は課金システムに転送されるため、ラベルを基準に請求料金を分析することもできます。

ラベルの一般的な用途

タイムスタンプやすべての API 呼び出しに個別に値を作成するなど、一意のラベルを多数作成することはおすすめしません。次に、ラベルの一般的な使用例を示します。

  • チームまたはコストセンターのラベル: チームやコストセンターに基づいてラベルを追加して、各チームが所有する Cloud Dataproc のクラスタやジョブを区別します(例: team:researchteam:analytics)。この種類のラベルは、費用計算または予算作成に使用できます。

  • コンポーネント ラベル: component:rediscomponent:frontendcomponent:ingestcomponent:dashboard など。

  • 環境またはステージのラベル: environment:productionenvironment:test など。

  • 状態のラベル: state:activestate:readytodeletestate:archive など。

ラベルの要件

リソースに適用するラベルは、次の要件を満たす必要があります。

  • 1 つのリソースには、最大 64 個のラベルを適用できます。
  • ラベルは、Key-Value ペアでなければなりません。
  • キーは 1 文字以上、63 文字までにする必要があります。空にすることはできません。値は 63 文字以下にします。空にすることもできます。
  • キーと値には、小文字、数字、アンダースコア、ダッシュのみを使用できます。すべての文字は UTF-8 でエンコードする必要があります。国際文字も使用できます。
  • ラベルのキー部分は一意でなければなりません。ただし、複数のリソースで同じキーを使用できます。
  • キーの先頭には、小文字または国際文字を使用する必要があります。

Cloud Dataproc ラベルの作成と使用

gcloud コマンド

gcloud コマンドライン ツールを使用して Cloud Dataproc クラスタまたはジョブを作成または送信するときに、適用するラベルを 1 つ以上指定できます。

gcloud dataproc clusters create args --labels env=prod,customer=acme
gcloud dataproc jobs submit args --labels env=prod,customer=acme
Cloud Dataproc クラスタまたはジョブを作成した後は、そのリソースに関連付けられているラベルを、gcloud コマンドライン ツールを使用して更新できます。
gcloud dataproc clusters update args --update-labels env=prod,customer=acme
gcloud dataproc jobs update args --update-labels env=prod,customer=acme
同様に、gcloud コマンドライン ツールを使用して Cloud Dataproc リソースをラベルでフィルタリングできます。これには、labels.<key=value> という形式のフィルタ式を使用します。
gcloud dataproc clusters list --filter "status.state=ACTIVE AND labels.env=prod"
gcloud dataproc jobs list --filter "status.state=ACTIVE AND labels.customer=acme"
フィルタ式の作成方法については、Cloud Dataproc API のドキュメントで clusters.list および jobs.list をご覧ください。

REST API

ラベルは、Cloud Dataproc REST API を使用して Cloud Dataproc リソースに追加できます。clusters.create API や jobs.submit API を使用して、クラスタやジョブを作成または送信するときにラベルを付けることができます。リソースの作成後は、clusters.patch API や jobs.patch API を使用してラベルを編集できます。次に示すのは、key1:value ラベルをクラスタに付ける cluster.create リクエストの JSON 本文の例です。

{
  "clusterName":"cluster-1",
  "projectId":"my-project",
  "config":{
    "configBucket":"",
    "gceClusterConfig":{
      "networkUri":".../networks/default",
      "zoneUri":".../zones/us-central1-f"
    },
    "masterConfig":{
      "numInstances":1,
      "machineTypeUri":"..../machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    },
    "workerConfig":{
      "numInstances":2,
      "machineTypeUri":"...machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    }
  },
  "labels":{
    "key1":"value1"
  }
}
clusters.list API や jobs.list API を使用して、指定したフィルタと一致するリソースを一覧表示できます。これには、labels.<key=value> という形式を使用します。次に示すサンプルは、Cloud Dataproc API の clusters.list HTTPS GET リクエストで key=value ラベルフィルタが指定されています。呼び出し元は、projectregion、フィルタ label-keylabel-valueapi-key を挿入します。このサンプル リクエストは読みやすさのために 2 行に分けて記載されています。
GET https://dataproc.googleapis.com/v1/projects/project/regions/region/clusters?
filter=labels.label-key=label-value&key=api-key
フィルタ式の作成方法については、Cloud Dataproc API のドキュメントで clusters.list および jobs.list をご覧ください。

Console

GCP Console を使用して Cloud Dataproc リソースを作成または送信するときに、適用するラベルのセットを指定できます。下の図は、[Cloud Dataproc] → [クラスタの作成] ページから Cloud Dataproc クラスタに関連付けるラベルを作成する例です。

次に示すのは、[Cloud Dataproc] → [ジョブを送信] ページから Cloud Dataproc ジョブに関連付けるラベルを作成する例です。

Cloud Dataproc リソースを作成した後は、そのリソースに関連付けられているラベルを更新できます。ラベルを更新するには、ページの左上にある [SHOW INFO PANEL] を最初にクリックする必要があります。次に示すのは、[Cloud Dataproc] → [クラスタのリスト表示] ページの例です。

情報パネルが表示されたら、Cloud Dataproc リソースのラベルを更新できます。次に示すのは、Cloud Dataproc クラスタのラベル更新の例です。

また、1 回のオペレーションで複数のアイテムのラベルを更新することもできます。次の例では、複数の Cloud Dataproc ジョブのラベルを一度に更新しています。

ラベルを使用すると、[Cloud Dataproc] → [クラスタのリスト表示] ページと [Cloud Dataproc] → [ジョブのリスト表示] ページに表示される Cloud Dataproc リソースをフィルタリングできます。ページの先頭で、labels.<labelname>=<value> という検索パターンを使用して、ラベルでリソースをフィルタできます。

自動的に適用されるラベル

クラスタを作成または更新する場合、Cloud Dataproc は自動的にいくつかのラベルをクラスタおよびクラスタ リソースに適用します。たとえば、クラスタを作成すると Cloud Dataproc によって仮想マシン、永続ディスク、アクセラレータにラベルが適用されます。自動的に適用されるラベルには、特殊な goog-dataproc 接頭部があります。

次の goog-dataproc ラベルは、Cloud Dataproc リソースに自動的に適用されます。自動指定された値は、クラスタ作成時に予約された goog-dataproc ラベルに指定された値によって上書きされます。このため、これらのラベルに独自の値を指定することはおすすめしません。

ラベル 説明
goog-dataproc-cluster-name ユーザー指定のクラスタ名
goog-dataproc-cluster-uuid 一意のクラスタ ID
goog-dataproc-location Cloud Dataproc リージョン クラスタ エンドポイント

これらの自動的に適用されたラベルは、以下をはじめとしてさまざまな方法で使用できます。

次のステップ

このページは役立ちましたか?評価をお願いいたします。

フィードバックを送信...

Cloud Dataproc ドキュメント
ご不明な点がありましたら、Google のサポートページをご覧ください。