Documentation updates (#141)

* fix: ensure there's a builld note for ingress Signed-off-by: Kevin Carter <[email protected]> * feat: add loki docs Signed-off-by: Kevin Carter <[email protected]> --------- Signed-off-by: Kevin Carter <[email protected]>
rackerlabs · Mar 11, 2024 · 2b04367 · 2b04367
1 parent f6c244a
commit 2b04367
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 28 deletions.
diff --git a/docs/infrastructure-ingress.md b/docs/infrastructure-ingress.md
@@ -1,5 +1,9 @@
 # Deploy the ingress controllers
 
+!!! tip
+
+    When deploying Ingress for the first time, make sure to build the helm charts. Information on building the helm charts can be [found here](openstack-helm-make.md).
+
 We need two different Ingress controllers, one in the `openstack` namespace, the other in the `ingress-nginx` namespace. The `openstack` controller is for east-west connectivity, the `ingress-nginx` controller is for north-south.
 
 ### Deploy our ingress controller within the ingress-nginx Namespace

diff --git a/docs/infrastructure-loki.md b/docs/infrastructure-loki.md
@@ -0,0 +1,44 @@
+# Setting up Loki
+
+## Add the grafana helm repo
+
+``` shell
+helm repo add grafana https://grafana.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 upgrade --install \
+             --values my-loki-helm-overrides.yaml \
+             loki grafana/loki \
+             --create-namespace \
+             --namespace grafana
+```
+
+!!! example
+
+    If you plan on using **Swift** as a backend for log storage see the `loki-helm-swift-overrides-example.yaml` file in the `helm-configs/loki` directory.
+
+    ``` yaml
+    --8<-- "helm-configs/loki/loki-helm-swift-overrides-example.yaml"
+    ```
+
+!!! example
+
+    If you plan on using **S3** as a backend for log storage see the `loki-helm-s3-overrides-example.yaml` file in the `helm-configs/loki` directory.
+
+    ``` yaml
+    --8<-- "helm-configs/loki/loki-helm-s3-overrides-example.yaml"
+    ```
+
+!!! example
+
+    If you plan on using **Minio** as a backend for log storage see the `loki-helm-s3-overrides-example.yaml` file in the `helm-configs/loki` directory.
+
+    ``` yaml
+    --8<-- "helm-configs/loki/loki-helm-minio-overrides-example.yaml"
+    ```
diff --git a/docs/loki.md b/docs/loki.md
diff --git a/docs/openstack-helm-make.md b/docs/openstack-helm-make.md
@@ -1,5 +1,8 @@
 # OpenStack Helm
 
+Before running a deploy the helm charts need to be built. If the charts for your deployment have already been built,
+then there's no need to do it a second time.
+
 ## Install Helm
 
 While `helm` should already be installed with the **host-setup** playbook, you will need to install helm manually on nodes. There are lots of ways to install helm, check the upstream [docs](https://helm.sh/docs/intro/install/) to learn more about installing helm.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -109,7 +109,8 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.inlinehilite
-  - pymdownx.snippets
+  - pymdownx.snippets:
+      restrict_base_path: false
 
 repo_name: rackerlabs/genestack
 repo_url: https://github.com/rackerlabs/genestack
@@ -164,6 +165,7 @@ nav:
                   - infrastructure-ovn.md
                   - OVN Setup: infrastructure-ovn-setup.md
               - MetalLB: infrastructure-metallb.md
+              - Loki: infrastructure-loki.md
           - OpenStack:
               - openstack-overview.md
               - OpenStack Preparations: openstack-helm-make.md