doc: rgw document s3 bucket location features

Fixes: ceph#10142 Reported-by: Neil Levine <[email protected]> Signed-off-by: Abhishek Lekshmanan <[email protected]>
zmc · Nov 24, 2014 · a1ba385 · a1ba385
1 parent a4222b4
commit a1ba385
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 1 deletion.
diff --git 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
@@ -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
 --------------