ceph/doc/radosgw/index.rst

   1 .. _object-gateway:
   2
   3 =====================
   4  Ceph Object Gateway
   5 =====================
   6
   7 :term:`Ceph Object Gateway` is an object storage interface built on top of
   8 ``librados`` to provide applications with a RESTful gateway to
   9 Ceph Storage Clusters. :term:`Ceph Object Storage` supports two interfaces:
  10
  11 #. **S3-compatible:** Provides object storage functionality with an interface
  12    that is compatible with a large subset of the Amazon S3 RESTful API.
  13
  14 #. **Swift-compatible:** Provides object storage functionality with an interface
  15    that is compatible with a large subset of the OpenStack Swift API.
  16
  17 Ceph Object Storage uses the Ceph Object Gateway daemon (``radosgw``), which is
  18 an HTTP server for interacting with a Ceph Storage Cluster. Since it
  19 provides interfaces compatible with OpenStack Swift and Amazon S3, the Ceph
  20 Object Gateway has its own user management. Ceph Object Gateway can store data
  21 in the same Ceph Storage Cluster used to store data from Ceph File System clients
  22 or Ceph Block Device clients. The S3 and Swift APIs share a common namespace, so
  23 you may write data with one API and retrieve it with the other.
  24
  25 .. ditaa::
  26
  27             +------------------------+ +------------------------+
  28             |   S3 compatible API    | |  Swift compatible API  |
  29             +------------------------+-+------------------------+
  30             |                      radosgw                      |
  31             +---------------------------------------------------+
  32             |                      librados                     |
  33             +------------------------+-+------------------------+
  34             |          OSDs          | |        Monitors        |
  35             +------------------------+ +------------------------+
  36
  37 .. note:: Ceph Object Storage does **NOT** use the Ceph Metadata Server.
  38
  39
  40 .. toctree::
  41    :maxdepth: 1
  42
  43    HTTP Frontends <frontends>
  44    Pool Placement and Storage Classes <placement>
  45    Multisite Configuration <multisite>
  46    Multisite Sync Policy Configuration <multisite-sync-policy>
  47    Configuring Pools <pools>
  48    Config Reference <config-ref>
  49    Admin Guide <admin>
  50    S3 API <s3>
  51    Data caching and CDN <rgw-cache.rst>
  52    Swift API <swift>
  53    Admin Ops API <adminops>
  54    Python binding <api>
  55    Export over NFS <nfs>
  56    OpenStack Keystone Integration <keystone>
  57    OpenStack Barbican Integration <barbican>
  58    HashiCorp Vault Integration <vault>
  59    KMIP Integration <kmip>
  60    Open Policy Agent Integration <opa>
  61    Multi-tenancy <multitenancy>
  62    Compression <compression>
  63    LDAP Authentication <ldap-auth>
  64    Server-Side Encryption <encryption>
  65    Bucket Policy <bucketpolicy>
  66    Dynamic bucket index resharding <dynamicresharding>
  67    Multi factor authentication <mfa>
  68    Sync Modules <sync-modules>
  69    Bucket Notifications <notifications>
  70    Data Layout in RADOS <layout>
  71    STS <STS>
  72    STS Lite <STSLite>
  73    Keycloak <keycloak>
  74    Session Tags <session-tags>
  75    Role <role>
  76    Orphan List and Associated Tooling <orphans>
  77    OpenID Connect Provider <oidc>
  78    troubleshooting
  79    Manpage radosgw <../../man/8/radosgw>
  80    Manpage radosgw-admin <../../man/8/radosgw-admin>
  81    QAT Acceleration for Encryption and Compression <qat-accel>
  82    S3-select <s3select>
  83    Lua Scripting <lua-scripting>
  84    D3N Data Cache <d3n_datacache>
  85    Cloud Transition <cloud-transition>
  86