From e75d18e317f03312fcc045e5f70ce575778805ea Mon Sep 17 00:00:00 2001 From: jameslaneovermind <122231433+jameslaneovermind@users.noreply.github.com> Date: Thu, 3 Oct 2024 10:40:22 +0100 Subject: [PATCH] Update README.md (#594) * Update README.md This adds reference to the release of the new assistant along with some other tweaks Co-authored-by: Dylan --- README.md | 37 +++++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b5f967d..3cf1621 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -159,12 +181,15 @@ Additionally a community maintained package can be found in the [aur](https://au -## 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?