From: John Wilkins <john.wilkins@inktank.com>
Date: Mon, 8 Sep 2014 18:58:09 +0000 (-0700)
Subject: doc: Added more robust usage example for uid and conf for QEMU.
X-Git-Tag: v0.86~124^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F2426%2Fhead;p=ceph.git

doc: Added more robust usage example for uid and conf for QEMU.

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
---

diff --git a/doc/rbd/qemu-rbd.rst b/doc/rbd/qemu-rbd.rst
index dce8b9df2d8e..8ce980ffc2ef 100644
--- a/doc/rbd/qemu-rbd.rst
+++ b/doc/rbd/qemu-rbd.rst
@@ -33,6 +33,34 @@ QEMU, see  `QEMU Open Source Processor Emulator`_. For QEMU documentation, see
    running Ceph cluster.
 
 
+Usage
+=====
+
+The QEMU command line expects you to specify the pool name and image name. You
+may also specify a snapshot name. 
+
+QEMU will assume that the Ceph configuration file resides in the default
+location (e.g., ``/etc/ceph/$cluster.conf``) and that you are executing
+commands as the default ``client.admin`` user unless you expressly specify
+another Ceph configuration file path or another user. When specifying a user,
+QEMU uses the ``ID`` rather than the full ``TYPE:ID``. See `User Management -
+User`_ for details. Do not prepend the client type (i.e., ``client.``) to the
+beginning of the user  ID, or you will receive an authentication error. You
+should have the key for the ``admin`` user or the key of another user you
+specify with the ``:id={user}`` option in a keyring file stored in default path
+(i.e., ``/etc/ceph`` or the local directory with appropriate file ownership and
+permissions. Usage takes the following form::
+
+	qemu-img {command} [options] rbd:{pool-name}/{image-name}[@snapshot-name][:option1=value1][:option2=value2...]
+
+For example, specifying the ``id`` and ``conf`` options might look like the following:: 
+
+	qemu-img {command} [options] rbd:glance-pool/maipo:id=glance:conf=/etc/ceph/ceph.conf
+
+.. tip:: Configuration values containing ``:``, ``@``, or ``=`` can be escaped with a
+         leading ``\`` character.
+
+
 Creating Images with QEMU
 =========================
 
@@ -186,4 +214,5 @@ QEMU command line settings override the Ceph configuration file settings.
 .. _QEMU Manual: http://wiki.qemu.org/Manual
 .. _RBD Cache: ../rbd-config-ref/
 .. _Snapshots: ../rbd-snapshot/
-.. _Installation: ../../install
\ No newline at end of file
+.. _Installation: ../../install
+.. _User Management - User: ../../rados/operations/user-management#user
\ No newline at end of file