Skip to content

Commit

Permalink
Update README.md (#594)
Browse files Browse the repository at this point in the history
* Update README.md

This adds reference to the release of the new assistant along with some other tweaks

Co-authored-by: Dylan <[email protected]>
  • Loading branch information
jameslaneovermind and dylanratcliffe authored Oct 3, 2024
1 parent 8bce06c commit e75d18e
Showing 1 changed file with 31 additions and 6 deletions.
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,23 @@

# What is Overmind?

Overmind is a powerful tool for real-time impact analysis on Terraform changes. Overmind can **identify the blast radius** and **uncover potential risks** with `overmind terrafrom plan` before they harm your infrastructure, allowing anyone to make changes with confidence. We also track the impacts of the changes you make with `overmind teraform apply`, so that you can be sure that your changes haven't had any unexpected downstream impact.
Overmind is a **tribal knowledge database** that empowers your team to manage infrastructure confidently, even without extensive experience.

### Signs your team needs Overmind

- **Blocked Experts & Slow Onboarding**

- Expert team members spend too much time on approvals, reducing overall productivity.
- Newer staff face a steep learning curve, delaying their effectiveness.

- **Limited Dependency Visibility**

- Tools like Terraform show intended changes but don't reveal underlying dependencies.
- Difficulty in assessing whether changes will disrupt existing applications.
- **Complex Outage Troubleshooting**

- Pinpointing issues during outages is challenging due to hidden dependencies.
- Outages often result from intricate, unforeseen relationships rather than simple cause-and-effect.

# Quick Start

Expand All @@ -25,6 +41,12 @@ Install the Overmind CLI using brew:
brew install overmindtech/overmind/overmind-cli
```

Launch the assistant and explore your newly configured AWS source:

```shell
overmind explore
```

Run a terraform plan:

```shell
Expand Down Expand Up @@ -159,12 +181,15 @@ Additionally a community maintained package can be found in the [aur](https://au

</details>

## Why Use Overmind?
**Discover CLI Commands**

- **☁️ Cloud Complexity:** Terraform tells you what it's going to change, but not whether this change will break everything. Teams need to understand dependencies to properly understand impact.
- **👨‍🏫 Onboarding & Productivity:** Due to the reliance on "tribal knowledge", expert staff are stuck doing approvals rather than productive work and newer staff take longer to become productive.
- **📋 Change Management Process:** IaC and automation mean that changes spend substantially more time in review and approval steps than the change itself actually takes.
- **🔥 Downtime:** Outages are not caused by simple cause-and-effect relationships. More often than not, downtime is a result of dependencies people didn't know existed.
- `overmind explore`

Overmind Assistant is a chat assistant that has real-time access to all your AWS and K8’s infrastructure. It alleviates the mental exhaustion of manual troubleshooting, simplifies incident resolution by easily accessing historical data, and automates time-consuming tasks such as documentation and Terraform code generation. You can access the assistant by running `overmind explore` .

- `overmind terrafrom plan / apply`

Overmind can identify the blast radius and uncover potential risks with `overmind terrafrom plan` before they harm your infrastructure, allowing anyone to make changes with confidence. It can also track the impact of the changes you make with `overmind teraform apply`, so that you can be sure that your changes haven't had any unexpected downstream impact.

## How We Solve It?

Expand Down

0 comments on commit e75d18e

Please sign in to comment.