feat: initial release of headlamp-rook-ceph-plugin v0.1.0

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>
This commit is contained in:
2026-02-18 16:55:39 -05:00
commit 25175b65b8
30 changed files with 21588 additions and 0 deletions
+183
View File
@@ -0,0 +1,183 @@
/**
* headlamp-rook-ceph-plugin — entry point.
*
* Registers sidebar entries, routes, detail view sections, table column
* processors, and app bar action for Rook-Ceph visibility in Headlamp.
*/
import {
registerAppBarAction,
registerDetailsViewSection,
registerResourceTableColumnsProcessor,
registerRoute,
registerSidebarEntry,
} from '@kinvolk/headlamp-plugin/lib';
import React from 'react';
import { RookCephDataProvider } from './api/RookCephDataContext';
import AppBarClusterBadge from './components/AppBarClusterBadge';
import BlockPoolsPage from './components/BlockPoolsPage';
import CephPodDetailSection from './components/CephPodDetailSection';
import { buildPVColumns, buildStorageClassColumns } from './components/integrations/StorageClassColumns';
import OverviewPage from './components/OverviewPage';
import PodsPage from './components/PodsPage';
import PVCDetailSection from './components/PVCDetailSection';
import PVDetailSection from './components/PVDetailSection';
import StorageClassesPage from './components/StorageClassesPage';
import VolumesPage from './components/VolumesPage';
// ---------------------------------------------------------------------------
// Sidebar entries
// ---------------------------------------------------------------------------
registerSidebarEntry({
parent: null,
name: 'rook-ceph',
label: 'Rook-Ceph',
url: '/rook-ceph',
icon: 'mdi:database-cog',
});
registerSidebarEntry({
parent: 'rook-ceph',
name: 'rook-ceph-overview',
label: 'Overview',
url: '/rook-ceph',
icon: 'mdi:view-dashboard',
});
registerSidebarEntry({
parent: 'rook-ceph',
name: 'rook-ceph-blockpools',
label: 'Block Pools',
url: '/rook-ceph/block-pools',
icon: 'mdi:database',
});
registerSidebarEntry({
parent: 'rook-ceph',
name: 'rook-ceph-pods',
label: 'Pods',
url: '/rook-ceph/pods',
icon: 'mdi:cube-outline',
});
// ---------------------------------------------------------------------------
// Routes
// ---------------------------------------------------------------------------
registerRoute({
path: '/rook-ceph',
sidebar: 'rook-ceph-overview',
name: 'rook-ceph-overview',
exact: true,
component: () => (
<RookCephDataProvider>
<OverviewPage />
</RookCephDataProvider>
),
});
registerRoute({
path: '/rook-ceph/block-pools',
sidebar: 'rook-ceph-blockpools',
name: 'rook-ceph-blockpools',
exact: true,
component: () => (
<RookCephDataProvider>
<BlockPoolsPage />
</RookCephDataProvider>
),
});
// Storage Classes and Volumes pages accessible via direct URL
registerRoute({
path: '/rook-ceph/storage-classes',
sidebar: 'rook-ceph-overview',
name: 'rook-ceph-storage-classes',
exact: true,
component: () => (
<RookCephDataProvider>
<StorageClassesPage />
</RookCephDataProvider>
),
});
registerRoute({
path: '/rook-ceph/volumes',
sidebar: 'rook-ceph-overview',
name: 'rook-ceph-volumes',
exact: true,
component: () => (
<RookCephDataProvider>
<VolumesPage />
</RookCephDataProvider>
),
});
registerRoute({
path: '/rook-ceph/pods',
sidebar: 'rook-ceph-pods',
name: 'rook-ceph-pods',
exact: true,
component: () => (
<RookCephDataProvider>
<PodsPage />
</RookCephDataProvider>
),
});
// ---------------------------------------------------------------------------
// Detail view section — PVC pages
// ---------------------------------------------------------------------------
registerDetailsViewSection(({ resource }) => {
if (resource?.kind !== 'PersistentVolumeClaim') return null;
return (
<RookCephDataProvider>
<PVCDetailSection resource={resource} />
</RookCephDataProvider>
);
});
// ---------------------------------------------------------------------------
// Detail view section — PV pages
// ---------------------------------------------------------------------------
registerDetailsViewSection(({ resource }) => {
if (resource?.kind !== 'PersistentVolume') return null;
return <PVDetailSection resource={resource} />;
});
// ---------------------------------------------------------------------------
// Detail view section — Pod pages (Rook-Ceph daemon pods only)
// ---------------------------------------------------------------------------
registerDetailsViewSection(({ resource }) => {
if (resource?.kind !== 'Pod') return null;
return <CephPodDetailSection resource={resource} />;
});
// ---------------------------------------------------------------------------
// Table column processors — native StorageClass and PV tables
// ---------------------------------------------------------------------------
registerResourceTableColumnsProcessor(({ id, columns }) => {
if (id === 'headlamp-storageclasses') {
return [...columns, ...buildStorageClassColumns()];
}
if (id === 'headlamp-persistentvolumes') {
return [...columns, ...buildPVColumns()];
}
return columns;
});
// ---------------------------------------------------------------------------
// App bar action — cluster health badge
// ---------------------------------------------------------------------------
registerAppBarAction(() => (
<RookCephDataProvider>
<AppBarClusterBadge />
</RookCephDataProvider>
));