From: Yehuda Sadeh Date: Wed, 12 Dec 2012 00:44:46 +0000 (-0800) Subject: doc: document swift compatibility X-Git-Tag: v0.57~328 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=6a8a58dc4b71df6d291d67ddad0b5667289d6d3b;p=ceph.git doc: document swift compatibility Add a table that specifies swift features compatibility Signed-off-by: Yehuda Sadeh --- diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst index d9c2e3579bd3..7f76c588c2d3 100644 --- a/doc/radosgw/index.rst +++ b/doc/radosgw/index.rst @@ -40,7 +40,7 @@ one API and retrieve it with the other. Config Reference Purging Temp Data S3 API - Swift API + Swift API Admin API troubleshooting Manpage radosgw <../../man/8/radosgw> diff --git a/doc/radosgw/swift.rst b/doc/radosgw/swift.rst new file mode 100644 index 000000000000..d3fbcd1ca039 --- /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 + Authentication + Service Ops + Container Ops + Object Ops + Tutorial + Java + Python + 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 index 3b8531d7bd45..000000000000 --- 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-Java - Tutorial-Python - Tutorial-Ruby - Auth API - Service API - Container API - Object API - -.. _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 index 000000000000..3b8531d7bd45 --- /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-Java + Tutorial-Python + Tutorial-Ruby + Auth API + Service API + Container API + Object API + +.. _OpenStack Swift: http://docs.openstack.org/api/openstack-object-storage/1.0/content/ \ No newline at end of file