ceph/doc/radosgw/swift.rst
Florian Haas d730820a48 Improve OpenStack integration and multitenancy docs for radosgw
Add explanatory information on:

* "rgw swift account in url" (including the Swift account in the Swift
  API url and Keystone endpoint)
* "rgw swift versioning enabled" (enabling Swift object versioning)
* "rgw s3 auth use keystone" (enabling S3 authentication against
  Keystone)
* "rgw keystone implicit tenants" (multi-tenancy via Keystone, including
  its implications for the Swift and S3 APIs)

Fixes: http://tracker.ceph.com/issues/36765
Signed-off-by: Florian Haas <florian@citynetwork.eu>
2018-12-19 17:46:56 +01:00

78 lines
5.0 KiB
ReStructuredText

===============================
Ceph Object Gateway Swift API
===============================
Ceph supports a RESTful API that is compatible with the basic data access model of the `Swift API`_.
API
---
.. toctree::
:maxdepth: 1
Authentication <swift/auth>
Service Ops <swift/serviceops>
Container Ops <swift/containerops>
Object Ops <swift/objectops>
Temp URL Ops <swift/tempurl>
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 | |
+---------------------------------+-----------------+----------------------------------------+
| **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** | 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** | Supported | |
+---------------------------------+-----------------+----------------------------------------+
| **Temporary URLs** | Partial Support | No support for container-level keys |
+---------------------------------+-----------------+----------------------------------------+
| **Object Versioning** | Partial Support | No support for ``X-History-Location`` |
+---------------------------------+-----------------+----------------------------------------+
| **CORS** | Not Supported | |
+---------------------------------+-----------------+----------------------------------------+
.. _Swift API: https://developer.openstack.org/api-ref/object-store/index.html