kubernetes-sigs/headlamp
Headlamp
Headlamp is a Kubernetes web interface that runs as either a desktop application or a browser-based dashboard, providing a unified view for managing resources across multiple clusters. It supports authentication through OpenID Connect providers and kubeconfig files, and renders the UI according to the user's Kubernetes RBAC permissions, hiding or disabling actions that are not permitted.
The project distinguishes itself through a plugin system that allows extending the dashboard with custom views, components, and business logic without modifying the core code. Plugins can be installed from a catalog, developed from scratch, or run as sidecar containers alongside the main application. The interface also supports custom theming, UI component customization, and the creation of dedicated monitoring dashboards with specialized visualizations.
Headlamp includes an inline resource editor with built-in documentation and validation, terminal and log access for debugging pods, and the ability to discover clusters by watching custom resources. It can be deployed as a desktop application on Linux, Mac, and Windows, exposed through an ingress, or accessed via port forwarding. The project provides documentation for installation, plugin development, and configuration.
Features
- Desktop - A native desktop application for managing Kubernetes clusters on Linux, Mac, and Windows.
- OIDC Authentication Integrations - Authenticates users via OpenID Connect providers to control access to cluster resources.
- Access Control and RBAC - Hides or disables UI actions based on the user's Kubernetes RBAC permissions.
- UI-Level RBAC Enforcements - Hides or disables UI elements based on the user's Kubernetes RBAC permissions, enforcing access control at the interface level.
- Kubernetes Resource Inspectors - Lists and inspects cluster resources through an intuitive web interface that works both in-cluster and on a desktop.
- Kubernetes Cluster Management - Provides a unified web interface for viewing and managing Kubernetes resources across multiple clusters.
- Multi-Cluster Dashboard Managers - A dashboard that connects to and switches between multiple Kubernetes clusters from a single interface.
- Multi-Cluster Orchestrators - Connects to and switches between several Kubernetes clusters from one unified interface.
- Kubernetes Dashboards - A browser-based interface for browsing, managing, and debugging Kubernetes cluster resources across namespaces.
- OIDC-Authenticated Dashboards - A Kubernetes web interface that authenticates users via OpenID Connect providers for access control.
- Plugin-Extensible Dashboards - A Kubernetes dashboard that supports custom plugins for adding views, components, and business logic.
- Plugin-Extensible Runtimes - Extends the dashboard by loading JavaScript plugins that add custom views, components, and actions at runtime without modifying core code.
- Kubernetes Resource Browsers - Displays Kubernetes resources across namespaces with a clean, modern interface for viewing and managing them.
- OpenID Connect Support - Authenticates users through an OpenID Connect provider to verify identity and control access to the cluster.
- Desktop Applications - Runs as a native desktop application on Linux, Mac, and Windows for managing clusters without in-cluster deployment.
- Electron Browser Hosting - Runs the web interface as a native desktop application using Electron, supporting Linux, Mac, and Windows.
- Container Orchestration Debugging - Opens terminal sessions into containers and streams logs for debugging Kubernetes workloads.
- Kubernetes Resource Page Extensions - Adds custom sections and actions to Kubernetes resource pages for richer management.
- Kubernetes Manifest Editors - Modifies Kubernetes resource manifests with built-in documentation and validation to ensure correctness.
- Kubernetes Manifest Editors - Modifies Kubernetes resource manifests directly in the browser with built-in documentation and validation to ensure correctness.
- Multi-Kubeconfig Loaders - Loads and merges multiple kubeconfig files from a colon-separated environment variable to authenticate against several clusters simultaneously.
- Plugin Development Kits - Adds custom views and functionality to the Kubernetes dashboard by developing and loading plugins.
- Plugin - Ships a sidecar container pattern for running plugins alongside the main dashboard application.
- Bearer Token Authentication - Accepts a bearer token, such as a Service Account token, to log in and access cluster resources.
- Kubernetes Monitoring Dashboards - Builds dedicated pages with specialized visualizations and metrics for monitoring cluster resources.
- Custom UI Components - Provides custom UI components that can be added to the app bar, sidebar, and resource detail views.
- Container Terminal and Log Access - Opens a terminal session into a container or streams its logs for debugging purposes.
- UI Theming - Supports replacing logos and applying custom themes to match organizational branding across the interface.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
