# v1d1an/zvelk architecture

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

- Interactive diagram: https://gitdiagram.com/v1d1an/zvelk
- Repository: https://github.com/v1d1an/zvelk

## Overview

##### File structure
- Top-level orchestration scripts:
- 00_create_instance.sh, 01_deploy.sh, 99_cleanup_all.sh – lifecycle management
- docker-compose.yml – service definitions
- env.sample – environment variables template
- Directories per service:
- logstash/ – pipeline config, templates, JVM and Logstash settings
- kibana/ – dashboards export, index patterns, service config
- homer/ – static-site dashboard with config, manifest, assets
- mysql/ – schema initialization
- traefik/ – dynamic + static routing configs
- replay/ – script to replay log data
- instances.yml – likely defines multiple deployment targets or instance-specific overrides

##### README for additional insights
- Describes Linux prerequisites (Docker Compose v2, jq, vm.max_map_count) and physical requirements
- Installation steps simply git-clone + run creation script

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Deployment scripts and orchestration
    subgraph "Deployment" 
        direction TB
        Scripts00["00_create_instance.sh"]:::script
        Scripts01["01_deploy.sh"]:::script
        Scripts99["99_cleanup_all.sh"]:::script
        Compose["docker-compose.yml"]:::script
        Env["env.sample"]:::script
        Instances["instances.yml"]:::script
    end

    %% Proxy layer
    subgraph "Proxy & Routing"
        direction TB
        TraefikStatic["traefik.toml"]:::proxy
        TraefikDynamic["dyn.toml"]:::proxy
    end

    %% Ingestion layer
    subgraph "Logstash Service"
        direction TB
        LSConfig["logstash.yml"]:::ingestion
        JVMOptions["jvm.options"]:::ingestion
        PipelinesYML["pipelines.yml"]:::ingestion

        subgraph "Velociraptor Pipeline"
            direction TB
            VRIn["100_input_velociraptor.conf"]:::ingestion
            VRFilter["200_filter_velociraptor.conf"]:::ingestion
            VROut["300_output_velociraptor.conf"]:::ingestion
        end

        subgraph "Zircolite Pipeline"
            direction TB
            ZRIn["100_input_zircolite.conf"]:::ingestion
            ZRFilter["200_filter_zircolite.conf"]:::ingestion
            ZROut["300_output_zircolite.conf"]:::ingestion
        end

        Template["velociraptor.json"]:::ingestion
    end

    %% Storage layer
    Elasticsearch["Elasticsearch"]:::storage

    %% UI layer
    subgraph "Kibana UI"
        direction TB
        KibanaYML["kibana.yml"]:::ui
        NodeOptions["node.options"]:::ui
        KD1["dashboard/zircolite.ndjson"]:::ui
        KI1["index/velociraptor.ndjson"]:::ui
        KI2["index/zircolite.ndjson"]:::ui
    end

    subgraph "Homer Dashboard"
        direction TB
        HomerConfig["config.yml"]:::ui
        HomerManifest["manifest.json"]:::ui
        HomerPage["additional-page.yml.dist"]:::ui
        HomerCSS["custom.css.sample"]:::ui
        HomerIcons["icons/"]:::ui
        HomerTools["tools/"]:::ui
    end

    %% Database
    MySQL["MySQL"]:::db
    MySQLInit["databases.sql"]:::db

    %% Auxiliary
    Replay["replay.sh"]:::aux

    %% Connections
    Scripts00 --> Scripts01
    Scripts01 --> Compose
    Compose --> TraefikStatic
    Compose --> TraefikDynamic
    TraefikStatic --> KibanaYML
    TraefikStatic --> HomerConfig
    Replay --> VRIn
    Replay --> ZRIn
    VRIn --> VRFilter --> VROut --> Elasticsearch
    ZRIn --> ZRFilter --> ZROut --> Elasticsearch
    LSConfig --> VRIn
    LSConfig --> ZRIn
    Elasticsearch <--> KibanaYML
    Elasticsearch --> HomerConfig

    %% Initialization
    Scripts01 --> MySQLInit --> MySQL

    %% Classes
    classDef script fill:#f2f2f2,stroke:#888,stroke-width:1px
    classDef proxy fill:#ffe5cc,stroke:#cc8400,stroke-width:1px
    classDef ingestion fill:#cce5ff,stroke:#339,stroke-width:1px
    classDef storage fill:#cce6ff,stroke:#004080,stroke-width:1px
    classDef ui fill:#e6ffe6,stroke:#008000,stroke-width:1px
    classDef db fill:#f5e6ff,stroke:#800080,stroke-width:1px
    classDef aux fill:#ffe6e6,stroke:#cc0000,stroke-width:1px

    %% Click Events
    click Scripts00 "https://github.com/v1d1an/zvelk/blob/main/00_create_instance.sh"
    click Scripts01 "https://github.com/v1d1an/zvelk/blob/main/01_deploy.sh"
    click Scripts99 "https://github.com/v1d1an/zvelk/blob/main/99_cleanup_all.sh"
    click Compose "https://github.com/v1d1an/zvelk/blob/main/docker-compose.yml"
    click Env "https://github.com/v1d1an/zvelk/blob/main/env.sample"
    click Instances "https://github.com/v1d1an/zvelk/blob/main/instances.yml"
    click TraefikStatic "https://github.com/v1d1an/zvelk/blob/main/traefik/traefik.toml"
    click TraefikDynamic "https://github.com/v1d1an/zvelk/blob/main/traefik/dyn.toml"
    click LSConfig "https://github.com/v1d1an/zvelk/blob/main/logstash/config/logstash.yml"
    click JVMOptions "https://github.com/v1d1an/zvelk/blob/main/logstash/config/jvm.options"
    click PipelinesYML "https://github.com/v1d1an/zvelk/blob/main/logstash/config/pipelines.yml"
    click VRIn "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/velociraptor/100_input_velociraptor.conf"
    click VRFilter "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/velociraptor/200_filter_velociraptor.conf"
    click VROut "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/velociraptor/300_output_velociraptor.conf"
    click ZRIn "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/zircolite/100_input_zircolite.conf"
    click ZRFilter "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/zircolite/200_filter_zircolite.conf"
    click ZROut "https://github.com/v1d1an/zvelk/blob/main/logstash/pipeline/zircolite/300_output_zircolite.conf"
    click Template "https://github.com/v1d1an/zvelk/blob/main/logstash/template/velociraptor.json"
    click KibanaYML "https://github.com/v1d1an/zvelk/blob/main/kibana/kibana.yml"
    click NodeOptions "https://github.com/v1d1an/zvelk/blob/main/kibana/node.options"
    click KD1 "https://github.com/v1d1an/zvelk/blob/main/kibana/dashboard/zircolite.ndjson"
    click KI1 "https://github.com/v1d1an/zvelk/blob/main/kibana/index/velociraptor.ndjson"
    click KI2 "https://github.com/v1d1an/zvelk/blob/main/kibana/index/zircolite.ndjson"
    click HomerConfig "https://github.com/v1d1an/zvelk/blob/main/homer/config.yml"
    click HomerManifest "https://github.com/v1d1an/zvelk/blob/main/homer/manifest.json"
    click HomerPage "https://github.com/v1d1an/zvelk/blob/main/homer/additional-page.yml.dist"
    click HomerCSS "https://github.com/v1d1an/zvelk/blob/main/homer/custom.css.sample"
    click HomerIcons "https://github.com/v1d1an/zvelk/tree/main/homer/icons/"
    click HomerTools "https://github.com/v1d1an/zvelk/tree/main/homer/tools/"
    click MySQLInit "https://github.com/v1d1an/zvelk/blob/main/mysql/databases.sql"
    click Replay "https://github.com/v1d1an/zvelk/blob/main/replay/replay.sh"
```
