From: Kefu Chai <kchai@redhat.com>
Date: Sun, 25 Jul 2021 06:30:02 +0000 (+0800)
Subject: doc/dev/crimson: document cyanstore and alienstore
X-Git-Tag: v17.1.0~1282^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=587a8c9c22a57aff8e539e19669eb1454f02fef4;p=ceph.git

doc/dev/crimson: document cyanstore and alienstore

Signed-off-by: Kefu Chai <kchai@redhat.com>
---

diff --git a/doc/dev/crimson/crimson.rst b/doc/dev/crimson/crimson.rst
index 3508b5990b44..41651e1672f7 100644
--- a/doc/dev/crimson/crimson.rst
+++ b/doc/dev/crimson/crimson.rst
@@ -39,12 +39,30 @@ As you might expect, crimson is not featurewise on par with its predecessor yet.
 object store backend
 --------------------
 
-At the moment ``crimson-osd`` offers two object store backends:
+At the moment, ``crimson-osd`` offers both native and alienized object store
+backends. The native object store backends perform IO using seastar reactor.
+They are:
 
-- CyanStore: CyanStore is modeled after memstore in classic OSD.
-- AlienStore: AlienStore is short for Alienized BlueStore.
+.. describe:: cyanstore
 
-Seastore is still under active development.
+   CyanStore is modeled after memstore in classic OSD.
+
+.. describe:: seastore
+
+   Seastore is still under active development.
+
+While the alienized object store backends are backed by a thread pool, which
+is a proxy of the alien store adaptor running in SeaStar. The proxy issues
+requests to object stores running in alien threads, i.e., worker threads not
+managed by the Seastar framework. They are:
+
+.. describe:: memstore
+
+   The memory backed object store
+
+.. describe:: bluestore
+
+   The object store used by classic OSD by default.
 
 daemonize
 ---------
@@ -121,17 +139,20 @@ using ``vstart.sh``,
 
     for more Seastar specific command line options.
 
-``--memstore``
+``--cyanstore``
     use the CyanStore as the object store backend.
 
 ``--bluestore``
-    use the AlienStore as the object store backend. This is the default setting,
-    if not specified otherwise.
+    use the alienized BlueStore as the object store backend. This is the default
+    setting, if not specified otherwise.
+
+``--memstore``
+    use the alienized MemStore as the object store backend.
 
 So, a typical command to start a single-crimson-node cluster is::
 
   $  MGR=1 MON=1 OSD=1 MDS=0 RGW=0 ../src/vstart.sh -n -x \
-    --without-dashboard --memstore \
+    --without-dashboard --cyanstore \
     --crimson --nodaemon --redirect-output \
     --osd-args "--memory 4G"