From: Travis Rhoden Date: Thu, 19 Mar 2015 18:38:08 +0000 (-0400) Subject: Add rgw create to docs X-Git-Tag: v1.5.23~9^2~8 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=c8b445a968d6b2d56ecbb1a878be0324091301f5;p=ceph-deploy.git Add rgw create to docs Signed-off-by: Travis Rhoden --- diff --git a/docs/source/contents.rst b/docs/source/contents.rst index 9d3ad53..014c676 100644 --- 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 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.