From 11e9fa754fa6c5c28aacf61670783c47f7a22d1a Mon Sep 17 00:00:00 2001
From: Francesco Pantano <fpantano@redhat.com>
Date: Mon, 7 Oct 2024 21:52:10 +0200
Subject: [PATCH] Fix design doc and script location

This patch fixes a rendering issue in the design-decisions
documentation, and moves the scripts to the right directory.

Signed-off-by: Francesco Pantano <fpantano@redhat.com>
---
 docs/{dev => }/assumptions.md                |  0
 docs/{dev => }/design-decisions.md           | 39 ++++++++++++++++++--
 docs/{dev => }/faq.md                        |  0
 docs/{dev => }/local.md                      |  0
 docs/{dev => }/troubleshooting.md            |  0
 {docs/dev => hack}/troubleshoot_api_setup.sh |  0
 6 files changed, 35 insertions(+), 4 deletions(-)
 rename docs/{dev => }/assumptions.md (100%)
 rename docs/{dev => }/design-decisions.md (95%)
 rename docs/{dev => }/faq.md (100%)
 rename docs/{dev => }/local.md (100%)
 rename docs/{dev => }/troubleshooting.md (100%)
 rename {docs/dev => hack}/troubleshoot_api_setup.sh (100%)

diff --git a/docs/dev/assumptions.md b/docs/assumptions.md
similarity index 100%
rename from docs/dev/assumptions.md
rename to docs/assumptions.md
diff --git a/docs/dev/design-decisions.md b/docs/design-decisions.md
similarity index 95%
rename from docs/dev/design-decisions.md
rename to docs/design-decisions.md
index ba579540..e280d4bc 100644
--- a/docs/dev/design-decisions.md
+++ b/docs/design-decisions.md
@@ -278,7 +278,7 @@ spec:
     rbd_store_ceph_conf = /etc/ceph/ceph.conf
     store_description = "RBD backend"
     rbd_store_pool = images
-    rbd_store_user = openstackcustomServiceConfig: |
+    rbd_store_user = openstack
   databaseInstance: openstack
   databaseUser: glance
   keystoneEndpoint: central
@@ -337,10 +337,40 @@ spec:
 In the example above, all the `GlanceAPI` instances share the same configuration,
 which is inherited by the main `customServiceConfig`, while`extraMounts` are
 added to connect each instance to a different Ceph cluster.
-For each instance it's possible to configure the `layout` (split vs single)
-according to a given backend, but note that `webhooks` prevent any update to the
-defined layout.
+For each instance, you can configure the layout parameter (either split or
+single) based on the specific backend requirements. However, keep in mind that
+webhooks will prevent any modifications to the layout after it's been set.
 
+It's also possible to deploy multiple glanceAPI services within the same
+availability zone (AZ) to handle different workloads. Here's an example
+configuration:
+
+```
+  keystoneEndpoint: api0
+  glanceAPIs:
+    api0:
+      customServiceConfig: |
+        [DEFAULT]
+        enabled_backends = default_backend:rbd
+      replicas: 1
+      type: split
+    api1:
+      customServiceConfig: |
+        [DEFAULT]
+        enabled_backends = default_backend:swift
+      replicas: 1
+      type: split
+```
+
+In this setup:
+
+* api0 is registered in the Keystone catalog and used as the default endpoint
+  for CLI operations.
+* api1, while not the default, remains an active API that can still be utilized
+  for image uploads by specifying the `--os-image-url` parameter.
+
+Switching the Keystone catalog's active API is straightforward and can be done
+by updating the `keystoneEndpoint` parameter.
 
 ## Manage KeystoneEndpoint
 
@@ -618,6 +648,7 @@ api2
 
 num_pvc = [(3 + 3) * 3] * 1 = 18
 storage_size = 3 * [(30 + 20) * 3] = 450G
+```
 
 We can conclude that **150G** is required for each API: given we have 3 APIs the
 total number is **450G**.
diff --git a/docs/dev/faq.md b/docs/faq.md
similarity index 100%
rename from docs/dev/faq.md
rename to docs/faq.md
diff --git a/docs/dev/local.md b/docs/local.md
similarity index 100%
rename from docs/dev/local.md
rename to docs/local.md
diff --git a/docs/dev/troubleshooting.md b/docs/troubleshooting.md
similarity index 100%
rename from docs/dev/troubleshooting.md
rename to docs/troubleshooting.md
diff --git a/docs/dev/troubleshoot_api_setup.sh b/hack/troubleshoot_api_setup.sh
similarity index 100%
rename from docs/dev/troubleshoot_api_setup.sh
rename to hack/troubleshoot_api_setup.sh