すべてのインスタンス構成でインスタンス テンプレート プロパティをオーバーライドする

コンソール

1. Google Cloud コンソールの [インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

2. すべてのインスタンスの構成を設定する MIG を選択します。

3. [VM を更新] をクリックします。

4. [すべてのインスタンスの構成] セクションで、次の操作を行います。

   • メタデータ値を追加または更新するには、[メタデータの管理] をクリックします。設定を完了して、[保存] をクリックします。
   • ラベルを追加または更新するには、[ラベルの管理] をクリックします。設定を完了して、[保存] をクリックします。

5. すべてのインスタンス構成でプロパティの設定が完了したら、[VM を更新] をクリックします。

   MIG の更新タイプが自動に設定されている場合、設定したすべてのインスタンス構成が既存のすべての VM にすぐに適用されます。更新タイプが選択的の場合は、構成を既存の VM に選択的に適用する必要があります。詳細については、すべてのインスタンス構成を既存の VM に適用するをご覧ください。

gcloud

すべてのインスタンス構成を追加または更新するには、all-instances-config update コマンドを使用します。

gcloud compute instance-groups managed all-instances-config update INSTANCE_GROUP_NAME \
    --metadata=KEY1=VALUE1,KEY2=VALUE2 \
    --labels=KEY3=VALUE3,KEY4=VALUE4

以下を置き換えます。

• INSTANCE_GROUP_NAME: MIG の名前。
• KEYS と VALUES: ラベルまたはメタデータの Key-Value ペア。キーが存在しない場合、更新コマンドによって追加されます。既存のキーについては、値が更新されます。

更新した構成を、MIG 内の既存の VM に適用してください。

REST

すべてのインスタンス構成を追加または更新するには、ゾーンまたはリージョンの MIG で PATCH リクエストを作成します。

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

{
  "allInstancesConfig": {
    "properties": {
      "metadata": {
        "KEY1": "VALUE1",
        ...
      },
      "labels": {
        "KEY2": "VALUE2",
        ...
      },
    }
  }
}

以下を置き換えます。

• PROJECT_ID: MIG が存在するプロジェクト。
• REGION: MIG が配置されているリージョン。ゾーン MIG の場合は、regions/REGION を zones/ZONE に置き換えます。
• INSTANCE_GROUP_NAME: MIG の名前。
• KEYS と VALUES: ラベルまたはメタデータの Key-Value ペア。キーが存在しない場合は、リクエストによって追加されます。既存のキーの場合、その値が更新されます。

更新した構成を、MIG 内の既存の VM に適用してください。

gcloud

update コマンドを使用すると、自動（先行型）での更新を構成できます。

gcloud compute instance-groups managed update INSTANCE_GROUP_NAME \
    --update-policy-type=proactive \
    --update-policy-max-unavailable=MAX_UNAVAILABLE \
    --update-policy-max-surge=MAX_SURGE \
    --update-policy-min-ready=MIN_READY \
    --update-policy-minimal-action=MINIMAL_ACTION \
    --update-policy-replacement-method=REPLACEMENT_METHOD

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

• INSTANCE_GROUP_NAME: MIG の名前。
• MAX_UNAVAILABLE（省略可）: 更新中に利用できなくなるインスタンスの最大数。たとえば、update-minimal-action フラグを restart に設定すると、このフラグは一度に再起動される VM の数を制限します。固定数（5 など）か、マネージド インスタンス グループのサイズの割合（10% など）を指定できます。
• MAX_SURGE（省略可）: 更新中に作成できる追加のインスタンスの最大数。固定数（5 など）か、マネージド インスタンス グループのサイズの割合（10% など）を指定できます。
• MIN_READY（省略可）: 再起動または置換された VM が使用可能と見なされるまでの最小時間。たとえば、10 秒間は 10s です。時刻の形式については、gcloud topic datetimes をご覧ください。
• MINIMAL_ACTION（省略可）: 構成の更新中に各インスタンスで実行するアクション。
  • refresh: 実行中のインスタンスを再起動せずに新しい構成を適用します。
  • restart: 更新中に VM を再起動します。これは、アプリが再起動中にのみメタデータを読み取る場合に便利です。
  • replace: VM を削除し、新しい構成を適用する新しい VM を作成します。
• REPLACEMENT_METHOD（省略可）: インスタンスの置換に使用するアクションを指定します。
  • recreate: 古いインスタンスが削除されるのを待ってから、古いインスタンスと同じ名前の新しいインスタンスを作成します。
  • substitute: 古いインスタンスを削除しながら、新しい名前でインスタンスを作成します。

REST

自動（先行型）での更新を構成するには、ゾーンまたはリージョンの MIG に対して PATCH リクエストを行います。

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

{
  "updatePolicy": {
    "type": "PROACTIVE",
    "maxUnavailable": {
      "percent": MAX_UNAVAILABLE
    },
    "maxSurge": {
      "percent": MAX_SURGE
    },
    "minimalAction": MINIMAL_ACTION,
    "replacementMethod": REPLACEMENT_METHOD
  }
}

以下を置き換えます。

• PROJECT_ID: MIG が存在するプロジェクト。
• REGION: MIG が配置されているリージョン。ゾーン MIG の場合は、regions/REGION を zones/ZONE に置き換えます。
• INSTANCE_GROUP_NAME: MIG の名前。
• MAX_UNAVAILABLE（省略可）: 更新中に利用できなくなるインスタンスの最大数。たとえば、update-minimal-action フラグを RESTART に設定すると、このフラグは一度に再起動される VM の数を制限します。これは割合（たとえば、80% には "percent": 80 を指定）または固定数を指定できます。固定数を指定するには、"percent": MAX_UNAVAILABLE を "fixed": MAX_UNAVAILABLE に置き換えます。
• MAX_SURGE（省略可）: 更新中に作成できる追加のインスタンスの最大数。割合または固定数を指定できます。
• MINIMAL_ACTION（省略可）: 構成の更新中に各インスタンスで実行するアクション。
  • REFRESH: 実行中のインスタンスを再起動せずに新しい構成を適用します。
  • RESTART: 更新中に VM を再起動します。これは、アプリが再起動中にのみメタデータを読み取る場合に便利です。
  • REPLACE: VM を削除し、新しい構成を適用する新しい VM を作成します。
• REPLACEMENT_METHOD（省略可）: インスタンスの置換に使用するアクションを指定します。
  • RECREATE: 古いインスタンスが削除されるのを待ってから、古いインスタンスと同じ名前の新しいインスタンスを作成します。
  • SUBSTITUTE: 古いインスタンスを削除しながら、新しい名前でインスタンスを作成します。

gcloud

update コマンドを使用すると、選択型（追従型）更新を構成できます。

gcloud compute instance-groups managed update INSTANCE_GROUP_NAME \
    --update-policy-type=opportunistic

グループの更新タイプを opportunistic に設定した場合、既存の VM に新しい構成を適用する場合は、更新を開始する必要があります。

特定の VM に構成を適用する

選択したインスタンスを更新するには、次のコマンドを使用します。

gcloud compute instance-groups managed update-instances INSTANCE_GROUP_NAME \
    --instances INSTANCE_NAMES \
    --minimal-action=MINIMAL_ACTION \
    --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION

すべての VM に構成を適用する

既存のすべてのインスタンスを更新するには、次のコマンドを使用します。

gcloud compute instance-groups managed update-instances INSTANCE_GROUP_NAME \
    --all-instances \
    --minimal-action=MINIMAL_ACTION \
    --most-disruptive-allowed-action=MOST_DISRUPTIVE_ALLOWED_ACTION

以下を置き換えます。

• INSTANCE_GROUP_NAME: MIG の名前。
• INSTANCE_NAMES: テンプレートを適用するインスタンスのリスト
• MINIMAL_ACTION（省略可）: 構成の更新中に各インスタンスで実行するアクション。
  • refresh（デフォルト）: 実行中のインスタンスを再起動せずに新しい構成を適用します。
  • restart: 更新中に VM を再起動します。これは、アプリが再起動中にのみメタデータを読み取る場合に便利です。
  • replace: VM を削除し、新しい構成を適用する新しい VM を作成します。
• MOST_DISRUPTIVE_ALLOWED_ACTION（省略可）: 各インスタンスに対して、最大でこの操作を行います。構成の更新で、ここで指定したアクションよりも大がかりなアクションが必要な場合、更新は失敗し、変更は行われません。
  • none：なし
  • refresh: 可能であれば、インスタンスを停止せずに新しい構成を適用します。たとえば、メタデータまたは追加ディスクにのみ影響する変更を適用するには、refresh を使用します。
  • restart: 可能であれば、インスタンスを置き換えずに新しい構成を適用します。たとえば、マシンタイプを変更するには、インスタンスを停止して再起動するだけで十分です。
  • replace: --replacement-method フラグに従って古いインスタンスを置き換えます。

REST

選択型（追従型）更新を構成するには、ゾーンまたはリージョンの MIG に対して PATCH リクエストを行います。

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

{
  "updatePolicy": {
    "type": "OPPORTUNISTIC"
  }
}

グループの更新タイプを OPPORTUNISTIC に設定した場合、既存の VM に新しい構成を適用する場合は、更新を開始する必要があります。

特定の VM に構成を適用する

特定のインスタンスを更新するには、次のリクエストを使用します。

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

{
  "instances": [
    "zones/ZONE/instances/INSTANCE_NAME_1",
    "zones/ZONE/instances/INSTANCE_NAME_2"
  ],
  "minimalAction": MINIMAL_ACTION,
  "mostDisruptiveAllowedAction": MOST_DISRUPTIVE_ALLOWED_ACTION
}

すべての VM に構成を適用する

既存のインスタンスをすべて更新するには、次のリクエストを使用します。

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

{
  "allInstances": true,
  "minimalAction": MINIMAL_ACTION,
  "mostDisruptiveAllowedAction": MOST_DISRUPTIVE_ALLOWED_ACTION
}

以下を置き換えます。

• PROJECT_ID: MIG が存在するプロジェクト。
• REGION: MIG が配置されているリージョン。ゾーン MIG の場合は、regions/REGION を zones/ZONE に置き換えます。
• INSTANCE_GROUP_NAME: MIG の名前。
• MINIMAL_ACTION（省略可）: 構成の更新中に各インスタンスで実行するアクション。
  • REFRESH: 実行中のインスタンスを再起動せずに新しい構成を適用します。
  • RESTART: 更新中に VM を再起動します。これは、アプリが再起動中にのみメタデータを読み取る場合に便利です。
  • REPLACE: VM を削除し、新しい構成を適用する新しい VM を作成します。
• MOST_DISRUPTIVE_ALLOWED_ACTION（省略可）: 各インスタンスに対して、最大でこの操作を行います。構成の更新で、ここで指定したアクションよりも大がかりなアクションが必要な場合、更新は失敗し、変更は行われません。
  • NONE：なし
  • REFRESH: 可能であれば、インスタンスを停止せずに新しい構成を適用します。たとえば、メタデータまたは追加ディスクにのみ影響する変更を適用するには、REFRESH を使用します。
  • RESTART: 可能であれば、インスタンスを置き換えずに新しい構成を適用します。たとえば、マシンタイプを変更するには、インスタンスを停止して再起動するだけで十分です。
  • REPLACE: グループの updatePolicy.replacementMethod フィールドに従って古いインスタンスを置き換えます。

コンソール

1. Google Cloud コンソールの [インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

2. すべてのインスタンス構成を表示する MIG を選択します。

3. [詳細] タブに移動します。

4. 最新のすべてのインスタンス構成がすべての VM に適用されている場合、[すべてのインスタンスの構成] セクションの [最終更新日] タイムスタンプと [ステータス] フィールドには次のような値が表示されます。

   • 最終更新日: すべてのインスタンス構成をすべての VM に適用した時刻が表示されます。
   • ステータス: [すべての VM に適用されました] が表示されます。すべてのインスタンス構成がすべての VM に適用されていない場合、ステータスは [VM の更新が保留中です] と表示されます。

gcloud

describe コマンドを使用し、--format フラグを指定して status.allInstancesConfig.effective 値を検索します。

gcloud compute instance-groups managed describe INSTANCE_GROUP_NAME \
    --format="(status.allInstancesConfig)"

出力例:

status:
  allInstancesConfig:
    currentRevision: 2022-12-02T10:30:15.012345Z
    effective: true

effective 値が true に設定されている場合、すべての VM には最新の構成が適用されます。currentRevision 値は、グループのすべてのインスタンス構成に加えられた最新の変更のタイムスタンプを示します。

effective 値が false に設定されている場合、最新の構成はまだすべての VM に適用されていません。

各 VM のステータスを確認するには、MIG のすべての VM を一覧取得するか、describe-instance コマンドで各 VM を個別に確認します。

gcloud compute instance-groups managed describe-instance INSTANCE_GROUP_NAME \
    --instance INSTANCE_NAME

出力例:

allInstancesConfig:
  revision: 2022-12-02T10:30:15.012345Z
currentAction: NONE
id: '8393021473297481188'
instance: .../projects/PROJECT/zones/ZONE/instances/INSTANCE_NAME
instanceStatus: RUNNING
name: INSTANCE_NAME
version:
  instanceTemplate: .../projects/PROJECT/global/instanceTemplates/INSTANCE_TEMPLATE

最新の構成が適用された VM を確認するには、各 VM の revision タイムスタンプを MIG の currentRevision タイムスタンプと比較します。

REST

ゾーンまたはリージョンの MIG に対して GET リクエストを行い、status.allInstancesConfig.effective フラグの値を確認します。

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

レスポンスの例:

{
  ...
  "status": {
    "isStable": "true",
    "versionTarget": {
      "isReached": "true"
    },
    "allInstancesConfig": {
      "currentRevision": "2022-12-02T10:30:15.012345Z",
      "effective": "true"
    },
  ...
  },
  ...
}

effective フィールドが true に設定されている場合、すべての VM に最新の構成が適用されます。currentRevision フィールドは、グループのすべてのインスタンス構成に加えられた最新の変更のタイムスタンプを示します。

effective フィールドが false に設定されている場合、最新の構成はまだすべての VM に適用されていません。

各インスタンスのステータスを確認するには、ゾーンまたはリージョンの MIG のマネージド インスタンスを一覧表示します。

GET https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/instanceGroupManagers/INSTANCE_GROUP_NAME/listManagedInstances

出力例:

{
  "managedInstances": [
    ...
    {
      "instance": ".../zones/ZONE/instances/INSTANCE_NAME",
      "instanceStatus": "RUNNING",
      "currentAction": "NONE",
      "allInstancesConfig": {
        "revision": "2022-12-02T10:30:15.012345Z"
      },
      "version": {
        "name": "V1",
        "instanceTemplate": ".../projects/.../instanceTemplates/INSTANCE_TEMPLATE"
      }
    },
    {
      ...
    }
  ]
}

最新の構成が適用された VM を確認するには、各 VM の revision タイムスタンプを MIG の currentRevision タイムスタンプと比較します。

コンソール

1. Google Cloud コンソールの [インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

2. すべてのインスタンス構成を表示する MIG を選択します。

3. [詳細] タブに移動します。

4. すべてのインスタンス構成セクションをご覧ください。

gcloud

describe コマンドを使用し、--format フラグを指定して、グループのすべてのインスタンス構成の値を表示します。

gcloud compute instance-groups managed describe INSTANCE_GROUP_NAME \
    --format="(allInstancesConfig)"

グループのすべてのインスタンス構成が存在する場合は、このコマンドで返されます。

REST

ゾーンまたはリージョンの MIG で GET リクエストを行い、allInstancesConfig フィールドを探します。

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

allInstancesConfig フィールドが設定されていない場合、グループにすべてのインスタンス構成はありません。

コンソール

1. Google Cloud コンソールの [インスタンス グループ] ページに移動します。

   [インスタンス グループ] に移動

2. すべてのインスタンス構成を削除する MIG を選択します。

3. [VM を更新] をクリックします。

4. [すべてのインスタンスの構成] セクションで、次の操作を行います。

   • メタデータを削除するには、[メタデータの管理] をクリックします。
   • ラベルを削除するには、[ラベルの管理] をクリックします。

5. [メタデータの管理] または [ラベルの管理] ペインで、次の操作を行います。

   1. 設定の上にポインタを置いて削除オプションを有効にし、[delete 項目を削除] をクリックします。
   2. [保存] をクリックします。

6. 削除が完了したら、[VM を更新] をクリックします。

   MIG の更新タイプが自動に設定されている場合、すべてのインスタンス構成の変更は既存のすべての VM にすぐに適用されます。更新タイプが選択的の場合は、構成を既存の VM に選択的に適用する必要があります。詳細については、すべてのインスタンス構成を既存の VM に適用するをご覧ください。

gcloud

プロパティを削除するには、all-instances-configuration delete コマンドを使用し、削除するプロパティのキーを 1 つ以上指定します。

gcloud compute instance-groups managed all-instances-config delete INSTANCE_GROUP_NAME \
    --metadata=KEY1[, KEY1]\
    --labels=KEY1[, KEY1]

更新した構成を、MIG 内の既存の VM に適用してください。

REST

プロパティを削除するには、ゾーンまたはリージョンの MIG で PATCH リクエストを行い、削除する各プロパティに対して null 値をキーとして指定します。

PATCH https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/regions/REGION/instanceGroupManagers/INSTANCE_GROUP_NAME
{
  "allInstancesConfig": {
    "properties": {
      "metadata": {
        "KEY1": null,
        ...
      },
      "labels": {
        "KEY2": null,
        ...
      }
    }
  }
}

更新した構成を、MIG 内の既存の VM に適用してください。