]> git.proxmox.com Git - ceph.git/blob - ceph/doc/radosgw/archive-sync-module.rst
update sources to ceph Nautilus 14.2.1
[ceph.git] / ceph / doc / radosgw / archive-sync-module.rst
1 ===================
2 Archive Sync Module
3 ===================
4
5 .. versionadded:: Nautilus
6
7 This sync module leverages the versioning feature of the S3 objects in RGW to
8 have an archive zone that captures the different versions of the S3 objects
9 as they occur over time in the other zones.
10
11 An archive zone allows to have a history of versions of S3 objects that can
12 only be eliminated through the gateways associated with the archive zone.
13
14 This functionality is useful to have a configuration where several
15 non-versioned zones replicate their data and metadata through their zone
16 gateways (mirror configuration) providing high availability to the end users,
17 while the archive zone captures all the data updates and metadata for
18 consolidate them as versions of S3 objects.
19
20 Including an archive zone in a multizone configuration allows you to have the
21 flexibility of an S3 object history in one only zone while saving the space
22 that the replicas of the versioned S3 objects would consume in the rest of the
23 zones.
24
25
26
27 Archive Sync Tier Type Configuration
28 ------------------------------------
29
30 How to Configure
31 ~~~~~~~~~~~~~~~~
32
33 See `Multisite Configuration`_ for how to multisite config instructions. The
34 archive sync module requires a creation of a new zone. The zone tier type needs
35 to be defined as ``archive``:
36
37 ::
38
39 # radosgw-admin zone create --rgw-zonegroup={zone-group-name} \
40 --rgw-zone={zone-name} \
41 --endpoints={http://fqdn}[,{http://fqdn}]
42 --tier-type=archive
43
44 .. _Multisite Configuration: ./multisite