ラベルを使用してリソースを整理する

ラベルは、関連するリソースをグループ化するために Google Cloud で使用できる Key-Value ペアのことです。たとえば、Compute Engine では、ラベルを使用して、本番環境、ステージング環境、開発環境などのカテゴリで VM をグループ化し、各開発段階に属するリソースを検索できます。

リソースにラベルを追加すると、ネスト化フィルタリング機能により、ラベルを使用してリソースをより正確に検索できます。

始める前に

• 永続ディスクのドキュメントをお読みください。
• イメージのドキュメントをお読みください。
• まだ設定していない場合は、認証を設定します。認証とは、 Google Cloud サービスと API にアクセスするために ID を確認するプロセスです。ローカル開発環境からコードまたはサンプルを実行するには、次のいずれかのオプションを選択して Compute Engine に対する認証を行います。
  

  Select the tab for how you plan to use the samples on this page:

  Console

  When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

  gcloud

  1. After installing the Google Cloud CLI, initialize it by running the following command:

     gcloud init

     If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  2. Set a default region and zone.

  REST

  このページの REST API サンプルをローカル開発環境で使用するには、gcloud CLI に指定した認証情報を使用します。

  After installing the Google Cloud CLI, initialize it by running the following command:

  gcloud init

  If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  詳細については、 Google Cloud 認証ドキュメントの REST を使用して認証するをご覧ください。

ラベルとは

ラベルは、 Google Cloud インスタンスに割り当てることができる Key-Value ペアのことです。ラベルはこれらのリソースを整理し、必要な粒度に基づいてコストを大規模に管理する場合に役立ちます。各リソースにラベルを設定し、そのラベルに基づいてリソースをフィルタできます。ラベルに関する情報は課金システムに転送され、請求料金をラベル別に分類できます。組み込みの請求レポートにより、リソースラベルで費用をフィルタしてグループ化できます。また、ラベルを使用して請求データ エクスポートをクエリすることもできます。

ラベルの要件

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

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

これらの上限は、各ラベルのキーと値だけでなく、ラベルのある個々の Google Cloud リソースにも適用されます。1 つのプロジェクト内のすべてのリソースに適用できるラベルの数に上限はありません。

ラベルの一般的な用途

次に、ラベルの一般的な使用例を示します。

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

• コンポーネント ラベル: component:redis、component:frontend、component:ingest、component:dashboard など。

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

• 状態のラベル: state:active、state:readytodelete、state:archive など。

• オーナー権限ラベル: 運用担当チームの識別に使用されます（例: team:shopping-cart）。

• 仮想マシンのラベル: 仮想マシンに設定できるラベル。過去に定義した仮想マシンのタグは、値のないラベルとして表示されます。

すべての API 呼び出しにタイムスタンプや個別の値を設定するなど、一意のラベルを多数作成することはおすすめしません。このアプローチの問題は、値が頻繁に変更される場合やカタログを混乱させるキーを使用している場合に、リソースを効果的にフィルタして報告することが困難になることです。

ラベルとタグ

ラベルは、リソースに対するクエリ可能なアノテーションとして使用できますが、ポリシーの条件の設定には使用できません。タグを使用すると、ポリシーをきめ細かく制御することによって、リソースに特定のタグが付加されているかどうかに基づいて、条件付きでポリシーを許可または拒否することが可能になります。詳細については、タグの概要をご覧ください。

Compute Engine でラベルを使用する

ラベルは次の Compute Engine リソースに適用できます。

• 仮想マシン（VM）インスタンス
• イメージ
• 永続ディスク
• 永続ディスクのスナップショット

次のような関連する Google Cloud コンポーネントにもラベルを使用できます。

• Cloud Storage バケット
• ネットワーキング リソース:
  • 転送ルール
  • VPN トンネル（プレビュー）
  • 静的外部 IP アドレス（プレビュー）

たとえば、次のラベルを Key-Value ペアとしてリソースに追加できます。

{
 "labels": {
    "vmrole": "webserver",
    "environment": "production",
    "location": "west",...
    }
 }

ラベルを適用したリソースを作成する

リソースを新規作成する際は、そのリソースにラベルを適用できます。

gcloud compute instances create ... \
    --labels webserver=backend,media=images

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances

