diff --git a/docs/genestack-logging.md b/docs/genestack-logging.md index a7a3bc85..1c62f82c 100644 --- 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 index c72f0a2e..f3aecb1b 100644 --- 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 index dc95558d..2eb465eb 100644 --- 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 <