summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYehuda Sadeh <yehuda@inktank.com>2012-12-11 16:44:46 -0800
committerYehuda Sadeh <yehuda@inktank.com>2012-12-12 13:08:05 -0800
commitbece012caaf5cd89cc727d93e38eeb34b6649db1 (patch)
treefe771cf09b3717cdb5ad37fd8762ef26bb603603
parent88229a49d9870b7646569bcaa9a97e0689edfa73 (diff)
downloadceph-bece012caaf5cd89cc727d93e38eeb34b6649db1.tar.gz
doc: document swift compatibility
Add a table that specifies swift features compatibility Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
-rw-r--r--doc/radosgw/index.rst2
-rw-r--r--doc/radosgw/swift.rst74
-rw-r--r--doc/radosgw/swift/swift.rst (renamed from doc/radosgw/swift/index.rst)0
3 files changed, 75 insertions, 1 deletions
diff --git a/doc/radosgw/index.rst b/doc/radosgw/index.rst
index d9c2e3579bd..7f76c588c2d 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 <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
index 00000000000..d3fbcd1ca03
--- /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/swift.rst
index 3b8531d7bd4..3b8531d7bd4 100644
--- a/doc/radosgw/swift/index.rst
+++ b/doc/radosgw/swift/swift.rst