Add rgw create to docs

Signed-off-by: Travis Rhoden <trhoden@redhat.com>

diff --git a/docs/source/contents.rst b/docs/source/contents.rst
index 9d3ad536c6c35b3189feac9dd0ea55045d34ffa8..014c676d666412e879307f8076ee79486d914f2f 100644 (file)
--- a/docs/source/contents.rst
+++ b/docs/source/contents.rst
@@ -11,3 +11,4 @@ Content Index
    mon.rst
    new.rst
    conf.rst
+   rgw.rst

diff --git a/docs/source/rgw.rst b/docs/source/rgw.rst
new file mode 100644 (file)
index 0000000..4cff9ea
--- /dev/null
+++ b/docs/source/rgw.rst
@@ -0,0 +1,29 @@
+.. _rgw:
+
+``rgw``
+=======
+The ``rgw`` subcommand provides an interface to interact with a cluster's
+RADOS Gateway instances.
+
+``create``
+----------
+Deploy RGW instances by specifying directly like::
+
+    ceph-deploy rgw create node1 node2 node3
+
+This will create an instance of RGW on the given node(s) and start the
+corresponding service. The daemon will listen on the default port of 7480.
+
+The RGW instances will default to having a name corresponding to the hostname
+where it runs.  For example, ``rgw.node1``.
+
+.. note:: If an error is presented about the ``bootstrap-rgw`` keyring not being
+          found, that is because the ``bootstrap-rgw`` only been auto-created on
+          new clusters starting with the Hammer release.
+
+.. versionadded:: 1.5.23
+
+.. note:: Removing RGW instances is not yet supported
+
+.. note:: Changing the port on which RGW will listen at deployment time is not yet
+          supported.