使用 Infrastructure Manager 部署基礎架構

本頁說明如何使用 Infrastructure Manager，佈建 Terraform 設定中定義的一組Google Cloud 資源。

如要預覽部署項目，但不要佈建資源，請參閱「預覽部署項目」。

您可以部署至多個專案和多個位置。服務帳戶必須具備資源和專案的權限，才能部署資源。如需權限清單，請參閱「使用 IAM 控管存取權」。

本頁面假設您已熟悉 Terraform。詳情請參閱「Terraform 和基礎架構管理工具」。

事前準備

  1. 啟用 Infra Manager。
  2. 請確認您具備建立部署作業所需的 IAM 權限：roles/config.admin。
  3. 請確認您有具備必要權限的服務帳戶。詳情請參閱「設定服務帳戶」。
  4. 找出要部署的 Terraform 設定。請確認這項 Terraform 設定符合限制。具體來說，請確認設定不含機密資料。
  5. 如要在設定資源前預覽部署作業，請參閱「預覽部署作業」。
  6. 確認與預期基礎架構相關聯的產品機構配額。如果預期基礎架構超出貴機構的產品配額，您可能會遇到部署錯誤。詳情請參閱「配額與限制」。

授予設定專屬權限

如要部署 Terraform 設定中指定的 Google Cloud 資源，您用來呼叫 Infra Manager 的服務帳戶必須具備部署資源所需的特定權限。

除了使用 Infra Manager 服務所需的權限外，您還需要這些權限。

如要進一步瞭解如何授予 Google Cloud 資源的權限，以及確保您有權存取所需專案，請參閱「設定服務帳戶」一文。

將私人 Git 存放區和主機連結至 Cloud Build

如果您要從私人 Git 存放區部署 Terraform 設定，請將 Git 主機和存放區連結至 Cloud Build。

使用 Terraform 設定建立部署作業

您可以使用 Infra Manager，透過下列幾種方式部署 Terraform 設定：

  • 建議：在 Google Cloud 控制台中使用 Infra Manager 選取來源、查看部署詳細資料、預覽及部署 Terraform 設定。您可以透過 Google Cloud 控制台使用 Infra Manager，從 Cloud Storage 值區和 Git 存放區部署。
  • 使用 Google Cloud CLI 中的 Infra Manager，從下列位置部署 Terraform 設定：
    • Cloud Storage 值區
    • Git 存放區
    • 在地目錄

如需範例和範本 Terraform 設定，請參閱「Terraform 模組和藍圖 Google Cloud」，瞭解如何搭配 Infra Manager 使用。

選取所選工作流程的分頁，進一步瞭解如何建立部署作業。

控制台

