Merge branch 'rackerlabs:main' into development

rackerlabs · Nov 15, 2024 · cebe52c · cebe52c
2 parents a155a3b + 588296e
commit cebe52c
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 11 deletions.
diff --git a/docs/genestack-logging.md b/docs/genestack-logging.md
@@ -1,12 +1,12 @@
-#@ Genestack Logging
+# Genestack Logging
 
 [TOC]
 
-### Overview
+### Introduction
 
 Genestack logging is a straight forward system that collects, stores and provides an interface to search and read logs on-demand.  The storage backend is open to fit the needs of your deployment, so whether backing up to Openstack Swift, S3, Ceph, or file-share, Genestack logging can fit in your environment.
 
-Out of box Genestack logging is comprised of three separate technologies:
+Out-of-box Genestack logging is comprised of three separate technologies:
 
 - [Fluentbit](https://fluentbit.io/), a fast and lightweight telemetry agent for logs, metrics, and traces for Linux, macOS, Windows, and BSD family operating systems.  Fluentbit grabs log entries immediately from your Kubernetes application and ships them to Loki for aggregation
 - [Loki](https://github.com/grafana/loki), a log aggregation system for Kubernetes that stores logs in a time series database and is often used with Grafana to visualize them.

diff --git a/docs/infrastructure-gateway-api.md b/docs/infrastructure-gateway-api.md
@@ -75,15 +75,15 @@ There are various implementations of the Gateway API. In this document, we will
                     --namespace=nginx-gateway \
                     --wait \
                     --timeout 10m \
-                    -f /opt/genestack/base-helm-configs/nginx-gateway-fabric/helm-overrides.yaml \
-                    --post-renderer /opt/genestack/base-kustomize/kustomize.sh \
+                    -f /etc/genestack/helm-configs/nginx-gateway-fabric/helm-overrides.yaml \
+                    --post-renderer /etc/genestack/kustomize/kustomize.sh \
                     --post-renderer-args gateway/base
         ```
 
     === "Experimental"
 
         ``` shell
-        cd /opt/genestack/submodules/nginx-gateway-fabric/charts/nginx-gateway-fabric
+        cd /opt/genestack/submodules/nginx-gateway-fabric/charts
 
         helm upgrade --install nginx-gateway-fabric . \
                     --namespace=nginx-gateway \

diff --git a/docs/infrastructure-mariadb-ops.md b/docs/infrastructure-mariadb-ops.md
@@ -87,9 +87,40 @@ dump to your MariaDB database.
 Refer to the mariadb-operator [restore documentation](https://github.com/mariadb-operator/mariadb-operator/blob/main/docs/BACKUP.md#restore)
 for more information.
 
+!!! tip "Operator Restore Tips"
+
+    1. If you have multiple backups available, the operator is able to infer
+    which backup to restore based on the `spec.targetRecoveryTime` field
+    discussed in the operator documentation [here](https://github.com/mariadb-operator/mariadb-operator/blob/main/docs/BACKUP.md#target-recovery-time).
+    2. The referred database (db1 in the example below) must previously exist
+    for the Restore to succeed.
+    3. The mariadb CLI invoked by the operator under the hood only supports
+    selecting a single database to restore via the `--one-database` option,
+    restoration of multiple specific databases is not supported.
+
+### Restore All Databases
+
+!!! danger "The following command may lead to data loss"
+
+    ``` shell
+    cat <<EOF | kubectl -n openstack apply -f -
+    apiVersion: k8s.mariadb.com/v1alpha1
+    kind: Restore
+    metadata:
+      name: maria-restore
+    spec:
+      mariaDbRef:
+        name: mariadb-cluster
+      backupRef:
+        name: mariadb-backup
+    EOF
+    ```
+
+### Restore Single Database
+
 !!! danger "The following command may lead to data loss"
 
-    ```shell
+    ``` shell
     cat <<EOF | kubectl -n openstack apply -f -
     apiVersion: k8s.mariadb.com/v1alpha1
     kind: Restore
@@ -100,11 +131,19 @@ for more information.
         name: mariadb-cluster
       backupRef:
         name: mariadb-backup
+      databases: db1
     EOF
     ```
 
-!!! tip
+### Check Restore Progress
+
+!!! success "Simply _get_ the restore object previously created"
+
+    ``` shell
+    kubectl -n openstack get restore maria-restore
+    ```
 
-    If you have multiple backups available, the operator is able to infer which
-    backup to restore based on the `spec.targetRecoveryTime` field discussed
-    in the operator documentation [here](https://github.com/mariadb-operator/mariadb-operator/blob/main/docs/BACKUP.md#target-recovery-time).
+    ``` { .no-copy }
+    NAME            COMPLETE   STATUS    MARIADB           AGE
+    maria-restore   True       Success   mariadb-cluster   26s
+    ```