docs: add Headlamp plugin installation guides and setup script
Add comprehensive installation documentation and automated setup for Headlamp plugin manager integration. New files: - install-plugin.sh: Automated installation script for macOS/Linux - HEADLAMP_INSTALLATION.md: Complete installation guide covering: - Local installation (development/testing) - NPM installation (for published plugin) - Headlamp server mode - Kubernetes deployment with ConfigMaps - Troubleshooting common issues - Uninstallation instructions - SETUP_STATUS.md: Quick reference for current setup status Features: - Cross-platform support (macOS, Linux, Windows) - Multiple installation methods documented - Troubleshooting guide for common issues - Development mode instructions - Plugin verification steps Plugin is now ready for: ✅ Local Headlamp desktop installation ✅ Headlamp server deployment ✅ Kubernetes-based Headlamp with ConfigMaps ✅ Development with hot reload Current installation: - Location: ~/Library/Application Support/Headlamp/plugins/headlamp-sealed-secrets/ - Version: 0.2.0 - Sealed Secrets controller: Running in cluster - Status: Ready for use 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>
This commit is contained in:
+177
@@ -0,0 +1,177 @@
|
||||
# Plugin Setup Status
|
||||
|
||||
## ✅ Current Installation Status
|
||||
|
||||
### Plugin Installation
|
||||
- **Status**: ✅ Installed
|
||||
- **Location**: `~/Library/Application Support/Headlamp/plugins/headlamp-sealed-secrets/`
|
||||
- **Version**: 0.2.0
|
||||
- **Build Date**: 2026-02-11
|
||||
|
||||
### Files Installed
|
||||
```
|
||||
~/Library/Application Support/Headlamp/plugins/headlamp-sealed-secrets/
|
||||
├── main.js ✅ (359.73 kB)
|
||||
├── package.json ✅
|
||||
├── README.md ✅
|
||||
└── LICENSE ✅
|
||||
```
|
||||
|
||||
### Kubernetes Cluster
|
||||
- **Context**: `default`
|
||||
- **Sealed Secrets Controller**: ✅ Running
|
||||
- Deployment: `sealed-secrets-controller` in `kube-system`
|
||||
- CRD: `sealedsecrets.bitnami.com` installed
|
||||
- Age: 4 days 4 hours
|
||||
|
||||
### Development Environment
|
||||
- **Dev Server**: ✅ Running (port-forward to headlamp on port 8080)
|
||||
- **Build Status**: ✅ Latest build successful
|
||||
- **Tests**: 36/39 passing (92%)
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
### Access the Plugin
|
||||
|
||||
1. **If using Headlamp Desktop App**:
|
||||
- Restart Headlamp
|
||||
- Open Headlamp
|
||||
- Look for "Sealed Secrets" in the sidebar
|
||||
|
||||
2. **If using Development Server** (currently running):
|
||||
- Access at: http://localhost:8080
|
||||
- Plugin is hot-reloading (changes rebuild automatically)
|
||||
|
||||
### Create Your First Sealed Secret
|
||||
|
||||
1. Navigate to "Sealed Secrets" in the sidebar
|
||||
2. Click "Create Sealed Secret"
|
||||
3. Fill in:
|
||||
- Name: `my-first-secret`
|
||||
- Namespace: `default`
|
||||
- Secret key: `password`
|
||||
- Secret value: `mysecretvalue`
|
||||
4. Click "Create"
|
||||
|
||||
### View Sealing Keys
|
||||
|
||||
1. Navigate to "Sealed Secrets" → "Sealing Keys"
|
||||
2. View all active and expired certificates
|
||||
3. Download certificates for CI/CD use
|
||||
|
||||
## 📋 Installation Methods
|
||||
|
||||
### Method 1: Automated Install Script (Recommended)
|
||||
```bash
|
||||
./install-plugin.sh
|
||||
```
|
||||
|
||||
### Method 2: Manual Install
|
||||
```bash
|
||||
cd headlamp-sealed-secrets
|
||||
npm install
|
||||
npm run build
|
||||
|
||||
# macOS
|
||||
cp -r dist/* ~/Library/Application\ Support/Headlamp/plugins/headlamp-sealed-secrets/
|
||||
cp package.json ~/Library/Application\ Support/Headlamp/plugins/headlamp-sealed-secrets/
|
||||
```
|
||||
|
||||
### Method 3: Development Mode (Hot Reload)
|
||||
```bash
|
||||
cd headlamp-sealed-secrets
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
Access at: http://localhost:8080
|
||||
|
||||
## 🔧 Troubleshooting
|
||||
|
||||
### Plugin Not Showing Up
|
||||
|
||||
1. **Check installation**:
|
||||
```bash
|
||||
ls -la ~/Library/Application\ Support/Headlamp/plugins/headlamp-sealed-secrets/
|
||||
```
|
||||
Should show: `main.js` and `package.json`
|
||||
|
||||
2. **Restart Headlamp completely**:
|
||||
- Quit Headlamp (⌘+Q on macOS)
|
||||
- Reopen Headlamp
|
||||
|
||||
3. **Check browser console**:
|
||||
- View → Toggle Developer Tools
|
||||
- Look for plugin errors in Console
|
||||
|
||||
### Controller Issues
|
||||
|
||||
1. **Verify controller is running**:
|
||||
```bash
|
||||
kubectl get pods -n kube-system -l name=sealed-secrets-controller
|
||||
```
|
||||
|
||||
2. **Check controller logs**:
|
||||
```bash
|
||||
kubectl logs -n kube-system -l name=sealed-secrets-controller
|
||||
```
|
||||
|
||||
3. **Reinstall controller if needed**:
|
||||
```bash
|
||||
kubectl apply -f https://github.com/bitnami-labs/sealed-secrets/releases/download/v0.24.0/controller.yaml
|
||||
```
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
- **Installation Guide**: [HEADLAMP_INSTALLATION.md](HEADLAMP_INSTALLATION.md)
|
||||
- **Plugin README**: [headlamp-sealed-secrets/README.md](headlamp-sealed-secrets/README.md)
|
||||
- **Development Guide**: [DEVELOPMENT.md](DEVELOPMENT.md) (if exists)
|
||||
- **Enhancement Plan**: [ENHANCEMENT_PLAN.md](ENHANCEMENT_PLAN.md)
|
||||
|
||||
## 🎯 Features Available
|
||||
|
||||
### Current Features (v0.2.0)
|
||||
- ✅ List all SealedSecrets across namespaces
|
||||
- ✅ Create new SealedSecrets with client-side encryption
|
||||
- ✅ View and download sealing keys
|
||||
- ✅ Certificate expiry warnings (30-day threshold)
|
||||
- ✅ Controller health monitoring
|
||||
- ✅ RBAC permission checks
|
||||
- ✅ API version auto-detection
|
||||
- ✅ WCAG 2.1 AA accessibility
|
||||
- ✅ Skeleton loading states
|
||||
- ✅ Error boundaries for error handling
|
||||
- ✅ Type-safe error handling (Result types)
|
||||
- ✅ Input validation with helpful error messages
|
||||
- ✅ Retry logic with exponential backoff
|
||||
|
||||
### Planned Features
|
||||
- 🔄 Decrypt SealedSecret values (requires controller API)
|
||||
- 🔄 Re-encrypt secrets to new scope
|
||||
- 🔄 Export/import SealedSecrets
|
||||
- 🔄 Bulk operations
|
||||
- 🔄 Advanced filtering and search
|
||||
|
||||
## 📊 Version History
|
||||
|
||||
### v0.2.0 (2026-02-11) - Current
|
||||
- Phase 1: Type-safe error handling
|
||||
- Phase 2: UX improvements
|
||||
- Phase 3: Performance optimizations
|
||||
- Phase 4.1: Unit tests (92% passing)
|
||||
|
||||
### v0.1.0 (2026-02-11) - Initial Release
|
||||
- Basic SealedSecret management
|
||||
- Create, list, view operations
|
||||
- Certificate management
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- **Repository**: https://github.com/cpfarhood/headlamp-sealed-secrets-plugin
|
||||
- **Issues**: https://github.com/cpfarhood/headlamp-sealed-secrets-plugin/issues
|
||||
- **NPM**: (To be published)
|
||||
- **Artifact Hub**: (To be published)
|
||||
|
||||
---
|
||||
|
||||
**Last Updated**: 2026-02-11 23:03 PST
|
||||
**Status**: ✅ Ready for Use
|
||||
Reference in New Issue
Block a user