metal3: Add BareMetalHost plugin with list and detail views by mastermaxx03 · Pull Request #852 · headlamp-k8s/plugins

mastermaxx03 · 2026-06-24T20:19:45Z

Summary

Initial Metal3 plugin. Adds a Metal3 section to Headlamp for the
BareMetalHost resource. First phase of the plugin development; more resources and a
map view to follow.

Included

BareMetalHost list view with a composite Status column (operational
status, provisioning state, and error type in one cell).
BareMetalHost detail view (config, status, consumer, power, BMC).
A reusable CRD guard that shows a clear message when the Metal3 CRDs
aren't installed in the cluster.
Unit tests for the status logic and a Storybook story.

How to test

A cluster with the Metal3 CRDs installed.
cd metal3 && npm install && npm start, then run Headlamp.
Apply the sample host: kubectl apply -f metal3/test-files/baremetalhost.yaml.
Open the Metal3 section: the host lists, and clicking it opens the detail view.

Scope

Read-only, BareMetalHost only for now. The cluster-api-provider-metal3
resources, the relationship map, and mutating actions are planned follow-ups.

Relates to kubernetes-sigs/headlamp#5268.

mastermaxx03 · 2026-06-24T20:19:58Z

@illume Ready for review!

Copilot

Pull request overview

Adds an initial Metal3 plugin to the headlamp-k8s/plugins repo, introducing a new sidebar section and routes to view Metal3 BareMetalHost resources in Headlamp (list + details), along with supporting status composition logic, tests, and Storybook coverage.

Changes:

Register a new Metal3 sidebar entry and routes for BareMetalHost list/detail pages.
Implement BareMetalHost list and detail views, including a composite Status column and a reusable CRD presence guard.
Add unit tests + Storybook story for the status composition/rendering, plus local test YAML and plugin scaffolding files.

Reviewed changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
metal3/tsconfig.json	TypeScript config extending the standard Headlamp plugin tsconfig.
metal3/test-files/baremetalhost.yaml	Sample Secret + BareMetalHost manifest for local testing.
metal3/src/storybook.test.tsx	Storyshots test runner for Storybook stories in this plugin.
metal3/src/index.tsx	Registers Metal3 sidebar entry and list/detail routes.
metal3/src/headlamp-plugin.d.ts	Adds Headlamp plugin type references for TS.
metal3/src/common/CRDGuard.tsx	Guard component to render a clear message when CRDs are missing.
metal3/src/BareMetalHost/status.tsx	Composite status derivation + status cell rendering component.
metal3/src/BareMetalHost/status.test.ts	Unit tests for `composeStatus`.
metal3/src/BareMetalHost/status.stories.tsx	Storybook stories for the status label rendering.
metal3/src/BareMetalHost/List.tsx	BareMetalHost list view using `ResourceListView` + composite Status column.
metal3/src/BareMetalHost/Details.tsx	BareMetalHost detail view using `DetailsGrid` extraInfo fields.
metal3/README.md	Plugin documentation, scope, dev workflow, and limitations.
metal3/package.json	Plugin package metadata and standard headlamp-plugin scripts.
metal3/.gitignore	Ignores build output, caches, editor files, node_modules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+ * limitations under the License.
+ */
+
+import CustomResourceDefinition from '@kinvolk/headlamp-plugin/lib/lib/k8s/crd';


