docs/projects/kubernetes_monitoring/index.md

@@ -1,18 +1,71 @@
 ---
 title: Kubernetes Monitoring Helm Chart
 description: How to use No Fuss Computings kubernetes monitoring helm chart for full stack monitoring.
-date: 2023-08-29
+date: 2023-09-19
 template: project.html
 about: https://gitlab.com/nofusscomputing/projects/kubernetes_monitoring
 ---
 
+This Helm chart deploys the components needed for full stack monitoring.
 
-## Running the container
+What this chart is:
 
-To quickly setup a container the following `docker-compose.yaml` file could be used.
+- Collectors for metrics and logging
 
-``` yaml title="docker-compose.yaml" linenums="1"
+- Distribution / Routing of metrics/logging
+
+- Data visualization
+
+What this chart is not:
+
+- A complete monitoring stack inclusive of long term storage.
+
+Intentionally we have kept this helm chart to the monitoring components only. Keeping the monitoring components seperate from storage is advantageous. for all intents and purposes this helm chart is ephemeral.
+
+This helm chart started off with components from multiple open-source projects. As such attribution is warrented, so head on over to thier projects and give them a star. Projects used to create the building blocks of this helm chart are
+
+- [Kube prometheus](https://github.com/prometheus-operator/kube-prometheus)
+
+- [prometheus adaptor](https://github.com/kubernetes-sigs/prometheus-adapter)
 
 
+## Features
+
+- Prometheus as the metrics collector
+
+- Grafana-Agent as the daemonset for node and node-exporter metrics and also as the logging injestor for loki
+
+- Grafana as the visualization frontend
+
+
+## Installation
+
+This chart as the following **dependencies:**
+
+- [Grafana Operator](https://artifacthub.io/packages/olm/community-operators/grafana-operator)
+
+- [Prometheus Operator](https://artifacthub.io/packages/olm/community-operators/prometheus)
+
+These dependencies must be present before installing this chart. to install run the following commands:
+
+``` bash
+
+git clone -b development https://gitlab.com/nofusscomputing/projects/kubernetes_monitoring.git
+
+helm upgrade -i nfc_monitoring kubernetes_monitoring/
+
+```
+
+
+## Template Values
+
+The values file included in this helm chart is below.
+
+!!! note
+    This values file is from the development branch and as such may not reflect the current version you have deployed. If you require a specific version, head on over to the git repository and select the git tag that matches the version you are after.
+
+``` yaml title="values.yaml" linenums="1"
+
+--8<-- "values.yaml"
 
 ```