# akrasic/souschef architecture

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

- Interactive diagram: https://gitdiagram.com/akrasic/souschef
- Repository: https://github.com/akrasic/souschef

## Overview

##### Main Components

a. Client-Side Components (arrange from top to bottom):
- CLI Interface Layer (main.rs, cli.rs)
- Configuration Management (config.rs)
- Chef Resource Handlers (chef/* modules)
- HTTP Client Layer (client/* modules)
- Parser Layer (parse.rs)

b. External Systems:
- Chef Server API
- Configuration Files (~/.chef/knife.rb, ~/.cinc/knife.rb)

##### Component Relationships

- User → CLI Interface (input/commands)
- CLI Interface → Configuration Management (config loading)
- Configuration Management → Configuration Files (file reading)
- CLI Interface → Chef Resource Handlers (command routing)
- Chef Resource Handlers → HTTP Client Layer (API requests)
- HTTP Client Layer → Chef Server API (REST communication)
- Parser Layer ↔ Chef Resource Handlers (data transformation)

##### Specific Design Elements

Use the following visual elements:
- Rounded rectangles for external systems
- Blue: User interface (CLI)
- Green: Business logic (Chef resources)
- Yellow: Infrastructure (HTTP client)
- Gray: External systems

##### Component Details

Annotations showing:
- Chef Resource Types (nodes, roles, environments, databags)
- Supported Operations (list, show, search)
- Configuration Sources (Chef/Cinc profiles)

##### Implementation Details to Highlight

Create callouts showing:
- Resource Handlers Structure (chef/*)
- HTTP Client Components (headers.rs, request.rs)
- Configuration Management (profile handling)

##### Data Flow Patterns

Typical flow:
1. Command Input → CLI Parser
2. Configuration Loading
3. Resource Handler Selection
4. HTTP Request Formation
5. API Communication
6. Response Parsing
7. Output Formatting

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        UI[User Interface]:::ui
        BL[Business Logic]:::business
        IN[Infrastructure]:::infra
        EX[External System]:::external
    end

    subgraph "CLI Interface Layer"
        CLI["Command Line Interface"]:::ui
        MainRS["Main Entry Point"]:::ui
        CLIRS["Command Handler"]:::ui
    end

    subgraph "Configuration Management"
        Config["Configuration Manager"]:::business
        ConfigFiles["Config Files<br/>(~/.chef/knife.rb,<br/>~/.cinc/knife.rb)"]:::external
    end

    subgraph "Chef Resource Handlers"
        direction TB
        ChefMain["Chef Module"]:::business
        Node["Node Handler"]:::business
        Role["Role Handler"]:::business
        Env["Environment Handler"]:::business
        DataBag["Data Bag Handler"]:::business
        Search["Search Handler"]:::business
    end

    subgraph "HTTP Client Layer"
        Client["HTTP Client"]:::infra
        Headers["Headers Handler"]:::infra
        Request["Request Handler"]:::infra
    end

    subgraph "Parser Layer"
        Parser["Response Parser"]:::business
    end

    ChefServer["Chef Server API"]:::external

    %% Relationships
    User -->|"Input/Commands"| CLI
    CLI --> MainRS
    CLI --> CLIRS
    CLIRS --> Config
    Config -->|"Read"| ConfigFiles
    CLIRS --> ChefMain
    ChefMain --> Node & Role & Env & DataBag & Search
    Node & Role & Env & DataBag & Search --> Client
    Client --> Headers
    Client --> Request
    Request -.->|"API Requests"| ChefServer
    ChefServer -.->|"Responses"| Parser
    Parser --> Node & Role & Env & DataBag & Search

    %% Styles
    classDef ui fill:#a8d1f0
    classDef business fill:#90EE90
    classDef infra fill:#FFE5B4
    classDef external fill:#D3D3D3

    %% Click Events
    click MainRS "https://github.com/akrasic/souschef/blob/main/src/main.rs"
    click CLIRS "https://github.com/akrasic/souschef/blob/main/src/cli.rs"
    click Config "https://github.com/akrasic/souschef/blob/main/src/config.rs"
    click ChefMain "https://github.com/akrasic/souschef/blob/main/src/chef.rs"
    click Node "https://github.com/akrasic/souschef/blob/main/src/chef/node.rs"
    click Role "https://github.com/akrasic/souschef/blob/main/src/chef/role.rs"
    click Env "https://github.com/akrasic/souschef/blob/main/src/chef/environment.rs"
    click DataBag "https://github.com/akrasic/souschef/blob/main/src/chef/databag.rs"
    click Search "https://github.com/akrasic/souschef/blob/main/src/chef/search.rs"
    click Client "https://github.com/akrasic/souschef/blob/main/src/client.rs"
    click Headers "https://github.com/akrasic/souschef/blob/main/src/client/headers.rs"
    click Request "https://github.com/akrasic/souschef/blob/main/src/client/request.rs"
    click Parser "https://github.com/akrasic/souschef/blob/main/src/parse.rs"
```
