From: Soumya Koduri <skoduri@redhat.com>
Date: Wed, 15 Sep 2021 19:29:35 +0000 (+0530)
Subject: rgw/dbstore: Update README
X-Git-Tag: v17.1.0~832^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=be7ab7d24db69b78b9f6cc57c8e4fb0cd599707c;p=ceph-ci.git

rgw/dbstore: Update README

Signed-off-by: Soumya Koduri <skoduri@redhat.com>
---

diff --git a/src/rgw/store/dbstore/README.md b/src/rgw/store/dbstore/README.md
index 15e214d0365..3e7016cab93 100644
--- a/src/rgw/store/dbstore/README.md
+++ b/src/rgw/store/dbstore/README.md
@@ -1,33 +1,43 @@
-# dbstore
-DBStore for Rados Gateway (RGW)
+# DBStore
+Standalone Rados Gateway (RGW) on DBStore (Experimental)
+
+
+## CMake Option
+Add below cmake option (enabled by default)
+
+    -DWITH_RADOSGW_DBSTORE=ON 
 
-## Pre-install
-fmt(-devel) and gtest(-devel) packages need to be installed
 
 ## Build
-Add below options to cmake - 
--DWITH_RADOSGW_DBSTORE=ON -DWITH_RADOSGW_LUA_PACKAGES=OFF
 
-cd build
+    cd build
+    ninja [vstart]
+
+
+## Running Test cluster
+Edit ceph.conf to add below option
+
+    [client]
+        rgw backend store = dbstore
+
+Restart vstart cluster or just RGW server
+
+    [..] RGW=1 ../src/vstart.sh -d
 
-ninja src/rgw/store/dbstore/install
+The above configuration brings up RGW server on dbstore and creates testid user to be used for s3 operations.
 
-## Gtests
-To execute Gtest cases, from build directory
+By default, dbstore creates .db file named 'default_ns.db' where in the data is stored.
 
-./bin/dbstore-tests
-(default logfile: rgw_dbstore_tests.log, loglevel: 20)
 
-## Execute Sample test file
+## DBStore Unit Tests
+To execute DBStore unit test cases (using Gtest framework), from build directory
 
-./bin/dbstore-bin
-(default logfile: rgw_dbstore_bin.log, loglevel: 20)
+    ninja src/rgw/store/dbstore/install
+    ./bin/dbstore-tests [logfile] [loglevel]
+    (default logfile: rgw_dbstore_tests.log, loglevel: 20)
 
-## Logging
-[To provide custom log file and change log level]
+To execute Sample test file
 
-./dbstore-tests log_file log_level
-./dbstore-bin log_file log_level
+    ./bin/dbstore-bin [logfile] [loglevel]
+    (default logfile: rgw_dbstore_bin.log, loglevel: 20)
 
-When run as RADOSGW process, logfile and loglevel are set to the
-ones provided to the radosgw cmd args.