Skip to content

Documentation Update: 0.6.14 #292

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.

Sign up for GitHub

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
sg-doc-holiday wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Documentation Update: 0.6.14 #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5b8428
getting-started: update local.mdx
sg-doc-holiday[bot] Jan 15, 2026
fa43590
getting-started: update local.mdx
sg-doc-holiday[bot] Jan 15, 2026
525aa9f
getting-started: update local.mdx
sg-doc-holiday[bot] Jan 15, 2026
722d57a
reporting-analytics: update analytics.mdx
sg-doc-holiday[bot] Jan 15, 2026
31db569
getting-started: update local.mdx
sg-doc-holiday[bot] Jan 15, 2026
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,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.13/openops-dc-0.6.13.zip && \
unzip openops-dc-0.6.13.zip && cp -n .env.defaults .env
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.14/openops-dc-0.6.14.zip && \
unzip openops-dc-0.6.14.zip && cp -n .env.defaults .env
```
3. <UpdateCredentials/>
4. Pull the images and run `docker compose`:
Expand All @@ -54,13 +54,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.13/openops-dc-0.6.13.zip
curl -OL https://github.com/openops-cloud/openops/releases/download/0.6.14/openops-dc-0.6.14.zip
# refresh package lists
sudo apt update
# install unzip
sudo apt install unzip
# decompress release file
unzip openops-dc-0.6.13.zip
unzip openops-dc-0.6.14.zip
# copy the defaults to env without overwriting existing files
cp --update=none .env.defaults .env
```
Expand Down Expand Up @@ -99,8 +99,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.13/openops-dc-0.6.13.zip"
Expand-Archive -Path "openops-dc-0.6.13.zip" -DestinationPath .
Invoke-WebRequest -Uri "https://github.com/openops-cloud/openops/releases/download/0.6.14/openops-dc-0.6.14.zip"
Expand-Archive -Path "openops-dc-0.6.14.zip" -DestinationPath .
if (-Not (Test-Path ".env")) {
Copy-Item ".env.defaults" ".env"
}
Expand Down
64 changes: 64 additions & 0 deletions reporting-analytics/analytics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@ You can visualize data that you collect with [OpenOps tables](/reporting-analyti

In addition to OpenOps tables, OpenOps Analytics can connect to and visualize your existing data sources, such as CSV files, Google Sheets, Postgres databases, and more.

## Prerequisites

* OpenOps Analytics must be enabled and reachable from the OpenOps application (for example, via `OPS_ANALYTICS_PUBLIC_URL` and `OPS_ANALYTICS_PRIVATE_URL` in your `.env` file).
* Your OpenOps user must have permission to access Analytics in your OpenOps instance.

## Analytics admin portal

To configure data visualizations, click **Analytics** on the main navigation bar in OpenOps. When the **Analytics** view opens, click **Admin Panel** to proceed to the Analytics admin portal that is separate from the main OpenOps application.
Expand Down Expand Up @@ -71,3 +76,62 @@ To upload CSV files into your database, click **+** in the top right corner, the
You can now build charts based on the data from your external data source, similar to how you do it with OpenOps tables. When you add charts to the **FinOps** dashboard, they become available in the **Analytics** view in OpenOps.

<JoinCommunity/>

To configure data visualizations, click **Analytics** on the main navigation bar in OpenOps. When the **Analytics** view opens, click **Admin Panel** to proceed to the Analytics admin portal that is separate from the main OpenOps application.

To sign in to the Analytics portal, use `admin` as the username and the password defined with the `OPS_ANALYTICS_ADMIN_PASSWORD` variable in the `.env` file in your OpenOps installation folder. (If you haven’t changed the password, the default is `please-change-this-password-1`.)

<Note>
If you don't have access to the OpenOps installation folder:
* Contact your OpenOps instance administrator if you're using a self-managed OpenOps instance.
* [Contact OpenOps support](mailto:[email protected]) if you're using an OpenOps-hosted instance.
</Note>

Once you log in, you can see a built-in dashboard called **FinOps**. Modifying this dashboard will affect the **Analytics** tab in OpenOps.

![Built-in dashboards in the analytics portal](/images/analytics-builtin-dashboards.png)

Behind every OpenOps table, there is a Postgres database view that can be used to build charts and queries.

When a new table is created in [OpenOps tables](/reporting-analytics/tables/), the system automatically creates a new database view with the naming convention _table name \_ table id \_ userfriendly_. You can use this view to create dashboards in OpenOps, as well as connect it to other BI systems.

## Building new charts

To configure a new chart based on an OpenOps table to display in the **Analytics** view in OpenOps, do the following:

1. Navigate to **Datasets** and click **+ Dataset**:
![Creating a dataset](/images/analytics-create-dataset.png)
2. Select `openops_tables_connection` for **Database** and `public` for **Schema**. In the **Table** dropdown, select a Postgres DB view corresponding to the OpenOps table you want to source data from. For example, here is what a view may be named for the *Opportunities* table:
<NarrowImage src="/images/analytics-new-dataset.png" alt="New dataset" />
3. Click **Create dataset and create chart**.
4. In the **Create a new chart** view, select a chart type, then click **Create new chart**:
![Selecting a chart type](/images/analytics-select-chart-type.png)
5. Configure your chart. Refer to [this Superset documentation page](https://superset.apache.org/docs/using-superset/creating-your-first-dashboard#creating-charts-in-explore-view) if you need help. To preview the configured chart, click **Create chart** in the right pane.
![Chart preview](/images/analytics-chart-preview.png)
6. If you make further changes to the chart, click **Update chart** to refresh the preview.
7. When you're done, click **Save**. In the **Save chart** dialog, select **FinOps** in the **Add to dashboard** dropdown:
<NarrowImage src="/images/analytics-save-chart.png" alt="Saving a chart" />
8. Click **Save**. When you go back to the **Analytics** view in OpenOps, you can see that the chart is now displayed there:
![Chart in OpenOps Analytics](/images/analytics-chart-in-openops.png)

For more information on how to create charts, see the [Superset documentation](https://superset.apache.org/docs/intro/).

## Connecting to external data sources

Here's what you can do to connect OpenOps Analytics to external data sources such as CSV files:

1. In the Analytics admin portal, in the top right corner, click **Settings**, then **Database Connections**.
<NarrowImage src="/images/analytics-external-menu.png" alt="Database connections settings" widthPercent={40} />
2. Click **+ Database** to connect to an external data source, such as your own Postgres instance or Google Sheets.
3. Once you have created a database connection, if you’d like to upload CSVs to it, click the **Edit** icon for the database connection:
![Editing a database connection](/images/analytics-edit-db-connection.png)
4. In the popup that displays, go to **Advanced > Security**, scroll down, and enable **Allow file uploads to database**.
<NarrowImage src="/images/analytics-database-allow-file-uploads.png" alt="Allowing file uploads" widthPercent={60} />
5. Click **Finish**.

To upload CSV files into your database, click **+** in the top right corner, then select **Data > Upload CSV to database**:
<NarrowImage src="/images/analytics-upload-csv-to-db.png" alt="Uploading CSV into a database" widthPercent={65} />

You can now build charts based on the data from your external data source, similar to how you do it with OpenOps tables. When you add charts to the **FinOps** dashboard, they become available in the **Analytics** view in OpenOps.

<JoinCommunity/>