Skip to content

Commit

Permalink
update incorrect info
Browse files Browse the repository at this point in the history
  • Loading branch information
abhishekbhakat committed Dec 12, 2024
1 parent 4369eb0 commit c781cd3
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 21 deletions.
30 changes: 16 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,22 @@ Orbis is a deployment compute report generator tool that analyzes data from Astr

## Quick Start with Docker (Recommended)


```bash
# Pull the latest version
docker pull quay.io/astronomer/orbis:0.5.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 \
-s START_DATE \
-e END_DATE \
-o ORGANIZATION_ID
```
1. Create a `.env` file with your configuration:
```env
ASTRO_SOFTWARE_API_TOKEN=your_token_here
```

2. Run Orbis using Docker:
```bash
docker run --pull always --rm -it \
--env-file .env \
-v $(pwd)/output:/app/output \
quay.io/astronomer/orbis:0.5.0 orbis compute-software \
-s START_DATE \
-e END_DATE \
-o ORGANIZATION_ID \
[-v] [-w WORKSPACES] [-z] [-r] [-p]
```

## Documentation Sections

Expand Down
6 changes: 1 addition & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@

## 1. Docker (Recommended)

!!! note

Docker images are currently in beta.


The recommended way to run Orbis is using Docker. This ensures consistent behavior across different environments and simplifies the setup process.

Expand All @@ -24,7 +20,7 @@ docker pull quay.io/astronomer/orbis:0.5.0
Create a `.env` file with your configuration:

```
HOUSTON_API_TOKEN=your_token_here
ASTRO_SOFTWARE_API_TOKEN=your_token_here
ORG_ID=your_org_id
```

Expand Down
4 changes: 2 additions & 2 deletions docs/usage/software_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide explains how to use Orbis to generate compute reports for Astronomer

1. Create a `.env` file with your configuration:
```env
HOUSTON_API_TOKEN=your_token_here
ASTRO_SOFTWARE_API_TOKEN=your_token_here
```

2. Run Orbis using Docker:
Expand All @@ -35,7 +35,7 @@ This guide explains how to use Orbis to generate compute reports for Astronomer
1. Create a `.env` file with your configuration:
```env
HOUSTON_API_TOKEN=your_token_here
ASTRO_SOFTWARE_API_TOKEN=your_token_here
```

2. Run Orbis using the Orbis CLI:
Expand Down

0 comments on commit c781cd3

Please sign in to comment.