[stgt] [PATCH] README.rbd: add documentation for the rbd --bsopts parameters

[Dan Mick]

Signed-off-by: Dan Mick <dan.mick at inktank.com>
---
 doc/README.rbd |   25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/doc/README.rbd b/doc/README.rbd
index a91305a..274cc4d 100644
--- a/doc/README.rbd
+++ b/doc/README.rbd
@@ -24,3 +24,28 @@ where poolname is the RADOS pool containing the rbd image (defaults to
 optional (readonly) snapshot of the image imagename.  (Obviously when
 a snapshot is exported, writes are not supported.)
 
+You may also want to use the --bsopts parameter to pass Ceph-specific
+parameters to bs_rbd.  Accepted keywords are
+
+conf=<path to ceph.conf file>
+
+This sets the path to the ceph.conf file for the cluster that
+stgt should connect to for this target/lun creation (luns may
+use different cluster connections).
+
+id=<client id>
+
+This sets the id portion of the ceph "client name" (which is
+"type.id").  Type is fixed at "client", and the default name is
+"client.admin", but you probably want this to set id to
+something like "tgt" so that the name of the ceph client is
+"client.tgt".  This lets you control permissions differently
+for the tgt client compared to others, and sets the default log path, etc.
+See the Ceph documentation regarding client names.
+
+To specify both options, separate them with ';', and since you are,
+make sure to quote the option string to protect the semicolon from
+the shell:
+
+	--bsopts "conf=/usr/local/ceph/ceph.conf;id=tgt"
+
-- 
1.7.10.4

--
To unsubscribe from this list: send the line "unsubscribe stgt" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html