コンパクトプレースメントポリシーを使用してレイテンシを短縮する

このドキュメントでは、コンパクトプレースメントポリシーを作成して適用することで、仮想マシン（VM）インスタンス間のネットワークレイテンシを短縮する方法について説明します。

コンパクトプレースメントポリシーでは、VM を互いに物理的に近い位置に配置するよう指定します。これにより、ハイパフォーマンスコンピューティング（HPC）、機械学習（ML）、データベースサーバーのワークロードなどを実行する際に、パフォーマンスを向上させ、VM 間のネットワークレイテンシを短縮できます。

始める前に

まだ設定していない場合は、認証を設定します。認証とは、Google Cloud サービスと API にアクセスするために ID を確認するプロセスです。ローカル開発環境からコードまたはサンプルを実行するには、次のように Compute Engine に対する認証を行います。

Select the tab for how you plan to use the samples on this page:
gcloud
1. Install the Google Cloud CLI, then initialize it by running the following command:
  gcloud init
  Note: If you installed the gcloud CLI previously, make sure you have the latest version by running gcloud components update.
2. Set a default region and zone.

必要なロール

コンパクトプレースメントポリシーを作成して VM に適用するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

Compute インスタンス管理者（v1）（roles/compute.instanceAdmin.v1）
予約を作成する: Compute 管理者（roles/compute.admin）

ロールの付与の詳細については、アクセス権の管理をご覧ください。

これらの事前定義ロールには、コンパクトプレースメントポリシーを作成して VM に適用するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

コンパクトプレースメントポリシーを作成して VM に適用するには、次の権限が必要です。

プレースメントポリシーを作成する: プロジェクトに対する compute.resourcePolicies.create
既存の VM にプレースメントポリシーを適用する: プロジェクトに対する compute.instances.addResourcePolicies
VM を作成する:
- プロジェクトに対する compute.instances.create
- カスタムイメージを使用して VM を作成する: イメージに対する compute.images.useReadOnly
- スナップショットを使用して VM を作成する: スナップショットに対する compute.snapshots.useReadOnly
- インスタンステンプレートを使用して VM を作成する: インスタンステンプレートに対する compute.instanceTemplates.useReadOnly
- レガシーネットワークを VM に割り当てる: プロジェクトに対する compute.networks.use
- VM の静的 IP アドレスを指定する: プロジェクトに対する compute.addresses.use
- レガシーネットワークの使用時に VM に外部 IP アドレスを割り当てる: プロジェクトに対する compute.networks.useExternalIp
- VM のサブネットを指定する: プロジェクトまたは選択したサブネットに対する compute.subnetworks.use
- VPC ネットワークの使用時に VM に外部 IP アドレスを割り当てる: プロジェクトまたは選択したサブネットに対する compute.subnetworks.useExternalIp
- VM の VM インスタンスメタデータを設定する: プロジェクトに対する compute.instances.setMetadata
- VM にタグを設定する: VM に対する compute.instances.setTags
- VM にラベルを設定する: VM に対する compute.instances.setLabels
- VM が使用するサービスアカウントを設定する: VM に対する compute.instances.setServiceAccount
- VM に新しいディスクを作成する: プロジェクトに対する compute.disks.create
- 既存のディスクを読み取り専用モードまたは読み取り / 書き込みモードでアタッチする: ディスクに対する compute.disks.use
- 既存のディスクを読み取り専用モードでアタッチする: ディスクに対する compute.disks.useReadOnly
予約を作成する: プロジェクトに対する compute.reservations.create
インスタンステンプレートを作成する: プロジェクトに対する compute.instanceTemplates.create
リージョンまたはゾーンのマネージドインスタンスグループ（MIG）を作成する: プロジェクトに対する compute.instanceGroupManagers.create
VM の詳細を表示する: プロジェクトに対する compute.instances.get

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

コンパクトプレースメントポリシーを作成する

コンパクトプレースメントポリシーを作成するときに、必要に応じて次のいずれかまたは両方を指定できます。

最大距離値。これにより、ネットワークレイテンシの要件が厳しい場合に VM 間の距離を制御できます。ポリシーを適用する VM のマシンタイプとゾーンに応じて、次の条件が適用されます。
- ゾーンに使用可能な容量がある場合、最大距離が大きい（3 など）コンパクトプレースメントポリシーでは、VM 同士がより近い位置に配置されることがあります。
- ゾーンの容量が不足している場合、最大距離が小さい（1 など）コンパクトプレースメントポリシーでは、一部の VM にこのポリシーが適用されない可能性が高くなります。
また、最大距離の値は、コンパクトプレースメントポリシーを適用できる VM の数と、VM のホストメンテナンスポリシーに影響します。詳細については、コンパクトプレースメントポリシーの制限事項をご覧ください。
VM の固定数。これにより、特定の数の VM に適用する場合にのみコンパクトプレースメントポリシーが有効になります。指定された数を超える VM にコンパクトプレースメントポリシーを適用しようとすると、エラーが発生します。VM の固定数が設定されたコンパクトプレースメントポリシーを予約に適用することはできません。