{
 "name": "myVM",
 "machineType": "zones/us-central1-f/machineTypes/custom-2-15360-ext",
  ...,
 "labels": {
   "webserver": "backend",
   "media": "images"
  }
}

既存のリソースへのラベルの追加や更新

Google Cloud コンソール、gcloud CLI、または Compute Engine API を使用して、リソースにラベルを追加したり、既存のラベルを更新したりできます。転送ルールのラベルを追加または更新するには、gcloud CLI または Compute Engine API を使用します。

gcloud compute disks update example-disk \
    --update-labels backend=webserver,media=images

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance/setLabels

{
 "labels": {
  "environment": "test",
  "an-existing-tag": "yes"
 },
 "labelFingerprint": "42WmSpB8rSM="
}

ラベルを表示する

Google Cloud コンソール、gcloud CLI、または Compute Engine API を使用して、リソースのラベルを表示できます。転送ルールのラベルを表示するには、gcloud CLI または Compute Engine API を使用します。

gcloud compute disks describe example-disk

...
id: '5047929990219134234'
kind: compute#disk
labelFingerprint: GHZ1Un209U=0
labels:
  environment: dev
  department: finance
...

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME

API リクエストに使用するラベルのフィンガープリントを取得する

API でラベルを更新または追加するときは、リクエストに最新のラベルのフィンガープリントを入力して、他のリクエストとの競合を防止する必要があります。フィンガープリントが必要となるのは、API リクエストを使用する場合のみです。Google Cloud コンソールと Google Cloud CLI ツールの場合、フィンガープリントは必要ありません。

最新の labelsFingerprint を取得するには、次のリソースに対して GET リクエストを行います。

• VM インスタンスの場合は、instances.get() メソッドを使用します。
• スナップショットの場合は、snapshots.get() メソッドを使用します。
• イメージの場合は、images.get() メソッドを使用します。
• ディスクの場合は、disks.get() メソッドを使用します。
• 転送ルールの場合は、forwardingRules.get() メソッドを使用します。
• リージョン静的外部 IP アドレスの場合は、ベータ版の addresses.get() メソッドを使用します。
• グローバル静的外部 IP アドレスの場合は、ベータ版の globalAddresses.get() メソッドを使用します。
• VPN トンネルの場合は、ベータ版の vpnTunnels.get() メソッドを使用します。

たとえば、次のスニペットは VM インスタンスの labelsFingerprint を取得します。

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance

レスポンスには、labelFingerprint プロパティが含まれます。

200 OK

{
 "kind": "compute#instance",
 "id": "4392196237934605253",
 "creationTimestamp": "2015-09-15T14:05:16.475-07:00",
 "zone": "https://content.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f",
 "status": "RUNNING",
 ...
 "labels": {
  "environment": "test"
 },
 "labelFingerprint": "p1ty_9HoBk0="
}

ラベルを削除する

Google Cloud コンソール、gcloud CLI、または Compute Engine API を使用して、リソースからラベルを削除できます。転送ルールのラベルを削除するには、gcloud CLI または Compute Engine API を使用します。

gcloud compute disks update example-disk \
    --remove-labels backend,media

POST https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-f/instances/example-instance/setLabels

{
 "labels": { },
 "labelFingerprint": "42WmSpB8rSM="
}

ラベルを使用して検索結果をフィルタする

Google Cloud コンソール、gcloud CLI、または Compute Engine API を使用して、リソースの検索結果をラベルでフィルタできます。転送ルールをラベルでフィルタするには、gcloud CLI または Compute Engine API を使用します。

gcloud compute instances list \
    --filter labels.env=dev

GET https://compute.googleapis.com/compute/v1/projects/myproject/zones/us-central1-a/instances?filter=labels.env%3Adev

VM ラベルとネットワーク タグの関係

以前は、ラベルとタグが関連していました。たとえば、webserver:test ラベルを VM に追加すると、Compute Engine がその VM に webserver タグを自動的に追加していました。

現在、ラベルとタグは互いに独立しています。VM にラベルを作成しても、Compute Engine は VM のタグを作成しません。VM にタグを作成する必要がある場合は、手動で作成する必要があります。

タグを作成する方法については、ネットワーク タグをご覧ください。

次のステップ

• ネットワーク タグの追加方法を学習する。
• フィルタリングを学習する。