# cadrake/kafka-admin-tool architecture

> Architecture diagram of the GitHub repository cadrake/kafka-admin-tool, 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/cadrake/kafka-admin-tool
- Repository: https://github.com/cadrake/kafka-admin-tool

## Overview

##### Main Components

a) Command Interface Layer:
- Root Command Handler (from cmd/root.go)
- Three main subcommands:
- Reassign Command (cmd/reassign.go)
- Alter Command (cmd/alter.go)
- Verify Command (cmd/verify.go)

b) Utility Layer:
- Admin Client (utils/adminclient.go)
- Utility Functions (utils/utils.go)

c) External Components:
- Kafka Cluster
- Kafka Brokers
- Topic Partitions

**[User CLI Input]**
- ↓
**[Command Layer]**
- ↓
**[Utility Layer]**
- ↓
**[Kafka Cluster]**

##### Specific Elements

a) Input/Output:
- CLI commands (reassign, alter, verify)
- JSON file handling (for assignments)
- Broker list inputs
- Topic regex filters

b) Flow Connections:
- Command processing flow
- Admin client interactions
- Kafka cluster communications

##### Important Details to Capture

a) Command Operations:
- Partition reassignment flows
- Replication factor modification
- Verification processes

b) Integration Points:
- Kafka broker connections
- Topic management
- Partition management

- Command Layer      |
- [Reassign] [Alter]   |
- [Verify] [Root]   |

- ↓

- Utility Layer      |
- [AdminClient] [Utils]  |

- ↓

- Kafka Cluster       |
- [Brokers] [Partitions]|

##### Implementation Details

- Annotations for critical configuration points

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef command fill:#2196F3,stroke:#1565C0,color:white
    classDef utility fill:#4CAF50,stroke:#388E3C,color:white
    classDef kafka fill:#FF9800,stroke:#F57C00,color:white
    classDef input fill:#9E9E9E,stroke:#616161,color:white
    classDef flow fill:none,stroke:#757575

    %% Input Layer
    CLI["CLI Input"]:::input

    %% Command Layer
    subgraph CommandLayer["Command Layer"]
        Root["Root Command"]:::command
        Reassign["Reassign Command"]:::command
        Alter["Alter Command"]:::command
        Verify["Verify Command"]:::command
    end

    %% Utility Layer
    subgraph UtilityLayer["Utility Layer"]
        AdminClient["Admin Client"]:::utility
        Utils["Utility Functions"]:::utility
    end

    %% Kafka Layer
    subgraph KafkaLayer["Kafka Cluster"]
        Brokers["Kafka Brokers"]:::kafka
        Partitions["Topic Partitions"]:::kafka
    end

    %% Connections
    CLI --> Root
    Root --> Reassign
    Root --> Alter
    Root --> Verify
    
    Reassign --> AdminClient
    Alter --> AdminClient
    Verify --> AdminClient
    
    AdminClient --> Utils
    Utils --> Brokers
    Brokers --> Partitions

    %% Click events for component mapping
    click Root "https://github.com/cadrake/kafka-admin-tool/blob/main/cmd/root.go"
    click Reassign "https://github.com/cadrake/kafka-admin-tool/blob/main/cmd/reassign.go"
    click Alter "https://github.com/cadrake/kafka-admin-tool/blob/main/cmd/alter.go"
    click Verify "https://github.com/cadrake/kafka-admin-tool/blob/main/cmd/verify.go"
    click AdminClient "https://github.com/cadrake/kafka-admin-tool/blob/main/utils/adminclient.go"
    click Utils "https://github.com/cadrake/kafka-admin-tool/blob/main/utils/utils.go"

    %% Legend
    subgraph Legend
        L1["Command Components"]:::command
        L2["Utility Components"]:::utility
        L3["Kafka Components"]:::kafka
        L4["Input/Output"]:::input
    end
```
