Preview a deletion of a deployment

This page describes how to use Infrastructure Manager to preview the deletion of an existing deployment.

A preview describes the actions to actuate a specific Terraform configuration. Before you delete a deployment, you can use a preview to verify the resources that are planned to be deleted.

A preview does not delete any provisioned resources. To delete a deployment, including deleting provisioned resources, see Delete deployments.

A preview executes the Terraform plan command. This page assumes you are familiar with Terraform. For details, see Terraform and Infrastructure Manager.

Before you begin

  1. Enable Infra Manager.
  2. Ensure that you have the IAM permissions needed to create previews: roles/config.admin.
  3. Ensure you have a service account with the needed permissions. For details, see Configure the service account.
  4. Identify the Terraform configuration to preview. Ensure this Terraform configuration complies with the constraints, including that the configuration does not contain sensitive data.

  5. If you want to store the Terraform configuration in a storage bucket, ensure the Terraform configuration is uploaded to a Cloud Storage bucket. See Upload a configuration to a storage bucket for more details.

    A storage bucket lets you control access to the configuration. You can also deploy a Terraform configuration that is stored in a public Git repository, or stored on your local machine.

Preview the deletion of a deployment

Before you delete a deployment, you can preview and review the deletion.

To preview the deletion of a deployment:

gcloud infra-manager previews create --preview-mode DELETE --deployment=projects/PROJECT_ID/locations/LOCATION/previews/DEPLOYMENT_ID \
    --service-account projects/SERVICE_ACCOUNT_PROJECT_ID/serviceAccounts/SERVICE_ACCOUNT \

Replace:

  • PROJECT_ID is the project ID where Infrastructure Manager runs.
  • LOCATION is the location where Infra Manager runs. See Infrastructure Manager locations for the list of valid locations.
  • PREVIEW_ID is the preview identifier that you specify. See Preview name for details about constraints on the preview identifier.
  • SERVICE_ACCOUNT is the name of the service account you use to call Infra Manager.
  • SERVICE_ACCOUNT_PROJECT_ID is the project ID of the service account. It's common for this to be the same project where Infra Manager runs.
  • DEPLOYMENT_ID is the deployment identifier of the deployment you want to update.

Now that you have created a preview, you can export and view the results to review the plan for the deployment.

For more information about deleting deployments, see Delete a deployment.

What's next