Provision Dataplex Universal Catalog resources with Terraform

HashiCorp Terraform is an infrastructure-as-code (IaC) tool that lets you provision and manage cloud infrastructure. Terraform provides plugins called providers that let you interact with cloud providers and other APIs. You can use the Terraform provider for Google Cloud to provision and manage Google Cloud resources, including Dataplex Universal Catalog.

This page introduces you to using Terraform with Dataplex Universal Catalog, including an introduction to how Terraform works and some resources to help you get started using Terraform with Google Cloud. You'll also find links to Terraform reference docs for Dataplex Universal Catalog, code examples, and guides for using Terraform to provision Dataplex Universal Catalog resources.

For instructions on how to get started with Terraform for Google Cloud, see Install and configure Terraform or the Terraform for Google Cloud quickstart.

How Terraform works

Terraform has a declarative and configuration-oriented syntax, which you can use to describe the infrastructure that you want to provision in your Google Cloud project. After you author this configuration in one or more Terraform configuration files, you can use the Terraform CLI to apply this configuration to your Dataplex Universal Catalog resources.

The following steps explain how Terraform works:

1. You describe the infrastructure you want to provision in a Terraform configuration file. You don't need to write code describing how to provision the infrastructure. Terraform provisions the infrastructure for you.
2. You run the terraform plan command, which evaluates your configuration and generates an execution plan. You can review the plan and make changes as needed.

3. You run the terraform apply command, which performs the following actions:

   1. It provisions your infrastructure based on your execution plan by invoking the corresponding Dataplex Universal Catalog APIs in the background.
   2. It creates a Terraform state file, which is a JSON file that maps the resources in your configuration file to the resources in the real-world infrastructure. Terraform uses this file to keep a record of the most recent state of your infrastructure, and to determine when to create, update, and destroy resources.

   3. When you run terraform apply, Terraform uses the mapping in the state file to compare the existing infrastructure to the code, and make updates as necessary:

      • If a resource object is defined in the configuration file, but doesn't exist in the state file, Terraform creates it.
      • If a resource object exists in the state file, but has a different configuration from your configuration file, Terraform updates the resource to match your configuration file.
      • If a resource object in the state file matches your configuration file, Terraform leaves the resource unchanged.

Terraform resources for Dataplex Universal Catalog

Resources are the fundamental elements in the Terraform language. Each resource block describes one or more infrastructure objects, such as virtual networks or compute instances.

The following table lists the Terraform resources available for Dataplex Universal Catalog:

Service	Terraform resources	Data sources
Dataplex Universal 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

Terraform-based guides for Dataplex Universal Catalog

The following table lists Terraform-based how-to guides and tutorials for Dataplex Universal Catalog:

Guide	Details
Manage data quality rules as code with Terraform	This tutorial explains how to manage Dataplex Universal Catalog data quality rules as code with Terraform, Cloud Build, and GitHub.

Terraform modules and blueprints for Dataplex Universal Catalog

Modules and blueprints help you automate provisioning and managing of Google Cloud resources at scale. A module is a reusable set of Terraform configuration files that creates a logical abstraction of Terraform resources. A blueprint is a package of deployable and reusable modules, and a policy that implements and documents a specific solution.

The following table lists modules and blueprints related to Dataplex Universal Catalog:

Module or blueprint	Details
dataplex-auto-data-quality	This module shows how to deploy data quality rules on BigQuery tables across development and production environments using Cloud Build.

What's next

• Terraform code samples for Dataplex Universal Catalog
• Terraform on Google Cloud documentation
• Google Cloud provider documentation in HashiCorp
• Infrastructure as code for Google Cloud