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