Orbis

Orbis is a comprehensive toolkit developed by the Astronomer RDC Team for customer success operations. It provides deployment reporting, resource analysis, and diagnostic capabilities for Astronomer Software deployments.

Key Features

• Report Generation: Comprehensive deployment metrics analysis and resource utilization tracking

  • Multiple Output Formats: DOCX reports, JSON data, and CSV exports

• Diagnostic Scanner: Curates comprehensive diagnostic packages - the critical deliverable for accelerating Astronomer support engagement

  • Telescope Integration: Advanced Airflow diagnostics
  • Custom Resource Support: Custom resource allocation support

• Docker-based Deployment: Easy setup and consistent behavior across environments

Quick Start with Docker (Recommended)

For Report Generation

1. Create a .env file with your configuration:

   ASTRO_SOFTWARE_API_TOKEN=your_token_here
   

Warning

Please use SYSTEM_ADMIN level token otherwise Orbis won't be able to query Prometheus and will result in empty metrics. Ref

1. Run Orbis using Docker:

   docker run --pull always --rm -it \
     --env-file .env \
     -v $(pwd)/output:/app/output \
     quay.io/astronomer/orbis:0.8.0 orbis compute-software \
     -s START_DATE \
     -e END_DATE \
     -b BASE_DOMAIN \
     [-v] [-w WORKSPACES] [-z] [-r] [-p]
   

For Diagnostic Scanner

Create support bundle for troubleshooting:

docker run --pull always --rm -it \
  -v $(pwd)/output:/app/output \
  quay.io/astronomer/orbis:0.8.0 orbis scanner create \
  -n astronomer --image quay.io/astronomer/orbis-scanner:0.8.0

Documentation Sections

• Installation
• Usage
  • Software Reports - Report generation
  • Software Diagnostics - Scanner support bundles
• Modules
  • API
    • Houston
    • Prometheus
  • Report
    • Generator
    • Visualizer
    • CSV Generator
  • Data Models
• Reports

Support

For support, please contact success@astronomer.io