Page Comparison

...

Back up — S3 Backup is an integral part of your operating Swarm cluster. In the Swarm UI, you will create a new feed of type S3 Backup, giving credentials and information about the network path to the service. After the feed is started, you can monitor its progress and be warned of blockages and particular object failures, as with any other feed. The S3 Backup feed will honor honors the versioning settings in your cluster, as enabled, disabled, or suspended throughout the domains and buckets. While you can create multiple S3 Backup feeds, each one requires its own dedicated target bucket.

Clean up — No action on your part is needed to keep the backup current and trimmed. Whenever you disable Swarm versioning on buckets or domains, delete buckets or domains, or have object lifepoints expire, the Swarm feeds mechanism will process processes the expired content as deleted, allowing the S3 Backup feed to clear them from the S3 bucket. Throughout content additions and deletions, the total number objects in your the S3 bucket will always approximate approximates twice the number of logical objects that you are backing up from the source cluster (because AWS functionality requires there to be one for the object's content and another for its metadata).

...

• Cold storage offers the lowest monthly prices per byte stored compared to the standard storage classes.

• Standard storage classes have low-latency retrieval times, which can allow a Swarm Restore to complete in a single run.

• Cold storage has longer retrieval latency, as much as 12-48 hours for S3 Glacier Deep Archive, to pull content from archival storage. Depending upon how a restore is performed, you may need to run the Swarm Restore tool multiple times over several hours in order to complete a restoration.

• Cold storage incurs additional charges for egress and API requests to access your backup, so it is best suited to low-touch use cases.

• S3 Glacier Deep Archive rounds up small objects, so the overall footprint being charged may be larger because of Swarm's use of metadata objects.

...

To implement an S3 backup feed, you will first complete a one-time set up of the S3 side: you will set up an account with an S3 cloud service provider and then create an S3 bucket that will be dedicated to backing up this cluster only.

While these instruction steps are for AWS S3 (see also S3 Backup Feeds to Wasabi), S3-based public cloud providers will have a similar setup process:

1. Service — If needed, sign up for Amazon S3.

   1. Go to aws.amazon.com/s3 and choose Get started with Amazon S3.

   2. Follow the on-screen instructions.

   3. AWS will notify you notifies by email when your account is active and ready to use.

   4. Note that you will access S3 for your new bucket but the separate IAM service for your new user:
      

      Image RemovedImage Added

2. Bucket — Create a bucket that will be dedicated to backing up your the Swarm cluster.

   1. Sign in and open the S3 console: console.aws.amazon.com/s3

   2. Choose Create bucket. (See S3 documentation: Creating a Bucket.) 

   3. On tab 1 - Name and region, make your initial entries:

      1. For Bucket name, enter a DNS-compliant name for your new bucket. You will not be able are unable to change it later, so choose well:

         1. The name must be unique across all existing bucket names in Amazon S3.

         2. The name must be a valid DNS name, containing only lowercase letters and numbers (and internal periods, hyphens, underscores), between 3 and 64 characters. (See S3 documentation: Rules for Bucket Naming.)
            Tip: For easier identification, incorporate the name of the Swarm cluster that this bucket will be is dedicated to backing up.

      2. For Region, choose the one that is appropriate for your business needs. (See S3 documentation: Regions and Endpoints.)

   4. On tab 2 - Configure options, take the defaults. (See S3 documentation: Creating a Bucket, step 4.)
      Best practice: Do not enable versioning or any other optional features, unless it is required for your organization.

   5. On tab 3 - Set permissions, take the default to select Block all public access; now only the bucket owner account has full access.
      Best practice: Do not use the bucket owner account to provide Swarm's access to the bucket; instead, you will create a new, separate IAM user that will hold holds the credentials to share with Swarm. 

   6. Choose Create, and record the fully qualified bucket name (such as "arn:aws:s3:::example.cluster1.backup") for use later, in policies.

   7. Record these values for configuring your S3 Backup feed in Swarm:

      • Bucket Name

      • Region

3. User — Create a programmatic (non-human) user that will be dedicated to Swarm access.

   1. On the Amazon S3 console, select the service IAM (Identity and Access Management), click Users.
      
      

   2. Add a dedicated user, such as caringo_backup, to provide Programmatic access for Swarm.
      
      

   3. The IAM console generates an access key (an access key ID + secret access key), which you must record immediately.
      (See S3 documentation: Managing Access Keys for IAM Users and Understanding and Getting Your Security Credentials.)

      • This is your only opportunity to view or download the secret access key, so save it in a secure place.

   4. Record the fully qualified user (such as "arn:aws:iam::123456789012:user/caringo_backup") for use later, in policies.

   5. Record these values for configuring your S3 Backup feed in Swarm:

      • Access Key ID

      • Secret Access Key

4. Policies — Create policies on both the user and the bucket so that the programmatic user has exclusive rights to your S3 bucket. You may use the policy generators provided or enter edited versions of the examples below.

   1. Create an IAM policy for this user, allowing it all S3 actions on the backup bucket, which you need to specify as a fully qualified Resource (which you recorded above), starting with arn:aws:s3:::
      

      IAM policy

      Code Block
      language xml
      { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "s3:*", "Resource": "arn:aws:s3:::example.cluster1.backup" } ] }

      
      

   2. Create a matching bucket policy to grant access to the dedicated backup user, which you need to specify as a fully qualified Principal, which is the User ARN (which you recorded above) starting with arn:aws:iam:: (See S3 Using Bucket Policies.) 
      Using the Policy Generator, be sure to allow all S3 actions for your bucket, using the full ARN name:
      

      Bucket policy

      Code Block
      language xml
      { "Id": "Policy1560809845679", "Version": "2012-10-17", "Statement": [ { "Sid": "Stmt1560809828003", "Action": "s3:*", "Effect": "Allow", "Resource": "arn:aws:s3:::example.cluster1.backup", "Principal": { "AWS": [ "arn:aws:iam::123456789012:user/caringo_backup" ] } } ] }

      
      

