maziadi / dashboard

General-purpose web UI for Kubernetes clusters

Kubernetes Dashboard

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.

Getting Started

IMPORTANT: Read the Access Control guide before performing any further steps. The default Dashboard deployment contains a minimal set of RBAC privileges needed to run.

Installation

Kubernetes Dashboard supports both Helm and Manifest-based installation. Since release v3.0.0 using Helm Chart should be faster and simpler in general as it will install dependencies such as cert-manager, nginx-ingress-controller and metrics-server for you. In case you are using different software to handle certificates, ingress/egress traffic, etc. it is possible to disable those dependencies by overriding helm chart values.

Helm

You can install Dashboard using Helm as described here.

Manifest

You can install Dashboard using kubectl as described in the installation instructions that can be found in the latest release.

Access

You can access Dashboard as described in the instructions that can be found in the access guide.

Create An Authentication Token (RBAC)

To find out how to create sample user and log in follow Creating sample user guide.

NOTE:

• Kubeconfig Authentication method does not support external identity providers or certificate-based authentication.
• Metrics-Server has to be running in the cluster for the metrics and graphs to be available. Read more about it in Integrations guide.

Documentation

Dashboard documentation can be found on docs directory which contains:

• Common: Entry-level overview.
• User Guide: Accessing Dashboard and more for users.
• Developer Guide: Getting Started, Dependency Management and more for anyone interested in contributing.

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:

• #sig-ui on Kubernetes Slack
• kubernetes-sig-ui mailing list
• Issue tracker
• SIG info
• Roles

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