Skip to main content
A newer release of this product is available.

Configuring CloudMirror replication

Contributors netapp-lhalbert
PDFs

The CloudMirror replication service is one of the three StorageGRID platform services. You can use CloudMirror replication to automatically replicate objects to an external S3 bucket.

What you'll need

  • Platform services must be enabled for your tenant account by a StorageGRID administrator.

  • You must have already created a bucket to act as the replication source.

  • The endpoint that you intend to use as a destination for CloudMirror replication must already exist, and you must have its URN.

  • You must belong to a user group that has the Manage All Buckets or the Root Access permission, which allows you to manage the settings for all S3 buckets in your tenant account. These permissions override the permission settings in group or bucket policies when configuring the bucket using the Tenant Manager.

About this task

CloudMirror replication copies objects from a source bucket to a destination bucket that is specified in an endpoint. To enable CloudMirror replication for a bucket, you must create and apply valid bucket replication configuration XML. The replication configuration XML must use the URN of an S3 bucket endpoint for each destination.

Note Replication is not supported for source or destination buckets with S3 Object Lock enabled.

For general information on bucket replication and how to configure it, see the Amazon documentation on cross-region replication (CRR). For information on how StorageGRID implements the S3 bucket replication configuration API, see the instructions for implementing S3 client applications.

If you enable CloudMirror replication on a bucket that contains objects, new objects added to the bucket are replicated, but the existing objects in the bucket are not. You must update existing objects to trigger replication.

If you specify a storage class in the replication configuration XML, StorageGRID uses that class when performing operations against the destination S3 endpoint. The destination endpoint must also support the specified storage class. Be sure to follow any recommendations provided by the destination system vendor.

Steps

  1. Enable replication for your source bucket:

    Use a text editor to create the replication configuration XML required to enable replication, as specified in the S3 replication API. When configuring the XML:

    • Note that StorageGRID only supports V1 of the replication configuration. This means that StorageGRID does not support the use of the Filter element for rules, and follows V1 conventions for deletion of object versions. See the Amazon documentation on replication configuration for details.

    • Use the URN of an S3 bucket endpoint as the destination.

    • Optionally add the <StorageClass> element, and specify one of the following:

      • STANDARD: The default storage class. If you do not specify a storage class when you upload an object, the STANDARD storage class is used.

      • STANDARD_IA: (Standard - infrequent access.) Use this storage class for data that is accessed less frequently, but that still requires rapid access when needed.

      • REDUCED_REDUNDANCY: Use this storage class for noncritical, reproducible data that can be stored with less redundancy than the STANDARD storage class.

    • If you specify a Role in the configuration XML it will be ignored. This value is not used by StorageGRID.

    <ReplicationConfiguration>
    <Role></Role>
    <Rule>
        <Status>Enabled</Status>
        <Prefix>2020</Prefix>
        <Destination>
           <Bucket>urn:sgws:s3:::2017-records</Bucket>
           <StorageClass>STANDARD</StorageClass>
         </Destination>
     </Rule>
</ReplicationConfiguration>

  2. In the Tenant Manager select STORAGE (S3) > Buckets.

  3. Select the name of the source bucket.

    The bucket details page appears.

  4. Select Platform services > Replication.

  5. Select the Enable replication check box.

  6. Paste the replication configuration XML into the text box, and select Save changes.

    screenshot of replication configuration dialog box
    Note Platform services must be enabled for each tenant account by a StorageGRID administrator using the Grid Manager or Grid Management API. Contact your StorageGRID administrator if an error occurs when you save the configuration XML.

  7. Verify that replication is configured correctly:

    1. Add an object to the source bucket that meets the requirements for replication as specified in the replication configuration.

      In the example shown earlier, objects that match the prefix “2020” are replicated.

    2. Confirm that the object has been replicated to the destination bucket.

      For small objects, replication happens quickly.

Related information

Understanding the CloudMirror replication service

Use S3

Creating a platform services endpoint