# yannh/kubeconform architecture

> Architecture diagram of the GitHub repository yannh/kubeconform, 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/yannh/kubeconform
- Repository: https://github.com/yannh/kubeconform

## Overview

Kubeconform validates Kubernetes manifests from files, directories, or stdin against configurable local or remote JSON schemas, then reports each resource’s result. The CLI configures discovery, runs validation concurrently, and selects a result format. Validation parses resource identity, applies skip/reject and strictness options, retrieves and caches schemas, and checks manifests against them. The README also documents custom schema locations, missing-schema handling, and JSON, JUnit, pretty, TAP, and text output. Source excerpts show the primary runtime wiring; unsampled resource and registry internals limit some relationship detail.

Main entry points: [`cmd/kubeconform/main.go`](https://github.com/yannh/kubeconform/blob/master/cmd/kubeconform/main.go) (Kubeconform CLI), [`pkg/registry/registry.go`](https://github.com/yannh/kubeconform/blob/master/pkg/registry/registry.go) (Schema registries), [`pkg/resource`](https://github.com/yannh/kubeconform/tree/master/pkg/resource) (Resource discovery), [`pkg/validator/validator.go`](https://github.com/yannh/kubeconform/blob/master/pkg/validator/validator.go) (Resource validator)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and configuration"]
  node_cli["Kubeconform CLI<br/>[main.go]"]
  node_config["Flag configuration<br/>[config.go]"]
end

subgraph group_inputs["Manifest inputs"]
  node_discovery["Resource discovery"]
  node_stream["Stream parsing<br/>[stream.go]"]
  node_files["File discovery<br/>[files.go]"]
end

subgraph group_validation["Schema validation"]
  node_validator["Resource validator<br/>[validator.go]"]
  node_registry["Schema registries<br/>[registry.go]"]
  node_httpreg["HTTP registry<br/>[http.go]"]
  node_localreg["Local registry<br/>[local.go]"]
  node_httploader["HTTP schema loader<br/>[http.go]"]
  node_fileloader["File schema loader<br/>[file.go]"]
  node_cache[("Schema cache")]
end

subgraph group_reporting["Results and reporting"]
  node_outputs["Output selection<br/>[output.go]"]
  node_formats["Result formatters"]
end

node_user(("CLI user"))
node_schemahost(("Schema source"))

node_user -->|"invokes"| node_cli
node_cli -->|"parses flags"| node_config
node_cli -->|"selects format"| node_outputs
node_cli -->|"creates and calls"| node_validator
node_cli -->|"discovers resources"| node_discovery
node_discovery -.->|"reads stdin"| node_stream
node_discovery -.->|"scans files"| node_files
node_validator -->|"parses streams"| node_discovery
node_validator -->|"requests schemas"| node_registry
node_registry -->|"creates HTTP registry"| node_httpreg
node_registry -->|"creates local registry"| node_localreg
node_registry -->|"configures HTTP loading"| node_httploader
node_registry -->|"configures file loading"| node_fileloader
node_httploader -->|"reads and writes"| node_cache
node_registry -->|"configures disk cache"| node_cache
node_httploader -->|"fetches schema"| node_schemahost
node_fileloader -.->|"loads local schema"| node_schemahost
node_cli -->|"writes results"| node_formats
node_outputs -->|"constructs formatter"| node_formats
node_formats -->|"accepts results"| node_cli

click node_cli "https://github.com/yannh/kubeconform/blob/master/cmd/kubeconform/main.go"
click node_config "https://github.com/yannh/kubeconform/blob/master/pkg/config/config.go"
click node_discovery "https://github.com/yannh/kubeconform/tree/master/pkg/resource"
click node_stream "https://github.com/yannh/kubeconform/blob/master/pkg/resource/stream.go"
click node_files "https://github.com/yannh/kubeconform/blob/master/pkg/resource/files.go"
click node_validator "https://github.com/yannh/kubeconform/blob/master/pkg/validator/validator.go"
click node_registry "https://github.com/yannh/kubeconform/blob/master/pkg/registry/registry.go"
click node_httpreg "https://github.com/yannh/kubeconform/blob/master/pkg/registry/http.go"
click node_localreg "https://github.com/yannh/kubeconform/blob/master/pkg/registry/local.go"
click node_httploader "https://github.com/yannh/kubeconform/blob/master/pkg/loader/http.go"
click node_fileloader "https://github.com/yannh/kubeconform/blob/master/pkg/loader/file.go"
click node_cache "https://github.com/yannh/kubeconform/tree/master/pkg/cache"
click node_outputs "https://github.com/yannh/kubeconform/blob/master/pkg/output/output.go"
click node_formats "https://github.com/yannh/kubeconform/tree/master/pkg/output"

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_cli,node_config,node_user toneBlue
class node_discovery,node_stream,node_files toneAmber
class node_validator,node_registry,node_httpreg,node_localreg,node_httploader,node_fileloader,node_cache toneMint
class node_outputs,node_formats toneRose
class node_schemahost toneIndigo
```

## Components

### CLI and configuration

- [Kubeconform CLI](https://github.com/yannh/kubeconform/blob/master/cmd/kubeconform/main.go): `cmd/kubeconform/main.go`
- [Flag configuration](https://github.com/yannh/kubeconform/blob/master/pkg/config/config.go): `pkg/config/config.go`

### Manifest inputs

- [Resource discovery](https://github.com/yannh/kubeconform/tree/master/pkg/resource): `pkg/resource`
- [Stream parsing](https://github.com/yannh/kubeconform/blob/master/pkg/resource/stream.go): `pkg/resource/stream.go`
- [File discovery](https://github.com/yannh/kubeconform/blob/master/pkg/resource/files.go): `pkg/resource/files.go`

### Schema validation

- [Resource validator](https://github.com/yannh/kubeconform/blob/master/pkg/validator/validator.go): `pkg/validator/validator.go`
- [Schema registries](https://github.com/yannh/kubeconform/blob/master/pkg/registry/registry.go): `pkg/registry/registry.go`
- [HTTP registry](https://github.com/yannh/kubeconform/blob/master/pkg/registry/http.go): `pkg/registry/http.go`
- [Local registry](https://github.com/yannh/kubeconform/blob/master/pkg/registry/local.go): `pkg/registry/local.go`
- [HTTP schema loader](https://github.com/yannh/kubeconform/blob/master/pkg/loader/http.go): `pkg/loader/http.go`
- [File schema loader](https://github.com/yannh/kubeconform/blob/master/pkg/loader/file.go): `pkg/loader/file.go`
- [Schema cache](https://github.com/yannh/kubeconform/tree/master/pkg/cache): `pkg/cache`

### Results and reporting

- [Output selection](https://github.com/yannh/kubeconform/blob/master/pkg/output/output.go): `pkg/output/output.go`
- [Result formatters](https://github.com/yannh/kubeconform/tree/master/pkg/output): `pkg/output`

### Other components

- **CLI user**
- **Schema source**

## Connections

- CLI user → Kubeconform CLI: invokes (evidence: `Readme.md`)
- Kubeconform CLI → Flag configuration: parses flags (evidence: `cmd/kubeconform/main.go`)
- Kubeconform CLI → Output selection: selects format (evidence: `cmd/kubeconform/main.go`)
- Kubeconform CLI → Resource validator: creates and calls (evidence: `cmd/kubeconform/main.go`)
- Kubeconform CLI → Resource discovery: discovers resources (evidence: `cmd/kubeconform/main.go`)
- Resource discovery → Stream parsing: reads stdin
- Resource discovery → File discovery: scans files
- Resource validator → Resource discovery: parses streams (evidence: `pkg/validator/validator.go`)
- Resource validator → Schema registries: requests schemas (evidence: `pkg/validator/validator.go`)
- Schema registries → HTTP registry: creates HTTP registry (evidence: `pkg/registry/registry.go`)
- Schema registries → Local registry: creates local registry (evidence: `pkg/registry/registry.go`)
- Schema registries → HTTP schema loader: configures HTTP loading (evidence: `pkg/registry/registry.go`)
- Schema registries → File schema loader: configures file loading (evidence: `pkg/registry/registry.go`)
- HTTP schema loader → Schema cache: reads and writes (evidence: `pkg/loader/http.go`)
- Schema registries → Schema cache: configures disk cache (evidence: `pkg/registry/registry.go`)
- HTTP schema loader → Schema source: fetches schema (evidence: `pkg/loader/http.go`)
- File schema loader → Schema source: loads local schema
- Kubeconform CLI → Result formatters: writes results (evidence: `cmd/kubeconform/main.go`)
- Output selection → Result formatters: constructs formatter (evidence: `pkg/output/output.go`)
- Result formatters → Kubeconform CLI: accepts results (evidence: `cmd/kubeconform/main.go`)
