使用 Terraform 预配 Knowledge Catalog 资源

借助 Terraform，您可以将 Knowledge Catalog 资源作为代码进行管理。 您无需手动设置方面类型和条目组等资源， 而是编写声明性配置文件，以便在所有环境中重复使用。

HashiCorp Terraform 是一种基础设施即代码 (IaC) 工具，可让您 预配和管理云基础设施。Terraform 提供了称为 “提供程序”的插件，可让您与云服务提供商和其他 API 进行交互。您可以使用适用于的 Terraform 提供程序来预配和管理资源，包括 Knowledge Catalog。 Google CloudGoogle Cloud

本页面介绍了如何将 Terraform 与 Knowledge Catalog 搭配使用，包括其 工作原理以及一些可帮助您开始使用 Terraform 与集成的资源 Google Cloud。您还可以找到一些链接，这些链接指向适用于 Knowledge Catalog 的 Terraform 参考文档、代码示例以及有关如何使用 Terraform 预配 Knowledge Catalog 资源的指南。

如需了解如何开始使用适用于 Google Cloud的 Terraform，请参阅 安装和配置 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	google_dataplex_aspect_type google_dataplex_aspect_type_iam google_dataplex_asset google_dataplex_asset_iam google_dataplex_datascan google_dataplex_datascan_iam google_dataplex_entry google_dataplex_entry_group google_dataplex_entry_group_iam google_dataplex_entry_type google_dataplex_entry_type_iam google_dataplex_lake google_dataplex_lake_iam google_dataplex_task google_dataplex_task_iam google_dataplex_zone google_dataplex_zone_iam	google_dataplex_aspect_type_iam_policy google_dataplex_asset_iam_policy google_dataplex_datascan_iam_policy google_dataplex_entry_group_iam_policy google_dataplex_entry_type_iam_policy google_dataplex_lake_iam_policy google_dataplex_task_iam_policy google_dataplex_zone_iam_policy google_data_lineage_config

适用于 Knowledge Catalog 的基于 Terraform 的指南

下表列出了适用于 Knowledge Catalog 的基于 Terraform 的方法指南和教程：

指南	详细信息
使用 Terraform 以代码形式管理数据质量规则	本教程介绍了如何使用 Terraform、Cloud Build 和 GitHub 以代码形式管理 Knowledge Catalog 数据质量 规则。
Codelab：使用 Knowledge Catalog 元数据构建数据基础	此 Codelab 介绍了如何使用 Knowledge Catalog 元数据构建数据基础。

适用于 Knowledge Catalog 的 Terraform 模块和蓝图

模块和蓝图可帮助您大规模自动执行 Google Cloud 资源的预配和管理。模块是一组可重复使用的 Terraform 配置文件，用于创建 Terraform 资源的逻辑抽象。一个 蓝图 是一个可部署且可重复使用的 模块和政策的软件包，用于实现和记录特定解决方案。

下表列出了与 Knowledge Catalog 相关的模块和蓝图：

模块或蓝图	详情
dataplex-auto-data-quality	此模块展示了如何使用 Cloud Build 在开发环境和生产环境中针对 BigQuery 表部署数据质量规则。

后续步骤

• 适用于 Knowledge Catalog 的 Terraform 代码示例
• Terraform on Google Cloud 文档
• HashiCorp 中的Google Cloud 提供程序文档
• 适用于 Google Cloud的基础设施即代码