doc: Edited RGW quick start.

Applied downstream version, need more tuning, (removed references to
components specific to Red Hat Ceph Storage.)

Signed-off-by: Bara Ancincova <bancinco@redhat.com>

diff --git a/doc/start/quick-rgw-old.rst b/doc/start/quick-rgw-old.rst
new file mode 100644 (file)
index 0000000..5f9cfc1
--- /dev/null
+++ b/doc/start/quick-rgw-old.rst
@@ -0,0 +1,28 @@
+===========================
+ Quick Ceph Object Storage
+===========================
+
+To use the :term:`Ceph Object Storage` Quick Start guide, you must have executed the
+procedures in the `Storage Cluster Quick Start`_ guide first. Make sure that you
+have at least one :term:`RGW` instance running.
+
+Configure new RGW instance
+==========================
+
+The :term:`RGW` instance created by the `Storage Cluster Quick Start`_ will run using
+the embedded CivetWeb webserver. ``ceph-deploy`` will create the instance and start
+it automatically with default parameters.
+
+To administer the :term:`RGW` instance, see details in the the
+`RGW Admin Guide`_.
+
+Additional details may be found in the `Configuring Ceph Object Gateway`_ guide, but
+the steps specific to Apache are no longer needed.
+
+.. note:: Deploying RGW using ``ceph-deploy`` and using the CivetWeb webserver instead
+   of Apache is new functionality as of **Hammer** release.
+
+
+.. _Storage Cluster Quick Start: ../quick-ceph-deploy
+.. _RGW Admin Guide: ../../radosgw/admin
+.. _Configuring Ceph Object Gateway: ../../radosgw/config

diff --git a/doc/start/quick-rgw.rst b/doc/start/quick-rgw.rst
index 5f9cfc1bea4809f70dcf594629e35f89991c3304..7dc1e589d46ad62fedcf959d3afec58fee3eed5b 100644 (file)
--- a/doc/start/quick-rgw.rst
+++ b/doc/start/quick-rgw.rst
@@ -1,28 +1,57 @@
-===========================
- Quick Ceph Object Storage
-===========================
+===============================
+Ceph Object Gateway Quick Start
+===============================
 
-To use the :term:`Ceph Object Storage` Quick Start guide, you must have executed the
-procedures in the `Storage Cluster Quick Start`_ guide first. Make sure that you
-have at least one :term:`RGW` instance running.
+Red Hat Ceph Storage v1.3 dramatically simplifies installing and configuring a Ceph Object Gateway. The Gateway daemon embeds Civetweb, so you do not have to install a web server or configure FastCGI. Additionally, ``ceph-deploy`` can install the gateway package, generate a key, configure a data directory and create a gateway instance for you.
 
-Configure new RGW instance
-==========================
+.. tip:: Civetweb uses port ``7480`` by default. You must either open port ``7480``, or set the port to a preferred port (e.g., port 80) in your Ceph configuration file.
 
-The :term:`RGW` instance created by the `Storage Cluster Quick Start`_ will run using
-the embedded CivetWeb webserver. ``ceph-deploy`` will create the instance and start
-it automatically with default parameters.
+To start a Ceph Object Gateway, follow this procedure:
 
-To administer the :term:`RGW` instance, see details in the the
-`RGW Admin Guide`_.
+#. Execute the pre-installation steps on your ``client-node``. If you intend to use Civetweb's default port ``7480``, you must open it using ``firewall-cmd``.
 
-Additional details may be found in the `Configuring Ceph Object Gateway`_ guide, but
-the steps specific to Apache are no longer needed.
+#. Enable the ``rhel-7-server-rhceph-1.3-tools-rpms`` repository on the ``client-node`` node, if you haven't done so already::
 
-.. note:: Deploying RGW using ``ceph-deploy`` and using the CivetWeb webserver instead
-   of Apache is new functionality as of **Hammer** release.
+    sudo subscription-manager repos --enable=rhel-7-server-rhceph-1.3-tools-rpms
 
+#. From the working directory of your administration server, install the Ceph Object Gateway package on the ``client-node`` node. For example::
 
-.. _Storage Cluster Quick Start: ../quick-ceph-deploy
-.. _RGW Admin Guide: ../../radosgw/admin
-.. _Configuring Ceph Object Gateway: ../../radosgw/config
+    ceph-deploy install --rgw <client-node> [<client-node> ...]
+
+#. From the working directory of your administration server, create an instance of the Ceph Object Gateway on the ``client-node``. For example::
+
+    ceph-deploy rgw create
+
+   Once the gateway is running, you should be able to access it on port ``7480``. (e.g., ``http://client-node:7480``).
+
+#. To change the default port (e.g,. to port ``80``), modify your Ceph configuration file. Add a section entitled ``[client.rgw.<client-node>]``, replacing ``<client-node>`` with the short node name of your Ceph client node (i.e., ``hostname -s``). For example, if your node name is ``client-node``, add a section like this after the ``[global]`` section::
+
+    [client.rgw.client-node] rgw_frontends = "civetweb port=80"
+
+   .. note:: Ensure that you leave no whitespace between ``port=<port-number>`` in the ``rgw_frontends`` key/value pair.
+
+#. To make the new port setting take effect, restart the Ceph Object Gateway::
+
+    sudo systemctl restart ceph-radosgw.service
+
+#. Finally, check to ensure that the port you selected is open on the node's firewall (e.g., port ``80``). If it is not open, add the port and reload the firewall configuration. For example::
+
+    sudo firewall-cmd --list-all sudo firewall-cmd --zone=public --add-port 80/tcp --permanent sudo firewall-cmd --reload
+
+   You should be able to make an unauthenticated request, and receive a response. For example, a request with no parameters like this::
+
+    http://<client-node>:80
+
+   Should result in a response like this::
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
+      <Owner>
+        <ID>anonymous</ID>
+        <DisplayName></DisplayName>
+      </Owner>
+       <Buckets>
+      </Buckets>
+    </ListAllMyBucketsResult>
+
+See the Ceph Object Storage Guide for RHEL ``x86_64`` for additional administration and API details.