Add docs

Signed-off-by: Michel Hollands <michel.hollands@grafana.com>

README.md

@@ -1,47 +1,37 @@
 # meta-monitoring-chart
 
-A meta-monitoring chart for GEL, GEM and GET.
+This is a meta-monitoring chart for GEL, GEM and GET. It should be installed in a
+separate namespace next to GEM, GEL or GET installations.
 
-## Install this chart
+## Preparation
 
-1. Create the meta namespace
+Create a values.yaml file based on the [default one](../charts/meta-monitoring/values.yaml).
 
-   ```
+1. Add or remove the namespaces to monitor in the `namespacesToMonitor` setting
-   kubectl create namespace meta
-   ```
 
-1. Create a values.yaml file
+1. Set the cluster name in the `clusterName` setting. This will be added as a label to all logs, metrics and traces.
 
-1. Install this helm chart
+## Local and cloud modes
 
-   ```
+The chart has 2 modes: local and cloud. In the local mode logs, metrics and traces are sent
-   helm install -n meta meta ./charts/meta-monitoring
+to small Loki, Mimir and Tempo installations running in the meta-monitoring namespace.
-   ```
 
-1. Upgrade
+![local mode](docs/images/Meta%20monitoring%20local.png)
 
-   ```
+To enable local mode set `local.enabled` to true.
-   helm upgrade --install -n meta meta ./charts/meta-monitoring
-   ```
 
-1. Delete this chart:
+In the cloud mode the logs, metrics and traces are sent to
 
-   ```
+![cloud mode](docs/images/Meta%20monitoring%20cloud.png)
-   helm delete -n meta meta
-   ```
 
+To enable cloud mode set `cloud.enabled` to true. The `endpoint`, `username` and `password` settings for your Grafana Cloud logs, metrics and traces instances have to be filled in as well.
 
-## Update dependencies
+Both modes can be enabled at the same time.
 
-Run this in the charts/meta-monitoring directory after updating a dependency:
+## More help topics
 
-```
+- [installation](docs/installation.md)
-helm dependency update meta-monitoring
-```
 
-List dependencies:
+Developer help topics
-
-```
-helm dependency list meta-monitoring
-```
 
+- [update dependencies](docs/dev_update_dependencies.md)

docs/dev_update_dependencies.md

@@ -0,0 +1,16 @@
+# Update the dependencies
+
+The dependencies are the version of Loki, Mimir, Agent and so on that are included in this chart.
+The current versions can be found in the [Chart.yaml](../charts/meta-monitoring/Chart.yaml) file.
+
+Run this in the charts/meta-monitoring directory after updating a dependency:
+
+```
+helm dependency update meta-monitoring
+```
+
+List the current dependencies:
+
+```
+helm dependency list meta-monitoring
+```

docs/installation.md

@@ -0,0 +1,27 @@
+# Install this chart
+
+1. Create the meta namespace
+
+   ```
+   kubectl create namespace meta
+   ```
+
+1. Create a values.yaml file based on the [default one](../charts/meta-monitoring/values.yaml).
+
+1. Install this helm chart
+
+   ```
+   helm install -n meta meta ./charts/meta-monitoring
+   ```
+
+1. Upgrade
+
+   ```
+   helm upgrade --install -n meta meta ./charts/meta-monitoring
+   ```
+
+1. Delete this chart:
+
+   ```
+   helm delete -n meta meta
+   ```