スプレッド プレースメント ポリシーを作成して VM に適用する

gcloud

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

gcloud compute resource-policies create group-placement POLICY_NAME \
    --availability-domain-count=DOMAIN_COUNT \
    --region=REGION

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

• POLICY_NAME: スプレッド プレースメント ポリシーの名前。

• DOMAIN_COUNT: VM を配置するアベイラビリティ ドメインの個別の数。値は 1 と 8 の範囲で指定してください。

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

REST

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

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

{
  "name": "POLICY_NAME",
  "groupPlacementPolicy": {
    "availabilityDomainCount": DOMAIN_COUNT
  }
}

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

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

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

• POLICY_NAME: スプレッド プレースメント ポリシーの名前。

• DOMAIN_COUNT: VM を配置するアベイラビリティ ドメインの個別の数。値は 1 と 8 の範囲で指定してください。

gcloud

既存の 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 が配置されているゾーン。

REST

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

gcloud

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

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

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

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

• MACHINE_TYPE: VM のマシンタイプ。

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

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

VM を作成するアベイラビリティ ドメインを指定する場合は、--availability-domain フラグを含めます。

gcloud compute instances create VM_NAME \
    --availability-domain=DOMAIN_NUMBER \
    --machine-type=MACHINE_TYPE \
    --resource-policies=POLICY_NAME \
    --zone=ZONE

DOMAIN_NUMBER は、VM を配置するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、スプレッド プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

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",
  "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"
  ]
}

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

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

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

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

• MACHINE_TYPE: VM のマシンタイプ。

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

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

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

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

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

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

VM を作成するアベイラビリティ ドメインを指定する場合は、リクエスト本文に availabilityDomain フィールドを含めます。

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": {
    "availabilityDomain": DOMAIN_NUMBER
  }
}

DOMAIN_NUMBER は、VM を配置するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、スプレッド プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

gcloud

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

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

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

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

• COUNT: 作成する VM の数。

• MACHINE_TYPE: VM のマシンタイプ。

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

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

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

VM を一括作成するアベイラビリティ ドメインを指定する場合は、--availability-domain フラグを含めます。

gcloud compute instances bulk create \
    --availability-domain=DOMAIN_NUMBER \
    --count=COUNT \
    --machine-type=MACHINE_TYPE \
    --name-pattern=NAME_PATTERN \
    --resource-policies=POLICY_NAME \
    --zone=ZONE

DOMAIN_NUMBER は、VM を配置するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、スプレッド プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

REST

スプレッド プレースメント ポリシーを指定する VM を一括作成するには、instances.bulkInsert メソッドに POST を行います。リクエスト本文に、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": [
      "POLICY_NAME"
    ]
  }
}

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

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

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

• COUNT: 作成する VM の数。

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

• MACHINE_TYPE: VM のマシンタイプ。

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

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

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

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

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

VM を一括作成するアベイラビリティ ドメインを指定する場合は、リクエスト本文に availabilityDomain フィールドを含めます。

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": [
      "POLICY_NAME"
    ],
    "scheduling": {
      "availabilityDomain": DOMAIN_NUMBER
    }
  }
}

DOMAIN_NUMBER は、VM を配置するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、スプレッド プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

gcloud

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

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

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

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

• INSTANCE_TEMPLATE_NAME: インスタンス テンプレートの名前。

• MACHINE_TYPE: インスタンス テンプレートを使用して作成された VM のマシンタイプ。

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

VM を作成するアベイラビリティ ドメインを指定する場合は、--availability-domain フラグを含めます。

gcloud compute instance-templates create INSTANCE_TEMPLATE_NAME \
    --availability-domain=DOMAIN_NUMBER  \
    --machine-type=MACHINE_TYPE \
    --resource-policies=POLICY_NAME

DOMAIN_NUMBER は、VM を作成するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

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"
    ]
  }
}

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

• 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: インスタンス テンプレートを使用して作成された VM のマシンタイプ。

• POLICY_NAME: 既存のスプレッド プレースメント ポリシーの名前。

VM を作成するアベイラビリティ ドメインを指定する場合は、リクエスト本文に availabilityDomain フィールドを含めます。

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": {
      "availabilityDomain": DOMAIN_NUMBER
    }
  }
}

DOMAIN_NUMBER は、VM を作成するアベイラビリティ ドメインの数に置き換えます。値は、1 以上、プレースメント ポリシーで指定されたドメイン数以下にする必要があります。スプレッド プレースメント ポリシーのドメイン数を確認するには、プレースメント ポリシーの詳細を表示します。

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 を作成する: instanceGroupManagers.insert メソッド。

• リージョン MIG を作成する: regionInstanceGroupManagers.insert メソッド。

たとえば、スプレッド プレースメント ポリシーを指定するグローバル インスタンス テンプレートを使用してゾーン 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 の名前。

• SIZE: MIG のサイズ。

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

gcloud

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

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

gcloud compute instance-groups managed rolling-action start-update INSTANCE_GROUP_NAME \
    --version=template=INSTANCE_TEMPLATE_NAME \
    --zone=ZONE

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

• INSTANCE_GROUP_NAME: 既存の MIG の名前。

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

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

REST

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

• ゾーン MIG を更新する: instanceGroupManagers.insert メソッド

• リージョン MIG を更新する: regionInstanceGroupManagers.insert メソッド。

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

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

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

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

• PROJECT_ID: 既存の MIG、スプレッド プレースメント ポリシー、スプレッド プレースメント ポリシーを指定するインスタンス テンプレートの作成に使用したプロジェクトの ID。

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

• INSTANCE_GROUP_NAME: 既存の MIG の名前。

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