headlamp

Headlamp is an easy-to-use and extensible Kubernetes web UI.

Headlamp lets you view and manage Kubernetes resources through a graphical interface, with plugins to extend its functionality.

Features

• Vendor-independent Kubernetes UI
• Runs in-cluster or locally as a desktop app
• Multi-cluster support
• Extensible through plugins
• UI controls that reflect user permissions
• Clean, modern UI
• Cancellable create, update, and delete operations
• Logs, terminal access, and a resource editor with documentation
• Read and write access based on user permissions

Screenshots

Quick start

To deploy Headlamp in your cluster, follow the in-cluster installation guide. Container images are published as ghcr.io/headlamp-k8s/headlamp on GitHub Container Registry.

To run Headlamp locally, install the desktop application for Linux, macOS, or Windows. Make sure your kubeconfig is configured for the clusters you want to access. See the desktop configuration options to use a non-default kubeconfig file or multiple files.

Access and permissions

Headlamp uses Kubernetes role-based access control (RBAC) to determine which resources you can view and which actions you can perform. The resources available in Headlamp depend on the permissions granted to your credentials.

For token-based authentication, see how to create a service account token.

Quick start for contributors

Want to hack on Headlamp? We’d love your help!

See the contributing guidelines for local development setup, build instructions, and platform-specific tips.

For more detailed documentation, see the development guide.

Tested platforms

See the Kubernetes platforms Headlamp has been tested with. Please contribute results for other platforms or report regressions.

Extensions and plugins

Browse Headlamp plugins on Artifact Hub for published plugins.

See the plugins repository for official plugins.

Plugin development

To extend Headlamp for your use cases, see the plugin development guide.

Get involved

Join the community and contribute:

• Contribution guidelines
• Code of Conduct
• #headlamp channel on Kubernetes Slack
• Monthly community meeting

Roadmap and release planning

Track upcoming releases in GitHub milestones and proposed changes in GitHub issues. See the release notes for changes in published versions.

License

Headlamp is released under the terms of the Apache 2.0 license.

Frequently asked questions

For more information about Headlamp, see the Headlamp FAQ.