re-add chartsvc and chart-repo info in docs, mentioning monocular repo

vmware-tanzu · Oct 9, 2018 · b026561 · b026561
1 parent 3c520bc
commit b026561
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md
@@ -21,3 +21,11 @@ This proxy is written in Go. Check more details about the implementation in this
 ### Apprepository CRD and Controller
 
 Chart repositories in Kubeapps are managed with a `CustomResourceDefinition` called `apprepositories.kubeapps.com`. Each repository added to Kubeapps is an object of type `AppRepository` and the `apprepository-controller` will watch for changes on those type of objects to update the list of available charts to deploy.
+
+### `chart-repo`
+
+The `chart-repo` component is tool that scans a Helm chart repository and populates chart metadata in a MongoDB database. This metadata is then served by the chartsvc component. It is maintained as part of the [Helm Monocular project](https://github.com/helm/monocular/tree/master/cmd/chart-repo).
+
+### `chartsvc`
+
+The `chartsvc` component is a micro-service that creates an API endpoint for accessing the metadata for charts in Helm chart repositories that's populated in a MongoDB database. It is maintained as part of the [Helm Monocular project](https://github.com/helm/monocular/tree/master/cmd/chartsvc).
diff --git a/docs/developer/README.md b/docs/developer/README.md
@@ -6,6 +6,18 @@ The dashboard is the main UI component of the Kubeapps project. Written in Javas
 
 Please refer to the [Kubeapps Dashboard Developer Guide](dashboard.md) for the developer setup.
 
+### chartsvc
+
+The `chartsvc` component is a micro-service that creates a API endpoint for accessing the metadata for charts in Helm chart repositories that's populated in a MongoDB server.
+
+<!-- TODO: Point to developer guide in Monocular repo  -->
+
+### chart-repo
+
+The `chart-repo` component is tool that scans a Helm chart repository and populates chart metadata in a MongoDB server. This metadata is then served by the `chartsvc` component.
+
+<!-- TODO: Point to developer guide in Monocular repo  -->
+
 ### tiller-proxy
 
 The `tiller-proxy` component is a service used both as a client for Tiller but also to provide a way to authorize users to deploy, upgrade and delete charts in different namespaces.