How reschandreas/aeolus works
Main Components Overview
a) Core Components:
• CLI Tool (Primary interface)
• API Service
• Bamboo Generator
• Playground (Web Interface)
• Worker Service
b) Input/Output Components:
• Input: Windfiles (YAML)
• Input: Actionfiles (YAML)
• Output: Generated CI Configurations (CLI/Bash, Jenkins, Bamboo)
┌─ User Interface Layer ─────────────────────┐
• Web Playground (React) │
• CLI Interface │
• ┬───────────────────────┘
• ↓
┌─ Processing Layer ──────────────────────────┐
• ┌─ Parser ─────┐ ┌─ Validator ──────┐ │
• YAML │ │ - Schema │ │
• JSON │ │ - Syntax │ │
• ┘ └─────────────────┘ │
• ┌─ Generator ──────────────────────────┐ │
• CLI Generator │ │
• Jenkins Generator │ │
• Bamboo Generator │ │
• ┘ │
• ┬───────────────────────┘
• ↓
┌─ Output Layer ────────────────────────────┐
• Bash Scripts │
• Jenkinsfile │
• Bamboo YAML Specs │
• ┘
Key Relationships to Highlight
• Input Flow:
• How Windfiles and Actionfiles are processed through the system
• Validation steps and schema checking
• How the playground and CLI interface feed into the processing layer
• Generation Flow:
• Demonstrate how the parsed input is transformed into different target formats
• Relationship between generators and their respective output formats
• Integration Points:
• Connections to external CI systems (Bamboo, Jenkins)
• Where Docker configurations are applied
• How the API service interfaces with other components
Additional Elements
• Version information (api: v0.0.1)
• Where environment variables are processed
• Error handling paths
Technical Details
• File formats (YAML, JSON, Groovy, Shell)
• Docker container integration points
• API endpoints and their purposes
• Schema validation points
• Configuration storage and processing