Awesome

	This project is no longer supported.

Monocular

Monocular is a web-based application that enables the search and discovery of charts from multiple Helm Chart repositories. It is the codebase that powers the Helm Hub project.

Click here to learn more about Helm, Charts and Kubernetes.

⚠️ Deprecation and Archive Notice

Monocular is deprecated and no longer supported. There have been no new updates to the codebase since March 2020. It has now been deprecated by the maintainers.

If you need an open source project to display your charts you may consider using the Artifact Hub (which you can run yourself). Helm uses the Artifact Hub software to power the built-in hub search.

Install

You can use the chart in this repository to install Monocular in your cluster.

Prerequisites

• Helm and Tiller installed
• Nginx Ingress controller
  • Install with Helm: helm install stable/nginx-ingress
  • Minikube/Kubeadm: helm install stable/nginx-ingress --set controller.hostNetwork=true

$ helm repo add monocular https://helm.github.io/monocular
$ helm install monocular/monocular

Access Monocular

Use the Ingress endpoint to access your Monocular instance:

# Wait for all pods to be running (this can take a few minutes)
$ kubectl get pods --watch

$ kubectl get ingress
NAME                        HOSTS     ADDRESS         PORTS     AGE
tailored-alpaca-monocular   *         192.168.64.30   80        11h

Visit the address specified in the Ingress object in your browser, e.g. http://192.168.64.30.

Read more on how to deploy Monocular here.

Documentation

• Configuration
• Deployment
• Development

Looking for an in-cluster Application management UI?

To focus on the CNCF Helm Hub requirements, in-cluster features have been removed from Monocular 1.0 and above. We believe that providing a good solution for deploying and managing apps in-cluster is an orthogonal user experience to a public search and discovery site. There is other tooling that can support this usecase better (e.g. Kubeapps or RedHat Automation Broker).

Monocular v0.7.3 includes in-cluster features and can still be installed and used until your team has migrated to another tool.

Roadmap

The Monocular roadmap is currently located in the wiki.

Contribute

This project is still under active development, so you'll likely encounter issues.

Interested in contributing? Check out the documentation.

Also see developer's guide for information on how to build and test the code.