# A Kubernetes web UI that is fully-featured, user-friendly and extensible


![](https://github.com/headlamp-k8s/headlamp/raw/main/docs/headlamp_light.svg align="center")

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.

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/videos/headlamp_quick_run.gif align="left")

## 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

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/home.png align="left")

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/cluster_chooser.png align="left")

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/workloads.png align="left")

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/resource_edition.png align="left")

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/logs.png align="left")

![](https://raw.githubusercontent.com/headlamp-k8s/headlamp/screenshots/screenshots/terminal.png align="left")

## 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](https://github.com/headlamp-k8s/headlamp/blob/main/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/), including our [Code of Conduct](https://github.com/headlamp-k8s/headlamp/blob/main/CODE_OF_CONDUCT.md), and join the discussion on the [#headlamp](https://kubernetes.slack.com/messages/headlamp) channel in the Kubernetes Slack.

## 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](https://github.com/headlamp-k8s/headlamp/blob/main/LICENSE) license.

## Frequently Asked Questions

For more information about Headlamp, see the [Headlamp FAQ](https://headlamp.dev/docs/latest/faq/).