Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/headlamp-k8s/headlamp

A Kubernetes web UI that is fully-featured, user-friendly and extensible
https://github.com/headlamp-k8s/headlamp

cloud-native dashboard debugging devops headlamp k8s kinvolk kubernetes kubernetes-dashboard kubernetes-debugging kubernetes-monitoring kubernetes-ui orchestration plugins

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/headlamp-k8s/headlamp
Owner: headlamp-k8s
License: apache-2.0
Created: 2019-11-08T21:00:03.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2024-04-26T18:10:20.000Z (5 months ago)
Last Synced: 2024-04-28T06:35:05.295Z (5 months 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: 74.7 MB
Stars: 1,620
Watchers: 24
Forks: 116
Open Issues: 296
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

awesome-ops - headlamp-k8s/headlamp - 2.0|1907|2019-11-08|2024-08-07 | Headlamp 是一个易于使用且可扩展的 Kubernetes Web UI。 | (K8S-Cluster-Manage)
awesome-repositories - headlamp-k8s/headlamp - A Kubernetes web UI that is fully-featured, user-friendly and extensible (TypeScript)
awesome-starred - headlamp-k8s/headlamp - A Kubernetes web UI that is fully-featured, user-friendly and extensible (kubernetes)

README

        # Headlamp  [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7551/badge)](https://www.bestpractices.dev/projects/7551) [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/headlamp-k8s/headlamp/badge)](https://scorecard.dev/viewer/?uri=github.com/headlamp-k8s/headlamp)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fheadlamp-k8s%2Fheadlamp.svg?type=shield)](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 be a Kubernetes web UI that has the traditional functionality of other

web UIs/dashboards available (i.e. to list and view resources) as well as other features.



  



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

whether and how users can access 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, and invite you to add any missing platform you have

tested, or comments if there are regressions in already filed platforms that

should be consider.

## 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](./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) for it, with 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/).