# yonahd/kor architecture

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

- Interactive diagram: https://gitdiagram.com/yonahd/kor
- Repository: https://github.com/yonahd/kor

## Overview

Kor is a CLI and Prometheus exporter for finding unused Kubernetes resources. A user runs a resource subcommand or requests a combined scan; the CLI initializes Kubernetes clients and options, resource analyzers identify candidates, and results are formatted for output or optionally deleted. The README also documents Slack notifications and broad resource coverage. Several resource implementations and the exporter internals were not sampled, so their links are documented or shown as unverified rather than inferred from naming alone.

Main entry points: [`cmd/kor/root.go`](https://github.com/yonahd/kor/blob/main/cmd/kor/root.go) (Command setup), [`cmd/kor`](https://github.com/yonahd/kor/tree/main/cmd/kor) (Resource commands), [`pkg/kor/all.go`](https://github.com/yonahd/kor/blob/main/pkg/kor/all.go) (All-resource scan), [`pkg/kor/multi.go`](https://github.com/yonahd/kor/blob/main/pkg/kor/multi.go) (Multi-resource scan)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["CLI entrypoints"]
  node_main["Program entry<br/>[main.go]"]
  node_commands["Command setup<br/>[root.go]"]
  node_resource_commands["Resource commands"]
  node_combined_command["Combined scan<br/>[all.go]"]
  node_exporter_command["Exporter command<br/>[exporter.go]"]
end

subgraph group_analysis["Resource analysis"]
  node_multi["Multi-resource scan<br/>[multi.go]"]
  node_all_scan["All-resource scan<br/>[all.go]"]
  node_resource_scanners["Resource analyzers"]
  node_service_analysis["Service analysis<br/>[services.go]"]
  node_service_account_analysis["Account analysis<br/>[serviceaccounts.go]"]
  node_storage_analysis["Storage analysis<br/>[storageclasses.go]"]
  node_filters["Scan filters<br/>[filters.go]"]
end

subgraph group_output["Results and actions"]
  node_formatting["Output formatting<br/>[formatter.go]"]
  node_deletion["Resource deletion<br/>[delete.go]"]
  node_slack["Slack delivery<br/>[slack.go]"]
end

subgraph group_operations["Cluster operations"]
  node_exporter["Metrics exporter<br/>[exporter.go]"]
end

node_user(("CLI user"))
node_kubernetes[("Kubernetes API")]
node_prometheus(("Prometheus"))
node_slack_service(("Slack"))

node_user -->|"runs"| node_main
node_main -->|"executes"| node_commands
node_commands -->|"invokes scan"| node_multi
node_commands -->|"registers commands"| node_resource_commands
node_combined_command -.->|"runs combined scan"| node_all_scan
node_exporter_command -->|"starts exporter"| node_exporter
node_multi -.->|"dispatches resources"| node_all_scan
node_all_scan -->|"calls analyzers"| node_resource_scanners
node_resource_commands -->|"runs service scan"| node_service_analysis
node_resource_commands -->|"runs account scan"| node_service_account_analysis
node_resource_commands -->|"runs storage scan"| node_storage_analysis
node_service_analysis -->|"reads endpoints"| node_kubernetes
node_service_account_analysis -->|"reads account usage"| node_kubernetes
node_storage_analysis -->|"reads storage usage"| node_kubernetes
node_resource_scanners -.->|"applies filters"| node_filters
node_resource_scanners -.->|"may delete"| node_deletion
node_multi -.->|"formats results"| node_formatting
node_all_scan -->|"formats results"| node_formatting
node_commands -.->|"may notify"| node_slack
node_exporter -.->|"collects cluster data"| node_kubernetes
node_exporter -.->|"exposes metrics"| node_prometheus
node_slack -->|"sends messages"| node_slack_service

click node_main "https://github.com/yonahd/kor/blob/main/main.go"
click node_commands "https://github.com/yonahd/kor/blob/main/cmd/kor/root.go"
click node_resource_commands "https://github.com/yonahd/kor/tree/main/cmd/kor"
click node_combined_command "https://github.com/yonahd/kor/blob/main/cmd/kor/all.go"
click node_exporter_command "https://github.com/yonahd/kor/blob/main/cmd/kor/exporter.go"
click node_multi "https://github.com/yonahd/kor/blob/main/pkg/kor/multi.go"
click node_all_scan "https://github.com/yonahd/kor/blob/main/pkg/kor/all.go"
click node_resource_scanners "https://github.com/yonahd/kor/tree/main/pkg/kor"
click node_service_analysis "https://github.com/yonahd/kor/blob/main/pkg/kor/services.go"
click node_service_account_analysis "https://github.com/yonahd/kor/blob/main/pkg/kor/serviceaccounts.go"
click node_storage_analysis "https://github.com/yonahd/kor/blob/main/pkg/kor/storageclasses.go"
click node_filters "https://github.com/yonahd/kor/blob/main/pkg/filters/filters.go"
click node_formatting "https://github.com/yonahd/kor/blob/main/pkg/kor/formatter.go"
click node_deletion "https://github.com/yonahd/kor/blob/main/pkg/kor/delete.go"
click node_slack "https://github.com/yonahd/kor/blob/main/pkg/utils/slack.go"
click node_exporter "https://github.com/yonahd/kor/blob/main/pkg/kor/exporter.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_commands,node_resource_commands,node_combined_command,node_exporter_command,node_user toneBlue
class node_multi,node_all_scan,node_resource_scanners,node_service_analysis,node_service_account_analysis,node_storage_analysis,node_filters,node_kubernetes toneAmber
class node_formatting,node_deletion,node_slack toneMint
class node_exporter toneRose
class node_prometheus,node_slack_service toneIndigo
```

## Components

### CLI entrypoints

- [Program entry](https://github.com/yonahd/kor/blob/main/main.go): `main.go`
- [Command setup](https://github.com/yonahd/kor/blob/main/cmd/kor/root.go): `cmd/kor/root.go`
- [Resource commands](https://github.com/yonahd/kor/tree/main/cmd/kor): `cmd/kor`
- [Combined scan](https://github.com/yonahd/kor/blob/main/cmd/kor/all.go): `cmd/kor/all.go`
- [Exporter command](https://github.com/yonahd/kor/blob/main/cmd/kor/exporter.go): `cmd/kor/exporter.go`

### Resource analysis

- [Multi-resource scan](https://github.com/yonahd/kor/blob/main/pkg/kor/multi.go): `pkg/kor/multi.go`
- [All-resource scan](https://github.com/yonahd/kor/blob/main/pkg/kor/all.go): `pkg/kor/all.go`
- [Resource analyzers](https://github.com/yonahd/kor/tree/main/pkg/kor): `pkg/kor`
- [Service analysis](https://github.com/yonahd/kor/blob/main/pkg/kor/services.go): `pkg/kor/services.go`
- [Account analysis](https://github.com/yonahd/kor/blob/main/pkg/kor/serviceaccounts.go): `pkg/kor/serviceaccounts.go`
- [Storage analysis](https://github.com/yonahd/kor/blob/main/pkg/kor/storageclasses.go): `pkg/kor/storageclasses.go`
- [Scan filters](https://github.com/yonahd/kor/blob/main/pkg/filters/filters.go): `pkg/filters/filters.go`

### Results and actions

- [Output formatting](https://github.com/yonahd/kor/blob/main/pkg/kor/formatter.go): `pkg/kor/formatter.go`
- [Resource deletion](https://github.com/yonahd/kor/blob/main/pkg/kor/delete.go): `pkg/kor/delete.go`
- [Slack delivery](https://github.com/yonahd/kor/blob/main/pkg/utils/slack.go): `pkg/utils/slack.go`

### Cluster operations

- [Metrics exporter](https://github.com/yonahd/kor/blob/main/pkg/kor/exporter.go): `pkg/kor/exporter.go`

### Other components

- **CLI user**
- **Kubernetes API**
- **Prometheus**
- **Slack**

## Connections

- CLI user → Program entry: runs
- Program entry → Command setup: executes (evidence: `main.go`)
- Command setup → Multi-resource scan: invokes scan (evidence: `cmd/kor/root.go`)
- Command setup → Resource commands: registers commands (evidence: `cmd/kor/root.go`)
- Combined scan → All-resource scan: runs combined scan
- Exporter command → Metrics exporter: starts exporter (evidence: `cmd/kor/exporter.go`)
- Multi-resource scan → All-resource scan: dispatches resources
- All-resource scan → Resource analyzers: calls analyzers (evidence: `pkg/kor/all.go`)
- Resource commands → Service analysis: runs service scan (evidence: `cmd/kor/services.go`)
- Resource commands → Account analysis: runs account scan (evidence: `cmd/kor/serviceaccounts.go`)
- Resource commands → Storage analysis: runs storage scan (evidence: `cmd/kor/storageclasses.go`)
- Service analysis → Kubernetes API: reads endpoints (evidence: `pkg/kor/services.go`)
- Account analysis → Kubernetes API: reads account usage (evidence: `pkg/kor/serviceaccounts.go`)
- Storage analysis → Kubernetes API: reads storage usage (evidence: `pkg/kor/storageclasses.go`)
- Resource analyzers → Scan filters: applies filters
- Resource analyzers → Resource deletion: may delete
- Multi-resource scan → Output formatting: formats results
- All-resource scan → Output formatting: formats results (evidence: `pkg/kor/all.go`)
- Command setup → Slack delivery: may notify
- Metrics exporter → Kubernetes API: collects cluster data
- Metrics exporter → Prometheus: exposes metrics
- Slack delivery → Slack: sends messages (evidence: `pkg/utils/slack.go`)
