-
Notifications
You must be signed in to change notification settings - Fork 10
Quick Start Guide review (DOC-51) #114
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,8 @@ description: 'Get started with OpenOps in minutes' | |
icon: 'rocket' | ||
--- | ||
|
||
import AutoInstall from '/snippets/auto-install.mdx' | ||
|
||
Here's how you can go from downloading the open source distribution of OpenOps to starting getting value out of your OpenOps deployment. | ||
|
||
## Deploy OpenOps on your local machine | ||
|
@@ -12,43 +14,23 @@ You don't need a beefy machine for a test deployment. A modern OS like Windows 1 | |
|
||
You'll also need Docker, so see [Docker requirements](/getting-started/system-requirements#docker) to make sure you have a compatible version of a Docker client. | ||
|
||
Once you know your machine meets the system requirements: | ||
1. Go to the [OpenOps Releases](https://github.com/openops-cloud/openops/releases) page on GitHub and download `openops-dc-{version}.zip` from the latest release. | ||
2. Unzip the file to a new directory with a semantic name: for example, `openops-installation`. | ||
3. Inside the directory, make a copy of the `.env.defaults` file and save it as `.env`. | ||
4. Open the `.env` file and find two variables that represent admin credentials: `OPS_OPENOPS_ADMIN_EMAIL` and `OPS_OPENOPS_ADMIN_PASSWORD`. Change the values of these variables now: you won't be able to change them after the initial deployment. | ||
5. Make sure your Docker client such as Docker Desktop is running (if you're deploying on Linux, you don't need this). | ||
6. Inside the `openops-installation` directory, open a terminal and perform the following command to download Docker images: | ||
```shell | ||
COMPOSE_PARALLEL_LIMIT=4 docker compose pull | ||
``` | ||
Wait until all images are pulled: | ||
|
||
 | ||
> ℹ️ **Note** | ||
> | ||
> If you previously worked with AWS ECR, you might encounter an error of `pull access denied`. If that happens, please run `docker logout public.ecr.aws` to fix the faulty authentication. | ||
7. To launch OpenOps, run this in your terminal: | ||
```shell | ||
docker compose up -d | ||
``` | ||
Wait until all volumes are created, and all containers are either `Healthy` or `Started`: | ||
 | ||
8. If you want to configure Slack approvals, please see [setting up Slack on local environment](/getting-started/deployment/local#configuring-slack-approvals) | ||
<AutoInstall/> | ||
|
||
Wait for the installation script to complete. When it finishes, it will display the URL of your OpenOps instance (typically `http://localhost/`), along with the admin username and an autogenerated password. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't see the command to run the install script There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. indeed, my confusion came from it not rendering properly in "view file". It looks all good, thanks! |
||
|
||
## Open OpenOps in your browser | ||
|
||
Your OpenOps instance is now available at http://localhost/, so go ahead and open it in your browser: | ||
Go ahead and open OpenOps in your browser: | ||
 | ||
|
||
You can now log in with the admin account credentials that you've updated in the `.env` file. | ||
To log in, use the admin credentials that the installation script has displayed. | ||
|
||
## Look around | ||
|
||
After logging in, the first thing you'll see is the OpenOps **Overview** view: | ||
 | ||
|
||
On the left, you can see a sidebar containing the main OpenOps navigation menu. In a fresh installation, the following views contain little content, but knowing they exist can be helpful: | ||
In the top-left corner, click the **Open sidebar** icon to expand the main OpenOps navigation menu. In a fresh installation, the following views contain little content, but knowing they exist can be helpful: | ||
* **Workflows** will let you keep track of the workflows that you create. | ||
* **Runs** will keep a history of executing your workflows, indicating start time and status. | ||
* **Connections** will list all permissions you provide to OpenOps for various cloud providers and services, as well as let you create new ones. | ||
|
@@ -57,7 +39,7 @@ On the left, you can see a sidebar containing the main OpenOps navigation menu. | |
|
||
## Run a sample workflow | ||
|
||
Back in **Overview**, OpenOps suggests two sample beginner-level workflows to help you get a feel of the product. Let's use one of them to collect all available AWS Compute Optimizer recommendations for a variety of AWS resource types, and save the recommendations to an [OpenOps table](/reporting-analytics/tables/). | ||
Back in **Overview**, OpenOps suggests three sample beginner-level workflows to help you get a feel of the product. Let's use one of them to collect all available AWS Compute Optimizer recommendations for a variety of AWS resource types, and save the recommendations to an [OpenOps table](/reporting-analytics/tables/). | ||
|
||
Click **AWS sample workflow**: | ||
 | ||
|
@@ -155,7 +137,7 @@ The sample AWS workflow that you've just tested and published provides just a qu | |
In real FinOps scenarios, you would want your workflows to do more: for example, find owners of unused resources, request their decision on whether to delete or keep resources, and if they decide to delete, then execute IaC automations and create GitHub pull requests. | ||
|
||
Fortunately, OpenOps provides dozens of real-world FinOps templates that you can base your workflows on. To get hold of them, in the sidebar, click **Overview**. Then click **Explore templates** in the top-right menu bar to see the **Templates catalog**: | ||
 | ||
 | ||
|
||
By default, the catalog contains six templates. To view more, click **Explore more** and sign up for a free OpenOps Cloud account. As a result, the **Templates catalog** in your OpenOps installation will be extended to show all available templates: | ||
 | ||
|
@@ -165,6 +147,18 @@ You can click any template in the catalog to see its full description, a preview | |
|
||
If you find a template useful, you can click **Use template** and create a workflow based on the template, just like you did earlier with the sample AWS workflow. | ||
|
||
## Connect OpenOps to your AI provider | ||
|
||
Building steps in OpenOps workflows is usually intuitive. Still, when you need to enter a cloud-specific command, write an SQL query, or add a custom script, it can be helpful to get assistance. | ||
|
||
OpenOps lets you connect your preferred LLM provider, such as OpenAI or Anthropic, so you can generate queries, scripts, and CLI commands directly within the workflow editor. | ||
|
||
At the bottom of the sidebar, click **Settings**, then **AI**. Choose your LLM provider, select a model, enter your API key, and click **Save**. | ||
|
||
Once connected, any time you edit a step that involves a command, query, or custom code, you can click **Generate with AI** to prompt your LLM and generate it for you: | ||
|
||
 | ||
|
||
## Join the OpenOps community | ||
|
||
We hope that you've appreciated what OpenOps can do for you to help automate your FinOps practices. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this should be in the "Deploy OpenOps on your local machine" section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is just an import statement, it's supposed to be at the top.