本節說明如何使用 Google Cloud 主控台中的 Infra Manager 部署 Terraform 設定。

  1. 前往 Google Cloud 控制台的「Infra Manager」頁面。

    前往 Infra Manager

  2. 按一下「建立」，建立新的部署作業。

  3. 在「部署詳細資料」頁面中，設定部署作業的初始參數。

    取代：

    • 部署作業 ID：在「部署作業 ID」欄位中，輸入部署作業的描述性名稱。 如要進一步瞭解命名限制，請參閱「部署名稱」說明文件。
    • 「Region」(區域)：從下拉式選單中選擇支援的區域。
    • Terraform 版本：從下拉式選單中選擇支援的 Terraform 版本。系統會根據您選取的「Region」(區域)，自動填入可用的 Terraform 版本清單。
    • 服務帳戶：選取現有的服務帳戶，或建立新的服務帳戶。Infra Manager 會根據 Terraform 設定中列出的基礎架構，自動驗證權限。如要進一步瞭解如何使用服務帳戶和 Infra Manager，請參閱「設定服務帳戶」。
    • Terraform 設定來源：按一下切換鈕，選取「Git」或「Cloud Storage」做為要部署的 Terraform 設定來源。
      • 如果是 Git，請取代：
        • Git 存放區：提供公開或私人的 Git 存放區網址、分支或標記。
          如果提供私人的 Git 存放區，請務必將主機和存放區連結至 Cloud Build。
        • 選用：Git 目錄：Git 存放區中含有 Terraform 設定的目錄。
        • 選用：Git 參照：設定的 Git 參照。如未指定參照，系統會使用 Git 存放區的預設設定分支。
      • 在「Cloud Storage bucket」(Cloud Storage 值區)，取代：
        • 來源：儲存設定的儲存空間值區名稱。

    按一下「繼續」。

  4. 在「Terraform details」(Terraform 詳細資料) 頁面中，使用「Key」(鍵) 和「Value」(值) 欄位，在 Terraform 設定中填入輸入值清單。

    這些值可以是 Terraform 設定中的任何輸入值，包括預設未定義的值。如果所有輸入值都預設在 Terraform 設定中定義，則這些值為選用。按一下 [繼續]。

  5. 在「進階詳細資料」頁面中，設定部署作業的選用參數。

    取代：

    • 標籤：標籤和註解是不限格式的鍵/值組合。您可以使用這些標籤，附加與資源相關的任意資訊。詳情請參閱「註解」說明文件。
    • 工作站集區：Cloud Build 工作將在其中執行的工作站集區資源。 工作站集區的格式為 projects/{project}/locations/{location}/workerPools/{workerPoolId}。
    • 構件 Cloud Storage bucket：Cloud Build 記錄和構件在 Cloud Storage 中的位置。路徑格式為 gs://{bucket}/{folder}。
  6. 按一下「建立部署作業」，開始部署 Terraform 設定。在「Deployments」(部署作業) 頁面中，部署作業會新增至清單，並顯示「Status」(狀態)。
    7. 如要進一步瞭解部署作業，請選取部署作業，前往「部署作業詳細資料」頁面。
  7. 大功告成！您已使用 Infra Manager 部署 Terraform 設定。

gcloud CLI

本節說明如何部署儲存在 Cloud Storage bucket 中的 Terraform 設定。您可以透過儲存空間 bucket 控制設定的存取權。

  1. 確認 Terraform 設定位於 Cloud Storage 值區中。詳情請參閱「將設定檔上傳至儲存空間 bucket」。

  2. 如果儲存空間值區與您執行 Infra Manager 的專案不同，請確保 Infra Manager 的服務帳戶具備該值區的讀取權限。詳情請參閱「設定服務帳戶」。

    如果儲存空間值區與 Infra Manager 位於同一個專案，系統會自動啟用該值區的讀取權限。

  3. 部署 Terraform 設定：

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --gcs-source gs://BUCKET_NAME/OBJECT_NAME \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotations="ANNOTATION_KEY=ANNOTATION_VALUE"
        --provider-source=SERVICE_MAINTAINED
取代：
  • PROJECT_ID：Infra Manager 執行的專案 ID。
  • LOCATION：Infra Manager 的執行位置。如需有效位置清單，請參閱「Infra Manager 位置」。
  • DEPLOYMENT_ID：您指定的部署作業 ID。如要瞭解部署 ID 的限制，請參閱「部署名稱」。
  • SERVICE_ACCOUNT_PROJECT_ID 是服務帳戶的專案 ID。這通常是執行 Infra Manager 的專案。
  • SERVICE_ACCOUNT：用於呼叫 Infra Manager 的服務帳戶名稱。
  • BUCKET_NAME：儲存設定的儲存空間 bucket 名稱。
  • OBJECT_NAME：設定檔的物件名稱。這個物件可以是目錄或 ZIP 檔案，但不能是 Terraform 檔案。如果您使用物件版本管理，也可以指定物件的產生編號。詳情請參閱「使用版本化物件」。

    如果儲存空間 bucket 是 Terraform 設定的根路徑，則 OBJECT_NAME 為選用項目。

  • 選用：QUOTA_VALIDATION：這個值會決定您建立部署作業時，是否啟用或強制執行 Terraform 設定檔中資源的配額驗證。可能的值包括：
    • ENABLED：為 Terraform 設定檔中的資源啟用運算配額驗證。可查看配額不足的資源。
    • ENFORCED：強制執行配額驗證，如果 Terraform 設定檔中定義的基礎架構沒有足夠配額，部署作業就會失敗。

    如果未定義 QUOTA_VALIDATION，系統會停用 Terraform 設定檔的配額驗證。這是預設值。配額驗證適用於有限的 Google Cloud 資源。詳情請參閱「配額與限制」。

  • INPUT_1_NAME 和 INPUT_2_NAME：Terraform 設定中的任何輸入值，包括預設未定義的值。舉例來說，您可以將部署資源的專案指定為 project_id=my-project。

    如果設定中預設定義了所有輸入值，則此標記為選用。

  • 選用：TERRAFORM_VERSION：Infra Manager 用於建立部署作業的 Terraform 版本。如需支援的版本清單，請參閱「支援的 Terraform 版本」。如果移除這個選用旗標，系統會使用最新支援的 Terraform 版本。
  • 選用：ANNOTATION_KEY 和 ANNOTATION_VALUE 代表可附加至 Infra Manager 部署作業的不限格式文字鍵/值組合。如要進一步瞭解註解和標籤的使用方式和限制，請參閱「註解和標籤」。

  • 選用：PROVIDER_SOURCE：決定部署作業使用的 Terraform 提供者。 Google Cloud 設為 SERVICE_MAINTAINED，即可使用 Infra Manager 維護的 Terraform 供應商。如要使用 HashiCorp 維護的 Terraform 供應商，請省略這個欄位。詳情請參閱「使用 Google Cloud 的 Terraform 供應商」。