コンパクトプレースメントポリシーを作成するには、gcloud CLI または REST を使用します。

gcloud

コンパクトプレースメントポリシーを作成するには、--collocation=collocated フラグを指定して gcloud compute resource-policies create group-placement コマンドを使用します。

gcloud compute resource-policies create group-placement POLICY_NAME \
    --collocation=collocated \
    --region=REGION

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

POLICY_NAME: 作成するポリシーの名前。
REGION: ポリシーを作成するリージョン。コンパクトプレースメントポリシーを既存の VM に適用する場合は、VM が配置されているゾーンを含むリージョンにポリシーを作成します。

必要に応じて、以下のいずれかまたは両方の操作を行うことができます。

VM の配置距離を適切に制御するには、gcloud beta compute resource-policies create group-placement コマンドを使用して --max-distance フラグを指定します。

プレビュー — The --max-distance flag

この機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 pre-GA の機能は「現状有姿」で利用できますが、サポートが制限される場合があります。詳しくは、リリースステージの説明をご覧ください。
```
gcloud beta compute resource-policies create group-placement POLICY_NAME \
    --collocation=collocated \
    --max-distance=MAX_DISTANCE \
    --region=REGION
```
MAX_DISTANCE は、VM の最大距離の構成に置き換えます。この値は 1 と 3 の間にする必要があります。前者は、ネットワークレイテンシを最小化するために VM を同じラックに配置するように指定します。後者は、VM を隣接するクラスタに配置するように指定します。コンパクトプレースメントポリシーを予約に適用する場合は、1 の値を指定できません。
特定の数の VM に適用する場合にのみコンパクトプレースメントポリシーを有効にするには、--vm-count フラグを指定します。
```
gcloud compute resource-policies create group-placement POLICY_NAME \
    --collocation=collocated \
    --region=REGION \
    --vm-count=VM_COUNT
```
VM_COUNT は、コンパクトプレースメントポリシーを適用できる VM の正確な数に置き換えます。この値は 1 から、コンパクトプレースメントポリシーを適用できる VM の最大数までの範囲にする必要があります。

REST

コンパクトプレースメントポリシーを作成するには、resourcePolicies.insert メソッドに POST リクエストを送信します。リクエストの本文に collocation フィールドを含め、COLLOCATED に設定します。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/resourcePolicies

{
  "name": "POLICY_NAME",
  "groupPlacementPolicy": {
    "collocation": "COLLOCATED"
  }
}

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

PROJECT_ID: プレースメントポリシーを作成するプロジェクトの ID。
REGION: ポリシーを作成するリージョン。コンパクトプレースメントポリシーを既存の VM に適用する場合は、VM が配置されているゾーンを含むリージョンにポリシーを作成します。
POLICY_NAME: 作成するコンパクトプレースメントポリシーの名前。

必要に応じて、以下のいずれかまたは両方の操作を行うことができます。

VM の配置距離を適切に制御するには、beta.resourcePolicies.insert メソッドに POST リクエストを送信します。リクエスト本文に、maxDistance フィールドを含めます。

プレビュー — The maxDistance field

この機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 pre-GA の機能は「現状有姿」で利用できますが、サポートが制限される場合があります。詳しくは、リリースステージの説明をご覧ください。
```
POST https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/regions/REGION/resourcePolicies

{
  "name": "POLICY_NAME",
  "groupPlacementPolicy": {
    "collocation": "COLLOCATED",
    "maxDistance": "MAX_DISTANCE"
  }
}
```
MAX_DISTANCE は、VM の最大距離の構成に置き換えます。この値は 1 と 3 の間にする必要があります。前者は、ネットワークレイテンシを最小化するために VM を同じラックに配置するように指定します。後者は、VM を隣接するクラスタに配置するように指定します。コンパクトプレースメントポリシーを予約に適用する場合は、1 の値を指定できません。
特定の数の VM に適用する場合にのみコンパクトプレースメントポリシーを有効にするには、リクエスト本文に vmCount フィールドを含めます。
```
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/resourcePolicies

{
  "name": "POLICY_NAME",
  "groupPlacementPolicy": {
    "collocation": "COLLOCATED",
    "vmCount": "VM_COUNT"
  }
}
```
VM_COUNT は、コンパクトプレースメントポリシーを適用できる VM の正確な数に置き換えます。この値は 1 から、コンパクトプレースメントポリシーを適用できる VM の最大数までの範囲にする必要があります。

