Skip to main content

Terraform

Integrate Terraform with Cloudaware to inventory organizations, projects, workspaces, teams, users, runs, registry modules, and registry providers for DevOps governance.

info
  • Audience: Cloudaware administrators, DevOps teams, platform engineering teams, and cloud governance teams
  • Outcome: Terraform Cloud or Terraform Enterprise metadata is available in CMDB for IaC visibility, workspace governance, ownership review, and reporting

Capabilities​

The integration supports:

  • Read-only discovery of Terraform Cloud or Terraform Enterprise metadata
  • CMDB records for Terraform organizations, projects, workspaces, teams, users, runs, registry modules, registry providers, and AWS resources
  • IaC coverage and governance reporting across Terraform workspaces and projects
  • Search and reporting for Terraform objects using CMDB Navigator, CMDB list views, and reports

Prerequisites​

Before you begin, make sure you have:

  • Access to a Cloudaware account.
  • A user with access to the Admin Console and permissions to manage cloud accounts, organizations, and integrations (Cloudaware Administrator).
  • Terraform API token with Viewer access to Projects and Workspaces. The token can be a user, team, or organization token.
  • Terraform Enterprise instance URL reachable from Cloudaware, if using a self-hosted deployment.

Add a Terraform Token to Cloudaware​

  1. In Cloudaware, go to Admin.
  2. Find Terraform, then click + ADD.
  3. Enter the following values:
    • Token Name: A display name for the Terraform token.
    • Terraform Token: The Terraform API token with Viewer access.
    • URL: (optional)
      • For Cloud-hosted (HCP Terraform): Leave blank, as Cloudaware will use https://app.terraform.io as the default endpoint.
      • For Self-hosted Deployments: The Terraform Enterprise instance URL in the format https://terraform.companyname.com/.
    • Trust Certificate: Enable this option for self-hosted Terraform Enterprise endpoints only.
  4. Click Save.
  5. Confirm that the integration status indicator is green.
tip

Allow the initial discovery cycle to complete after enabling the integration.

View Terraform Data in CMDB​

  1. In Cloudaware, open CMDB Navigator.
  2. In the left pane, select HCP TERRAFORMm.
  3. Open an object list, e.g., Terraform Software Packages, to view discovered records.

Supported Objects​

Cloudaware ingests the following Terraform objects:

Terraform ObjectCMDB Object API Name
Terraform Cloud Resource AWSCA10TF__CaTerraformCloudResourceAws__c
Terraform OrganizationCA10TF__CaTerraformOrganization__c
Terraform Organization MemberCA10TF__CaTerraformOrganizationMember__c
Terraform ProjectCA10TF__CaTerraformProject__c
Terraform Registry ModuleCA10TF__CaTerraformRegistryModule__c
Terraform Registry ProviderCA10TF__CaTerraformRegistryProvider__c
Terraform RunCA10TF__CaTerraformRun__c
Terraform TeamCA10TF__CaTerraformTeam__c
Terraform Team User LinkCA10TF__CaTerraformTeamUserLink__c
Terraform UserCA10TF__CaTerraformUser__c
Terraform WorkspaceCA10TF__CaTerraformWorkspace__c

Troubleshooting​

note

Initial data collection may take time to complete.

Authentication Fails or Integration Shows Red Status​

  • Verify that the Terraform API token is correct and active.
  • Confirm that the token has Viewer access to the organizations, projects, and workspaces expected in Cloudaware.
  • For self-hosted Terraform Enterprise, verify that the URL is correct and reachable.
  • If the endpoint uses a private or self-signed certificate, enable Trust Certificate if required.

No Terraform Data Appears in CMDB​

  • Allow the initial discovery cycle to complete.
  • Confirm that the token can access the expected Terraform organizations and workspaces.
  • In CMDB Navigator, verify that you are viewing the HCP TERRAFORMm section and related resources.

Some Workspaces or Projects Are Missing​

  • Confirm that the missing workspaces or projects are visible to the Terraform API token.
  • Check whether the missing records belong to an organization outside the token scope.
  • Review recent Terraform changes after the next discovery cycle completes.

Still stuck? Contact Cloudaware Support at support@cloudaware.com with the integration name and a brief description of the issue.

Reconfigure or Remove the Integration​

warning

To rotate a Terraform token or change a self-hosted URL, edit the existing integration instead of deleting and re-creating it.

Update the Integration Details​

  1. Go to Admin.
  2. Select Terraform.
  3. Under the tab Tokens and Organizations, select the specific integration.
  4. Open the three-dot menu (⋮), then click Edit.
  5. Update the required fields.
  6. Click Save.

Remove the Integration from Cloudaware​

  1. Go to Admin.
  2. Select Terraform.
  3. Under the tab Tokens and Organizations, select the specific integration.
  4. Open the three-dot menu (⋮), then click Delete.
  5. Confirm the deletion if prompted.

Security Notes​

  • Use a dedicated Terraform token for Cloudaware discovery where possible.
  • Grant the token only the Viewer access required for Terraform metadata discovery.
  • Do not reuse personal administrator tokens for production integrations.
  • Rotate Terraform tokens according to your organization's credential management policy.
  • Review Terraform metadata visibility with your platform engineering team, because workspace names, run history, team membership, and resource references may reveal sensitive infrastructure context.
  • Revoke unused Terraform tokens when the integration is retired.