在 MIG 中設定有狀態中繼資料

gcloud

如要建立具有自訂名稱的受管理執行個體，並在該 VM 上設定具狀態中繼資料，請使用 gcloud compute instance-groups managed create-instance 指令搭配 --stateful-metadata 旗標。

gcloud compute instance-groups managed create-instance NAME \
  --instance INSTANCE_NAME \
  --stateful-metadata KEY=VALUE[,KEY=VALUE,...]

更改下列內容：

• NAME：要在其中建立執行個體的 MIG 名稱
• INSTANCE_NAME：要建立的執行個體名稱
• KEY 和 VALUE：有狀態的中繼資料鍵/值組合，可為執行個體個別設定，並加入執行個體範本中定義的中繼資料
  • 您在此設定的鍵值優先於執行個體範本中的任何衝突鍵值

示例

您需要部署節點叢集 example-cluster，該叢集可以下列兩種模式之一運作：active 或 standby。您可以使用中繼資料，為叢集中的每個 VM 個別設定模式，例如：mode:active。您也可以使用 logging 中繼資料鍵，為每個節點設定詳細程度不同的記錄，這個鍵可以設為 basic 或 elaborate。節點上的應用程式會使用執行個體中繼資料中的值進行設定。

如要建立具有詳細記錄的有效節點 node-12，請執行下列指令：

gcloud compute instance-groups managed create-instance example-cluster \
  --instance node-12 \
  --stateful-metadata mode=active,logging=elaborate

這項指令會在 example-cluster MIG 中建立 VM node-12，並為新執行個體設定兩個中繼資料鍵值組合 mode:active 和 logging:elaborate。

Terraform

如要建立具有自訂名稱的代管執行個體，並在該 VM 上設定具狀態中繼資料，請使用 google_compute_per_instance_config 資源。

以下範例使用區域 MIG。如果還沒有可用區 MIG，請建立可用區 MIG，並將 VM 限制在單一可用區。

resource "google_compute_per_instance_config" "default" {
  instance_group_manager = google_compute_instance_group_manager.default.name
  zone                   = google_compute_instance_group_manager.default.zone
  name                   = "node-12"
  preserved_state {
    metadata = {
      mode    = "active"
      logging = "elaborate"
    }
  }
}

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

REST

如要在 MIG 中建立一或多個具有自訂 VM 名稱的代管執行個體，並在這些 VM 上個別設定具狀態中繼資料，請使用 instanceGroupManagers.createInstances 方法。如果是區域 MIG，請使用 regionInstanceGroupManagers.createInstances 方法。

POST https://compute.googleapis.com/compute/v1/projects/PROJECT_ID/zones/ZONE/instanceGroupManagers/NAME/createInstances
{
  "perInstanceConfigs": [
    {
      "name": "INSTANCE_NAME",
      "preservedState" : {
        "metadata": {
          "KEY" : "VALUE",
          ...
        }
      }
    },
    ...
  ]
}

更改下列內容：

• PROJECT_ID：要求的專案 ID
• ZONE：MIG 所在的區域 (適用於區域 MIG)
  • 如果是區域 MIG，請將 zones/ZONE 替換為 regions/REGION，並指定 MIG 的區域
• NAME：要在其中建立執行個體的 MIG 名稱
• INSTANCE_NAME：要建立的執行個體名稱
• KEY 和 VALUE：有狀態的中繼資料鍵/值組合，可為執行個體個別設定，並加入執行個體範本中定義的中繼資料
  • 您在此設定的鍵值優先於執行個體範本中的任何衝突鍵值

示例

您需要部署節點叢集 example-cluster，該叢集可以下列兩種模式之一運作：active 或 standby。您可以使用中繼資料，為叢集中的每個 VM 個別設定模式，例如：mode:active。您也可以使用 logging 中繼資料鍵，為每個節點設定詳細程度不同的記錄，這個鍵可以設為 basic 或 elaborate。節點上的應用程式會使用執行個體中繼資料中的值進行設定。

如要建立具有詳細記錄功能的有效節點 node-12，請執行下列方法：

POST https://compute.googleapis.com/compute/v1/projects/example-project/zones/us-east1-c/instanceGroupManagers/example-cluster/createInstances

{
  "instance": [
    {
      "name": "node-12",
      "preservedState" : {
        "metadata": {
          "mode":"active",
          "logging":"elaborate"
        }
      }
    }
  ]
}

這個方法會在 example-cluster MIG 中建立 VM (node-12)，並為新執行個體設定兩個中繼資料鍵值組合 (mode:active 和 logging:elaborate)。

gcloud

