# anshchoudhary/quick-kube architecture

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

- Interactive diagram: https://gitdiagram.com/anshchoudhary/quick-kube
- Repository: https://github.com/anshchoudhary/quick-kube

## Overview

##### Main components
- User / CLI Layer
– src/main.py (entry point)
– scripts/setup.sh (environment bootstrap)
– examples/sample_apps/docker-compose.yml (input)
- AI Agent Layer (pipeline steps)
– Analysis Agent
– Conversion Agent (Kompose orchestration)
– Helm Agent (chart generation)
– Terraform Agent (GKE provisioning)
– Deployment Agent (final deploy + monitoring)
- Conversion & Generation Tools
– Kompose (Docker → Kubernetes manifests)
– Helm (chart templating & packaging)
– Terraform (GKE infra as code)
- Outputs / Artifacts
– Kubernetes manifests (output/kubernetes/)
– Helm charts (output/helm/quick-kube-app/)
– Terraform configs (templates/terraform or inline)
- Target Cloud Environment
– Google Kubernetes Engine (GKE)
– Kubernetes API (kubectl)
- External Services
– AI Providers (OpenAI GPT, Anthropic Claude, Google Gemini)
– Google Cloud SDK

##### Relationships and data flows
- User invokes CLI with a Docker-Compose file
└▶ Orchestrator (src/ai_agents/orchestrator.py)
- Orchestrator calls in sequence:
1. Analysis Agent → inspects containers, decides strategy
2. Conversion Agent → invokes Kompose → produces raw K8s manifests
3. Helm Agent → consumes manifests + templates → emits Helm chart
4. Terraform Agent → renders Terraform templates → provisions GKE cluster
5. Deployment Agent → applies Helm chart (helm install/upgrade) → monitors
- Each AI agent calls external AI APIs to generate or refine templates
- Terraform Agent applies to GCP via google_cloud SDK credentials
- Deployment Agent uses kubectl/Helm CLI to push to GKE

##### Architectural patterns
- Pipeline / Orchestration pattern (linear workflow)
- Agent-based modularity (each AI agent is a plug-in)
- Infrastructure as Code (Terraform, Helm)
- Template-driven code generation

##### Key technologies & frameworks
- Python 3.8+ (modules under src/, utils, ai_agents)
- Kompose CLI
- Helm
- Terraform
- Google Cloud SDK (gcloud, kubectl)
- AI Provider SDKs / HTTP APIs

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User / CLI Layer
    subgraph "User / CLI Layer"
        Main["src/main.py"]:::code
        Setup["scripts/setup.sh"]:::code
        Input["example-docker-compose.yml"]:::code
    end

    %% Shared Logic
    subgraph "Shared Logic"
        BaseAgent["Base Agent\n(src/ai_agents/base_agent.py)"]:::code
        Config["Config & Templates\n(src/utils/config.py)"]:::code
        Logger["Logger\n(src/utils/logger.py)"]:::code
    end

    %% AI Agent Pipeline
    subgraph "AI Agent Pipeline"
        Orchestrator["Orchestrator\n(src/ai_agents/orchestrator.py)"]:::code
        Analysis["Analysis Agent\n(src/ai_agents/analysis_agent.py)"]:::code
        Conversion["Conversion Agent\n(src/ai_agents/conversion_agent.py)"]:::code
        HelmAgentNode["Helm Agent\n(src/ai_agents/helm_agent.py)"]:::code
        TerraformAgentNode["Terraform Agent\n(src/ai_agents/terraform_agent.py)"]:::code
        Deployment["Deployment Agent\n(src/ai_agents/deployment_agent.py)"]:::code
    end

    %% Conversion & Provisioning Tools
    subgraph "Conversion & Provisioning Tools"
        Kompose["Kompose"]:::infra
        HelmCLI["Helm CLI"]:::infra
        TerraformCLI["Terraform CLI"]:::infra
        GKECluster["GKE Cluster"]:::infra
    end

    %% Artifacts
    subgraph "Artifacts"
        Manifests["K8s Manifests\n(output/kubernetes/)"]:::artifact
        HelmChart["Helm Chart\n(output/helm/quick-kube-app/)"]:::artifact
        TFTemplates["Terraform Templates\n(src/utils/config.py)"]:::artifact
    end

    %% External Services
    subgraph "External Services"
        AIProviders["AI Providers\n(OpenAI GPT, Claude, Gemini)"]:::ext
        GCloudSDK["Google Cloud SDK"]:::ext
    end

    %% Connections
    Input -->|invokes CLI| Orchestrator
    Main -->|runs| Orchestrator
    Setup -->|bootstraps env| Main

    Orchestrator -->|1. analysis| Analysis
    Analysis -->|2. conversion| Conversion
    Conversion -->|3. helm gen| HelmAgentNode
    HelmAgentNode -->|4. provisioning| TerraformAgentNode
    TerraformAgentNode -->|5. deploy| Deployment

    Conversion -->|uses Kompose| Kompose
    Kompose -->|generates| Manifests
    HelmAgentNode -->|uses Helm| HelmCLI
    HelmCLI -->|creates| HelmChart

    TerraformAgentNode -->|uses Terraform| TerraformCLI
    TerraformCLI -->|provisions| GKECluster

    Deployment -->|uses Helm| HelmCLI
    Deployment -->|deploys to| GKECluster
    Deployment -->|monitors| GKECluster

    %% Agent to External API calls
    Analysis -->|AI API| AIProviders
    Conversion -->|AI API| AIProviders
    HelmAgentNode -->|AI API| AIProviders
    TerraformAgentNode -->|AI API| AIProviders
    Deployment -->|AI API| AIProviders

    %% Utils usage
    Analysis -.-> Config
    Conversion -.-> Config
    HelmAgentNode -.-> Config
    TerraformAgentNode -.-> Config

    Analysis -.-> Logger
    Conversion -.-> Logger
    HelmAgentNode -.-> Logger
    TerraformAgentNode -.-> Logger
    Deployment -.-> Logger

    %% TF templates artifact link
    TerraformAgentNode -->|template source| TFTemplates

    %% Click Events
    click Main "https://github.com/anshchoudhary/quick-kube/blob/main/src/main.py"
    click Setup "https://github.com/anshchoudhary/quick-kube/blob/main/scripts/setup.sh"
    click Input "https://github.com/anshchoudhary/quick-kube/blob/main/example-docker-compose.yml"
    click Orchestrator "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/orchestrator.py"
    click Analysis "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/analysis_agent.py"
    click Conversion "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/conversion_agent.py"
    click HelmAgentNode "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/helm_agent.py"
    click TerraformAgentNode "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/terraform_agent.py"
    click Deployment "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/deployment_agent.py"
    click BaseAgent "https://github.com/anshchoudhary/quick-kube/blob/main/src/ai_agents/base_agent.py"
    click Config "https://github.com/anshchoudhary/quick-kube/blob/main/src/utils/config.py"
    click Logger "https://github.com/anshchoudhary/quick-kube/blob/main/src/utils/logger.py"
    click Manifests "https://github.com/anshchoudhary/quick-kube/tree/main/output/kubernetes/"
    click HelmChart "https://github.com/anshchoudhary/quick-kube/tree/main/output/helm/quick-kube-app/"
    click TFTemplates "https://github.com/anshchoudhary/quick-kube/blob/main/src/utils/config.py"

    %% Styles
    classDef code fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef infra fill:#E6FFDA,stroke:#2C662D,color:#2C662D
    classDef ext fill:#FFE8D0,stroke:#D96C06,color:#D96C06
    classDef artifact fill:#F0F0F0,stroke:#666,color:#666
```
