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


このドキュメントでは、コンパクト プレースメント ポリシーを作成して適用することで、仮想マシン(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
    2. Set a default region and zone.
    3. REST

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

        Install the Google Cloud CLI, then initialize it by running the following command:

        gcloud init

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

必要なロール

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

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

これらの事前定義ロールには、コンパクト プレースメント ポリシーを作成して 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

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

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

コンパクト プレースメント ポリシーを N2 または N2D VM に適用する場合を除き、ポリシーの作成時に最大距離値を指定することをおすすめします。詳細については、コンパクト プレースメント ポリシーの仕組みをご覧ください。

スプレッド プレースメント ポリシーを作成するには、次のいずれかのオプションを選択します。

gcloud

  • コンパクト プレースメント ポリシーを N2 または N2D VM に適用するには、--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 に適用するには、--collocation=collocated フラグと --max-distance フラグを指定して gcloud beta compute resource-policies create group-placement コマンドを使用してポリシーを作成します。

    gcloud beta compute resource-policies create group-placement POLICY_NAME \
        --collocation=collocated \
        --max-distance=MAX_DISTANCE \
        --region=REGION
    

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

    • POLICY_NAME: コンパクト プレースメント ポリシーの名前。

    • MAX_DISTANCE: VM 間の最大距離構成。ネットワーク レイテンシを最小化するために VM を同じラックに配置するように指定する 1 と、VM を隣接するクラスタに配置するように指定する 3 の間の値にする必要があります。コンパクト プレースメント ポリシーを予約に適用する場合は、1 の値を指定できません。

    • REGION: プレースメント ポリシーを作成するリージョン。

REST

  • コンパクト プレースメント ポリシーを N2 または N2D VM に適用するには、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: プレースメント ポリシーを作成するリージョン。

    • POLICY_NAME: コンパクト プレースメント ポリシーの名前。

  • コンパクト プレースメント ポリシーを他のサポートされている VM に適用するには、beta.resourcePolicies.insert メソッドPOST リクエストを送信してポリシーを作成します。リクエスト本文に、次のものを含めます。

    • COLLOCATED に設定されている collocation フィールド。

    • maxDistance フィールド。

    POST https://compute.googleapis.com/compute/beta/projects/PROJECT_ID/regions/REGION/resourcePolicies
    
    {
      "name": "POLICY_NAME",
      "groupPlacementPolicy": {
        "collocation": "COLLOCATED",
        "maxDistance": MAX_DISTANCE
      }
    }
    

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

    • PROJECT_ID: プレースメント ポリシーを作成するプロジェクトの ID。

    • REGION: プレースメント ポリシーを作成するリージョン。

    • POLICY_NAME: コンパクト プレースメント ポリシーの名前。

    • MAX_DISTANCE: VM 間の最大距離構成。ネットワーク レイテンシを最小化するために VM を同じラックに配置するように指定する 1 と、VM を隣接するクラスタに配置するように指定する 3 の間の値にする必要があります。コンパクト プレースメント ポリシーを予約に適用する場合は、1 の値を指定できません。

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

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

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

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

既存の VM にポリシーを適用する

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

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

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

gcloud

  1. VM を停止します

  2. 既存の VM にコンパクト プレースメント ポリシーを適用するには、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 が配置されているゾーン。

  3. VM を再起動します

REST

  1. VM を停止します

  2. コンパクト プレースメント ポリシーを既存の VM に適用するには、instances.addResourcePolicies メソッドPOST リクエストを送信します。

    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: 既存のコンパクト プレースメント ポリシーの名前。

  3. VM を再起動します

VM の作成時にポリシーを適用する

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

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

gcloud

コンパクト プレースメント ポリシーを指定する VM を作成するには、--maintenance-policy フラグと --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: 既存のコンパクト プレースメント ポリシーの名前。

  • ZONE: VM インスタンスを作成するゾーン。

REST

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

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

{
  "name": "VM_NAME",
  "machineType": "zones/ZONE/machineTypes/MACHINE_TYPE",
  "disks": [
    {
      "boot": true,
      "initializeParams": {
        "sourceImage": "projects/IMAGE_PROJECT/global/images/IMAGE"
      }
    }
  ],
  "networkInterfaces": [
    {
      "network": "global/networks/default"
    }
  ],
  "resourcePolicies": [
    "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
  ],
  "scheduling": {
    "onHostMaintenance": "MAINTENANCE_POLICY"
  }
}

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

  • PROJECT_ID: コンパクト プレースメント ポリシーを含むプロジェクトの ID。

  • ZONE: VM を作成するゾーンとマシンタイプが存在するゾーン。指定できるのは、コンパクト プレースメント ポリシーのリージョン内のゾーンのみです。

  • VM_NAME: 作成する VM の名前。

  • MACHINE_TYPE: コンパクト プレースメント ポリシーでサポートされているマシンタイプ

  • IMAGE_PROJECT: イメージを含むイメージ プロジェクト(例: debian-cloud)。サポートされているイメージ プロジェクトの詳細については、公開イメージをご覧ください。

  • IMAGE: 次のいずれかを指定します。

    • OS イメージの特定のバージョン。例: debian-12-bookworm-v20240617

    • イメージ ファミリーfamily/IMAGE_FAMILY の形式にする必要があります。これにより、非推奨ではない最新の OS イメージが指定されます。たとえば、family/debian-12 を指定すると、Debian 12 イメージ ファミリーの最新バージョンが使用されます。イメージ ファミリーの使用の詳細については、イメージ ファミリーのベスト プラクティスをご覧ください。

  • REGION: コンパクト プレースメント ポリシーが存在するリージョン。

  • POLICY_NAME: 既存のコンパクト プレースメント ポリシーの名前。

  • MAINTENANCE_POLICY: VM のホスト メンテナンス ポリシー。指定したコンパクト プレースメント ポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

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

VM を一括作成するときにポリシーを適用する

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

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

gcloud

コンパクト プレースメント ポリシーを指定する VM を一括で作成するには、--maintenance-policy フラグと --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-# を使用すると、vm-1vm-2 で始まり、COUNT で指定された VM の数まで続く名前の VM が生成されます。

  • POLICY_NAME: 既存のコンパクト プレースメント ポリシーの名前。

  • ZONE: VM を一括作成するゾーン。

REST

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

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

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

{
  "count": "COUNT",
  "namePattern": "NAME_PATTERN",
  "instanceProperties": {
    "machineType": "MACHINE_TYPE",
    "disks": [
      {
        "boot": true,
        "initializeParams": {
          "sourceImage": "projects/IMAGE_PROJECT/global/images/IMAGE"
        }
      }
    ],
    "networkInterfaces": [
      {
        "network": "global/networks/default"
      }
    ],
    "resourcePolicies": [
      "projects/PROJECT_ID/regions/REGION/resourcePolicies/POLICY_NAME"
    ],
    "scheduling": {
      "onHostMaintenance": "MAINTENANCE_POLICY"
    }
  }
}

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

  • PROJECT_ID: コンパクト プレースメント ポリシーを含むプロジェクトの ID。

  • ZONE: VM を一括作成するゾーン。

  • COUNT: 作成する VM の数。指定されたコンパクト プレースメント ポリシーのサポートされている VM の最大数を超えることはできません。

  • NAME_PATTERN: VM の名前パターン。VM 名の一連の数字を置き換えるには、一連のハッシュ(#)文字を使用します。たとえば、名前パターンに vm-# を使用すると、vm-1vm-2 で始まり、COUNT で指定された VM の数まで続く名前の VM が生成されます。

        with names starting with `vm-1`, `vm-2`, and continuing up to the number
    

    COUNT で指定された VM。

  • MACHINE_TYPE: コンパクト プレースメント ポリシーでサポートされているマシンタイプ

  • IMAGE_PROJECT: イメージを含むイメージ プロジェクト(例: debian-cloud)。サポートされているイメージ プロジェクトの詳細については、公開イメージをご覧ください。

  • IMAGE: 次のいずれかを指定します。

    • OS イメージの特定のバージョン。例: debian-12-bookworm-v20240617

    • イメージ ファミリーfamily/IMAGE_FAMILY の形式にする必要があります。これにより、非推奨ではない最新の OS イメージが指定されます。たとえば、family/debian-12 を指定すると、Debian 12 イメージ ファミリーの最新バージョンが使用されます。イメージ ファミリーの使用の詳細については、イメージ ファミリーのベスト プラクティスをご覧ください。

  • REGION: コンパクト プレースメント ポリシーが存在するリージョン。

  • POLICY_NAME: 既存のコンパクト プレースメント ポリシーの名前。

  • MAINTENANCE_POLICY: VM のホスト メンテナンス ポリシー。指定したコンパクト プレースメント ポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

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

予約の作成時にポリシーを適用する

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

  • VM には、予約に適用されたものと同じコンパクト プレースメント ポリシーを指定する必要があります。

  • VM は、その予約を明示的に対象として使用する必要があります。詳細については、特定の予約から VM を使用するをご覧ください。

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

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

gcloud

プロパティを直接指定してコンパクト プレースメント ポリシーを含む単一プロジェクトの予約を作成するには、--require-specific-reservation フラグと --resource-policies=policy フラグを指定して 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: 既存のコンパクト プレースメント ポリシーの名前。

  • 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: 既存のコンパクト プレースメント ポリシーの名前。

  • NUMBER_OF_VMS: 予約する VM の数。指定されたコンパクト プレースメント ポリシーのサポートされている VM の最大数を超えることはできません。

  • MACHINE_TYPE: コンパクト プレースメント ポリシーでサポートされているマシンタイプ

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

インスタンス テンプレートの作成時にポリシーを適用する

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

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

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

gcloud

コンパクト プレースメント ポリシーを指定するインスタンス テンプレートを作成するには、--maintenance-policy フラグと --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: 既存のコンパクト プレースメント ポリシーの名前。

REST

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

リクエストの本文に、onHostMaintenance フィールドと 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_PROJECT: イメージを含むイメージ プロジェクト(例: debian-cloud)。サポートされているイメージ プロジェクトの詳細については、公開イメージをご覧ください。

  • IMAGE: 次のいずれかを指定します。

    • OS イメージの特定のバージョン。例: debian-12-bookworm-v20240617

    • イメージ ファミリーfamily/IMAGE_FAMILY の形式にする必要があります。これにより、非推奨ではない最新の OS イメージが指定されます。たとえば、family/debian-12 を指定すると、Debian 12 イメージ ファミリーの最新バージョンが使用されます。イメージ ファミリーの使用の詳細については、イメージ ファミリーのベスト プラクティスをご覧ください。

  • MACHINE_TYPE: コンパクト プレースメント ポリシーでサポートされているマシンタイプ

  • POLICY_NAME: 既存のコンパクト プレースメント ポリシーの名前。

  • MAINTENANCE_POLICY: VM のホスト メンテナンス ポリシー。指定したコンパクト プレースメント ポリシーが 1 または 2 の最大距離値を使用する場合、指定できるのは TERMINATE のみです。それ以外の場合は、MIGRATE または TERMINATE を指定できます。

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

MIG 内の VM にポリシーを適用する

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

MIG の作成時にポリシーを適用する

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

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

gcloud

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

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

gcloud compute instance-groups managed create INSTANCE_GROUP_NAME \
    --size=SIZE \
    --template=INSTANCE_TEMPLATE_NAME \
    --zone=ZONE

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

  • INSTANCE_GROUP_NAME: 作成する MIG の名前。

  • SIZE: MIG のサイズ。

  • INSTANCE_TEMPLATE_NAME: コンパクト プレースメント ポリシーを指定する既存のグローバル インスタンス テンプレートの名前。

  • ZONE: MIG を作成するゾーン。コンパクト プレースメント ポリシーが適用されているリージョン内である必要があります。

REST

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

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

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

{
  "name": "INSTANCE_GROUP_NAME",
  "targetSize": SIZE,
  "versions": [
    {
      "instanceTemplate": "global/instanceTemplates/INSTANCE_TEMPLATE_NAME"
    }
  ]
}

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

  • PROJECT_ID: コンパクト プレースメント ポリシーと、プレースメント ポリシーを指定するインスタンス テンプレートがあるプロジェクトの ID。

  • ZONE: MIG を作成するゾーン。コンパクト プレースメント ポリシーが適用されているリージョン内である必要があります。

  • INSTANCE_GROUP_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 \
    --version=template=INSTANCE_TEMPLATE_NAME \
    --zone=ZONE

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

  • MIG_NAME: 既存の MIG の名前。

  • INSTANCE_TEMPLATE_NAME: コンパクト プレースメント ポリシーを指定する既存のグローバル インスタンス テンプレートの名前。

  • ZONE: MIG が配置されているゾーン。 コンパクト プレースメント ポリシーは、プレースメント ポリシーと同じリージョン内の MIG にのみ適用できます。

REST

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

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

PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instanceGroupManagers/MIG_NAME

{
  "instanceTemplate": "global/instanceTemplates/INSTANCE_TEMPLATE_NAME"
}

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

  • PROJECT_ID: MIG、コンパクト プレースメント ポリシー、プレースメント ポリシーを指定するインスタンス テンプレートがあるプロジェクトの ID。

  • ZONE: MIG が配置されているゾーン。コンパクト プレースメント ポリシーは、プレースメント ポリシーと同じリージョン内の MIG にのみ適用できます。

  • MIG_NAME: 既存の MIG の名前。

  • INSTANCE_TEMPLATE_NAME: コンパクト プレースメント ポリシーを指定する既存のグローバル インスタンス テンプレートの名前。

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

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

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 では、ネットワーク レイテンシが可能な限り最小限に抑えられます。

次のステップ