src/ceph/doc/radosgw/index.rst

   1 =====================
   2  Ceph Object Gateway
   3 =====================
   4
   5 :term:`Ceph Object Gateway` is an object storage interface built on top of
   6 ``librados`` to provide applications with a RESTful gateway to
   7 Ceph Storage Clusters. :term:`Ceph Object Storage` supports two interfaces:
   8
   9 #. **S3-compatible:** Provides object storage functionality with an interface
  10    that is compatible with a large subset of the Amazon S3 RESTful API.
  11
  12 #. **Swift-compatible:** Provides object storage functionality with an interface
  13    that is compatible with a large subset of the OpenStack Swift API.
  14
  15 Ceph Object Storage uses the Ceph Object Gateway daemon (``radosgw``), which is
  16 an HTTP server for interacting with a Ceph Storage Cluster. Since it
  17 provides interfaces compatible with OpenStack Swift and Amazon S3, the Ceph
  18 Object Gateway has its own user management. Ceph Object Gateway can store data
  19 in the same Ceph Storage Cluster used to store data from Ceph Filesystem clients
  20 or Ceph Block Device clients. The S3 and Swift APIs share a common namespace, so
  21 you may write data with one API and retrieve it with the other.
  22
  23 .. ditaa::  +------------------------+ +------------------------+
  24             |   S3 compatible API    | |  Swift compatible API  |
  25             +------------------------+-+------------------------+
  26             |                      radosgw                      |
  27             +---------------------------------------------------+
  28             |                      librados                     |
  29             +------------------------+-+------------------------+
  30             |          OSDs          | |        Monitors        |
  31             +------------------------+ +------------------------+
  32
  33 .. note:: Ceph Object Storage does **NOT** use the Ceph Metadata Server.
  34
  35
  36 .. toctree::
  37    :maxdepth: 1
  38
  39    Manual Install w/Civetweb <../../install/install-ceph-gateway>
  40    Multisite Configuration <multisite>
  41    Configuring Pools <pools>
  42    Config Reference <config-ref>
  43    Admin Guide <admin>
  44    S3 API <s3>
  45    Swift API <swift>
  46    Admin Ops API <adminops>
  47    Python binding <api>
  48    Export over NFS <nfs>
  49    OpenStack Keystone Integration <keystone>
  50    OpenStack Barbican Integration <barbican>
  51    Multi-tenancy <multitenancy>
  52    Compression <compression>
  53    LDAP Authentication <ldap-auth>
  54    Server-Side Encryption <encryption>
  55    Bucket Policy <bucketpolicy>
  56    Data Layout in RADOS <layout>
  57    troubleshooting
  58    Manpage radosgw <../../man/8/radosgw>
  59    Manpage radosgw-admin <../../man/8/radosgw-admin>