# kubernetes-sigs/apisnoop architecture

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

- Interactive diagram: https://gitdiagram.com/kubernetes-sigs/apisnoop
- Repository: https://github.com/kubernetes-sigs/apisnoop

## Overview

##### Main Components

a) Core Services:
- SnoopDB (PostgreSQL Database)
- Auditlogger Server
- Web Frontend
- Kubernetes Cluster Integration

b) Data Sources:
- Kubernetes OpenAPI Spec
- Conformance Tests List
- Ineligible Endpoints List
- Test Run Audit Logs

**Top Layer: User Interfaces**
- APISnoop Web UI (apisnoop.cncf.io)
- Conformance Gate Integration (Prow Job)

**Middle Layer: Services**
- Auditlogger Service
- Data Processing Pipeline

**Bottom Layer: Data Storage & Sources**
- SnoopDB (PostgreSQL)
- External Data Sources

##### Key Relationships to Highlight

a) Data Flow:
- Data pipeline from OpenAPI specs and conformance data → SnoopDB
- Web UI data retrieval from SnoopDB

b) Integration Points:
- Kubernetes Audit Sink configuration
- Prow Job integration
- TestGrid reporting

##### Implementation Details

- Rectangles: Services
- Hexagons: External interfaces
- Diamonds: Decision points
- Clouds: External systems

##### Additional Elements

Annotations for:
- Key SQL initialization scripts
- Configuration points
- API endpoints
- Helm chart deployment options

##### Deployment Context

How components are deployed:
- Kubernetes cluster requirements
- Helm chart relationships
- Container dependencies

Remember to maintain a balance between detail and clarity, focusing on the architectural relationships while avoiding overwhelming technical implementation details.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        WebUI["APISnoop Web UI"]:::ui
        ProwJob["Conformance Gate (Prow Job)"]:::external
    end

    subgraph "Service Layer"
        AuditLogger["Auditlogger Service"]:::service
        DataPipeline["Data Processing Pipeline"]:::service
    end

    subgraph "Data Storage Layer"
        SnoopDB[(SnoopDB)]:::database
        subgraph "Database Components"
            Schema["Schema & Tables"]:::db
            Views["Coverage Views"]:::db
            Functions["Processing Functions"]:::db
        end
    end

    subgraph "Data Sources"
        OpenAPI["OpenAPI Spec"]:::source
        ConformanceTests["Conformance Tests"]:::source
        IneligibleList["Ineligible Endpoints"]:::source
        AuditLogs["Test Run Audit Logs"]:::source
    end

    subgraph "Kubernetes Integration"
        K8sCluster["Kubernetes Cluster"]:::k8s
        AuditPolicy["Audit Policy"]:::k8s
        AuditSink["Audit Sink"]:::k8s
    end

    %% Relationships
    K8sCluster --> AuditSink
    AuditSink --> AuditLogger
    AuditLogger --> SnoopDB
    OpenAPI --> DataPipeline
    ConformanceTests --> DataPipeline
    IneligibleList --> DataPipeline
    AuditLogs --> DataPipeline
    DataPipeline --> SnoopDB
    SnoopDB --> Schema
    SnoopDB --> Views
    SnoopDB --> Functions
    SnoopDB --> WebUI
    SnoopDB --> ProwJob

    %% Click Events
    click SnoopDB "https://github.com/kubernetes-sigs/apisnoop/tree/main/apps/snoopdb/"
    click AuditLogger "https://github.com/kubernetes-sigs/apisnoop/tree/main/apps/auditlogger/"
    click WebUI "https://github.com/kubernetes-sigs/apisnoop/tree/main/apps/web/"
    click Schema "https://github.com/kubernetes-sigs/apisnoop/blob/main/apps/snoopdb/postgres/initdb/000_create_schemas.sql"
    click AuditPolicy "https://github.com/kubernetes-sigs/apisnoop/blob/main/kind/audit/policy.yaml"
    click AuditSink "https://github.com/kubernetes-sigs/apisnoop/blob/main/kind/audit/sink.yaml"
    click DataPipeline "https://github.com/kubernetes-sigs/apisnoop/blob/main/apps/snoopdb/postgres/snoopUtils.py"
    click Functions "https://github.com/kubernetes-sigs/apisnoop/blob/main/apps/snoopdb/postgres/initdb/300_fn_load_open_api.sql"

    %% Styles
    classDef database fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef ui fill:#9b59b6,stroke:#8e44ad,color:white
    classDef k8s fill:#1abc9c,stroke:#16a085,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef source fill:#e67e22,stroke:#d35400,color:white
    classDef db fill:#3498db,stroke:#2980b9,color:white

    %% Legend
    subgraph Legend
        DB[(Database)]:::database
        SVC["Service"]:::service
        UI["User Interface"]:::ui
        K8S["Kubernetes Component"]:::k8s
        EXT["External System"]:::external
        SRC["Data Source"]:::source
    end
```
