Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kinvolk/headlamp
A Kubernetes web UI that is fully-featured, user-friendly and extensible
https://github.com/kinvolk/headlamp
cloud-native dashboard debugging devops headlamp k8s kinvolk kubernetes kubernetes-dashboard kubernetes-debugging kubernetes-monitoring kubernetes-ui orchestration plugins
Last synced: about 14 hours ago
JSON representation
A Kubernetes web UI that is fully-featured, user-friendly and extensible
- Host: GitHub
- URL: https://github.com/kinvolk/headlamp
- Owner: headlamp-k8s
- License: apache-2.0
- Created: 2019-11-08T21:00:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-08T04:30:33.000Z (3 days ago)
- Last Synced: 2025-02-09T07:07:09.301Z (2 days ago)
- Topics: cloud-native, dashboard, debugging, devops, headlamp, k8s, kinvolk, kubernetes, kubernetes-dashboard, kubernetes-debugging, kubernetes-monitoring, kubernetes-ui, orchestration, plugins
- Language: TypeScript
- Homepage: https://headlamp.dev
- Size: 106 MB
- Stars: 2,767
- Watchers: 25
- Forks: 211
- Open Issues: 459
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://www.bestpractices.dev/projects/7551)
[](https://scorecard.dev/viewer/?uri=github.com/headlamp-k8s/headlamp)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fheadlamp-k8s%2Fheadlamp?ref=badge_shield)
Headlamp is an easy-to-use and extensible Kubernetes web UI.
Headlamp was created to blend the traditional feature set of other web UIs/dashboards
(i.e., to list and view resources) with added functionality.
## Features
- Vendor-independent / generic Kubernetes UI
- Works in-cluster, or locally as a desktop app
- Multi-cluster
- Extensible through plugins
- UI controls reflecting user roles (no deletion/update if not allowed)
- Clean & modern UI
- Cancellable creation/update/deletion operations
- Logs, exec, and resource editor with documentation
- Read-write / interactive (actions based on permissions)
## Screenshots
## Quickstart
If you want to deploy Headlamp in your cluster, check out the instructions on running it [in-cluster](https://headlamp.dev/docs/latest/installation/in-cluster/).
If you have a kubeconfig already, you can quickly try Headlamp locally as a
[desktop application](https://headlamp.dev/docs/latest/installation/desktop/)
for [Linux](https://headlamp.dev/docs/latest/installation/desktop/linux-installation),
[Mac](https://headlamp.dev/docs/latest/installation/desktop/mac-installation),
or [Windows](https://headlamp.dev/docs/latest/installation/desktop/win-installation).
**Make sure** you have a kubeconfig file set up with your favorite clusters and
in the default path so Headlamp can use it.
### Accessing
Headlamp uses [RBAC](https://kubernetes.io/docs/reference/access-authn-authz/rbac) for checking
users' access to resources. If you try Headlamp with a token that has very limited
permissions, you may not be able to view your cluster resources correctly.
See the documentation on [how to easily get a Service Account token](https://headlamp.dev/docs/latest/installation#create-a-service-account-token) for your cluster.
## Tested platforms
We maintain a list of the [Kubernetes platforms](./docs/platforms.md) we have
tested Headlamp with. We invite you to add any missing platforms you have
tested, or comment if there are any regressions in the existing ones.
## Extensions / Plugins
If you are interested in tweaking Headlamp to fit your use-cases, you can check out
our [plugin development guide](https://headlamp.dev/docs/latest/development/plugins/).
## Get involved
Check out our:
- [Guidelines](https://headlamp.dev/docs/latest/contributing/)
- [Code of Conduct](./CODE_OF_CONDUCT.md),
- [#headlamp](https://kubernetes.slack.com/messages/headlamp) slack channel in the Kubernetes Slack
- [Monthly Community Meeting](https://zoom-lfx.platform.linuxfoundation.org/meetings/headlamp)
## Roadmap / Release Planning
If you are interested in the direction of the project, we maintain a
[Roadmap](https://github.com/orgs/headlamp-k8s/projects/1/views/1). It has the
biggest changes planned so far, as well as a [board](https://github.com/orgs/headlamp-k8s/projects/1/) tracking each release.
## License
Headlamp is released under the terms of the [Apache 2.0](./LICENSE) license.
## Frequently Asked Questions
For more information about Headlamp, see the [Headlamp FAQ](https://headlamp.dev/docs/latest/faq/).