astronomer-orbis 0.9.0

A tool for generating astronomer software deployment compute reports

Orbis

Orbis is a deployment compute report generator tool developed by RDC Team. It analyzes data from Prometheus to provide insights into deployment metrics and resource utilization for Astronomer Software platforms.

Docs

• Internal Docs : https://potential-waffle-pl91nlj.pages.github.io/
• External Docs : https://astronomer.github.io/orbis-docs/

Features

• Generates comprehensive deployment compute reports
• Analyzes CPU, memory, and pod count metrics
• Supports both Kubernetes and Celery executors
• Creates visualizations for easy data interpretation
• Exports reports in DOCX, JSON, and CSV formats
• Supports resume functionality for interrupted report generation
• Diagnostic scanner for collecting cluster support bundles
• APC 1.x multi-cluster CP/DP support with topology discovery, incremental collection, and auto-merge
• Session-based resume workflow for collecting across separate cloud accounts

Flow Diagram

Installation

To install Orbis, follow these steps:

1. Download the distributions from Releases

2. Create and activate a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows, use `venv\Scripts\activate`
   

3. Install the package:

   pip install orbis-0.4.0-py3-none-any.whl
   

Configuration

Before running Orbis reporting, generate a system admin API token and export it as ASTRO_SOFTWARE_API_TOKEN.

export ASTRO_SOFTWARE_API_TOKEN=<your-token>

Reporting

Run reporting with a local Orbis install:

orbis reporting \
  -s <start-date> -e <end-date> \
  -b <base-domain> \
  --version <platform-version> -vvv -r -p -z

Run reporting with Podman:

podman run --rm -it \
  -e ASTRO_SOFTWARE_API_TOKEN=<your-token> \
  -v $(pwd)/output:/app/output \
  quay.io/astronomer/orbis:<orbis-version> \
  reporting \
  -s <start-date> -e <end-date> \
  -b <base-domain> \
  --version <platform-version> -vvv -r -p -z

Scanner

Run scanner with a local Orbis install:

orbis scanner create \
  -n <platform-namespace> \
  --kubeconfig <path-to-unified-kubeconfig> \
  -d <base-domain> \
  --image quay.io/astronomer/orbis:<orbis-version> \
  --log-level debug \
  --no-cleanup

Run scanner with Podman:

podman run --rm -it \
  -v ~/path/to/unified-kubeconfig:/kubeconfigs/unified_kubeconfig:ro \
  -v $(pwd)/output:/app/output \
  -v ~/.aws:/home/nonroot/.aws:ro \
  -e AWS_PROFILE \
  quay.io/astronomer/orbis:<orbis-version> \
  scanner create \
  -n <platform-namespace> \
  --kubeconfig /kubeconfigs/unified_kubeconfig \
  -d <base-domain> \
  --image quay.io/astronomer/orbis:<orbis-version> \
  --log-level debug \
  --no-cleanup

See docs/reporting/generate-report.md and docs/scanner/create-support-bundle.md for the full command list.

Output

Orbis generates:

1. A comprehensive deployment compute report in DOCX format
2. A JSON report for automation purposes
3. A CSV report for automation purposes

Development

To set up the development environment:

1. Clone the repository

2. Install development dependencies:

   pip install -e ".[dev]"
   

3. Install pre-commit hooks:

   pre-commit install
   

4. Run tests:

   pytest tests/
   

Debugging

Create a .vscode folder and add launch.json file with the following contents:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Orbis",
            "type": "debugpy",
            "request": "launch",
            "module": "orbis.cli",
            "console": "integratedTerminal",
            "args": [
                "sizing",
                "-o",
                "<org_id>",
                "-s",
                "2024-07-03",
                "-e",
                "2024-07-04"
            ]
        }
    ]
}

Using pre-commit

Pre-commit is used to maintain code quality. Here's how to use it:

1. Run pre-commit on all files:

   pre-commit run --all-files
   

2. Run pre-commit on staged files:

   pre-commit run
   

3. Run a specific hook:

   pre-commit run <hook_id>
   

   Replace <hook_id> with the ID of the specific hook you want to run (e.g., ruff).

4. To bypass pre-commit hooks when committing:

   git commit -m "Your commit message" --no-verify
   

Pre-commit will run automatically before each commit once the hooks are installed.