Kubernetes Dashboard

! IMPORTANT !

We are introducing a soft code-freeze due to an ongoing major architecture changes. This means that only important or non-breaking changes can be merged to master such as:

• Documentation updates
• Security fixes
• Critical bug fixes
• Compatibility changes required to support new Kubernetes versions

Tracking issues/pull requests:

• kubernetes#7047

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.

Install

To deploy Dashboard, execute following command:

kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.6.1/aio/deploy/recommended.yaml

Alternatively, you can install Dashboard using Helm as described at https://artifacthub.io/packages/helm/k8s-dashboard/kubernetes-dashboard.

Access

To access Dashboard from your local workstation you must create a secure channel to your Kubernetes cluster. Run the following command:

kubectl proxy

Now access Dashboard at:

http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/.

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: Installation, 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 contribution on 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