S3 Backup Feeds to IBM Cloud Object Storage

Owned by Kyle Miller (Deactivated)
Last updated: Dec 07, 2023 by Bala Harish A(AC)
2 min read

Backup

Objects in the S3 backup bucket are wholly dedicated to disaster recovery for Swarm and are not for general use by owners of the account where the bucket resides. Consider this feature a restricted form of S3, with constraints on the bucket's namespace that support Swarm's ability to backup and restore. For this reason, do not expect the namespace to be end-user-friendly.

Swarm S3 backups to IBM Cloud Object Storage targets are verified. To implement an S3 backup feed, complete a one-time set-up of the destination: set up an account with IBM and then create an S3 bucket dedicated to backing up this cluster.

Setting Up the S3 Bucket

Note

Swarm has the IBM Cloud Object Storage access granted as part of this configuration. Neither the S3 Backup feed nor the https://perifery.atlassian.net/wiki/spaces/public/pages/2443815581 administers the S3 credentials or creates any S3 buckets in IBM. See IBM Support for assistance.

These instructions are for IBM Cloud Object Storage, but any Internet-based S3 service has similar functionality:

  1. Account - Create an account at cloud.ibm.com or use the IBM Cloud CLI to log in and create resources if needed.

  2. Resources, Service Instances, and Buckets - See Working with resources and resource groups (ibmcloud resource) and Getting started with IBM Cloud Object Storage for details on creating resources, service instances and buckets using either the IBM Cloud UI or IBM Cloud CLI.

  3. S3 Key Pair - Create an S3 key pair dedicated to Swarm access. See IBM’s guide on Using HMAC credentials for details.

Configuring the S3 Backup Feed

Create a new S3 backup feed with IBM Cloud Object Storage as the target on the Swarm side.

  1. Open the Cluster > Feeds page in the Swarm UI.

  2. Click + Add at the top right.

  3. Choose the feed type S3 Backup.

  4. Provide the following values. See https://perifery.atlassian.net/wiki/spaces/public/pages/2443815149 for details on these fields.

    • Name - For description, such as "Replication to IBM Cloud Object Storage"

    • Endpoint - Include the complete endpoint, without the bucket: s3.us.cloud-object-storage.appdomain.cloud

    • Region - This example uses the us-geo storage region. Check with IBM Support for any other region or see IBM's list of endpoints.

    • Bucket - Enter the newly created bucket, which is dedicated to backing up the Swarm cluster.

    • Credentials - Paste in both the Access key name and Secret Key

    • Use SSL - Yes

      See https://perifery.atlassian.net/wiki/spaces/public/pages/2443815149 for details on all field options.

  5. Verify the new S3 backup appears in the list of Swarm feeds on the Cluster > Feeds dashboard.
    See  for more details on feed administration in Swarm.

© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.