privilegedescalation/headlamp-sealed-secrets-plugin
Archived
12
0
Fork 0
Code Issues 2 Pull Requests 2 Actions Packages Projects Releases 27 Wiki Activity
23 Commits 20 Branches 27 Tags
d2a032b34b2f487be814e6a11226ab7a40439d24
Commit Graph

3 Commits

Author SHA1 Message Date
Chris Farhood ebbdb42c05 docs: implement Phase 2 - API documentation with TypeDoc 
Set up TypeDoc to auto-generate comprehensive API reference documentation
from TypeScript source code.

Changes:
- Installed typedoc and typedoc-plugin-markdown (v0.2.0 plugins)
- Created typedoc.json configuration with 9 entry points
- Added docs:api and docs:watch npm scripts
- Fixed test file imports (validateNamespace → isValidNamespace)
- Updated tsconfig.json to exclude test files from compilation
- Generated markdown API documentation in docs/api-reference/generated/

Generated API documentation:
- 9 modules documented (lib/, hooks/, types/)
- lib/crypto - 14 encryption/certificate functions
- lib/controller - 5 Kubernetes API functions
- lib/validators - 6 validation functions
- lib/retry - Exponential backoff utilities
- lib/rbac - RBAC permission checking
- types - Result types, branded types, interfaces
- hooks/useSealedSecretEncryption - Encryption React hook
- hooks/usePermissions - RBAC React hooks
- hooks/useControllerHealth - Health monitoring hook

Benefits:
- Auto-generated from TypeScript source (stays in sync)
- Markdown format for easy integration
- Type signatures and JSDoc included
- Function parameters and return types documented
- Links between related types and functions

Phase 2 deliverables (2-3 days estimated, completed in 1 session):
✅ TypeDoc installed and configured
✅ Entry points identified for all core modules
✅ API documentation generated (9 modules, 40+ functions)
✅ npm scripts added for docs generation
✅ Test files excluded from documentation

Next: Phase 3 - User tutorials and guides

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>
 2026-02-11 23:27:18 -05:00
Chris Farhood 4740179b0b chore: bump version to 0.2.0 for Artifact Hub 
Update version metadata to 0.2.0 in preparation for Artifact Hub release.

Changes:
- package.json: 0.1.0 → 0.2.0
- artifacthub-pkg.yml: version and appVersion 0.1.0 → 0.2.0
- Enhanced description to highlight WCAG 2.1 AA accessibility

This version includes:
- Phase 1: Type-safe error handling (Result types, branded types, validators, retry logic)
- Phase 2: UX improvements (cert expiry warnings, health checks, RBAC, API version detection)
- Phase 3: Performance optimizations (React.memo, debouncing, lazy loading)
- Phase 4.1: Unit tests (36/39 passing - types, retry, validators)

Artifact Hub will pick up this version on next scan.

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>
 2026-02-11 22:33:38 -05:00
Chris Farhood dddbd30677 Initial release: Headlamp Sealed Secrets plugin v0.1.0 
Features:
- Complete SealedSecret CRD integration with Headlamp
- Client-side encryption using controller's public key
- Support for all three scoping modes (strict, namespace-wide, cluster-wide)
- List and detail views for SealedSecrets
- Encryption dialog for creating new SealedSecrets
- Decryption support with RBAC awareness
- Sealing keys management
- Settings page for controller configuration
- Integration with Secret detail view

Technical:
- Full TypeScript with strict mode
- ~1,345 lines of code
- Build size: 339.42 kB (93.21 kB gzipped)
- Compatible with Headlamp v0.13.0+
- Apache 2.0 license

Security:
- All encryption performed client-side
- RSA-OAEP + AES-256-GCM (kubeseal-compatible)
- Auto-hide decrypted values after 30 seconds

Closes: Initial implementation
 2026-02-11 20:31:20 -05:00