Skip to main content

Connect and disconnect (Terraform PR agent)

This page describes how to connect the Terraform PR agent to your GitHub repositories from the DoiT console. When completed, the Terraform PR agent can read your Terraform code in GitHub and open remediation pull requests when an Insight is processed through the DoiT-provided CloudFlow during early access.

Required permissions​

  • Billing Profiles Admin permission

  • GitHub organization administrator for the organization that hosts your Terraform repositories. To be able to install the IaC Remediation Agent GitHub App.

Connect GitHub repositories​

Set up your Terraform PR agent:

  1. Sign in to the DoiT console, select Data ingestion and integrations > Integrations from the top navigation mega menu.

  2. Select the Agents category tab.

  3. On the Terraform PR agent integration card, select Connect + to launch the setup page.

  4. Under Connect Github repositories, select Open GitHub marketplace.

    Terraform PR agent setup page

  5. Follow the prompts in the GitHub Marketplace to install the IaC Remediation Agent on your organization and choose the repositories to connect. Include repositories that hold your Terraform root modules. If those modules reference private modules in other repositories, select those repositories as well. Without access, the agent may not resolve module definitions when generating remediations.

    The app needs permission to create pull requests, push branches, and read pull request comments so it can open remediations and respond to reviewer feedback.

    Select repositories and set permissions

After installation completes, the setup page shows a success confirmation with your connected organization and selected repositories.

Success confirmation

Disconnect GitHub repositories​

To disconnect GitHub access for the Terraform PR agent, go to your GitHub organization settings and uninstall the IaC Remediation Agent. This stops the agent from accessing your repositories and opening new remediation pull requests.

After you uninstall the app, the Terraform PR agent card in the Integrations catalog returns to Not connected, and the setup page shows Connect + again so you can reconnect later.

Last updated on