Skip to content

Commit

Permalink
0.6.0 update
Browse files Browse the repository at this point in the history
  • Loading branch information
abhishekbhakat committed Feb 7, 2025
1 parent 3fcb4cb commit c4ec083
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ assignees: ''

## Orbis Version
<!-- Please specify the version of Orbis you're using -->
- Version: [e.g. 0.5.0]
- Version: [e.g. 0.6.0]

## What Happened
<!-- A clear and concise description of what happened -->
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ Orbis is a reporting tool designed for Astronomer Software that provides detaile

```bash
# Pull the latest version
docker pull quay.io/astronomer/orbis:0.5.0
docker pull quay.io/astronomer/orbis:0.6.0

# Run with environment variables
docker run --pull always --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
quay.io/astronomer/orbis:0.6.0 orbis compute-software \
-s START_DATE \
-e END_DATE \
-o ORGANIZATION_ID
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Orbis is a deployment compute report generator tool that analyzes data from Astr
docker run --pull always --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
quay.io/astronomer/orbis:0.6.0 orbis compute-software \
-s START_DATE \
-e END_DATE \
-o ORGANIZATION_ID \
Expand Down
5 changes: 3 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ The recommended way to run Orbis is using Docker. This ensures consistent behavi

1. Install [Docker](https://docs.docker.com/get-docker/)
2. Ensure you have a valid Houston API token (with `SYSTEM_ADMIN` role) for authentication
(_If only 1 workspace is specified, then you can use `WORKSPACE_ADMIN` token instead_)

### Docker Setup

```bash
# Pull the latest version
docker pull quay.io/astronomer/orbis:0.5.0
docker pull quay.io/astronomer/orbis:0.6.0
```

Create a `.env` file with your configuration:
Expand Down Expand Up @@ -46,7 +47,7 @@ Please contact your Astronomer representative to obtain the appropriate binary f

After installation, you'll need to configure Orbis with your credentials. You will need:

1. A valid Houston API token (with `SYSTEM_ADMIN` role)
1. A valid Houston API token (with `SYSTEM_ADMIN` role) (Or `WORKSPACE_ADMIN` token if only 1 workspace is specified)
2. Your Organization ID
3. The reporting period (start and end dates)

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/report/generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The Report Generator module is responsible for creating comprehensive deployment

This function orchestrates the entire report generation process:

1. Fetches data from Chronosphere for specified metrics and namespaces using `get_data_from_chronosphere_and_plot`.
1. Fetches data from Chronosphere for specified metrics and namespaces using `get_metrics_data_and_plot`.
2. Processes data and generates visualizations (figures) for each metric.
3. Creates an overall report structure containing detailed information for each namespace.
4. Generates a Word document report using the `ReportGenerator` class.
Expand Down
2 changes: 1 addition & 1 deletion docs/reports.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,6 @@ Reports are generated in the `output` directory when using Docker:
docker run --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
quay.io/astronomer/orbis:0.6.0 orbis compute-software \
-s START_DATE -e END_DATE -o ORGANIZATION_ID
```
6 changes: 3 additions & 3 deletions docs/usage/software_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This guide explains how to use Orbis to generate compute reports for Astronomer
## Prerequisites

1. Docker installed (recommended)
2. Houston API token with SYSTEM_ADMIN role
2. Houston API token with SYSTEM_ADMIN role (or WORKSPACE_ADMIN role if only 1 workspace is specified)
3. Organization domain for Astronomer Software
4. Start and end dates for the report period

Expand All @@ -22,7 +22,7 @@ This guide explains how to use Orbis to generate compute reports for Astronomer
docker run --pull always --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
quay.io/astronomer/orbis:0.6.0 orbis compute-software \
-s START_DATE \
-e END_DATE \
-o ORGANIZATION_ID \
Expand Down Expand Up @@ -108,7 +108,7 @@ This guide explains how to use Orbis to generate compute reports for Astronomer
docker run --pull always --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
quay.io/astronomer/orbis:0.6.0 orbis compute-software \
-s 2024-01-01 \
-e 2024-01-31 \
-o org-abcd1234 \
Expand Down

0 comments on commit c4ec083

Please sign in to comment.