Kubernetes Dashboard Project Overview
Introduction
The Kubernetes Dashboard is a comprehensive, web-based interface designed to manage Kubernetes clusters effectively. This user-friendly dashboard empowers users to oversee the applications running within the cluster and troubleshoot them if necessary. It also facilitates the management of the cluster itself, enhancing the overall administrative experience for Kubernetes users.
In the latest version, 7.0.0, Kubernetes Dashboard has transitioned exclusively to Helm-based installations, discontinuing support for Manifest-based installation. This shift is primarily due to the complexities involved in a multi-container setup and the critical reliance on the Kong gateway API proxy. Consequently, each module in the dashboard is now versioned separately, simplifying the management and deployment process.
Installation
The Kubernetes Dashboard currently supports installation only via Helm, which is a package manager for Kubernetes. This method is preferred because it speeds up the installation process and offers greater control over the dependencies needed for the dashboard to operate effectively.
The Kubernetes Dashboard employs a single-container, database-less version of the Kong gateway to connect all necessary containers and facilitate the user interface exposure. Users have the flexibility to deploy their preferred ingress controller or proxy in front of the Kong gateway to customize their setup as required.
To install the Kubernetes Dashboard, users should execute the following commands:
# 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 comprehensive installation instructions and customization options, users are encouraged to consult the ArtifactHub.
Documentation
The project provides extensive documentation to support users at every stage. Available resources include:
- Common: An entry-level overview to familiarize users with the basics.
- User Guide: Detailed instructions and helpful tips for users.
- How to Access Dashboard: Guidelines on gaining access to the Kubernetes Dashboard post-installation.
- Access Control: Information on managing access to the dashboard, including instructions to create a sample user for login purposes.
- Developer Guide: Essential information for contributors who wish to test, run, and develop the dashboard locally.
The documentation can be accessed in the docs directory of the project repository.
Community and Support
Users are encouraged to engage with the wider Kubernetes community for discussions, contributions, and support. This can be done through:
- Kubernetes Slack: Join the conversation in the #sig-ui channel.
- Mailing List: Subscribe to the kubernetes-sig-ui mailing list for updates and discussions.
- Issue Tracker: Report issues or contribute by tracking them on the project's GitHub page.
- Special Interest Group (SIG) Information: Find detailed information and roles associated with the SIG UI.
Contribution and Conduct
The project welcomes contributions, and guidelines are provided in the Contributing Guideline. All participants and contributors are expected to adhere to the Kubernetes Code of Conduct, ensuring a respectful and inclusive community environment.
License
The Kubernetes Dashboard is open source and is licensed under the Apache License 2.0, allowing for free use, distribution, and modification under the terms specified in the license.