Skip to main content

Custom Integrations

Overmind can read in your terraform/OpenTofu plans on every pull request and show you the potential impact ("blast radius"), as well as give a machine-generated list of risks of the change. If you use GitHub Actions, Overmind can deliver that information directly to your PR as a comment.

Manual Integration​

Setting Up the API Key​

Before using the Overmind CLI in CI, you need to create an API key with the required permissions:

  1. Go to Account Settings > API Keys and click "New API Key"
  2. Give the key a name (e.g., "CI/CD" or "Jenkins")
  3. Select the following permissions:
    • account:read
    • changes:write
    • config:write
    • request:receive
    • sources:read
    • source:write
  4. Click "Confirm" to create the API key
  5. Set the API key as an environment variable OVM_API_KEY in your CI/CD system

Using the CLI​

  • Install the latest overmindtech/cli from the GitHub repo.
  • Set the OVM_API_KEY environment variable to your API key
  • Run overmind changes submit-plan every time CI/CD creates a new terraform/OpenTofu plan.
  • Use overmind changes get-change --format markdown to generate a report of the impact and risks.
  • Surround the deployment execution with start-change/end-change calls to capture before/after system snapshots.