From 4e130affe1ae5ee9d54a792ee25e2f48d56afe17 Mon Sep 17 00:00:00 2001 From: Soumya Koduri Date: Tue, 12 Nov 2024 12:04:33 +0530 Subject: [PATCH] rgw: Update README for DBStore and Posix drivers Signed-off-by: Soumya Koduri --- src/rgw/driver/dbstore/README.md | 14 ++++++-------- src/rgw/driver/posix/README.md | 12 ++++++------ 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/src/rgw/driver/dbstore/README.md b/src/rgw/driver/dbstore/README.md index f7e5df331cc..2bf3391c8c4 100644 --- a/src/rgw/driver/dbstore/README.md +++ b/src/rgw/driver/dbstore/README.md @@ -15,23 +15,21 @@ Add below cmake option (enabled by default) ## Running Test cluster -Edit ceph.conf to add below option +Edit ceph.conf to add below options [client] rgw backend store = dbstore rgw config store = dbstore -Start vstart cluster +To start the `vstart` cluster, run the following cmd: - MON=1 RGW=1 ../src/vstart.sh -o rgw_backend_store=dbstore -o rgw_config_store=dbstore -n -d + MON=0 OSD=0 MDS=0 MGR=0 RGW=1 ../src/vstart.sh -n -d --rgw_store dbstore -The above vstart command brings up RGW server on dbstore. It creates default zonegroup, zone and few default users (eg., testid) to be used for s3 operations. +The above `vstart` command brings up the RGW server on DBStore without the need for MONs or OSDs. It creates a default zonegroup, zone, and few default users (e.g., `testid`) to be used for S3 operations, and generates database files in the `dev` subdirectory, by default, to store them. -`radosgw-admin` can be used to create and remove other users, zonegroups and zones. - - -By default, dbstore creates .db file *'/var/lib/ceph/radosgw/dbstore-default_ns.db'* to store the data and *'/var/lib/ceph/radosgw/dbstore-config.db'* file to store the configuration. This can be configured using below options in ceph.conf +`radosgw-admin` command can be used to create and remove other users, zonegroups and zones. +The location and prefix for the database files can be configured using the following options: [client] dbstore db dir = dbstore db name prefix = diff --git a/src/rgw/driver/posix/README.md b/src/rgw/driver/posix/README.md index 02dc8dfbe85..73971edc86f 100644 --- a/src/rgw/driver/posix/README.md +++ b/src/rgw/driver/posix/README.md @@ -23,15 +23,15 @@ Edit ceph.conf to add below option rgw config store = dbstore rgw filter = posix -Start vstart cluster +To start the `vstart` cluster, run the following cmd: - MON=0 OSD=0 MDS=0 MGR=0 RGW=1 ../src/vstart.sh -o rgw_backend_store=dbstore -o rgw_config_store=dbstore -o rgw_filter=posix -n -d + MON=0 OSD=0 MDS=0 MGR=0 RGW=1 ../src/vstart.sh -n -d --rgw_store posix -The above vstart command brings up RGW server on POSIXDriver. It creates default zonegroup, zone and few default users (eg., testid) to be used for s3 operations. +The above vstart command brings up RGW server on POSIXDriver. It creates default zonegroup, zone and few default users (e.g., testid) to be used for s3 operations. -`radosgw-admin` can be used to create and remove other users, zonegroups and zones. +`radosgw-admin` command can be used to create and remove other users, zonegroups and zones. -By default, the directory exported is *'/tmp/rgw_posix_driver'*. This can be changed with the `rgw_posix_base_path` option, either in ceph.conf or on the vstart command line above. +By default, the directory exported, *'rgw_posix_driver'*, is created in the `dev` subdirectory. This can be changed with the `rgw_posix_base_path` option. -The POSIXDriver keeps a LMDB based cache of directories, so that it can provide ordered listings. This directory lives in `rgw_posix_database_root`, which by default is in *'/var/lib/ceph/radosgw'* +The POSIXDriver keeps a LMDB based cache of directories, so that it can provide ordered listings. This directory lives in `rgw_posix_database_root`, which by default is created in the `dev` subdirectory