dashboard README

The project's README from github.com/kubernetes-retired/dashboard. As one markdown file: README.md.

Kubernetes Dashboard

Go Report Card Coverage Status License

IMPORTANT

This project is now archived and no longer maintained due to lack of active maintainers and contributors.

Thank you to everyone who used, starred, or contributed to this project! Feel free to fork this repository if you want to continue development yourself.

Please consider using Headlamp instead. It was recently moved under the sig-ui. From the creators:

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

Introduction

Kubernetes Dashboard is a general purpose, web-based UI for Kubernetes clusters. It allows users to manage applications running in the cluster and troubleshoot them, as well as manage the cluster itself.

As of version 7.0.0, we have dropped support for Manifest-based installation. Only Helm-based installation is supported now. Due to multi-container setup and hard dependency on Kong gateway API proxy it would not be feasible to easily support Manifest-based installation.

Additionally, we have changed the versioning scheme and dropped appVersion from Helm chart. It is because, with a multi-container setup, every module is now versioned separately. Helm chart version can be considered an app version now.

Dashboard UI workloads page

Installation

Kubernetes Dashboard supports only Helm-based installation currently as it is faster and gives us better control over all dependencies required by Dashboard to run. We now use a single-container, DBless Kong installation as a gateway that connects all our containers and exposes the UI. Users can then use any ingress controller or proxy in front of kong gateway. To find out more about ways to customize your installation check out helm chart values.

In order to install Kubernetes Dashboard simply run:

# Add kubernetes-dashboard repository
helm repo add kubernetes-dashboard https://kubernetes.github.io/dashboard/
# Deploy a Helm Release named "kubernetes-dashboard" using the kubernetes-dashboard chart
helm upgrade --install kubernetes-dashboard kubernetes-dashboard/kubernetes-dashboard --create-namespace --namespace kubernetes-dashboard

For more information about our Helm chart visit ArtifactHub.

Documentation

Dashboard documentation can be found in the docs directory which contains:

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

Contribution

Learn how to start contributing to the Contributing Guideline.

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.

License

Apache License 2.0


Copyright 2019 The Kubernetes Dashboard Authors

dashboard (kubernetes-retired/dashboard)

Searching Database…

15.4K ·GitHub
archived
What is this?Kubernetes Dashboard is a general-purpose, web-based UI for Kubernetes clusters. From a browser you can manage the applications running in the cluster, troubleshoot them, and manage the cluster itself.
Where does it actually run — on my machine or inside the cluster?Inside the cluster, not on your laptop. Helm deploys a multi-container setup in which a DBless Kong gateway connects all the containers and exposes the UI to your browser.
What do I need to have in place before installing?A running Kubernetes cluster and Helm. After installation you can put any ingress controller or proxy of your choice in front of the Kong gateway.
Is the project still actively maintained?No. It is archived and no longer maintained due to a lack of active maintainers and contributors, though forking it to continue development yourself is explicitly welcomed.
If I fork it and keep it alive, what are the terms?The README invites exactly that, and the code is under Apache License 2.0 — a permissive license, so you can freely continue development yourself.
What does the README recommend using instead?Headlamp, an easy-to-use and extensible Kubernetes web UI. It was recently moved under the sig-ui group, the same Kubernetes special interest group behind Dashboard.
How do I get into the dashboard once it is installed?The docs include a 'How to access Dashboard' guide for reaching your instance after installation, and an Access Control section that walks through creating a sample user you can log in with.
Why did the Helm chart drop its appVersion?The versioning scheme changed with the multi-container setup: every module is versioned separately now, so the Helm chart version itself can be treated as the app version.
Size
180.1 MB
Stars
15.4K
Age
11y
Commits · 90 Days