stacklok / toolhive / 18677426681
59%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 293
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 46.625% (-0.005%) from 46.63%
18677426681

push

github

web-flow 
Add architecture documentation (#2165)

* Add comprehensive architecture documentation

This commit introduces a new architectural documentation suite in docs/arch/
that provides in-depth coverage of ToolHive's design, components, and concepts.

The documentation is organized into the following sections:

- 00-overview.md: High-level architecture overview and introduction
- 01-deployment-modes.md: Local CLI, UI, and Kubernetes deployment patterns
- 02-core-concepts.md: Core terminology, abstractions, and design patterns
- 03-transport-architecture.md: MCP transport protocols and proxy architecture
- 04-secrets-management.md: Secret handling and backend integrations
- 05-runconfig-and-permissions.md: Configuration schema and security profiles
- 06-registry-system.md: Registry architecture and distribution
- 07-groups.md: Group management and virtual MCP servers
- 08-workloads-lifecycle.md: Workload state management and operations
- 09-operator-architecture.md: Kubernetes operator design and patterns
- README.md: Navigation guide and documentation index

This documentation serves as the canonical reference for understanding
ToolHive's architecture, making it easier for contributors to navigate
the codebase and for users to understand deployment options.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Juan Antonio Osorio <ozz@stacklok.com>

* Address review feedback on architecture docs

Made the following changes based on review comments:

- Fix API version references: point to actual examples instead of inline YAML
- Fix CRD names: ToolConfig → MCPToolConfig, add MCPExternalAuthConfig
- Remove all line number references from code file paths
- Fix CLI commands: registry show → info, group delete → rm
- Remove non-existent CLI commands from documentation
- Fix 1Password implementation details (uses SDK not CLI)
- Point to cmd/thv-operator/ README instead of duplicating info
- ... (continued)

18001 of 38608 relevant lines covered (46.63%)

15.65 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
2
92.86
 -1.43% pkg/secrets/keyring/composite.go
2
81.62
 0.0% pkg/transport/proxy/httpsse/http_proxy.go
3
72.39
 -1.12% pkg/ignore/processor.go
Jobs
ID Job ID Ran Files Coverage
1 18677426681.1 293
46.63
 GitHub Action Run
Source Files on build 18677426681