Use Terraform with Apigee

HashiCorp Terraform is an Infrastructure as Code (IaC) tool that you can use to provision and configure Apigee using code.

When you use Terraform with Apigee, you create Terraform files that describe your desired configuration for provisioning or a feature. When you apply the configuration, Terraform creates an execution plan and performs the operations needed to configure Apigee.

This page summarizes the Terraform functionality available for Apigee. For general information about using Terraform with Google Cloud, see Terraform on Google Cloud documentation.

Before you begin

In order to set up Terraform for your Apigee project:

  1. Prepare your development environment, either Cloud Shell or a local shell:

    Cloud Shell

    To use an online terminal with the gcloud CLI and Terraform already set up, activate Cloud Shell.

    At the bottom of this page, a Cloud Shell session starts and displays a command-line prompt. It can take a few seconds for the session to initialize.

    Note that Cloud Shell has Terraform already integrated.

    Local shell

    To use a local development environment, follow these steps:

    1. Install the Google Cloud CLI.

  2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  3. To initialize the gcloud CLI, run the following command: 

    gcloud init
  4. Install Terraform.