@@ -22,36 +22,58 @@ kubin create
2222## What it does
2323
2424Instead of sharing cluster dumps as files in Jira tickets:
25+
25261 . Run ` kubin create `
26- 2 . Get a shareable URL
27+ 2 . Get an immediate shareable URL
27283 . Anyone can explore the cluster state in a familiar Kubernetes dashboard
29+ 4 . Search and analyze logs with sub-second query performance
30+
31+ ## Architecture
32+
33+ Kubin uses a modern microservices architecture optimized for high-throughput uploads and sub-second queries:
34+
35+ ### Components
36+
37+ ** CLI Tool** (` /cli ` )
38+
39+ - Command-line tool for capturing cluster snapshots
40+ - Connects to Kubernetes clusters and uploads data
41+ - Distributed as a binary like ` kubectl ` or ` docker `
2842
29- ## Components
43+ ** Microservices Platform ** ( ` /services ` )
3044
31- - ** CLI** (` /cli ` ) - Capture clusters and get shareable links
32- - ** Server** (` /server ` ) - Store and serve snapshots
33- - ** UI** (` /ui ` ) - Lens-like interface for viewing snapshots
45+ - ** API Gateway** : Single entry point with auth, rate limiting, and routing
46+ - ** Upload Orchestrator** : Coordinates multi-step upload workflow with immediate URL generation
47+ - ** Metadata Service** : Fast PostgreSQL storage for K8s resource metadata and search
48+ - ** Storage Service** : Manages S3 file operations and generates pre-signed URLs
49+ - ** Log Processor** : Background parsing of logs into structured ClickHouse data
50+ - ** Query Service** : Orchestrates data from multiple services with Redis caching
51+ - ** Analytics Service** : Advanced log search and time-series analysis
52+
53+ ** Web UI** (` /ui ` )
54+
55+ - React-based interface for exploring snapshots
56+ - Lens-like experience with powerful search capabilities
57+ - Real-time log analytics and visualization
58+
59+ More info at: [ docs/architecture.md] ( docs/architecture.md )
3460
3561## Use Cases
3662
37- - Debug cluster issues with your team
38- - Document cluster state for reference
39- - Share cluster state with support
40- - Track changes over time
63+ - ** Debugging** : Capture cluster state when troubleshooting issues with team collaboration
64+ - ** Documentation** : Save cluster configurations for reference and compliance
65+ - ** Sharing** : Share cluster states with team members or support without file transfers
66+ - ** Backup** : Quick backup of cluster configurations with versioning
67+ - ** Audit** : Track changes in cluster state over time with analytics
68+ - ** Log Analysis** : Query and analyze historical log data with powerful search
69+ - ** Instant Sharing** : Get shareable URLs in under 2 seconds
4170
4271## Development
4372
44- ``` bash
45- # Build CLI
46- cd cli && go build
47-
48- # Build Server
49- cd server && go build
73+ TODO
5074
51- # Run Server
52- cd server && go run cmd/server/main.go
53- ```
75+ More info at: [ docs/development.md] ( docs/development.md )
5476
5577## License
5678
57- MIT
79+ MIT
0 commit comments