Doc fix logging (rackerlabs#627)

* fix: add fluentbit docs This change updates the docs to fix the missing fluentbit information from our install guide. While we had it doc'd we didn't have it published so this change removes the README file and pushes the content into the published set. Signed-off-by: Kevin Carter <[email protected]> * fix: removed the grafana readme file This change removes the grafana README file because this content is old, doesn't work, and largely duplicates what we already have in our main docs. Signed-off-by: Kevin Carter <[email protected]> * fix: cleanup loki docs so that our information is more consistent Signed-off-by: Kevin Carter <[email protected]> --------- Signed-off-by: Kevin Carter <[email protected]>
OpenStackKen · Dec 18, 2024 · c08ac8c · c08ac8c
1 parent 512e1f3
commit c08ac8c
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 134 deletions.
diff --git a/base-helm-configs/fluentbit/README.md b/base-helm-configs/fluentbit/README.md
diff --git a/base-helm-configs/grafana/README.md b/base-helm-configs/grafana/README.md
diff --git a/docs/infrastructure-fluentbit.md b/docs/infrastructure-fluentbit.md
@@ -0,0 +1,18 @@
+# Deploy Fluentbit
+
+This guide will help you deploy fluentbit to your kubernetes cluster. Fluentbit is a lightweight log shipper that can be used to send logs to loki.
+
+## Install the fluentbit helm chart
+
+``` shell
+helm repo add fluent https://fluent.github.io/helm-charts
+helm repo update
+```
+
+## Install the helm chart
+
+You will need to make changes depending on how you want to configure loki. Example files are included in this directory choose one relevant to your deploy
+
+``` shell
+helm install --values fluentbit-helm-overrides.yaml fluentbit fluent/fluent-bit
+```
diff --git a/docs/infrastructure-loki.md b/docs/infrastructure-loki.md
@@ -1,5 +1,7 @@
 # Setting up Loki
 
+Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost-effective and easy to operate. It does not index the contents of the logs, but rather a set of labels for each log stream.
+
 ## Add the grafana helm repo
 
 ``` shell
@@ -9,11 +11,11 @@ helm repo update
 
 ### Install the helm chart
 
-You will need to make changes depending on how you want to configure loki. Example files are included in this directory choose one relevant to your deploy
+ou will need to make changes depending on how you want to configure loki. Example files are included in `genetack/base-helm-configs`.  Choose one relevant to your deploy, edit for revelant data, and ensure you copy the file to `/etc/genestack/base-helm/loki-helm-overrides.yaml`
 
 ``` shell
 helm upgrade --install \
-             --values my-loki-helm-overrides.yaml \
+             --values /etc/genestack/helm-configs/loki/loki-helm-overrides.yaml \
              loki grafana/loki \
              --create-namespace \
              --namespace grafana \

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -184,6 +184,7 @@ nav:
               - Memcached: infrastructure-memcached.md
               - Libvirt: infrastructure-libvirt.md
               - OVN: infrastructure-ovn-setup.md
+              - FluentBit: infrastructure-fluentbit.md
               - Loki: infrastructure-loki.md
           - OpenStack:
               - openstack-overview.md