]> git.proxmox.com Git - ceph.git/blame - ceph/doc/radosgw/index.rst
update sources to ceph Nautilus 14.2.1
[ceph.git] / ceph / doc / radosgw / index.rst
CommitLineData
91327a77
AA
1.. _object-gateway:
2
7c673cae
FG
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
9Ceph 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
17Ceph Object Storage uses the Ceph Object Gateway daemon (``radosgw``), which is
31f18b77 18an HTTP server for interacting with a Ceph Storage Cluster. Since it
7c673cae
FG
19provides interfaces compatible with OpenStack Swift and Amazon S3, the Ceph
20Object Gateway has its own user management. Ceph Object Gateway can store data
21in the same Ceph Storage Cluster used to store data from Ceph Filesystem clients
22or Ceph Block Device clients. The S3 and Swift APIs share a common namespace, so
23you may write data with one API and retrieve it with the other.
24
25.. ditaa:: +------------------------+ +------------------------+
26 | S3 compatible API | | Swift compatible API |
27 +------------------------+-+------------------------+
28 | radosgw |
29 +---------------------------------------------------+
30 | librados |
31 +------------------------+-+------------------------+
32 | OSDs | | Monitors |
33 +------------------------+ +------------------------+
34
35.. note:: Ceph Object Storage does **NOT** use the Ceph Metadata Server.
36
37
38.. toctree::
39 :maxdepth: 1
40
41 Manual Install w/Civetweb <../../install/install-ceph-gateway>
94b18763 42 HTTP Frontends <frontends>
11fdf7f2 43 Pool Placement and Storage Classes <placement>
7c673cae 44 Multisite Configuration <multisite>
31f18b77 45 Configuring Pools <pools>
7c673cae
FG
46 Config Reference <config-ref>
47 Admin Guide <admin>
48 S3 API <s3>
49 Swift API <swift>
50 Admin Ops API <adminops>
51 Python binding <api>
224ce89b 52 Export over NFS <nfs>
7c673cae
FG
53 OpenStack Keystone Integration <keystone>
54 OpenStack Barbican Integration <barbican>
11fdf7f2 55 Open Policy Agent Integration <opa>
7c673cae
FG
56 Multi-tenancy <multitenancy>
57 Compression <compression>
224ce89b 58 LDAP Authentication <ldap-auth>
7c673cae 59 Server-Side Encryption <encryption>
31f18b77 60 Bucket Policy <bucketpolicy>
11fdf7f2
TL
61 Dynamic bucket index resharding <dynamicresharding>
62 Multi factor authentication <mfa>
63 Sync Modules <sync-modules>
7c673cae 64 Data Layout in RADOS <layout>
11fdf7f2
TL
65 STS Lite <STSLite>
66 Role <role>
7c673cae
FG
67 troubleshooting
68 Manpage radosgw <../../man/8/radosgw>
69 Manpage radosgw-admin <../../man/8/radosgw-admin>
11fdf7f2 70