コンパクトプレースメントポリシーを適用する

コンパクトプレースメントポリシーは既存の VM に適用できます。VM、インスタンステンプレート、MIG、VM の予約を作成するときに適用することもできます。

コンパクトプレースメントポリシーを指定する Compute Engine リソースを作成するには、次のいずれかの方法を選択します。

コンパクトプレースメントポリシーを既存の VM に適用する。
コンパクトプレースメントポリシーを使用して VM を作成する。
コンパクトプレースメントポリシーを使用して VM を一括作成する。
コンパクトプレースメントポリシーを使用して予約を作成する。
コンパクトプレースメントポリシーを使用してインスタンステンプレートを作成する。
MIG の VM にコンパクトプレースメントポリシーを適用する。

コンパクトプレースメントポリシーが VM に適用されたら、同じポリシーを指定している他の VM との関連で VM の物理的な場所を確認することができます。

コンパクトプレースメントポリシーを既存の VM に適用する

コンパクトプレースメントポリシーを既存の VM に適用する前に、次のことを確認してください。

VM とコンパクトプレースメントポリシーは同じリージョンに配置する必要があります。たとえば、プレースメントポリシーがリージョン us-central1 にある場合、VM は us-central1 のゾーンに配置する必要があります。VM を別のリージョンに移行する必要がある場合は、ゾーンまたはリージョン間で VM を移動するをご覧ください。
VM は、サポートされているマシンシリーズとホストメンテナンスポリシーを使用する必要があります。VM に変更を加える必要がある場合は、次のいずれかまたは両方を行います。
- VM のマシンタイプを変更する。
- VM のホストメンテナンスポリシーを更新する。
VM の固定数を指定するコンパクトプレースメントポリシーを適用する場合は、ホストエラー後に自動的に再起動されないように VM を更新する必要があります。

上記以外の場合、VM にコンパクトプレースメントポリシーを適用すると失敗します。VM にすでにプレースメントポリシーが指定されていて、そのプレースメントポリシーを置き換える場合は、VM のプレースメントポリシーを置き換えるをご覧ください。

コンパクトプレースメントポリシーを既存の VM に適用するには、次のいずれかのオプションを選択します。

gcloud

VM を停止します。
既存の VM にコンパクトプレースメントポリシーを適用するには、--resource-policies フラグを指定して gcloud compute instances add-resource-policies コマンドを使用します。
```
gcloud compute instances add-resource-policies VM_NAME \
    --resource-policies=POLICY_NAME \
    --zone=ZONE
```
次のように置き換えます。
- VM_NAME: 既存の VM の名前。
- POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。
- ZONE: VM が配置されているゾーン。
VM を再起動します。

REST

VM を停止します。
コンパクトプレースメントポリシーを既存の VM に適用するには、instances.addResourcePolicies メソッドに POST リクエストを送信します。リクエスト本文に、resourcePolicies フィールドを含めます。
```
POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/VM_NAME/addResourcePolicies

{
  "resourcePolicies": [
    "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
  ]
}
```
次のように置き換えます。
- PROJECT_ID: コンパクトプレースメントポリシーと VM が存在するプロジェクトの ID。
- ZONE: VM が存在するゾーン。コンパクトプレースメントポリシーが配置されているリージョン内である必要があります。
- VM_NAME: 既存の VM の名前。
- REGION: コンパクトプレースメントポリシーが存在するリージョン。
- POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。
VM を再起動します。

コンパクトプレースメントポリシーを使用して VM を作成する

コンパクトプレースメントポリシーを使用する VM は、プレースメントポリシーと同じリージョン内のゾーンにのみ作成できます。

コンパクトプレースメントポリシーを指定する VM を作成するには、次のいずれかを選択します。

gcloud

コンパクトプレースメントポリシーを指定する VM を作成するには、--resource-policies フラグを指定して gcloud compute instances create コマンドを使用します。

gcloud compute instances create VM_NAME \
    --machine-type=MACHINE_TYPE \
    --maintenance-policy=MAINTENANCE_POLICY \
    --resource-policies=POLICY_NAME \
    --zone=ZONE

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

VM_NAME: 作成する VM の名前。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合は、--no-restart-on-failure フラグを指定する必要があります。これは、ホストエラー後に VM が自動的に再起動されないことを示します。
ZONE: VM を作成するゾーン。

REST

