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 Agent Platform Workbench.

This page introduces you to using Terraform with Agent Platform Workbench, 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
Agent Platform Workbench, code examples, and guides for using Terraform to provision
Agent Platform Workbench resources.

For instructions on how to get started with Terraform for Google Cloud, see
[Install and configure Terraform](https://docs.cloud.google.com/docs/terraform/install-configure-terraform.md.txt) or the
[Terraform for Google Cloud quickstart](https://docs.cloud.google.com/docs/terraform/create-vm-instance.md.txt).

## 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 Agent Platform Workbench 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 Agent Platform Workbench 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 Agent Platform Workbench

*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
Agent Platform Workbench:


| Service | Terraform resources | Data sources |
|---|---|---|
| Agent Platform Workbench | - [`google_workbench_instance`](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/workbench_instance) - [`google_workbench_instance_iam`](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/workbench_instance_iam) | [`google_workbench_instance_iam_policy`](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/workbench_instance_iam_policy) |

<br />

## Terraform-based guides for Agent Platform Workbench

The following table lists Terraform-based how-to guides and tutorials for
Agent Platform Workbench:


| **Guide** | **Details** |
|---|---|
| [Create a Agent Platform Workbench instance](https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/instances/create.md.txt#terraform) | Create a Agent Platform Workbench instance with a basic configuration. |
| [Manage idle shutdown on Terraform](https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/instances/idle-shutdown.md.txt#terraform) | Configure the idle shutdown settings on a Agent Platform Workbench instance. |
| [Upgrade a custom container](https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/instances/create-custom-container.md.txt#upgrade-container) | Change the `container_image` field in the Terraform configuration to update the container payload. |
| [Create an instance with specific metadata](https://docs.cloud.google.com/gemini-enterprise-agent-platform/notebooks/workbench/instances/manage-metadata.md.txt#terraform) | Create a Agent Platform Workbench instance with specific metadata. |

<br />

## Terraform modules and blueprints for Agent Platform Workbench

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
Agent Platform Workbench:


| Module or blueprint | Details |
|---|---|
| [`ai-notebook`](https://github.com/GoogleCloudPlatform/notebooks-blueprint-security) | This module demonstrates how to protect confidential data in a Agent Platform Workbench instance. |

<br />

## What's next

- [Terraform code samples for Agent Platform Workbench](https://docs.cloud.google.com/docs/samples.md.txt?language=terraform)
- [Terraform on Google Cloud documentation](https://docs.cloud.google.com/docs/terraform.md.txt)
- [Google Cloud provider documentation in HashiCorp](https://registry.terraform.io/providers/hashicorp/google/latest/docs)
- [Infrastructure as code for Google Cloud](https://docs.cloud.google.com/docs/terraform/iac-overview.md.txt)