Chris Farhood
25175b65b8
Headlamp plugin for Rook-Ceph cluster visibility. Pages: - Overview dashboard: CephCluster health, capacity bar, resource counts (block pools, filesystems, object stores, PVs, PVCs), daemon pod health summary, non-Bound PVC alerts - Block Pools: CephBlockPool table with replication, failure domain, mirroring; slide-in detail panel - Pods: all Rook-Ceph daemon pods grouped by role with ready/total counts Native Headlamp integrations: - StorageClass table: Rook Type, Pool, Cluster ID columns - PV table: Rook Type, Pool columns - PVC detail injection: driver, type, pool, volume handle - PV detail injection: CSI volume attributes - Pod detail injection: Ceph daemon role badge - App bar badge: cluster health (HEALTH_OK/WARN/ERR), color-coded API / architecture: - src/api/k8s.ts: types + filters for ceph.rook.io/v1 CRDs; handles both default rook-ceph.* and custom-namespace provisioner strings - src/api/RookCephDataContext.tsx: shared context provider; fetches CephCluster, CephBlockPool, CephFilesystem, CephObjectStore CRDs plus daemon pods via label selectors - 37 unit tests (vitest + @testing-library/react) - TypeScript strict mode, zero any types - CI + release GitHub Actions workflows 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>
35 lines
1.0 KiB
Markdown
35 lines
1.0 KiB
Markdown
# Contributing
|
|
|
|
Contributions are welcome! Please open an issue before submitting large PRs.
|
|
|
|
## Development Setup
|
|
|
|
```bash
|
|
git clone https://github.com/cpfarhood/headlamp-rook-ceph-plugin.git
|
|
cd headlamp-rook-ceph-plugin
|
|
npm install
|
|
npm start # hot-reload dev server
|
|
```
|
|
|
|
## Before Submitting
|
|
|
|
```bash
|
|
npm run tsc # must exit 0
|
|
npm run lint # must exit 0
|
|
npm test # all tests must pass
|
|
npm run build # must succeed
|
|
```
|
|
|
|
## Coding Conventions
|
|
|
|
- Functional React components only — no class components
|
|
- TypeScript strict mode: no `any`, use `unknown` + type guards at API boundaries
|
|
- All imports from `@kinvolk/headlamp-plugin/lib` and `@kinvolk/headlamp-plugin/lib/CommonComponents`
|
|
- No additional UI libraries (no direct MUI imports, no Ant Design, etc.)
|
|
- Context provider (`RookCephDataProvider`) wraps each route component in `index.tsx`
|
|
- Tests: vitest + @testing-library/react, mock with `vi.mock('@kinvolk/headlamp-plugin/lib', ...)`
|
|
|
|
## License
|
|
|
|
By contributing, you agree your contributions will be licensed under Apache-2.0.
|