All notable changes to the Kubernetes YAML Explainer project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
1.0.0 - 2024-10-19
The first production-ready release of Kubernetes YAML Explainer!
- FastAPI-based REST API with async support
- YAML parsing with multi-document support using ruamel.yaml
- Comprehensive validation engine with deprecated API detection
- Rule-based explanation engine with 80+ field explanations
- Optional LLM integration supporting OpenAI, Anthropic, and custom endpoints
- AES-256 encryption for API keys with PBKDF2 key derivation
- SQLite database for persistent storage (PostgreSQL compatible)
- YAML wizard for generating common resources (Deployment, Service, Ingress, ConfigMap)
- Health check endpoint for monitoring
- Interactive API documentation (Swagger/ReDoc)
- Modern React 18 single-page application
- Monaco Editor integration for YAML editing
- Glassmorphism UI design with smooth animations
- Light/Dark theme support with persistence
- Three-panel explanation view (Summary, Details, Validation)
- Settings modal for LLM configuration
- Wizard modal for guided YAML generation
- Real-time YAML validation and explanation
- File upload and export functionality
- Responsive design for mobile and desktop
- Multi-stage Dockerfile for optimized builds
- Docker Compose configuration with persistent volumes
- Makefile with convenience commands
- Health checks and monitoring
- Environment-based configuration
- Comprehensive README with feature overview
- Quick Start guide for 5-minute setup
- Detailed API documentation
- Architecture documentation with diagrams
- Example Kubernetes manifests
- Project summary document
- Encrypted storage for LLM API keys
- Safe YAML parsing (no code execution)
- CORS protection
- Environment-based secret management
- No telemetry or tracking
- ✅ Parse and validate Kubernetes/k3s YAML manifests
- ✅ 80+ built-in field explanations (works offline)
- ✅ Optional AI-enhanced explanations via LLM
- ✅ Detect deprecated API versions
- ✅ Generate YAML from templates
- ✅ Beautiful glassmorphism UI
- ✅ Persistent settings and configurations
- ✅ One-command Docker deployment
- ✅ Multi-provider LLM support
- Backend: Python 3.11, FastAPI, SQLAlchemy, ruamel.yaml
- Frontend: React 18, Monaco Editor, Axios
- Database: SQLite (PostgreSQL compatible)
- Deployment: Docker, Docker Compose
- Security: AES-256, PBKDF2
- Complete application source code
- Docker deployment configuration
- Comprehensive documentation
- Example YAML files
- Development and production configurations
- Glassmorphism aesthetic with blur effects
- Blue/purple gradient color scheme
- Smooth animations and transitions
- System font stack for optimal readability
- Responsive layout for all screen sizes
Crafted with ♡ by RoarinPenguin
- AI-assisted YAML generation from natural language
- Policy scanning (OPA/Kyverno)
- Diff/compare mode for multiple manifests
- Helm chart support
- Kustomize overlay explanations
- Export explanations as Markdown/PDF
- VS Code extension
- Browser extension
- Multi-language support
- Offline Kubernetes API reference
- Unit and integration tests
- Performance benchmarks
- Rate limiting for LLM endpoints
- Webhook validation mode
- CLI version
- GitHub Actions CI/CD
- Kubernetes deployment manifests
- Prometheus metrics