Terraform
💡 NOTE: Currently Overmind only supports Terraform as a way of creating changes
To get started with Overmind's Blast Radius and Risks you will first need to create a change. Overmind will parse the resources and items from your Terraform plan output, stripping any sensitive information and then use these to create a change.
How Overmind Integrates with Terraform​
Overmind leverages the output of the terraform plan
command to evaluate the implications of proposed changes to your infrastructure. The following sections outline the technical processes involved in creating and analysing these changes using Overmind.
Inspection and Execution​
When a Terraform plan is generated terraform plan
, Overmind initiates a series of evaluations:
-
Inspection: Overmind inspects the current Terraform configuration and the proposed changes.
-
Plan Execution: It executes the
terraform plan
command to generate a detailed mapping of planned modifications to your infrastructure.
Data Collection and Mapping​
During the execution of the terraform plan
command, Overmind performs extensive data collection:
-
Resource Discovery: It gathers information about existing cloud resources and their configurations.
-
Dependency Mapping: It maps out all potential dependencies and interactions within your infrastructure, creating a comprehensive view of how resources are interconnected.
Comprehensive Reporting​
After collecting and mapping the data, Overmind generates a detailed report:
-
Impact Analysis: The report outlines all resources that could be impacted by the proposed changes.
-
Risk Assessment: It provides an automated assessment of deployment risks, identifying specific issues that may not be immediately visible from the Terraform plan alone.
Usage​
From version 0.19.3
of overmind-cli
, users can capture planned before and after attributes from Terraform changes.
Firstly you’ll want to make sure you have the latest version of overmind-cli
installed and up-to-date. Once installed run the following command to ensure it is working correctly:
overmind help
For further installation and usage please refer to the CLI docs.