xskh2007 / kubeapps

A web-based UI for deploying and managing applications in Kubernetes clusters

Kubeapps

Kubeapps is a web-based UI for deploying and managing applications in Kubernetes clusters. Kubeapps allows you to:

• Browse and deploy Helm charts from chart repositories
• Inspect, upgrade and delete Helm-based applications installed in the cluster
• Add custom and private chart repositories (supports ChartMuseum and JFrog Artifactory)
• Browse and deploy Kubernetes Operators.
• Secure authentication to Kubeapps using an OAuth2/OIDC provider
• Secure authorization based on Kubernetes Role-Based Access Control

Quick Start

Use the Helm chart to install the latest version of Kubeapps:

helm repo add bitnami https://charts.bitnami.com/bitnami
kubectl create namespace kubeapps
helm install kubeapps --namespace kubeapps bitnami/kubeapps

Note: Kubeapps 2.0 and onwards supports Helm 3 only. While only the Helm 3 API is supported, in most cases, charts made for Helm 2 will still work. For detailed instructions on how to install and use Kubeapps follow the Getting Started Guide.

Developer Documentation

Please refer to:

• The Kubeapps Build Guide for instructions on setting up the build environment and building Kubeapps from source.
• The Kubeapps Developer Documentation for instructions on setting up the developer environment for developing on Kubeapps and its components.

Next Steps

If you have followed the instructions for installing Kubeapps check how to use Kubeapps to easily manage your applications running in your cluster, or look under the hood to see what's included in Kubeapps.

Useful Resources

• Walkthrough for first-time users
• Detailed installation instructions
• Kubeapps Dashboard documentation
• Kubeapps components
• Roadmap

API documentation

Whereas Kubeapps does not have yet a well-designed API, we still want to share the current status of the APIs used across the internal components. Check out the latest API online documentation or download the Kubeapps OpenAPI Specification yaml file from the repository.

Feel free to contribute using this guide on how to update the API docs and send us a PR if you find any errors.

This API documentation is subject to change in each Kubeapps version. If you are interested in the Kubeapps API, please reach out to us for further information.

Differences from Monocular

The Monocular project was designed to run a public search and discovery website for Helm repositories (e.g. https://hub.kubeapps.com). Following its 1.0 release, Monocular is focused on delivering the experience for the Helm Hub.

Versions of Monocular 0.7 and older include a basic ability to install, view and delete Helm releases in a Kubernetes cluster. To focus on the Helm Hub experience, these features have been removed since the 1.0 release and are no longer supported. We recommend users of Monocular's in-cluster features try Kubeapps as it provides a more featured, robust and secure solution to managing Helm applications in your cluster.

Community

• #kubeapps on Kubernetes Slack

Click here to sign up to the Kubernetes Slack org.

FAQ

We maintain a section for frequently asked questions on the Kubeapps chart README.