DevContainer User
d8d83ffa47
Implements comprehensive enhancements to make the Helm chart more user-friendly and easier to deploy across different scenarios. 🎯 **IMPLEMENTED IMPROVEMENTS:** **1. Values Organization & Grouping** - Reorganized values.yaml with logical sections: - Basic Configuration (name, image, githubRepo) - Access & Interface (ide, ssh, display, user) - Infrastructure & Resources (storage, resources, shm, clusterAccess) - Integrations (happy, mcp sidecars) - Smart Defaults & Auto-Detection - Updated deployment templates to use new structure - Maintains clean, navigable configuration **2. Simplified Quick-Start Values** - Added values-quickstart.yaml for 80% of users - Just 2 required fields: name + githubRepo - Includes usage instructions and common customizations - Copy-paste ready deployment experience **3. Better Documentation Structure** - Added values.schema.json for IDE validation and autocomplete - Created comprehensive USAGE.md with real-world examples: - Development, team, K8s admin, AI/ML, lightweight scenarios - Secret configuration examples - Resource sizing by use case - Common troubleshooting patterns **4. Smart Defaults & Auto-Detection** - Added template helpers for intelligent resource sizing - Environment auto-detection based on naming patterns - Smart MCP sidecar selection based on cluster access - Resource profile auto-selection (auto/small/medium/large/xlarge) - Enhanced _helpers.tpl with smart default functions 🎫 **CREATED GITHUB ISSUES** for future enhancements: - #32: Helm chart preset profiles - #33: Split large deployment.yaml template - #34: Advanced auto-detection for Kubernetes environments - #35: Specialized Helm chart variants (basic/team/k8s/ai) - #36: Installation and configuration helper scripts - #37: Comprehensive validation and health monitoring - #38: User experience improvements with better error messages - #39: Comprehensive examples and template library 📊 **IMPACT:** - Reduced required configuration from ~20 values to 2 essential fields - Added IDE support with schema validation - Created guided examples for common scenarios - Established foundation for advanced auto-detection - Planned comprehensive tooling ecosystem 🚀 **USAGE:** ```bash # Quick start (new users) cp chart/values-quickstart.yaml my-values.yaml # Edit name and githubRepo helm install mydev ./chart -f my-values.yaml # Full customization (power users) # Edit chart/values.yaml with organized sections helm install mydev ./chart ``` Generated with [Claude Code](https://claude.ai/code) via [Happy](https://happy.engineering) Co-Authored-By: Claude <noreply@anthropic.com> Co-Authored-By: Happy <yesreply@happy.engineering>
58 lines
1.7 KiB
YAML
58 lines
1.7 KiB
YAML
# =============================================================================
|
|
# QUICKSTART VALUES - Just set these 3 essentials!
|
|
# =============================================================================
|
|
|
|
# Instance name (required)
|
|
name: mydev
|
|
|
|
# GitHub repository to clone (required)
|
|
githubRepo: https://github.com/youruser/yourrepo
|
|
|
|
# IDE choice (optional - defaults to vscode)
|
|
# Options: vscode | antigravity | none
|
|
ide:
|
|
type: vscode
|
|
|
|
# =============================================================================
|
|
# COMMON CUSTOMIZATIONS (optional)
|
|
# =============================================================================
|
|
|
|
# Enable SSH access
|
|
# ssh:
|
|
# enabled: true
|
|
|
|
# Adjust resources for smaller/larger workloads
|
|
# resources:
|
|
# requests:
|
|
# memory: "1Gi" # Smaller
|
|
# cpu: "500m"
|
|
# limits:
|
|
# memory: "4Gi" # Smaller
|
|
# cpu: "2000m"
|
|
|
|
# Different storage size
|
|
# storage:
|
|
# size: 16Gi # Smaller
|
|
|
|
# Disable some MCP sidecars to save resources
|
|
# mcp:
|
|
# sidecars:
|
|
# kubernetes:
|
|
# enabled: false
|
|
# flux:
|
|
# enabled: false
|
|
|
|
# =============================================================================
|
|
# USAGE INSTRUCTIONS
|
|
# =============================================================================
|
|
|
|
# 1. Copy this file: cp values-quickstart.yaml my-values.yaml
|
|
# 2. Edit the 'name' and 'githubRepo' fields above
|
|
# 3. Deploy: helm install mydev ./chart -f my-values.yaml
|
|
# 4. Access: kubectl port-forward deployment/devcontainer-mydev 5800:5800
|
|
# 5. Open: http://localhost:5800
|
|
|
|
# For secrets (GitHub token, passwords):
|
|
# kubectl create secret generic devcontainer-mydev-secrets-env \
|
|
# --from-literal=GITHUB_TOKEN='ghp_...' \
|
|
# --from-literal=VNC_PASSWORD='changeme' |