cloudnative-pg / cloudnative-pg/cloudnative-pg

[Feature]: Integrate CloudNativePG with Headlamp

Open
#11,396 2 comments 3 reactions 1 assignee Claimed by @gbartolini View on GitHub
triage
Dominant language
Go
Stars
9.3k
Forks
759
Avg merge
2d 6h
Merged PRs (30d)
44

Description

### Is there an existing issue already for this feature request/idea?

- [x] I have searched for an existing issue, and could not find anything. I believe this is a new feature request to be evaluated.

### What problem is this feature going to solve? Why should it be added?

CloudNativePG provides a Kubernetes-native way to deploy and manage PostgreSQL clusters, but users currently need to rely on `kubectl`, YAML manifests, or other tools to inspect and manage CloudNativePG resources.

For users who already use Headlamp as their Kubernetes management interface, this requires switching between different tools to understand the state and health of their PostgreSQL clusters.

A dedicated Headlamp integration could provide a more accessible way to visualize CloudNativePG resources and their relationships, making it easier to monitor and troubleshoot PostgreSQL clusters directly from the Kubernetes UI.

### Describe the solution you'd like

I would like to explore integrating CloudNativePG with [Headlamp](https://headlamp.dev/) through a dedicated Headlamp plugin.

The integration could provide dedicated views for CloudNativePG resources, including:

* PostgreSQL cluster health and status
* Primary and replica instances
* Replication status
* Cluster conditions and events
* Backups and recovery status
* Poolers
* Storage and resource information
* Relationships between CloudNativePG resources

The goal would be to provide a clear, Kubernetes-native UI for understanding and managing CloudNativePG deployments while following Headlamp's existing UI patterns.

I would be interested in discussing the scope and design with the CloudNativePG maintainers before starting implementation.

### Describe alternatives you've considered

Users can currently manage CloudNativePG resources using `kubectl` and Kubernetes manifests, or use other PostgreSQL and Kubernetes management tools.

Another alternative would be to use Headlamp's generic Custom Resource views. However, this would not provide CloudNativePG-specific information, relationships, health indicators, or workflows.

A dedicated Headlamp plugin would allow CloudNativePG-specific functionality to be presented in a way that is easier to understand and operate.

### Additional context

Headlamp is an open-source Kubernetes web UI with a plugin architecture that allows integrations with Kubernetes ecosystem projects.

There are already Headlamp plugins for several Kubernetes ecosystem projects, demonstrating the possibility of providing project-specific views and workflows within Headlamp.

* Headlamp: https://github.com/kubernetes-sigs/headlamp
* Headlamp plugins: https://github.com/headlamp-k8s/plugins

I would like to explore this integration as a potential community contribution and work with the CloudNativePG maintainers to determine an appropriate scope.

### Backport?

No

### Are you willing to actively contribute to this feature?

Yes

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.