From: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
Date: Mon, 24 Nov 2014 17:27:44 +0000 (+0530)
Subject: doc: rgw document s3 bucket location features
X-Git-Tag: v0.90~46^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F2998%2Fhead;p=ceph.git

doc: rgw document s3 bucket location features

Fixes: #10142
Reported-by: Neil Levine <nlevine@redhat.com>
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@ril.com>
---

diff --git a/doc/radosgw/s3.rst b/doc/radosgw/s3.rst
index e925872d6c22..fe975e6b9667 100644
--- a/doc/radosgw/s3.rst
+++ b/doc/radosgw/s3.rst
@@ -46,7 +46,7 @@ The following table describes the support status for current Amazon S3 functiona
 +---------------------------------+-----------------+----------------------------------------+
 | **Bucket ACLs (Get, Put)**      | Supported       | Different set of canned ACLs           |
 +---------------------------------+-----------------+----------------------------------------+
-| **Bucket Location**             | Not Supported   |                                        |
+| **Bucket Location**             | Supported       |                                        |
 +---------------------------------+-----------------+----------------------------------------+
 | **Bucket Notification**         | Not Supported   |                                        |
 +---------------------------------+-----------------+----------------------------------------+
diff --git a/doc/radosgw/s3/bucketops.rst b/doc/radosgw/s3/bucketops.rst
index ed089789c62c..f066005ab24b 100644
--- a/doc/radosgw/s3/bucketops.rst
+++ b/doc/radosgw/s3/bucketops.rst
@@ -157,6 +157,34 @@ The ``ListBucketResult`` contains objects, where each object is within a ``Conte
 | ``StorageClass``       | String    | Should always return ``STANDARD``.       |
 +------------------------+-----------+------------------------------------------+
 
+Get Bucket Location
+-------------------
+Retrieves the bucket's region. The user needs to be the bucket owner
+to call this. A bucket can be constrained to a region by providing
+``LocationConstraint`` during a PUT request.
+
+Syntax
+~~~~~~
+Add the ``location`` subresource to bucket resource as shown below
+
+::
+
+   GET /{bucket}?location HTTP/1.1
+   Host: cname.domain.com
+
+   Authorization: AWS {access-key}:{hash-of-header-and-secret}
+
+Response Entities
+~~~~~~~~~~~~~~~~~~~~~~~~
+
++------------------------+-----------+------------------------------------------+
+| Name                   | Type      | Description                              |
++========================+===========+==========================================+
+| ``LocationConstraint`` | String    | The region where bucket resides, empty   |
+|                        |           | string for defult region                 |
++------------------------+-----------+------------------------------------------+
+
+
 
 Get Bucket ACL
 --------------