gcloud CLI

本節說明如何使用儲存在 Git 存放區的 Terraform 設定。

  1. 確認您已安裝 Git。
  2. 如果 Terraform 設定儲存在私人 Git 存放區，請確保 Git 主機和存放區已連結至 Cloud Build。

  3. 部署 Terraform 設定：

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --git-source-repo="GIT_REPO" \
        --git-source-directory="DIRECTORY" \
        --git-source-ref="REF" \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotations="ANNOTATION_KEY=ANNOTATION_VALUE"
        --provider-source=SERVICE_MAINTAINED
取代：
  • PROJECT_ID：Infra Manager 執行的專案 ID。
  • LOCATION：Infra Manager 的執行位置。如需有效位置清單，請參閱「Infra Manager 位置」。
  • DEPLOYMENT_ID：您指定的部署作業 ID。如要瞭解部署 ID 的限制，請參閱「部署名稱」。
  • SERVICE_ACCOUNT_PROJECT_ID 是服務帳戶的專案 ID。這通常是執行 Infra Manager 的專案。
  • SERVICE_ACCOUNT：用於呼叫 Infra Manager 的服務帳戶名稱。
  • GIT_REPO：Git 存放區。
  • DIRECTORY：包含 Terraform 設定的目錄。
  • 選用：REF：設定的 Git 參照。參考資料為選填項目。如未指定參照，系統會使用 Git 存放區的預設設定分支。
  • 選用：QUOTA_VALIDATION：這個值會決定您建立部署作業時，是否啟用或強制執行 Terraform 設定檔中資源的配額驗證。可能的值包括：
    • ENABLED：為 Terraform 設定檔中的資源啟用運算配額驗證。可查看配額不足的資源。
    • ENFORCED：強制執行配額驗證，如果 Terraform 設定檔中定義的基礎架構沒有足夠配額，部署作業就會失敗。

    如果未定義 QUOTA_VALIDATION，系統會停用 Terraform 設定檔的配額驗證。這是預設值。配額驗證適用於有限的 Google Cloud 資源。詳情請參閱「配額與限制」。

  • INPUT_1_NAME 和 INPUT_2_NAME：Terraform 設定中的任何輸入值，包括預設未定義的值。舉例來說，您可以將部署資源的專案指定為 project_id=my-project。

    如果設定中預設定義了所有輸入值，則此標記為選用。

  • 選用：TERRAFORM_VERSION：Infra Manager 用於建立部署作業的 Terraform 版本。如需支援的版本清單，請參閱「支援的 Terraform 版本」。如果移除這個選用旗標，系統會使用最新支援的 Terraform 版本。
  • 選用：ANNOTATION_KEY 和 ANNOTATION_VALUE 代表可附加至 Infra Manager 部署作業的不限格式文字鍵/值組合。如要進一步瞭解註解和標籤的使用方式和限制，請參閱「註解和標籤」。

  • 選用：PROVIDER_SOURCE：決定部署作業使用的 Terraform 提供者。 Google Cloud 設為 SERVICE_MAINTAINED，即可使用 Infra Manager 維護的 Terraform 供應商。如要使用 HashiCorp 維護的 Terraform 供應商，請省略這個欄位。詳情請參閱「使用 Google Cloud 的 Terraform 供應商」。

