doc: document swift compatibility

Add a table that specifies swift features compatibility

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>

diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst
index d9c2e3579bd37e326f5a287da3e922289d1e4627..7f76c588c2d3a3b9d36c5f3052318b42ec565b99 100644 (file)
--- a/doc/radosgw/index.rst
+++ b/doc/radosgw/index.rst
@@ -40,7 +40,7 @@ one API and retrieve it with the other.
        Config Reference <config-ref>
        Purging Temp Data <purge-temp>
        S3 API <s3>
-       Swift API <swift/index>
+       Swift API <swift>
        Admin API <admin/index>
        troubleshooting
        Manpage radosgw <../../man/8/radosgw>

diff --git a/doc/radosgw/swift.rst b/doc/radosgw/swift.rst
new file mode 100644 (file)
index 0000000..d3fbcd1
--- /dev/null
+++ b/doc/radosgw/swift.rst
@@ -0,0 +1,74 @@
+===============
+RADOS Swift API
+===============
+
+Ceph supports a RESTful API that is compatible with the the basic data access model of the Swift API.
+
+API
+---
+
+.. toctree::
+   :maxdepth: 1
+
+   Common <swift/index>
+   Authentication <swift/auth>
+   Service Ops <swift/serviceops>
+   Container Ops <swift/containerops>
+   Object Ops <swift/objectops>
+   Tutorial <swift/tutorial>
+   Java <swift/java>
+   Python <swift/python>
+   Ruby <swift/ruby>
+
+
+Features Support
+----------------
+
+The following table describes the support status for current Swift functional features:
+
++---------------------------------+-----------------+----------------------------------------+
+| Feature                         | Status          | Remarks                                |
++=================================+=================+========================================+
+| **Authentication**              | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Get Account Metadata**        | Supported       | No custom metadata                     |
++---------------------------------+-----------------+----------------------------------------+
+| **Swift ACLs**                  | Supported       | Supports a subset of Swift ACLs        |
++---------------------------------+-----------------+----------------------------------------+
+| **List Containers**             | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Delete Container**            | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Create Container**            | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Get Container Metadata**      | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Update Container Metadata**   | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Delete Container Metadata**   | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **List Objects**                | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Static Website**              | Not Supported   |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Create Object**               | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Create Large Object**         | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Delete Object**               | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Get Object**                  | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Copy Object**                 | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Get Object Metadata**         | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Update Object Metadata**      | Supported       |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Expiring Objects**            | Not Supported   |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **Object Versioning**           | Not Supported   |                                        |
++---------------------------------+-----------------+----------------------------------------+
+| **CORS**                        | Not Supported   |                                        |
++---------------------------------+-----------------+----------------------------------------+
+

diff --git a/doc/radosgw/swift/index.rst b/doc/radosgw/swift/index.rst
deleted file mode 100644 (file)
index 3b8531d..0000000
--- a/doc/radosgw/swift/index.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-======================
- Swift-compatible API
-======================
-
-RADOS Gateway provides a scalable, highly available redundant object storage 
-API that is compatible with a subset of the `OpenStack Swift`_ API. The 
-Swift-compatible API provides a container-based object storage, with support
-for multiple users, storage containers, and access control lists (ACLs). 
-This API makes it possible to use a RADOS storage cluster as a Swift-compatible
-object storage system, while simultaneously supporting Ceph FS and RADOS block
-devices too (*e.g.*, you can use it for your Rackspace Cloud Files).
-
-.. note:: The popular Amazon S3 API uses the term 'bucket' to describe a data 
-   container. When you hear someone refer to a 'bucket' within the Swift API, 
-   the term 'bucket' may be construed as the equivalent of the term 'container.'
-
-.. toctree::
-
-       Tutorial Overview <tutorial>
-       Tutorial-Java <java>
-       Tutorial-Python <python>
-       Tutorial-Ruby <ruby>
-       Auth API <auth>
-       Service API <serviceops>
-       Container API <containerops>
-       Object API <objectops>
-
-.. _OpenStack Swift: http://docs.openstack.org/api/openstack-object-storage/1.0/content/
\ No newline at end of file

diff --git a/doc/radosgw/swift/swift.rst b/doc/radosgw/swift/swift.rst
new file mode 100644 (file)
index 0000000..3b8531d
--- /dev/null
+++ b/doc/radosgw/swift/swift.rst
@@ -0,0 +1,28 @@
+======================
+ Swift-compatible API
+======================
+
+RADOS Gateway provides a scalable, highly available redundant object storage 
+API that is compatible with a subset of the `OpenStack Swift`_ API. The 
+Swift-compatible API provides a container-based object storage, with support
+for multiple users, storage containers, and access control lists (ACLs). 
+This API makes it possible to use a RADOS storage cluster as a Swift-compatible
+object storage system, while simultaneously supporting Ceph FS and RADOS block
+devices too (*e.g.*, you can use it for your Rackspace Cloud Files).
+
+.. note:: The popular Amazon S3 API uses the term 'bucket' to describe a data 
+   container. When you hear someone refer to a 'bucket' within the Swift API, 
+   the term 'bucket' may be construed as the equivalent of the term 'container.'
+
+.. toctree::
+
+       Tutorial Overview <tutorial>
+       Tutorial-Java <java>
+       Tutorial-Python <python>
+       Tutorial-Ruby <ruby>
+       Auth API <auth>
+       Service API <serviceops>
+       Container API <containerops>
+       Object API <objectops>
+
+.. _OpenStack Swift: http://docs.openstack.org/api/openstack-object-storage/1.0/content/
\ No newline at end of file