From 8086e5048430b3e819c04d6da9a4c6231147e076 Mon Sep 17 00:00:00 2001
From: Guillaume Abrioux <gabrioux@redhat.com>
Date: Wed, 24 Mar 2021 13:51:36 +0100
Subject: [PATCH] doc: add detailed scenarios examples

wip

Signed-off-by: Guillaume Abrioux <gabrioux@redhat.com>
---
 docs/source/index.rst                   | 11 +++++
 docs/source/scenarios/basic_cluster.rst | 57 +++++++++++++++++++++++++
 docs/source/scenarios/index.rst         |  9 ++++
 3 files changed, 77 insertions(+)
 create mode 100644 docs/source/scenarios/basic_cluster.rst
 create mode 100644 docs/source/scenarios/index.rst

diff --git a/docs/source/index.rst b/docs/source/index.rst
index 67637a2de..76907f099 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -247,6 +247,17 @@ When deploying RGW instance(s) you are required to set the ``radosgw_interface``
 
 ``radosgw_address`` must be set the same way than ``monitor_address``.
 
+Detailed scenarios examples
+---------------------------
+
+You can find more detailed scenarios in link below.
+
+.. toctree::
+   :maxdepth: 1
+
+   scenarios/index
+
+
 ``ceph.conf`` Configuration File
 ---------------------------------
 
diff --git a/docs/source/scenarios/basic_cluster.rst b/docs/source/scenarios/basic_cluster.rst
new file mode 100644
index 000000000..d5e995980
--- /dev/null
+++ b/docs/source/scenarios/basic_cluster.rst
@@ -0,0 +1,57 @@
+*************************
+Deploying a basic cluster
+*************************
+
+Topology
+========
+
+Here we are going to describe how to deploy 3 monitors, 3 managers and 2 osds.
+
+
+Writing your inventory
+----------------------
+
+.. code-block:: ini
+
+    [mons]
+    mon0
+    mon1
+    mon2
+
+    [mgrs]
+    mgr0
+    mgr1
+    mgr2
+
+    [osds]
+    osd0
+    osd1
+
+.. note::
+    If you don't define a ``[mgrs]`` section, ceph-ansible will automatically collocate 1 ceph manager daemon on each monitor node.
+
+
+Configuring your cluster
+------------------------
+
+Configuring your cluster can be done in many ways. There are a lot of variables that are either mandatory or optional according what you want to achieve.
+
+By the way, these variables can be set at different places: inventory, host_vars, group_vars, etc.
+
+We will try to identify the most common cases and cover them through this documentation.
+
+
+
+- **ceph_origin**:
+    - valid value:
+        - ``repository``: Ceph will be get through a dedicated repository
+        - ``distro``: Ceph will be get through the main repository already present on your distro.
+        - ``local``: Ceph binaries will be copied over from the local machine
+- **ceph_repository**:
+    - Must be set when ``ceph_origin: repository``
+    - valid value:
+        - ``community``: 
+        - ``rhcs``
+        - ``dev``
+        - ``custom``
+        - ``uca``
\ No newline at end of file
diff --git a/docs/source/scenarios/index.rst b/docs/source/scenarios/index.rst
new file mode 100644
index 000000000..de525ff84
--- /dev/null
+++ b/docs/source/scenarios/index.rst
@@ -0,0 +1,9 @@
+Examples of detailed scenarios
+------------------------------
+
+
+
+.. toctree::
+    :maxdepth: 1
+ 
+    basic_cluster