gcloud CLI

本節說明如何使用儲存在本機電腦上的 Terraform 設定。

  1. 如果您使用 Cloud Shell，則需要將設定檔上傳至 Cloud Shell。詳情請參閱「使用 Cloud Shell 管理檔案」。

  2. 部署 Terraform 設定：

    gcloud infra-manager deployments apply projects/PROJECT_ID/locations/LOCATION/deployments/DEPLOYMENT_ID \
        --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \
        --local-source="LOCAL_DIRECTORY" \
        --quota-validation=QUOTA_VALIDATION \
        --input-values=INPUT_1_NAME=VALUE,INPUT_2_NAME=VALUE \
        --tf-version-constraint=TERRAFORM_VERSION \
        --annotations="ANNOTATION_KEY=ANNOTATION_VALUE"
        --provider-source=SERVICE_MAINTAINED
取代：
  • PROJECT_ID：Infra Manager 執行的專案 ID。
  • LOCATION：Infra Manager 的執行位置。如需有效位置清單，請參閱「Infra Manager 位置」。
  • DEPLOYMENT_ID：您指定的部署作業 ID。如要瞭解部署 ID 的限制，請參閱「部署名稱」。
  • SERVICE_ACCOUNT_PROJECT_ID 是服務帳戶的專案 ID。這通常是執行 Infra Manager 的專案。
  • SERVICE_ACCOUNT：用於呼叫 Infra Manager 的服務帳戶名稱。
  • LOCAL_DIRECTORY：儲存 Terraform 設定的本機目錄。如果您使用 Cloud Shell，這個目錄就是 Cloud Shell 中儲存設定的位置。
  • 選用：QUOTA_VALIDATION：這個值會決定您建立部署作業時，是否啟用或強制執行 Terraform 設定檔中資源的配額驗證。可能的值包括：
    • ENABLED：為 Terraform 設定檔中的資源啟用運算配額驗證。可查看配額不足的資源。
    • ENFORCED：強制執行配額驗證，如果 Terraform 設定檔中定義的基礎架構沒有足夠配額，部署作業就會失敗。

    如果未定義 QUOTA_VALIDATION，系統會停用 Terraform 設定檔的配額驗證。這是預設值。配額驗證適用於有限的 Google Cloud 資源。詳情請參閱「配額與限制」。

  • INPUT_1_NAME 和 INPUT_2_NAME：Terraform 設定中的任何輸入值，包括預設未定義的值。舉例來說，您可以將部署資源的專案指定為 project_id=my-project。

    如果設定中預設定義了所有輸入值，則此標記為選用。

  • 選用：TERRAFORM_VERSION：Infra Manager 用於建立部署作業的 Terraform 版本。如需支援的版本清單，請參閱「支援的 Terraform 版本」。如果移除這個選用旗標，系統會使用最新支援的 Terraform 版本。
  • 選用：ANNOTATION_KEY 和 ANNOTATION_VALUE 代表可附加至 Infra Manager 部署作業的不限格式文字鍵/值組合。如要進一步瞭解註解和標籤的使用方式和限制，請參閱「註解和標籤」。

  • 選用：PROVIDER_SOURCE：決定部署作業使用的 Terraform 提供者。 Google Cloud 設為 SERVICE_MAINTAINED，即可使用 Infra Manager 維護的 Terraform 供應商。如要使用 HashiCorp 維護的 Terraform 供應商，請省略這個欄位。詳情請參閱「使用 Google Cloud 的 Terraform 供應商」。

後續步驟