# reschandreas/aeolus architecture

> Architecture diagram of the GitHub repository reschandreas/aeolus, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/reschandreas/aeolus
- Repository: https://github.com/reschandreas/aeolus

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef processing fill:#2ecc71,stroke:#27ae60,color:white
    classDef generator fill:#e67e22,stroke:#d35400,color:white
    classDef external fill:#9b59b6,stroke:#8e44ad,color:white
    classDef config fill:#95a5a6,stroke:#7f8c8d,color:black
    classDef docker fill:#34495e,stroke:#2c3e50,color:white

    %% User Interface Layer
    subgraph UI
        CLI["CLI Interface"]:::ui
        PLAY["Web Playground"]:::ui
    end

    %% Input Layer
    subgraph Input
        WIND["Windfiles (YAML)"]:::config
        ACT["Actionfiles (YAML)"]:::config
    end

    %% Processing Layer
    subgraph Processing
        PARSER["Parser"]:::processing
        VAL["Validator"]:::processing
        API["API Service"]:::processing
    end

    %% Generator Layer
    subgraph Generators
        CLIGEN["CLI Generator"]:::generator
        JENGEN["Jenkins Generator"]:::generator
        BAMGEN["Bamboo Generator"]:::generator
    end

    %% Docker Layer
    subgraph Docker
        APIDOCK["API Docker"]:::docker
        CLIDOCK["CLI Docker"]:::docker
        PLAYDOCK["Playground Docker"]:::docker
        BAMDOCK["Bamboo Generator Docker"]:::docker
    end

    %% Output Layer
    subgraph Output
        BASH["Bash Scripts"]:::config
        JENKINS["Jenkinsfile"]:::config
        BAMBOO["Bamboo YAML"]:::config
    end

    %% External Systems
    subgraph CI_Systems
        JENKINS_CI["Jenkins"]:::external
        BAMBOO_CI["Bamboo"]:::external
    end

    %% Relationships
    WIND --> PARSER
    ACT --> PARSER
    CLI --> PARSER
    PLAY --> API
    API --> PARSER
    PARSER --> VAL
    VAL --> CLIGEN & JENGEN & BAMGEN
    CLIGEN --> BASH
    JENGEN --> JENKINS
    BAMGEN --> BAMBOO
    JENKINS --> JENKINS_CI
    BAMBOO --> BAMBOO_CI

    %% Docker Connections
    API --- APIDOCK
    CLI --- CLIDOCK
    PLAY --- PLAYDOCK
    BAMGEN --- BAMDOCK

    %% Click Events
    click CLI "https://github.com/reschandreas/aeolus/blob/develop/cli/main.py"
    click PLAY "https://github.com/reschandreas/aeolus/blob/develop/playground/src/playground/Playground.tsx"
    click API "https://github.com/reschandreas/aeolus/blob/develop/api/main.py"
    click BAMGEN "https://github.com/reschandreas/aeolus/blob/develop/bamboo-generator/src/main/java/de/tum/cit/ase/generator/Generator.java"
    click VAL "https://github.com/reschandreas/aeolus/blob/develop/cli/classes/validator.py"
    click WIND "https://github.com/reschandreas/aeolus/tree/develop/cli/examples/windfiles"
    click ACT "https://github.com/reschandreas/aeolus/tree/develop/cli/examples/actions"
    click CLIGEN "https://github.com/reschandreas/aeolus/blob/develop/cli/generators/cli.py"
    click JENGEN "https://github.com/reschandreas/aeolus/blob/develop/cli/generators/jenkins.py"
    click APIDOCK "https://github.com/reschandreas/aeolus/tree/develop/docker/api"
    click CLIDOCK "https://github.com/reschandreas/aeolus/tree/develop/docker/cli"
    click PLAYDOCK "https://github.com/reschandreas/aeolus/tree/develop/docker/playground"
    click BAMDOCK "https://github.com/reschandreas/aeolus/tree/develop/docker/bamboo-generator"

    %% Legend
    subgraph Legend
        UI_L["User Interface"]:::ui
        PROC_L["Processing"]:::processing
        GEN_L["Generator"]:::generator
        EXT_L["External System"]:::external
        CONF_L["Configuration"]:::config
        DOCK_L["Docker Container"]:::docker
    end
```
