]> git.proxmox.com Git - ceph.git/blame - ceph/src/rgw/driver/dbstore/README.md
update ceph source to reef 18.1.2
[ceph.git] / ceph / src / rgw / driver / dbstore / README.md
CommitLineData
1e59de90
TL
1# DBStore
2Standalone Rados Gateway (RGW) on DBStore (Experimental)
3
4
5## CMake Option
6Add below cmake option (enabled by default)
7
8 -DWITH_RADOSGW_DBSTORE=ON
9
10
11## Build
12
13 cd build
14 ninja [vstart]
15
16
17## Running Test cluster
18Edit ceph.conf to add below option
19
20 [client]
21 rgw backend store = dbstore
22
23Start vstart cluster
24
25 [..] RGW=1 ../src/vstart.sh -o rgw_backend_store=dbstore -n -d
26
27The above vstart command brings up RGW server on dbstore and creates few default users (eg., testid) to be used for s3 operations.
28
29`radosgw-admin` can be used to create and remove other users.
30
31
32By default, dbstore creates .db file *'/var/lib/ceph/radosgw/dbstore-default_ns.db'* to store the data. This can be configured using below options in ceph.conf
33
34 [client]
35 dbstore db dir = <path for the directory for storing the db backend store data>
36 dbstore db name prefix = <prefix to the file names created by db backend store>
37
38
39## DBStore Unit Tests
40To execute DBStore unit test cases (using Gtest framework), from build directory
41
42 ninja unittest_dbstore_tests
43 ./bin/unittest_dbstore_tests [logfile] [loglevel]
44 (default logfile: rgw_dbstore_tests.log, loglevel: 20)
45 ninja unittest_dbstore_mgr_tests
46 ./bin/unittest_dbstore_mgr_tests
47
48To execute Sample test file
49
50 ninja src/rgw/driver/dbstore/install
51 ./bin/dbstore-bin [logfile] [loglevel]
52 (default logfile: rgw_dbstore_bin.log, loglevel: 20)
53