コンパクトプレースメントポリシーを指定する VM を作成するには、instances.insert メソッドに POST リクエストを送信します。リクエスト本文に、resourcePolicies フィールドを含めます。

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

{
  "name": "VM_NAME",
  "machineType": "zones/ZONE/machineTypes/MACHINE_TYPE",
  "resourcePolicies": [
    "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
  ],
  "scheduling": {
    "onHostMaintenance": "MAINTENANCE_POLICY"
  }
}

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

PROJECT_ID: コンパクトプレースメントポリシーを含むプロジェクトの ID。
ZONE: VM を作成するゾーンとマシンタイプが存在するゾーン。コンパクトプレースメントポリシーのリージョン内で使用可能なマシンタイプのみを指定できます。
VM_NAME: 作成する VM の名前。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
REGION: コンパクトプレースメントポリシーが存在するリージョン。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合、scheduling フィールドで automaticRestart フィールドを false に設定する必要があります。これは、ホストエラー後に VM が自動的に再起動されないことを示します。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

VM を作成する構成オプションの詳細については、VM インスタンスを作成して起動するをご覧ください。

コンパクトプレースメントポリシーを使用して VM を一括作成する

コンパクトプレースメントポリシーを使用して VM を一括作成できるのは、プレースメントポリシーと同じリージョン内のみです。

コンパクトプレースメントポリシーを指定する VM を一括作成するには、次のいずれかのオプションを選択します。

gcloud

コンパクトプレースメントポリシーを指定する VM を一括で作成するには、--resource-policies フラグを指定して gcloud compute instances bulk create コマンドを使用します。

たとえば、単一のゾーンで VM を一括作成し、VM の名前パターンを指定するには、次のコマンドを実行します。

gcloud compute instances bulk create \
    --count=COUNT \
    --machine-type=MACHINE_TYPE \
    --maintenance-policy=MAINTENANCE_POLICY \
    --name-pattern=NAME_PATTERN \
    --resource-policies=POLICY_NAME \
    --zone=ZONE

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

COUNT: 作成する VM の数。指定されたコンパクトプレースメントポリシーのサポートされている VM の最大数を超えることはできません。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。
NAME_PATTERN: 作成する VM の名前パターン。ハッシュ文字（#）を使用して一連の数字に置き換えます。たとえば、vm-# を指定すると、vm-1 や vm-2 といった名前の VM が、COUNT で指定された VM の最大数まで作成されます。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合は、--no-restart-on-failure フラグを指定する必要があります。これは、VM がホストエラー後に自動的に再起動されないことを示します。
ZONE: VM を一括作成するゾーン。

REST

コンパクトプレースメントポリシーを指定する VM を一括作成するには、instances.bulkInsert メソッドに POST リクエストを送信します。リクエスト本文に、resourcePolicies フィールドを含めます。

たとえば、単一のゾーンで VM を一括作成し、VM の名前パターンを指定するには、次のように POST リクエストを送信します。

POST https://www.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instances/bulkInsert

{
  "count": "COUNT",
  "machineType": "MACHINE_TYPE",
  "namePattern": "NAME_PATTERN",
  "instanceProperties": {
    "resourcePolicies": [
      "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
    ],
    "scheduling": {
      "onHostMaintenance": "MAINTENANCE_POLICY"
    }
  }
}

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

PROJECT_ID: コンパクトプレースメントポリシーを含むプロジェクトの ID。
ZONE: VM を一括作成するゾーン。
COUNT: 作成する VM の数。指定されたコンパクトプレースメントポリシーのサポートされている VM の最大数を超えることはできません。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
NAME_PATTERN: 作成する VM の名前パターン。ハッシュ文字（#）を使用して一連の数字に置き換えます。たとえば、vm-# を指定すると、vm-1 や vm-2 といった名前の VM が、COUNT で指定された VM の最大数まで作成されます。
REGION: コンパクトプレースメントポリシーが存在するリージョン。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合、scheduling フィールドで automaticRestart フィールドを false に設定する必要があります。これは、VM がホストエラー後に自動的に再起動されないことを示します。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

VM を一括作成するための構成オプションの詳細については、VM を一括作成するをご覧ください。

コンパクトプレースメントポリシーを使用して予約を作成する

コンパクトプレースメントポリシーを指定するオンデマンドの単一プロジェクトの予約を作成する場合は、明示的に対象となる予約を作成する必要があります。予約を使用する VM を作成する場合は、次の点を確認してください。

VM には、予約に適用されたものと同じコンパクトプレースメントポリシーを指定する必要があります。
VM は、その予約を明示的に対象として使用する必要があります。詳細については、特定の予約から VM を使用するをご覧ください。

