From 09034cef86b837ebb65130499a5fa244485553e1 Mon Sep 17 00:00:00 2001 From: "sg-doc-holiday[bot]" <219201796+sg-doc-holiday[bot]@users.noreply.github.com> Date: Wed, 18 Feb 2026 09:41:55 +0000 Subject: [PATCH 1/5] update update guide to 0.6.19 sample --- getting-started/updating-openops.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/getting-started/updating-openops.mdx b/getting-started/updating-openops.mdx index b2aabe9..25257d2 100644 --- a/getting-started/updating-openops.mdx +++ b/getting-started/updating-openops.mdx @@ -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: From a7609b4a687d69dec15a93f06ecc5c19ef1bd289 Mon Sep 17 00:00:00 2001 From: "sg-doc-holiday[bot]" <219201796+sg-doc-holiday[bot]@users.noreply.github.com> Date: Wed, 18 Feb 2026 09:42:09 +0000 Subject: [PATCH 2/5] clarify auth and openapi access patterns --- getting-started/user-management.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/getting-started/user-management.mdx b/getting-started/user-management.mdx index b7c7685..48b72dc 100644 --- a/getting-started/user-management.mdx +++ b/getting-started/user-management.mdx @@ -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 `. +- 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 @@ -45,3 +52,11 @@ 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` + +This route is configured to skip authentication. From fb27b17de57ac89d4c16a2ea6c3e89e8ae294dd4 Mon Sep 17 00:00:00 2001 From: "sg-doc-holiday[bot]" <219201796+sg-doc-holiday[bot]@users.noreply.github.com> Date: Wed, 18 Feb 2026 09:42:37 +0000 Subject: [PATCH 3/5] remove unverified skipauth claim --- getting-started/user-management.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/getting-started/user-management.mdx b/getting-started/user-management.mdx index 48b72dc..e23ddf2 100644 --- a/getting-started/user-management.mdx +++ b/getting-started/user-management.mdx @@ -58,5 +58,3 @@ The user account that you create this way will be able to perform all operations OpenOps serves a Swagger UI at: - `http://your-openops-installation/api/v1/openapi` - -This route is configured to skip authentication. From 4e7386ea7fbb1a61a7378169c18df9ed4a4367de Mon Sep 17 00:00:00 2001 From: "sg-doc-holiday[bot]" <219201796+sg-doc-holiday[bot]@users.noreply.github.com> Date: Wed, 18 Feb 2026 09:48:11 +0000 Subject: [PATCH 4/5] update local deployment version references --- getting-started/deployment/local.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/getting-started/deployment/local.mdx b/getting-started/deployment/local.mdx index 864ce44..63e18fe 100644 --- a/getting-started/deployment/local.mdx +++ b/getting-started/deployment/local.mdx @@ -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. 4. Pull the images and run `docker compose`: @@ -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 ``` @@ -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" } From 6ce613a93ed066e3883a448d8cac09b258104f85 Mon Sep 17 00:00:00 2001 From: "sg-doc-holiday[bot]" <219201796+sg-doc-holiday[bot]@users.noreply.github.com> Date: Wed, 18 Feb 2026 09:51:53 +0000 Subject: [PATCH 5/5] add placeholder finops benchmark page --- workflow-management/finops-benchmarks.mdx | 32 +++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 workflow-management/finops-benchmarks.mdx diff --git a/workflow-management/finops-benchmarks.mdx b/workflow-management/finops-benchmarks.mdx new file mode 100644 index 0000000..99b298e --- /dev/null +++ b/workflow-management/finops-benchmarks.mdx @@ -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)