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

このドキュメントでは、信頼性を向上させるために、スプレッド プレースメント ポリシーを作成して 1 つ以上の仮想マシン（VM）インスタンスに適用する方法について説明します。

スプレッド プレースメント ポリシーでは、VM を異なるアベイラビリティ ドメインに配置して、VM 同士を物理的に離して配置することを指定します。アベイラビリティ ドメインとは、電源、冷却、ネットワーク ソースが分離された、データセンター内の独立したハードウェアのことです。スプレッド プレースメント ポリシーを使用すると、基盤となるハードウェアの障害やメンテナンス イベントがすべての VM に与える影響を軽減できます。

始める前に

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

    このページのサンプルをどのように使うかに応じて、タブを選択してください。

    gcloud

    1. Google Cloud CLI をインストールし、次のコマンドを実行して初期化します。

      gcloud init
    2. デフォルトのリージョンとゾーンを設定します。

    REST

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

      Google Cloud CLI をインストールし、次のコマンドを実行して初期化します。

      gcloud init

必要なロール

スプレッド プレースメント ポリシーを作成して VM に適用するために必要な権限を取得するには、プロジェクトに対する Compute インスタンス管理者（v1）（roles/compute.instanceAdmin.v1）の 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.instanceTemplates.create
  • リージョンまたはゾーンのマネージド インスタンス グループ（MIG）を作成する: プロジェクトに対する compute.instanceGroupManagers.create

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

スプレッド プレースメント ポリシーを作成する

スプレッド プレースメント ポリシーを作成するときに、VM を配置するアベイラビリティ ドメインを最大 8 つ指定できます。VM へのスプレッド プレースメント ポリシーの適用をテストする場合を除いて、複数のアベイラビリティ ドメインを指定することをおすすめします。これにより、単一のハードウェア障害やメンテナンス イベントによってすべての 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 の範囲で指定してください。

スプレッド プレースメント ポリシーを適用する

スプレッド プレースメント ポリシーは、既存の VM に適用するか、VM、インスタンス テンプレート、MIG を作成するときに適用できます。

スプレッド プレースメント ポリシーを指定する Compute Engine リソースを作成するか、既存の VM にスプレッド プレースメント ポリシーを適用するには、次のいずれかの方法を選択します。

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

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

  • スプレッド プレースメント ポリシーに複数のアベイラビリティ ドメインがある場合は、VM を停止せずにスプレッド プレースメント ポリシーを VM に追加できます。それ以外の場合、スプレッド プレースメント ポリシーで指定されているドメインが 1 つだけの場合は、まず VM を停止してから、VM にプレースメント ポリシーを適用する必要があります。

  • VM とスプレッド プレースメント ポリシーは同じリージョンに配置する必要があります。たとえば、プレースメント ポリシーがリージョン us-central1 にある場合、VM は us-central1 のゾーンに配置する必要があります。VM を別のリージョンに移行する必要がある場合は、ゾーンまたはリージョン間で VM を移動するをご覧ください。

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

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

gcloud

既存の 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 が存在するゾーン。スプレッド プレースメント ポリシーが配置されているリージョン内である必要があります。

REST

スプレッド プレースメント ポリシーを既存の 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 を作成するには、次のいずれかを選択します。

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 を作成するゾーン。

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

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

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

  • ZONE: VM を作成するゾーンとマシンタイプが存在するゾーン。指定できるマシンタイプは、スプレッド プレースメント ポリシーと同じリージョン内で使用できるマシンタイプに限られます。

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

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

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

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

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 \
    --name-pattern=NAME_PATTERN \
    --resource-policies=POLICY_NAME \
    --zone=ZONE

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

  • COUNT: 作成する VM の数。

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

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

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

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

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

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

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

  • COUNT: 作成する VM の数。

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

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

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

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

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

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

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

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

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

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

REST

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

リクエストの本文で 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 または IMAGE_FAMILY: 次のいずれかを指定します。

    • IMAGE: OS イメージの特定のバージョン。例: debian-10-buster-v20200309

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

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

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

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

MIG 内の VM にスプレッド プレースメント ポリシーを適用する

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

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

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

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

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

gcloud

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

たとえば、デフォルトの VM プロパティと任意の単一ゾーンの分布形状でリージョン 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",
  "targetSize": SIZE,
  "distributionPolicy": {
    "targetShape": "ANY_SINGLE_ZONE"
  }
}

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

  • 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 に新しい構成を更新して適用するをご覧ください。

次のステップ