コンパクトプレースメントポリシーを使用して単一プロジェクトの予約を作成するには、次のいずれかの方法を選択します。

このセクションで説明するように、プロパティを直接指定して予約を作成します。
このドキュメントの説明に沿ってコンパクトプレースメントポリシーを含むインスタンステンプレートを作成し、新しく作成したインスタンステンプレートを指定して単一プロジェクトの予約を作成します。

プロパティを直接指定してコンパクトプレースメントポリシーを含む単一プロジェクトの予約を作成するには、次のいずれかを選択します。

gcloud

プロパティを直接指定してコンパクトプレースメントポリシーを含む単一プロジェクトの予約を作成するには、--require-specific-reservation フラグと --resource-policies フラグを指定して gcloud compute reservations create コマンドを使用します。

gcloud compute reservations create RESERVATION_NAME \
    --machine-type=MACHINE_TYPE \
    --require-specific-reservation \
    --resource-policies=policy=POLICY_NAME \
    --vm-count=NUMBER_OF_VMS \
    --zone=ZONE

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

RESERVATION_NAME: 予約の名前。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。VM の固定数を持つコンパクトプレースメントポリシーを指定することはできません。この条件を満たしていない場合、予約の作成は失敗します。
NUMBER_OF_VMS: 予約する VM の数。指定されたコンパクトプレースメントポリシーのサポートされている VM の最大数を超えることはできません。
ZONE: VM を予約するゾーン。VM を予約できるのは、指定したコンパクトプレースメントポリシーのリージョン内のゾーンに限られます。

REST

プロパティを直接指定してコンパクトプレースメントポリシーを含む単一プロジェクトの予約を作成するには、reservations.insert メソッドに POST リクエストを送信します。リクエストの本文で、resourcePolicies フィールドと、specificReservationRequired フィールドを true に設定します。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/reservations

{
  "name": "RESERVATION_NAME",
  "resourcePolicies": {
    "policy" : "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
  },
  "specificReservation": {
    "count": "NUMBER_OF_VMS",
    "instanceProperties": {
      "machineType": "MACHINE_TYPE",
    }
  },
  "specificReservationRequired": true
}

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

PROJECT_ID: コンパクトプレースメントポリシーを含むプロジェクトの ID。
ZONE: VM を予約するゾーン。VM を予約できるのは、指定したコンパクトプレースメントポリシーのリージョン内のゾーンに限られます。
RESERVATION_NAME: 予約の名前。
REGION: コンパクトプレースメントポリシーが存在するリージョン。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。VM の固定数を持つコンパクトプレースメントポリシーを指定することはできません。この条件を満たしていない場合、予約の作成は失敗します。
NUMBER_OF_VMS: 予約する VM の数。指定されたコンパクトプレースメントポリシーのサポートされている VM の最大数を超えることはできません。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。

単一プロジェクトの予約の構成オプションと作成方法の詳細については、単一プロジェクトの予約を作成するをご覧ください。

コンパクトプレースメントポリシーを使用してインスタンステンプレートを作成する

リージョンインスタンステンプレートを作成する場合は、コンパクトプレースメントポリシーと同じリージョンにテンプレートを作成する必要があります。そうしないと、インスタンステンプレートの作成は失敗します。

インスタンステンプレートを作成すると、それを使用して次のことができます。

コンパクトプレースメントポリシーを指定するインスタンステンプレートを作成するには、次のいずれかのオプションを選択します。

gcloud

コンパクトプレースメントポリシーを指定するインスタンステンプレートを作成するには、--resource-policies フラグを指定して gcloud compute instance-templates create コマンドを使用します。

たとえば、コンパクトプレースメントポリシーを指定するグローバルインスタンステンプレートを作成するには、次のコマンドを実行します。

gcloud compute instance-templates create INSTANCE_TEMPLATE_NAME \
    --machine-type=MACHINE_TYPE \
    --maintenance-policy=MAINTENANCE_POLICY \
    --resource-policies=POLICY_NAME

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

INSTANCE_TEMPLATE_NAME: インスタンステンプレートの名前。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合は、--no-restart-on-failure フラグを指定する必要があります。これは、インスタンステンプレートを使用して作成された VM が、ホストエラー後に自動的に再起動されないことを示します。

REST

コンパクトプレースメントポリシーを指定するインスタンステンプレートを作成するには、次のいずれかのメソッドに POST リクエストを送信します。

グローバルインスタンステンプレートを作成するには: instanceTemplates.insert メソッド。
リージョンインスタンステンプレートを作成するには: regionInstanceTemplates.insert メソッド。

リクエストの本文で resourcePolicies フィールドを指定します。

