cluster-api
cluster-api copied to clipboard
kubernetes-sigs
Headlamp plugin for Cluster API
What would you like to be added (User Story)?
As an operator, I would like to visualize the structure and details of my CAPI clusters in the standard dashboard tool, headlamp.
Detailed Description
Currently headlamp does not have support for Cluster API objects. (There is a generic CRD viewer capability, however.) This means that Clusters, MachineDeployments, and such do not show up in the headlamp Map view and are not viewable or editable.
This seems like it should live in the https://github.com/headlamp-k8s/plugins repository. I opened it here for visibility.
Anything else you would like to add?
No response
Label(s) to be applied
/kind feature
/assign
I have a POC of this, so if we're interested in pursuing this, I will clean it up and create a PR.
Love to see the PR of this!
It feels like - at least for me - that this could be a good idea for another CAPI Addon Provider? Like Helm, and Fleet?
So that a user can provision headlamp alongside the CAPI components directly from the start 😊
I opened a working PR at headlamp-k8s/plugins#273 but there's still some work to do before it's fully ready.
All feedback is welcome! I'm no expert with TypeScript or React, so I'd love any advice on code refactoring, or help fleshing out the Detail views. And if anyone can test it, that would be wonderful--so far I've just tested with Docker clusters.
Testing instructions:
- Check out the headlamp-k8s/plugins repo at the above branch
- In the repo,
cd cluster-api && npm run start - Run the headlamp app and the plugin should auto-register and start working
- (Alternately, you can run the headlamp backend and frontend from source and use a browser, but you'll need to read the dev instructions for that)
- Point headlamp at an existing CAPI management cluster
- Check that objects are rendered usefully without errors in the sidebar and the map
- Report any bugs as a comment on the PR headlamp-k8s/plugins#273