rgw: Add archive sync module doc

Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
This commit is contained in:
Javier M. Mellid 2018-10-01 20:48:25 +02:00 committed by Yehuda Sadeh
parent 8c4574dd3c
commit d0a27bfb81
2 changed files with 46 additions and 0 deletions

View File

@ -0,0 +1,44 @@
===================
Archive Sync Module
===================
.. versionadded:: Mimic
This sync module leverages the versioning feature of the S3 objects in RGW to
have an archive zone that captures the different versions of the S3 objects
as they occur over time in the other zones.
An archive zone allows to have a history of versions of S3 objects that can
only be eliminated through the gateways associated with the archive zone.
This functionality is useful to have a configuration where several
non-versioned zones replicate their data and metadata through their zone
gateways (mirror configuration) providing high availability to the end users,
while the archive zone captures all the data updates and metadata for
consolidate them as versions of S3 objects.
Including an archive zone in a multizone configuration allows you to have the
flexibility of an S3 object history in one only zone while saving the space
that the replicas of the versioned S3 objects would consume in the rest of the
zones.
Archive Sync Tier Type Configuration
------------------------------------
How to Configure
~~~~~~~~~~~~~~~~
See `Multisite Configuration`_ for how to multisite config instructions. The
archive sync module requires a creation of a new zone. The zone tier type needs
to be defined as ``archive``:
::
# radosgw-admin zone create --rgw-zonegroup={zone-group-name} \
--rgw-zone={zone-name} \
--endpoints={http://fqdn}[,{http://fqdn}]
--tier-type=archive
.. _Multisite Configuration: ./multisite

View File

@ -30,6 +30,7 @@ for configuring any sync plugin
ElasticSearch Sync Module <elastic-sync-module>
Cloud Sync Module <cloud-sync-module>
PubSub Module <pubsub-module>
Archive Sync Module <archive-sync-module>
.. note ``rgw`` is the default sync plugin and there is no need to explicitly
configure this
@ -96,3 +97,4 @@ Now start the radosgw in the zone
.. _`elasticsearch`: ../elastic-sync-module
.. _`cloud sync module`: ../cloud-sync-module
.. _`pubsub module`: ../pubsub-module
.. _`archive sync module`: ../archive-sync-module