Google Cloud Platform Japan 公式ブログ: ラベルを使った効率化の方法

ラベルを使った効率化の方法

2015年10月23日金曜日

* この投稿は、米国時間 10 月 16 日、Google Cloud Platform の Product Manager である Rae Wang によって投稿されたもの（投稿はこちら）の抄訳です。

今回はラベルを紹介します。ラベルは、Google Cloud Platform のリソースにメタデータを付けて整理できるようにするツールです。

たとえば、リソースに対して環境（テスト、本番など）や所有者（ken、bob など）ごとにラベルを付けることができます。そうすることでリソースが何のために使われているか、リソースを所有している人、連絡すべき相手が誰か、がわかるようになります。

ラベルでフィルタリングすれば、リソースを探すのも簡単です。また、ラベルを使ってコスト分析や大量の作業を行うスクリプトを作成することもできます。

どのようにラベルを付けるか

Developers Console でリソース（プロジェクトまたは仮想マシンインスタンス）を選択し、“Edit labels”をクリックしてラベルの追加や表示、変更を行うことができます。

ラベルを追加したら、そのラベルを VM のリストビューに、列として追加することもできます。

どのようにラベルでフィルタリングするか

リソースにラベルを付けたら、ラベルを使ってそれらのリソースをフィルタリングできます。Developers Console の検索ボックスにキーか値を 1 文字入力するごとに、その下のフィルタボックスには、適切なフィルタ条件の候補とフィルタ結果の候補が自動的に絞り込まれて表示されます。

一般的な使い方

ラベルの一般的な使い方は以下のとおりです。

チームやコストセンターに基づくラベル - どのチームが所有しているかによってプロジェクトを区別します。このラベルは原価計算や予算管理に利用できます。例）team:marketing、team:research
コンポーネントに基づくラベル - 例）component:redis、component:frontend
環境やステージに基づくラベル - 例）environment:prod、environment:test
所有者や連絡先に基づくラベル - リソースに責任を持ち、リソースに関する第一連絡先である担当者がいる場合に使用します。
状態に基づくラベル - 例）state:inuse、state:readyfordeletion

ラベルの要素

ラベルは、プロジェクトや VM に付加できるキー:値のペアです。
ラベルのキーと空でない値には、小文字（a ～ z）と数字（0 ～ 9）、ハイフンのみを使用できます。キーと値の最初の文字は小文字に、最後の文字は小文字か数字にする必要があります。正規表現は [a-z0-9][a-z0-9._\-]* です。
ラベルのキーと値の長さはいずれも最大 63 桁です。
個々のリソースに付けることができるラベルの数は最大 64 個です。
これまでに定義した VM タグは、値のないラベルとしても表示されます。

API ではどう扱うのか

ラベルには API や Developers Console でアクセスできます。下の例では、ラベルを使って VM を作成し、フィルタリングしています。API ドキュメントに含まれているプロジェクトのラベルと VM のラベルに関する説明にも目を通すとよいでしょう。

VM ラベルの設定

setLabels パスへの POST リクエストでインスタンスのラベルを更新できます。このリクエストにはプロジェクト ID、ゾーン、インスタンス名が必要なほか、認証のために OAUTH トークンも必要になります。JSON リクエストボディには新しいラベルセットとラベルのフィンガープリントを含めなければなりません。このフィンガープリントは既存ラベルのハッシュであり、リソースで GET が実行されると返されます。これによって楽観的ロックが行われ、同じリソースについてリクエストが 1 回だけ行われます。

なお、setLabels が read-modify-write パターンに従い、インスタンスのすべてのラベルを置き換えることに注意してください。ラベルのサブセットを更新したい場合は、ラベルを読み出して変更を行ってから、ラベルリスト全体と共に setLabels を呼び出さなければなりません。

$ curl --request POST --header "Authorization: Bearer your-oauth-token" --header 'Content-Type: application/json' --data '{"labels": {"env": "canary"}, "labelFingerprint": "abcdefghij="}' https://www.googleapis.com/compute/alpha/projects/your-project-id/zones/your-zone/instances/your-instance/setLabels
{
"kind": "compute#operation",
"id": "1234567890",
…
"selfLink": "https://www.googleapis.com/compute/alpha/projects/your-project-id/zones/your-zone/operations/operation-12345678"
}

リストリクエストでのラベルによるフィルタリング

ラベルを設定したら、“labels.env eq prod” のようなフィルタを作成できます。このフィルタは、ラベル “env” が “prod” に設定されたインスタンスのみを返します。

$ curl --header "Authorization: Bearer your-oauth-token" https://www.googleapis.com/compute/alpha/projects/your-project-id/zones/your-zone/instances?filter=%28labels.env+eq+canary%29+%28labels.tier+eq+backend%29
{
"items": [
{
"name": "vm42"
"labels": {
"env": "prod",
"tier": "backend"
    }
   }
 ]
}