+A [Headlamp](https://headlamp.dev) plugin that adds a Metal3 section to the UI for viewing and
+managing bare-metal infrastructure through Kubernetes.


illume

Nice one!

I left some notes.

illume · 2026-06-26T13:41:11Z

+import { CRDGuard } from '../common/CRDGuard';
+import { bareMetalHostClass } from './List';
+
+// Detail view for a single BareMetalHost. DetailsGrid renders the standard


Please check the formatting of comments in other plugins. We use tsdoc to document interfaces+fields, functions, params, return values etc.

illume · 2026-06-26T13:42:01Z

+- A Kubernetes cluster whose API has the Metal3 `baremetal-operator` CRDs installed, in
+  particular `baremetalhosts.metal3.io`. If those CRDs are absent, the plugin indicates that the
+  operator is not installed rather than showing an empty view.
+


I think it would be good to add a link to the metal3 getting started page.

illume · 2026-06-26T13:45:01Z

+// Renders the composite status for the list view: operational status as the
+// colored headline, provisioning state beneath it, and the error type as a
+// separate badge carrying the error message on hover.
+export function BareMetalHostStatusLabel({ host }: { host: KubeObject }) {


Component file names should the same name as the component. So perhaps rename this HostStatusLabel.tsx HostStatusLabel.stories.tsx and HostStatusLabel.test.tsx

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated 3 comments.

+  if (!crd) {
+    // CRD presence is still being checked.
+    return null;
+  }


+
+export function BareMetalHosts() {
+  return (
+    <CRDGuard crdName="baremetalhosts.metal3.io" resourceLabel="BareMetalHost">


+  const { name = params.name, namespace = params.namespace } = props;
+
+  return (
+    <CRDGuard crdName="baremetalhosts.metal3.io" resourceLabel="BareMetalHost">


mastermaxx03 · 2026-06-27T13:25:38Z

@illume addressed the comments!

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated 2 comments.

+        <Typography variant="body2" color="textSecondary">
+          The {crdName} CRD was not found in this cluster. Install the corresponding Metal3 operator
+          to view {resourceLabel} resources here.
+        </Typography>


+{
+  "name": "@headlamp-k8s/metal3",
+  "version": "0.1.0",
+  "description": "A Headlamp plugin for viewing and managing Metal3 bare-metal hosts and infrastructure.",


Signed-off-by: mastermaxx03 <srivastavaanimesh22@gmail.com>

Copilot

Pull request overview

Copilot reviewed 13 out of 15 changed files in this pull request and generated no new comments.

illume requested a review from Copilot June 26, 2026 13:40

Copilot started reviewing on behalf of illume June 26, 2026 13:40 View session

Copilot AI reviewed Jun 26, 2026

View reviewed changes

illume requested changes Jun 26, 2026

View reviewed changes

illume requested a review from Copilot June 26, 2026 13:46

Copilot started reviewing on behalf of illume June 26, 2026 13:46 View session

Copilot AI reviewed Jun 26, 2026

View reviewed changes

mastermaxx03 force-pushed the metal3-plugin branch from 69b75d2 to 5c487b8 Compare June 27, 2026 13:24

mastermaxx03 requested review from Copilot and illume June 27, 2026 13:25

Copilot started reviewing on behalf of mastermaxx03 June 27, 2026 13:26 View session

Copilot AI reviewed Jun 27, 2026

View reviewed changes

mastermaxx03 added 4 commits June 27, 2026 19:41

metal3: Scaffold the plugin

612d82b

Signed-off-by: mastermaxx03 <srivastavaanimesh22@gmail.com>

metal3: Add composite Status column with tests

3d1f23f

Signed-off-by: mastermaxx03 <srivastavaanimesh22@gmail.com>

metal3: Add BareMetalHost list and detail views with a CRD guard

ef589e7

Signed-off-by: mastermaxx03 <srivastavaanimesh22@gmail.com>

metal3: Register sidebar entry and routes

db44806

Signed-off-by: mastermaxx03 <srivastavaanimesh22@gmail.com>

mastermaxx03 force-pushed the metal3-plugin branch from 5c487b8 to db44806 Compare June 27, 2026 14:11

mastermaxx03 requested a review from Copilot June 27, 2026 14:12

Copilot started reviewing on behalf of mastermaxx03 June 27, 2026 14:12 View session

Copilot AI reviewed Jun 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

metal3: Add BareMetalHost plugin with list and detail views#852

metal3: Add BareMetalHost plugin with list and detail views#852
mastermaxx03 wants to merge 4 commits into
headlamp-k8s:mainfrom
mastermaxx03:metal3-plugin

mastermaxx03 commented Jun 24, 2026 •

edited

Loading

Uh oh!

mastermaxx03 commented Jun 24, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

illume left a comment

Uh oh!

illume Jun 26, 2026

Uh oh!

illume Jun 26, 2026

Uh oh!

illume Jun 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

mastermaxx03 commented Jun 27, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		A [Headlamp](https://headlamp.dev) plugin that adds a Metal3 section to the UI for viewing and
		managing bare-metal infrastructure through Kubernetes.

Uh oh!

Conversation

mastermaxx03 commented Jun 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Included

How to test

Scope

Uh oh!

mastermaxx03 commented Jun 24, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

illume left a comment

Choose a reason for hiding this comment

Uh oh!

illume Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

illume Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

illume Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

mastermaxx03 commented Jun 27, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mastermaxx03 commented Jun 24, 2026 •

edited

Loading