privilegedescalation/headlamp-polaris-plugin

Files

T

Chris Farhood 036cb66897 feat: initial Polaris Headlamp plugin (v0.0.1)

Sidebar page at /polaris that reads Fairwinds Polaris audit results
from ConfigMap/polaris-dashboard in the polaris namespace. Displays
cluster score, check summary (pass/warning/danger counts), and
cluster info. Caches results with user-configurable refresh interval.
Handles 403, 404, and malformed JSON error states.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-05 14:47:25 -05:00

2.3 KiB

Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Headlamp plugin that surfaces Fairwinds Polaris audit results inside the Headlamp UI. Reads from ConfigMap/polaris-dashboard in the polaris namespace (key: dashboard.json). Target Headlamp ≥ v0.26.

Build & Development Commands

# Install dependencies
npm install

# Build the plugin (standard Headlamp plugin build)
npx @kinvolk/headlamp-plugin build

# Start development mode with hot reload
npx @kinvolk/headlamp-plugin start

# Type-check without emitting
npx tsc --noEmit

# Lint
npx eslint src/

Architecture

src/
├── index.tsx                    # Entry point: registerSidebarEntry + registerRoute for /polaris
├── api/
│   └── polaris.ts               # Types (AuditData schema), usePolarisData hook, countResults utility, refresh settings
└── components/
    └── PolarisView.tsx           # Main page: score badge, check summary, cluster info, error states, refresh interval selector

Single sidebar page at /polaris. Data is cached in React state and refreshed on a user-configurable interval (stored in localStorage under polaris-plugin-refresh-interval, default 5 minutes). The usePolarisData hook wraps ConfigMap.useGet with caching so stale data is shown while refreshing.

Key Constraints

Data source: ConfigMap/polaris-dashboard in polaris namespace, key dashboard.json. No CRDs, no external API calls, no cluster write operations.
UI components: Use only Headlamp-provided components (@kinvolk/headlamp-plugin/lib/CommonComponents). Do not import raw MUI packages. No custom theming.
Error handling: Must handle 403 (RBAC denied), 404 (Polaris not installed), malformed JSON, and loading states with distinct visual states.
TypeScript strictness: No any, no implicit unknown casting, no dead code, no unused imports.
Packaging: @kinvolk/headlamp-plugin is a peer dependency. Do not bundle React or MUI.

MCP Servers

The project has MCP server integrations configured in .mcp.json:

Gitea (git.farh.net): Source control via gitea-mcp-server
Kubernetes (local): Cluster access via kubernetes-mcp-server
Flux (local): Flux Operator access via flux-operator-mcp

2.3 KiB Raw Blame History