たとえば、コンパクトプレースメントポリシーを指定するグローバルインスタンステンプレートを作成するには、次のように POST リクエストを送信します。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/global/instanceTemplates

{
  "name": "INSTANCE_TEMPLATE_NAME",
  "properties": {
    "disks": [
      {
        "boot": true,
        "initializeParams": {
          "sourceImage": "projects/IMAGE_PROJECT/global/images/IMAGE"
        }
      }
    ],
    "machineType": "MACHINE_TYPE",
    "networkInterfaces": [
      {
        "network": "global/networks/default"
      }
    ],
    "resourcePolicies": [
      "POLICY_NAME"
    ],
    "scheduling": {
      "onHostMaintenance": "MAINTENANCE_POLICY"
    }
  }
}

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

PROJECT_ID: インスタンステンプレートに適用するコンパクトプレースメントポリシーが配置されているプロジェクトの ID。
INSTANCE_TEMPLATE_NAME: インスタンステンプレートの名前。
IMAGE または IMAGE_FAMILY: 次のいずれかを指定します。
- IMAGE: OS イメージの特定のバージョン。例: debian-10-buster-v20200309
- IMAGE_FAMILY: イメージファミリー。これにより、非推奨ではない最新の OS イメージが指定されます。たとえば、family/debian-10 を指定すると、Debian 10 イメージファミリーの最新バージョンが使用されます。イメージファミリーの使用の詳細については、イメージファミリーのベストプラクティスをご覧ください。
MACHINE_TYPE: コンパクトプレースメントポリシーでサポートされているマシンタイプ。
POLICY_NAME: 既存のコンパクトプレースメントポリシーの名前。コンパクトプレースメントポリシーで VM の固定数を指定する場合、scheduling フィールドで automaticRestart フィールドを false に設定する必要があります。これは、インスタンステンプレートを使用して作成された VM が、ホストエラー後に自動的に再起動されないことを示します。
MAINTENANCE_POLICY: VM のホストメンテナンスポリシー。指定したコンパクトプレースメントポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

インスタンステンプレートを作成するための構成オプションの詳細については、インスタンステンプレートを作成するをご覧ください。

MIG の VM にコンパクトプレースメントポリシーを適用する

コンパクトプレースメントポリシーを指定するインスタンステンプレートを作成すると、そのテンプレートを使用して次のことができます。

同じコンパクトプレースメントポリシーを持つ MIG を作成する。
コンパクトプレースメントポリシーを既存の MIG に適用する。

コンパクトプレースメントポリシーを MIG に適用する場合は、任意の単一ゾーンの分配形態でリージョン MIG を作成するか、このリージョン MIG にポリシーを適用することをおすすめします。これにより、VM を作成してリージョン MIG をスケールアウトする必要がある場合は、予約、割り当て、ハードウェア要件に基づいて VM を作成するゾーンが選択されます。

コンパクトプレースメントポリシーを使用して MIG を作成する

コンパクトプレースメントポリシーを指定する VM は、VM がプレースメントポリシーと同じリージョンにある場合にのみ作成できます。

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用して MIG を作成するには、次のいずれかの方法を選択します。

gcloud

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用して MIG を作成するには、--template フラグを指定して gcloud compute instance-groups managed create コマンドを使用します。

たとえば、任意の単一ゾーンの分配形態を持つリージョン MIG を作成するには、次のコマンドを実行します。

gcloud compute instance-groups managed create MIG_NAME \
    --region=REGION \
    --size=SIZE \
    --target-distribution-shape=any-single-zone \
    --template=INSTANCE_TEMPLATE_NAME

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

MIG_NAME: 作成する MIG の名前。
REGION: MIG を作成するリージョン。コンパクトプレースメントポリシーが存在するリージョンと一致している必要があります。
SIZE: MIG のサイズ。
INSTANCE_TEMPLATE_NAME: コンパクトプレースメントポリシーを指定する既存のインスタンステンプレートの名前。

REST

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用して MIG を作成するには、instanceGroupManagers.insert メソッドまたは regionInstanceGroupManagers.insert メソッドに POST リクエストを送信します。

たとえば、デフォルトの VM プロパティと任意の単一ゾーンの分配形態でリージョン MIG を作成するには、次のように POST リクエストを送信します。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/instanceGroupManagers

{
  "name": "MIG_NAME",
  "instanceTemplate": "global/instanceTemplates/INSTANCE_TEMPLATE_NAME",
  "distributionPolicy": {
    "targetShape": "ANY_SINGLE_ZONE"
  },
  "targetSize": SIZE
}

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