5. Best practice for security: After you implement the S3 Backup feed in Swarm, write a script to automate rotation of the S3 secret access key on a regular basis, including updating in the S3 Backup feed definition in Swarm (using the management API call, given in Rotating the S3 Access Key, below).
   

...

1. Go to the Feeds page.
   

2. Select + Add at the top right.
   

   Image RemovedImage Added

3. Choose the S3 Backup feed type:
   

   Image RemovedImage Added

An S3 Backup feed has these parameters:

ID (existing feeds)	Read-only; system-assigned identifier
Status (existing feeds)	Read-only; the current feed processing state. The state can be: Active. Default state when operating normally. Recovering. Temporarily paused due to volume recovery. Paused. Paused by user request. Blocked. Processing blocked due to a transient condition.  Configuration error. Feed is unable to operate due to incorrect configuration Overlapping feeds. More than the limit of 8 feeds have been defined for the same set of objects. Closed. Feed is inactive and no longer operational.
Name	The name you attach to this backup feed.
Scope	The scope filter that you select for your backup feed. Backup

will only include

includes objects within the scope you indicate here. If your scope includes a context where Swarm object versioning is (or was) generating historical versions, those versions are backed up as well. Entire source cluster (global) — To replicate all objects in the source cluster, leave the default selection of Entire source cluster (global) Only objects in select domain(s) — To replicate only the objects in one or more domains, select the 'Only objects in select domain(s) option. In the text box that appears, enter one or more domains: To replicate only the objects within a specific domain, enter that domain. To replicate only the objects within multiple domains, enter those domains separated by commas and/or use pattern matching. To exclude domains from replication, enter them. The field value allows pattern matching with the Python regular expression (RE) syntax so that multiple domain names can be matched. The exception to the RE matching is that the "{m,n}" repetitions qualifier may not be used. An example domain list value using RE is: .*\.example\.com  This

