使用 Terraform 佈建 Knowledge Catalog 資源

您可以使用 Terraform,以程式碼的形式管理 Knowledge Catalog 資源。您不必手動設定資源 (例如切面類型和項目群組),而是編寫宣告式設定檔,在所有環境中重複使用。

HashiCorp Terraform 是一種基礎架構即程式碼 (IaC) 工具,可讓您佈建及管理雲端基礎架構。Terraform 提供稱為「供應商」的外掛程式,可讓您與雲端服務供應商和其他 API 互動。您可以使用 Google Cloud的 Terraform 供應商佈建及管理 Google Cloud 資源,包括 Knowledge Catalog。

本頁面將介紹如何搭配使用 Terraform 和 Knowledge Catalog,包括 Terraform 的運作方式,以及一些資源,協助您開始搭配使用 Terraform 和 Google Cloud。此外,您也可以找到 Knowledge Catalog 的 Terraform 參考文件連結、程式碼範例,以及使用 Terraform 佈建 Knowledge Catalog 資源的指南。

如要瞭解如何開始使用 Terraform Google Cloud,請參閱「安裝及設定 Terraform」或「Terraform Google Cloud 快速入門導覽課程」。

Terraform 的運作方式

Terraform 採用宣告式和設定導向的語法,可用來描述要在 Google Cloud 專案中佈建的基礎架構。在一或多個 Terraform 設定檔中編寫這項設定後,您可以使用 Terraform CLI 將這項設定套用至 Knowledge Catalog 資源。

Terraform 的運作方式如下:

  1. 您可以在 Terraform 設定檔中描述要佈建的基礎架構。您不需要編寫程式碼來說明如何佈建基礎架構。Terraform 會為您佈建基礎架構。
  2. 執行 terraform plan 指令,評估設定並產生執行計畫。您可以查看計畫,並視需要進行變更。
  3. 執行 terraform apply 指令,執行下列動作:

    1. 系統會在背景叫用對應的 Knowledge Catalog API,根據執行計畫佈建基礎架構。
    2. 這項指令會建立 Terraform 狀態檔案,這個 JSON 檔案會將設定檔中的資源對應至實際基礎架構中的資源。Terraform 會使用這個檔案記錄基礎架構的最新狀態,並判斷何時要建立、更新及刪除資源。
    3. 執行 terraform apply 時,Terraform 會使用狀態檔案中的對應關係,比較現有基礎架構與程式碼,並視需要進行更新:

      • 如果設定檔中定義了資源物件,但狀態檔案中沒有該物件,Terraform 就會建立該物件。
      • 如果資源物件存在於狀態檔案中,但設定與設定檔不同,Terraform 會更新資源,使其與設定檔相符。
      • 如果狀態檔案中的資源物件與設定檔相符,Terraform 就不會變更資源。

Knowledge Catalog 的 Terraform 資源

資源是 Terraform 語言的基本元素。每個資源區塊都會描述一或多個基礎架構物件,例如虛擬網路或運算執行個體。

下表列出 Knowledge Catalog 適用的 Terraform 資源:

服務 Terraform 資源 資料來源
Knowledge Catalog

Knowledge Catalog 的 Terraform 指南

下表列出 Knowledge Catalog 的 Terraform 使用指南和教學課程:

指南 詳細資料
使用 Terraform 以程式碼形式管理資料品質規則 本教學課程說明如何使用 Terraform、Cloud Build 和 GitHub,以程式碼形式管理 Knowledge Catalog 資料品質規則。
程式碼實驗室:運用 Knowledge Catalog 中繼資料建立資料基礎 本程式碼實驗室說明如何使用 Knowledge Catalog 中繼資料建立資料基礎。

Knowledge Catalog 適用的 Terraform 模組和藍圖

模組和藍圖可協助您大規模自動佈建及管理 Google Cloud 資源。模組是一組可重複使用的 Terraform 設定檔,可建立 Terraform 資源的邏輯抽象。藍圖是一套可部署及重複使用的模組,以及實作和記錄特定解決方案的政策。

下表列出與 Knowledge Catalog 相關的模組和藍圖:

模組或藍圖 詳細資料
dataplex-auto-data-quality 本單元說明如何使用 Cloud Build,在開發和正式環境中的 BigQuery 資料表部署資料品質規則。

後續步驟