-
Notifications
You must be signed in to change notification settings - Fork 12
Add benchmark documentation #337
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ravikiranvm
wants to merge
4
commits into
main
Choose a base branch
from
ops-3865
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+57
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: 'Benchmark' | ||
| description: 'Automated cloud assessment that computes a cost efficiency score and a breakdown of savings opportunities.' | ||
| icon: 'chart-column' | ||
| --- | ||
|
|
||
| import JoinCommunity from '/snippets/join-community.mdx' | ||
|
|
||
| **Benchmark** helps you run an **automated cloud assessment** across the provider you use with OpenOps. You choose your connection, scope, and which cost and efficiency checks to include. OpenOps automatically creates the workflows, runs them, and collects findings so you can prioritize savings and cleanup in one place. | ||
|
|
||
|
|
||
| ## What you get | ||
|
|
||
| * A **library of checks** tuned to your selected provider - for example utilization and waste, rightsizing, and savings across compute, storage, databases, and related services. | ||
| * A **benchmark report** in [Analytics](/reporting-analytics/analytics) so you can review KPIs and trends. | ||
|
|
||
| ## Running a benchmark | ||
|
|
||
| 1. Click **Run a Benchmark** on the OpenOps home page to start. | ||
| 2. Select your **cloud provider**. If you have no connection yet, create one when prompted. | ||
|  | ||
|
|
||
| 3. Choose the **connection** the benchmark should use. | ||
|  | ||
| <Note> | ||
| For **AWS**, OpenOps must be able to assume a role that includes the **read-only permissions** defined in the Benchmark CloudFormation stack. Use the link beside this step in the wizard to open the stack details. If that role is missing or incomplete, benchmark workflows can fail. For installation steps and templates, see [AWS CloudFormation role stacks](/cloud-access/aws-cf-role-stack). | ||
| </Note> | ||
|
|
||
| 4. Select **accounts or subscriptions** and **regions** to include. | ||
|  | ||
|
|
||
| 5. Choose the **benchmark workflows** that correspond to the cost and efficiency checks you want this run to perform. | ||
|  | ||
|
|
||
| 6. Click **Run** to execute the benchmark. | ||
| 7. When the run completes, open the benchmark report from the link in the wizard. | ||
|
|
||
|
|
||
| ## Benchmark report | ||
|
|
||
| After a successful run, the **benchmark report** is built from benchmark opportunities and cost data from your chosen cloud provider. You will see: | ||
|
|
||
| * **Summary metrics**: For example estimated monthly savings from open opportunities, total opportunity count, a **unified cost efficiency** metric (savings versus monthly cost context), and **monthly amortized cost over time**. | ||
| * **Top opportunities to address**: A ranked view you can use to focus on the largest items first. | ||
| * **Breakdown of savings**: Charts such as savings **by service**, **by region**, and **by account** so you can see where optimization potential clusters. | ||
|
|
||
| Charts are **cross-linked**: Choose a service, region, or account in one chart to filter the rest of the dashboard. A short note on the dashboard reminds you that you can filter using those dimensions. | ||
|
|
||
|
|
||
| <JoinCommunity /> | ||
ravikiranvm marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.