would match

matches both of these domains: accounting.example.com, engineering.example.com.

Image Removed

Image Added Include objects without a domain — To replicate any unnamed objects that are not tenanted in any domain, enable the option.
Target S3 Provider	The configuration for your S3 bucket. Info Caution Although it's possible to specify another Swarm cluster (via Content Gateway S3) for your S3 backup, it is risky if there is any chance of it replicating back to your source cluster: both clusters could fill to capacity with backups of backups. Best practice is to use a regular Replication feed, which has the mechanisms needed for mirroring clusters safely.
Host	From your S3 configuration, the host name of the S3 service. You cannot use an IP address here because the host name itself becomes the Host header in the feed operation, which is required for communication to S3 services. Important: Add your bucket name as the prefix to the host name (mybackup.s3.aws.com). This prefix must match the bucket name exactly, including case. This supports the new AWS bucket-in-host request style. If you do not have the bucket defined here, Swarm

will use

uses the legacy bucket-in-path (s3.aws.com/mybackup) request style. (v12.0)  Amazon AWS: Existing feeds are not required to change to this format immediately, but new ones should, as bucket-in-path

will be

is unsupported in the future.  Other S3 provider: Ensure that your provider supports the bucket-in-host request style, where the bucket is part of the FQDN; if not, use bucket-in-path.
Port	The port to use for the S3 service, which defaults to 443 (for HTTPS) or else 80 (HTTP), if you disable Require trusted SSL, below. If you customize the port, the value

will

no longer

update

updates based on changes to the SSL setting.
Region	From your S3 configuration, the destination S3 bucket’s region.  Note: Changing this value triggers a restart of the feed.
Bucket	From your S3 configuration, the destination S3 bucket name. This bucket must be dedicated to one and only one source cluster. Complete this field regardless of whether your Host includes the bucket name as a prefix. Note: Changing this value triggers a restart of the feed.
Access key ID and secret key	From your S3 configuration, the S3 access key ID and S3 secret access key to use. (See S3 documentation: Understanding and Getting Your Security Credentials.) Swarm protects your secret key as a secure field, and hides it. Updating the key does not trigger a restart of the feed, so you may update keys as frequently as your security policies require.
SSL Server	For production usage, select Require trusted SSL. Recommended: To keep bandwidth usage by the S3 Backup feed in check, select the option to use a Local Cluster Forward Proxy and configure one for that purpose. The Forward Proxy Host (hostname or IP address) and Port are required.
Threads	The default backup speed (6 simultaneous threads) is optimal for maintaining an existing S3 backup.  For a faster initial backup, increase the threads temporarily, but

be sure to

monitor bandwidth and cluster performance, as boosting the speed

will stress your

stresses internet bandwidth.

Rotating the S3 Access Key

...

The following command template demonstrates how to use the Swarm management API to update the access credentials for an existing S3 backup feed:

curl -X PATCH --header 'Content-Type: application/json' -u <admin>:<password> -d '[       \
{"op": "replace", "path":"destination/accessKeyId", "value":"<newAccessKeyID>"},          \
{"op": "replace", "path":"destination/secretAccessKey", "value":"<newSecretAccessKey>"}]' \
'http://<nodeIP>/api/storage/s3backupfeeds/<s3feedid>'

• <admin> — The Swarm administrative user name, which is usually admin.

• <password> — The Swarm administrative password, required for all management API calls that perform actions.

• <newAccessKeyID> — The new access key ID for the target S3 bucket.

• <newSecretAccessKey> — The new secret access key for the target S3 bucket.

• <nodeIP> — The IP address of any Swarm node in the cluster.

• <s3feedid> — The small integer feed ID that is associated with the S3 Backup feed. It appears as the feed's ID field in the Swarm UI.

...