PROJECT_ID: コンパクトプレースメントポリシーと、プレースメントポリシーを指定するインスタンステンプレートがあるプロジェクトの ID。
REGION: MIG を作成するリージョン。コンパクトプレースメントポリシーが存在するリージョンと一致している必要があります。
MIG_NAME: 作成する MIG の名前。
INSTANCE_TEMPLATE_NAME: コンパクトプレースメントポリシーを指定する既存のインスタンステンプレートの名前。
SIZE: MIG のサイズ。

MIG を作成するための構成オプションの詳細については、MIG を作成するための基本的なシナリオをご覧ください。

既存の MIG にコンパクトプレースメントポリシーを適用する

コンパクトプレースメントポリシーを既存の MIG に適用できるのは、MIG がプレースメントポリシーと同じリージョンにある場合、またはゾーン MIG の場合はプレースメントポリシーと同じリージョン内のゾーンにある場合のみです。

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用するように MIG を更新するには、次のいずれかのオプションを選択します。

gcloud

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用するように MIG を更新するには、gcloud compute instance-groups managed rolling-action start-update コマンドを使用します。

たとえば、コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用するようにリージョン MIG を更新し、MIG の既存の VM をテンプレートのプロパティを指定する新しい VM に置き換えるには、次のコマンドを実行します。

gcloud compute instance-groups managed rolling-action start-update MIG_NAME \
    --region=REGION \
    --type=proactive \
    --version=template=INSTANCE_TEMPLATE_NAME

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

MIG_NAME: 既存の MIG の名前。
REGION: MIG が配置されているリージョン。コンパクトプレースメントポリシーは、同じリージョン内の MIG にのみ適用できます。
INSTANCE_TEMPLATE_NAME: コンパクトプレースメントポリシーを指定する既存のインスタンステンプレートの名前。

REST

コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用するように MIG を更新し、テンプレートのプロパティとプレースメントポリシーを MIG 内の既存の VM に自動的に適用するには、instanceGroupManagers.insert または regionInstanceGroupManagers.insert メソッドに PATCH リクエストを送信します。

たとえば、コンパクトプレースメントポリシーを指定するインスタンステンプレートを使用するようにリージョン MIG を更新し、MIG の既存の VM をテンプレートのプロパティを指定する新しい VM に置き換えるには、次の PATCH リクエストを送信します。

PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/instanceGroupManagers/MIG_NAME

{
  "instanceTemplate": "global/instanceTemplates/INSTANCE_TEMPLATE_NAME",
  "updatePolicy": {
    "type": "PROACTIVE"
  }
}

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

PROJECT_ID: MIG、コンパクトプレースメントポリシー、プレースメントポリシーを指定するインスタンステンプレートがあるプロジェクトの ID。
REGION: MIG が配置されているリージョン。コンパクトプレースメントポリシーは、同じリージョン内の MIG にのみ適用できます。
MIG_NAME: 既存の MIG の名前。
INSTANCE_TEMPLATE_NAME: コンパクトプレースメントポリシーを指定する既存のインスタンステンプレートの名前。

MIG 内の VM を更新するための構成オプションの詳細については、MIG 内の VM に新しい構成を更新して適用するをご覧ください。

VM の物理的な位置を確認する

VM にコンパクトプレースメントポリシーを適用すると、同じポリシーを指定する他の VM との関連でコンパクトプレースメントポリシーが物理的な位置にどのように影響したかを確認できます。これにより、コンパクトプレースメントポリシーが VM に正しく適用されたかどうかを判断し、どの VM が互いに最も近いかをマッピングできます。

他の VM との関係でプレースメントポリシーを指定する VM の物理的な場所を確認するには、次のいずれかのオプションを選択します。

gcloud

コンパクトプレースメントポリシーを指定する VM の物理的な位置を表示するには、--format フラグを指定して gcloud compute instances describe コマンドを使用します。

gcloud compute instances describe VM_NAME \
    --format="table[box,title=VM-Position](resourcePolicies.scope():sort=1,resourceStatus.physicalHost:label=location)" \
    --zone=ZONE

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

VM_NAME: 既存の VM の名前。
ZONE: VM が配置されているゾーン。

出力は次のようになります。

VM-Position

RESOURCE_POLICIES: us-central1/resourcePolicies/example-policy']
PHYSICAL_HOST: /CCCCCCC/BBBBBB/AAAA

PHYSICAL_HOST フィールドの値は 3 つの部分で構成されます。それぞれ、VM が配置されているクラスタ、ラック、ホストを表します。

