136 lines
2.8 KiB
Markdown
136 lines
2.8 KiB
Markdown
# HelmView Quick Start Guide
|
|
|
|
## 🚀 Get Started in 3 Steps
|
|
|
|
### Step 1: Start the Application
|
|
```bash
|
|
# Clone and enter directory
|
|
cd helmview
|
|
|
|
# Start with Docker Compose
|
|
docker-compose up --build
|
|
```
|
|
|
|
Wait for both services to start (2-3 minutes first time).
|
|
|
|
### Step 2: Open HelmView
|
|
Open your browser and navigate to:
|
|
- **Frontend**: http://localhost:5173
|
|
- **API Docs**: http://localhost:8000/docs
|
|
|
|
### Step 3: Create Your First Project
|
|
|
|
1. **Create a project**
|
|
- Click "Create Project"
|
|
- Enter name: "my-first-chart"
|
|
- Click "Create Project"
|
|
|
|
2. **Upload a Helm chart**
|
|
- Get a sample chart:
|
|
```bash
|
|
helm create sample-chart
|
|
helm package sample-chart
|
|
```
|
|
- Click "Upload Chart"
|
|
- Upload the `sample-chart-0.1.0.tgz` file
|
|
|
|
3. **Render the chart**
|
|
- Click "Render"
|
|
- Keep default settings
|
|
- Click "Render Chart"
|
|
|
|
4. **Edit resources**
|
|
- Click on any resource card (e.g., Deployment)
|
|
- Switch to "YAML" tab
|
|
- Edit the YAML (try changing replicas)
|
|
- Click "Save Changes"
|
|
|
|
5. **Export modified chart**
|
|
- Click "Export Chart"
|
|
- Wait for validation
|
|
- Click "Download Chart"
|
|
|
|
## 📋 What You Get
|
|
|
|
After following these steps, you'll have:
|
|
- ✅ A running HelmView instance
|
|
- ✅ A modified Helm chart with your changes
|
|
- ✅ A validated, packaged chart ready to deploy
|
|
|
|
## 🎯 Next Steps
|
|
|
|
- **Filter Resources**: Use the filters to find specific resources
|
|
- **Batch Edits**: Edit multiple resources and export them all
|
|
- **Re-render**: Try different values overrides
|
|
- **Multiple Projects**: Create more projects for different charts
|
|
|
|
## 💡 Tips
|
|
|
|
### Getting a Helm Chart to Test
|
|
```bash
|
|
# Create a new chart
|
|
helm create my-app
|
|
|
|
# Package it
|
|
helm package my-app
|
|
|
|
# Upload my-app-0.1.0.tgz to HelmView
|
|
```
|
|
|
|
### Using Existing Charts
|
|
```bash
|
|
# Add Helm repo
|
|
helm repo add bitnami https://charts.bitnami.com/bitnami
|
|
helm repo update
|
|
|
|
# Pull a chart
|
|
helm pull bitnami/nginx --untar
|
|
|
|
# Package it
|
|
helm package nginx
|
|
|
|
# Upload nginx-*.tgz to HelmView
|
|
```
|
|
|
|
### Common Edits to Try
|
|
- Change `spec.replicas` in Deployments
|
|
- Add environment variables
|
|
- Modify service ports
|
|
- Add labels and annotations
|
|
- Change resource limits
|
|
|
|
## 🐛 Troubleshooting
|
|
|
|
**Application won't start?**
|
|
```bash
|
|
# Check Docker is running
|
|
docker ps
|
|
|
|
# View logs
|
|
docker-compose logs backend
|
|
docker-compose logs frontend
|
|
|
|
# Restart clean
|
|
docker-compose down -v
|
|
docker-compose up --build
|
|
```
|
|
|
|
**Can't upload chart?**
|
|
- Ensure file is `.tgz`, `.tar.gz`, or `.zip`
|
|
- Max size is 100MB
|
|
- Chart must have valid `Chart.yaml`
|
|
|
|
**Export fails?**
|
|
- Check all YAML edits are saved
|
|
- Review helm lint output in the modal
|
|
- Ensure YAML syntax is valid
|
|
|
|
## 📚 Learn More
|
|
- Read the full [README.md](README.md)
|
|
- Check API docs at http://localhost:8000/docs
|
|
- Review example charts in `/examples` (coming soon)
|
|
|
|
---
|
|
|
|
**Happy Helm Editing! 🎉**
|