# yupiik/bundlebee architecture

> Architecture diagram of the GitHub repository yupiik/bundlebee, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yupiik/bundlebee
- Repository: https://github.com/yupiik/bundlebee

## Overview

##### Main Components

a. Core Components:
- BundleBee Core (bundlebee-core)
- Operator Component (bundlebee-operator)
- Maven Plugin (bundlebee-maven-plugin)
- JUnit5 Integration (bundlebee-junit5)
- Documentation Generator (bundlebee-documentation)

b. Alveoli Components (Pre-packaged Kubernetes Resources):
- Elasticsearch Local
- Grafana Simple
- Kafka Local
- Loki Simple
- MinIO Local
- PostgreSQL Local
- Prometheus Simple
- Zipkin Simple
- Monitoring Alveolus

##### Component Relationships

**[Core Components Layer]**

- BundleBee Core |<----| Maven Plugin    |     | JUnit5          |
- Integration     |
- ^                                       +------------------+
- ^
- v                                              |

- Operator      |                                   |

- ^                                            |

- v                                            |
**[Kubernetes Integration Layer]                        |**

- Kubernetes API |<---------------------------------+

- ^

- v
**[Alveoli Layer]**

- Database Alveoli |     | Monitoring      |     | Tracing         |
- (Postgres/ES)    |     | (Prometheus/    |     | (Zipkin)        |
- Grafana)       |     +------------------+

##### Important Elements to Highlight

a. Core Functionality:
- Command processing
- Kubernetes manifest handling
- Template processing
- Configuration management

b. Integration Points:
- Maven build system integration
- Kubernetes API interaction
- Testing framework integration
- Operator pattern support

##### Additional Details

Annotations for:
- Configuration sources
- Resource types handled
- Main command flows
- Extension points

##### The integration capabilities with build tools and testing frameworks

Keep the abstraction level focused on the main architectural components while showing enough detail to understand the system's structure and interactions.

This design reflects a Kubernetes-native application with strong integration capabilities and a modular approach to resource management through its Alveoli system.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Core Components Layer
    subgraph Core
        BundleCore["BundleBee Core"]:::core
        Operator["Operator Component"]:::core
        Maven["Maven Plugin"]:::core
        JUnit["JUnit5 Integration"]:::core
        DocGen["Documentation Generator"]:::core
    end

    %% Kubernetes Integration Layer
    subgraph KubeLayer
        KubeAPI["Kubernetes API"]:::kube
    end

    %% Alveoli Layer
    subgraph Alveoli
        subgraph Databases
            ES["Elasticsearch Local"]:::alveoli
            Postgres["PostgreSQL Local"]:::alveoli
            Minio["MinIO Local"]:::alveoli
        end

        subgraph Monitoring
            Prometheus["Prometheus Simple"]:::alveoli
            Grafana["Grafana Simple"]:::alveoli
            Loki["Loki Simple"]:::alveoli
        end

        subgraph Messaging
            Kafka["Kafka Local"]:::alveoli
            Zipkin["Zipkin Simple"]:::alveoli
        end

        MonAlveolus["Monitoring Alveolus"]:::alveoli
    end

    %% Relationships
    Maven --> BundleCore
    BundleCore <--> Operator
    JUnit --> KubeAPI
    BundleCore --> KubeAPI
    Operator <--> KubeAPI
    KubeAPI --> Databases
    KubeAPI --> Monitoring
    KubeAPI --> Messaging
    DocGen --> BundleCore

    %% Click Events
    click BundleCore "https://github.com/yupiik/bundlebee/tree/master/bundlebee-core"
    click Operator "https://github.com/yupiik/bundlebee/tree/master/bundlebee-operator"
    click Maven "https://github.com/yupiik/bundlebee/tree/master/bundlebee-maven-plugin"
    click JUnit "https://github.com/yupiik/bundlebee/tree/master/bundlebee-junit5"
    click DocGen "https://github.com/yupiik/bundlebee/tree/master/bundlebee-documentation"
    click ES "https://github.com/yupiik/bundlebee/tree/master/alveolus/elasticsearch-local"
    click Grafana "https://github.com/yupiik/bundlebee/tree/master/alveolus/grafana-simple"
    click Kafka "https://github.com/yupiik/bundlebee/tree/master/alveolus/kafka-local"
    click Loki "https://github.com/yupiik/bundlebee/tree/master/alveolus/loki-simple"
    click Minio "https://github.com/yupiik/bundlebee/tree/master/alveolus/minio-local"
    click Postgres "https://github.com/yupiik/bundlebee/tree/master/alveolus/postgres-local"
    click Prometheus "https://github.com/yupiik/bundlebee/tree/master/alveolus/prometheus-simple"
    click Zipkin "https://github.com/yupiik/bundlebee/tree/master/alveolus/zipkin-simple"
    click MonAlveolus "https://github.com/yupiik/bundlebee/tree/master/alveolus/monitoring-alveolus"

    %% Styling
    classDef core fill:#2374ab,stroke:#000,stroke-width:2px,color:#fff
    classDef kube fill:#57a773,stroke:#000,stroke-width:2px,color:#fff
    classDef alveoli fill:#ff8c42,stroke:#000,stroke-width:2px,color:#fff

    %% Legend
    subgraph Legend
        CoreComp["Core Component"]:::core
        KubeComp["Kubernetes Integration"]:::kube
        AlvComp["Alveoli Component"]:::alveoli
    end
```