如要為 MIG 中的 VM 執行個體個別設定有狀態中繼資料，請在相關聯的執行個體專屬設定中設定或移除有狀態中繼資料。如果您同時將設定套用至執行個體 (--update-instance)，可以選擇讓執行個體繼續執行、重新啟動或重新建立。如果您未套用設定 (--no-update-instance)，變更不會生效，直到您重新建立或更新執行個體為止。

如果特定執行個體沒有執行個體專屬設定，請使用 gcloud compute instance-groups managed instance-configs create 指令搭配下列其中一個旗標：

gcloud compute instance-groups managed instance-configs create NAME \
  --instance INSTANCE_NAME \
  --stateful-metadata KEY=VALUE[,KEY=VALUE,...] \
  [--no-update-instance | --update-instance] \
  [--instance-update-minimal-action MINIMAL_ACTION]

如果特定執行個體已有執行個體專屬設定，請使用 gcloud compute instance-groups managed instance-configs update 指令，並搭配下列參數：

• 設定或修改中繼資料的 --stateful-metadata 旗標，或
• --remove-stateful-metadata 旗標，用於移除執行個體專屬的有狀態中繼資料。

gcloud compute instance-groups managed instance-configs update NAME \
  --instance INSTANCE_NAME \
  [--stateful-metadata KEY=VALUE[,KEY=VALUE,...]] \
  [--remove-stateful-metadata KEY[,KEY,...]] \
  [--no-update-instance | --update-instance] \
  [--instance-update-minimal-action MINIMAL_ACTION]

更改下列內容：

• NAME：代管執行個體群組的名稱。
• INSTANCE_NAME：要設定有狀態中繼資料的執行個體名稱。
• KEY=VALUE：有狀態中繼資料鍵值組合，除了執行個體範本中定義的中繼資料，還可個別為執行個體設定。您在此設定的鍵值會優先於執行個體範本中的任何衝突鍵值。
• KEY：要從個別執行個體設定中移除的執行個體專屬有狀態中繼資料鍵。
  • 如果執行個體範本未定義鍵的值，系統會在套用變更時，從執行個體中完全移除鍵/值組合。
  • 如果執行個體範本定義了鍵的值，系統會在套用變更時，將執行個體範本的值設定在執行個體上。

• MINIMAL_ACTION：將個別執行個體設定更新套用至執行個體時，至少要執行指定動作。只有在使用 --update-instance 旗標時，才能設定 MINIMAL_ACTION。這個值必須是下列其中之一：

  • none：不執行任何動作。
  • refresh：套用可套用的更新，不必停止執行個體。
  • restart：停止執行個體，然後重新啟動。
  • replace：重新建立執行個體。

  如果省略這個值，系統會使用更新作業所需的干擾程度最低動作。

示例

您有一組節點 (example-cluster)，可透過 active 或 standby 兩種模式運作。您可以使用中繼資料，為叢集中的每個 VM 個別設定模式，例如：mode:active。您也可以使用可設為 basic 或 elaborate 的 logging 中繼資料鍵，為每個節點設定詳細記錄的程度。每個節點上的應用程式都會取用執行個體中繼資料中的值。

執行個體範本會定義 mode:active 和 logging:basic 中繼資料，做為所有執行個體的預設值。您已在叢集中的 node-12 VM 執行個體設定中設定 logging:elaborate。現在，您想將 node-12 切換為待機模式，並將這個 VM 的記錄切換為 basic。

如要將 node-12 執行個體切換為待命狀態，並將記錄功能切換為基本模式，請執行下列指令：

gcloud compute instance-groups managed instance-configs update example-cluster \
  --instance node-12 \
  --stateful-metadata mode=standby \
  --remove-stateful-metadata logging

這項指令會執行以下作業：

1. 在與 example-cluster MIG 中的 VM 相關聯的個別執行個體設定中，設定 mode:standby 中繼資料 node-12。
2. 從 node-12 執行個體的每個執行個體設定中移除 logging:elaborate 中繼資料。
3. 將個別執行個體設定變更套用至 node-12 VM：
   • 根據設定，設定 mode:standby 中繼資料。
   • 從執行個體範本設定 logging:basic 中繼資料，因為 logging 鍵的值不再由每個執行個體的設定定義。
4. 由於省略了 --no-update-instance 標記，變更預設會立即套用至 VM。
5. 由於省略了 --instance-update-minimal-action 標記，且系統預設會選擇干擾性最低的更新動作 (在本例中為 refresh)，因此 VM 會在更新期間持續執行。

REST

如要為 MIG 中現有的 VM 執行個體個別設定有狀態的中繼資料，請在相關聯的每個執行個體設定中設定或移除中繼資料。然後更新執行個體，套用設定。

