Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions getting-started/deployment/local.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ If you can't use the autoinstall script, follow the manual installation steps fo
2. Open a new terminal window and run the following command to create a folder and download the OpenOps release files:
```shell
mkdir -p openops && cd openops && \
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.18/openops-dc-0.6.18.zip && \
unzip openops-dc-0.6.18.zip && cp -n .env.defaults .env
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.19/openops-dc-0.6.19.zip && \
unzip openops-dc-0.6.19.zip && cp -n .env.defaults .env
```
3. <UpdateCredentials/>
4. Pull the images and run `docker compose`:
Expand All @@ -55,13 +55,13 @@ You can now access the application by navigating to http://localhost.
# create and change directory
mkdir -p openops && cd openops
# download the release file
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.18/openops-dc-0.6.18.zip
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.19/openops-dc-0.6.19.zip
# refresh package lists
sudo apt update
# install unzip
sudo apt install unzip
# decompress release file
unzip openops-dc-0.6.18.zip
unzip openops-dc-0.6.19.zip
# copy the defaults to env without overwriting existing files
cp --update=none .env.defaults .env
```
Expand Down Expand Up @@ -100,8 +100,8 @@ You can now access the application by navigating to http://localhost.
```
3. Download the OpenOps release files:
```powershell
Invoke-WebRequest -Uri "https://github.com/openops-cloud/openops/releases/download/0.6.18/openops-dc-0.6.18.zip"
Expand-Archive -Path "openops-dc-0.6.18.zip" -DestinationPath .
Invoke-WebRequest -Uri "https://github.com/openops-cloud/openops/releases/download/0.6.19/openops-dc-0.6.19.zip"
Expand-Archive -Path "openops-dc-0.6.19.zip" -DestinationPath .
if (-Not (Test-Path ".env")) {
Copy-Item ".env.defaults" ".env"
}
Expand Down
4 changes: 2 additions & 2 deletions getting-started/updating-openops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The script will stop all running containers, pull the latest images, and restart
```
4. Download and extract the new version:
```shell
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.18/openops-dc-0.6.18.zip && \
unzip -o openops-dc-0.6.18.zip
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.19/openops-dc-0.6.19.zip && \
unzip -o openops-dc-0.6.19.zip
```
(This code sample refers to a specific version. Don't forget to update it to the version you're installing.)
5. Fetch the new images and restart the application:
Expand Down
15 changes: 14 additions & 1 deletion getting-started/user-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,14 @@ Content-Type: application/json
}
```

This call will return a JSON object that contains a property called `token`. Copy the value of this property and use it in the authorization header in the next call. This next call actually creates a new user account. Before making the call, in the body, don't forget to specify actual values for the four properties that are left empty in the sample below:
This call returns a JSON object that contains a property called `token`.

Use that token in one of the following ways:

- Send it in the `Authorization` header as `Bearer <token>`.
- Send it as a cookie named `token`.

The next call creates a new user account. Before making the call, in the body, don't forget to specify actual values for the four properties that are left empty in the sample below:

```
POST http://your-openops-installation/api/v1/authentication/sign-up
Expand All @@ -45,3 +52,9 @@ Content-Type: application/json
```

The user account that you create this way will be able to perform all operations in OpenOps except for creating new user accounts. Every time you do that, you'll still need an admin token.

## Viewing the OpenAPI UI

OpenOps serves a Swagger UI at:

- `http://your-openops-installation/api/v1/openapi`
32 changes: 32 additions & 0 deletions workflow-management/finops-benchmarks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: 'FinOps Benchmarks'
description: 'Run a FinOps benchmark and understand the benchmark wizard flow'
icon: 'gauge'
---

## Overview

OpenOps includes a benchmark flow that is represented in the API as a multi-step wizard.

At the API level, the wizard request can include:

* `currentStep` (optional)
* `benchmarkConfiguration` (optional)

Wizard steps returned by the API include:

* `currentStep`
* `title`
* `description` (optional)
* `nextStep` (string or `null`)
* `selectionType` (`single` or `multi-select`)
* `options` (each option includes `id`, `displayName`, and optional `imageLogoUrl` and `metadata`)
* `stepIndex`
* `totalSteps`

When a benchmark run is initiated, the API returns an `orchestratorRunId`.

## Related documentation

* [Workflow templates](./workflow-templates.mdx)
* [Building workflows](./building-workflows.mdx)