同一のコンパクトプレースメントポリシーを指定する 2 つの VM の位置を比較すると、PHYSICAL_HOST フィールドで VM が共有する部分が多いほど相互に配置される位置は近くなります。たとえば、2 つの VM の両方で PHYSICAL_HOST フィールドに次のサンプル値のいずれかを指定するとします。

/CCCCCCC/xxxxxx/xxxx: 2 つの VM は同じクラスタに配置されます。これは、最大距離値 2 に相当します。同じクラスタに配置された VM では、ネットワークレイテンシが低くなります。
/CCCCCCC/BBBBBB/xxxx: 2 つの VM は同じラックに配置されます。これは、最大距離値 1 に相当します。同じラックに配置された VM では、同じクラスタに配置された VM よりもネットワークレイテンシが低くなります。
/CCCCCCC/BBBBBB/AAAA: 2 つの VM が同じホストを共有しています。同じホストに配置された VM では、ネットワークレイテンシが可能な限り最小限に抑えられます。

REST

コンパクトプレースメントポリシーを指定する VM の物理的な位置を表示するには、instances.get メソッドに GET リクエストを送信します。

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

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

PROJECT_ID: VM が配置されているプロジェクトのプロジェクト ID。
ZONE: VM が配置されているゾーン。
VM_NAME: プレースメントポリシーを指定する既存の VM の名前。

出力は次のようになります。

{
...
"resourcePolicies": [
  "https://www.googleapis.com/compute/v1/projects/example-project/regions/us-central1/resourcePolicies/example-policy"
],
"resourceStatus": {
  "physicalHost": "/xxxxxxxx/xxxxxx/xxxxx"
},
...
}

physicalHost フィールドの値は 3 つの部分で構成されます。それぞれ、VM が配置されているクラスタ、ラック、ホストを表します。

同一のコンパクトプレースメントポリシーを指定する 2 つの VM の位置を比較すると、physicalHost フィールドで VM が共有する部分が多いほど相互に配置される位置は近くなります。たとえば、2 つの VM の両方で physicalHost フィールドに次のサンプル値のいずれかを指定するとします。

/CCCCCCC/xxxxxx/xxxx: 2 つの VM は同じクラスタに配置されます。これは、最大距離値 2 に相当します。同じクラスタに配置された VM では、ネットワークレイテンシが低くなります。
/CCCCCCC/BBBBBB/xxxx: 2 つの VM は同じラックに配置されます。これは、最大距離値 1 に相当します。同じラックに配置された VM では、同じクラスタに配置された VM よりもネットワークレイテンシが低くなります。
/CCCCCCC/BBBBBB/AAAA: 2 つの VM が同じホストを共有しています。同じホストに配置された VM では、ネットワークレイテンシが可能な限り最小限に抑えられます。

次のステップ

プレースメントポリシーを表示する方法を学習する。
プレースメントポリシーを置換、削除、消去する方法を学習する。
プレースメントポリシーを指定する VM で、次の操作を行う方法を学習する。
- VM のステータスを表示する。
- VM に接続する。

コンパクト プレースメント ポリシーを使用してレイテンシを短縮する

始める前に

gcloud

REST

必要なロール

必要な権限

コンパクト プレースメント ポリシーを作成する

gcloud

REST

コンパクト プレースメント ポリシーを適用する

コンパクト プレースメント ポリシーを既存の VM に適用する

gcloud

REST

コンパクト プレースメント ポリシーを使用して VM を作成する

gcloud

REST

コンパクト プレースメント ポリシーを使用して VM を一括作成する

gcloud

REST

コンパクト プレースメント ポリシーを使用して予約を作成する

gcloud

REST

コンパクト プレースメント ポリシーを使用してインスタンス テンプレートを作成する

gcloud

REST

MIG の VM にコンパクト プレースメント ポリシーを適用する

コンパクト プレースメント ポリシーを使用して MIG を作成する

gcloud

REST

既存の MIG にコンパクト プレースメント ポリシーを適用する

gcloud

REST

VM の物理的な位置を確認する

gcloud

REST

次のステップ

コンパクトプレースメントポリシーを使用してレイテンシを短縮する

コンパクトプレースメントポリシーを作成する

コンパクトプレースメントポリシーを適用する

コンパクトプレースメントポリシーを既存の VM に適用する

コンパクトプレースメントポリシーを使用して VM を作成する

コンパクトプレースメントポリシーを使用して VM を一括作成する

コンパクトプレースメントポリシーを使用して予約を作成する

コンパクトプレースメントポリシーを使用してインスタンステンプレートを作成する

MIG の VM にコンパクトプレースメントポリシーを適用する

コンパクトプレースメントポリシーを使用して MIG を作成する

既存の MIG にコンパクトプレースメントポリシーを適用する