如果指定執行個體尚未有執行個體專屬設定，請使用instanceGroupManagers.updatePerInstanceConfigs 方法 搭配有狀態中繼資料：

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

{
  "perInstanceConfigs": [
    {
      "name": "INSTANCE_NAME",
      "preservedState" : {
        "metadata": {
          "KEY": "VALUE",
          ...
        }
      },
      "fingerprint: "FINGERPRINT"
    },
    ...
  ]
}

如果指定執行個體已有個別執行個體設定，請使用 instanceGroupManagers.patchPerInstanceConfigs 方法

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

{
  "perInstanceConfigs": [
    {
      "name": "INSTANCE_NAME",
      "preservedState" : {
        "metadata": {
          "KEY": "VALUE",
          ...
        }
      },
      "fingerprint: "FINGERPRINT"
    },
    ...
  ]
}

更改下列內容：

• PROJECT_ID：要求的專案 ID。
• ZONE：MIG 所在的區域 (適用於可用區 MIG)。
  • 如果是區域 MIG，請將 zones/ZONE 替換為 regions/REGION，並指定 MIG 的區域。
• NAME：MIG 的名稱。
• INSTANCE_NAME：要設定具狀態中繼資料的 VM 名稱。
• KEY 和 VALUE：有狀態的中繼資料鍵值組合，可為執行個體個別設定，此外，您也可以在執行個體範本中定義中繼資料。
  • 針對執行個體範本中已存在的鍵定義的具狀態中繼資料值，會覆寫執行個體範本中的值。
  • 執行個體範本中的其他中繼資料項目不受影響，仍可使用。
  • 提供 null 做為值，即可從每個執行個體的設定中移除金鑰。
• FINGERPRINT：(選用)。如果指定設定已存在，則為該設定的指紋。用於樂觀鎖定。

updatePerInstanceConfigs 和 patchPerInstanceConfigs 方法會更新指定的個別執行個體設定，但不會將設定更新套用至相關聯的 VM 執行個體。更新或重新建立執行個體時，系統會將變更套用至 VM。如要將變更套用至 VM，您可以手動套用更新，或在主動或隨機模式下使用 Updater。

示例

您有一組節點 (example-cluster)，可透過 active 或 standby 兩種模式運作。您可以使用中繼資料，為叢集中的每個 VM 個別設定模式，例如：mode:active。您也可以使用可設為 basic 或 elaborate 的 logging 中繼資料鍵，為每個節點設定詳細記錄的程度。每個節點上的應用程式都會取用執行個體中繼資料中的值。

執行個體範本會定義 mode:active 和 logging:basic 中繼資料，做為所有執行個體的預設值。您已在叢集中的 node-12 VM 執行個體設定中設定 logging:elaborate。現在，您想將 node-12 切換至待機模式，並將這個執行個體的記錄切換至 basic。

如要將 node-12 VM 切換為待命狀態，並將記錄檔切換為基本記錄檔，請使用 patchPerInstanceConfigs 方法修補相關聯的個別執行個體設定：

POST https://compute.googleapis.com/compute/v1/projects/example-project/zones/us-east1-c/instanceGroupManagers/example-cluster/patchPerInstanceConfigs

{
  "perInstanceConfigs": [
    {
      "name": "node-12",
      "preservedState" : {
        "metadata": {
          "mode": "standby",
          "logging": null
        }
      }
    }
  ]
}

這個方法會執行下列作業：

1. 在與 VM 相關聯的個別執行個體設定中，於 example-cluster MIG 內設定 mode:standby 中繼資料 node-12。
2. 從每個執行個體的設定中移除 logging:elaborate 中繼資料，因為提供的值為 null。

設定更新尚未套用至 node-12 VM 執行個體。下次重新建立或更新執行個體時，或使用主動自動更新時，系統就會套用設定更新。

如要將個別執行個體設定更新套用至 node-12 VM 執行個體，請對該執行個體呼叫 instanceGroupManagers.applyUpdatesToInstances 方法：

POST https://compute.googleapis.com/compute/v1/projects/example-project/zones/us-east1-c/instanceGroupManagers/example-cluster/applyUpdatesToInstances

{
  "instances": ["/zones/us-east1-c/instances/node-12"],
  "minimalAction": "NONE"
}

這個方法會將更新後的個別執行個體設定套用至 node-12 VM：

1. 根據每個執行個體的設定，設定 mode:standby 中繼資料。
2. 從執行個體範本設定 logging:basic 中繼資料，因為 logging 鍵的值不再由每個執行個體的設定定義。
3. 由於 minimalAction 設為 NONE，因此 VM 會在更新期間持續執行，MIG 也能使用更新所需的最低干擾動作。更新執行個體中繼資料需要 REFRESH 動作，這不會中斷執行中的執行個體。