AWS S3 or S3-compatible

Overview

vProtect can store backups in AWS S3 or S3-compatible backup providers. In most cases, you just need to prepare a bucket (with versioning enabled if possible) and generate an access/secret key for vProtect. vProtect can be installed in AWS (if EC2 backup is used), but in most cases, S3 is used just as a cloud backup provider for on-prem environments.
Typical use cases are:
  • When AWS is used - choose a single bucket with versioning enabled - all backup objects will have names in /container_name/path/to/backup format, where container_name typically is the VM name with an identifier.
  • When a 3rd party is used - you need to verify:
    • Which strategy is supported by the vendor - i.e. Scality requires a single bucket without versioning.
    • When timestamp recording of the object should occur - i.e. Scality does it after data is stored (unlike AWS).
vProtect is also able to encrypt backups before sending backups (client-side encryption: SSE-C). Once enabled, new data being stored is encrypted with keys generated and kept by vProtect. For performance improvements, we also recommend using AWS Direct Connect to access S3. Otherwise, backups would be sent over the Internet, which could result in poor performance.
Note: S3 has a limit of 5TB per object. This means that depending on the virtualization platform and backup format used by export/import mode you may have a limit of 5TB per VM (if it is Proxmox VMA or Citrix XVA image-based backup) or per VM disk (in most cases). Bigger files are currently not supported.

Permissions

Depending on the selected mode, you may have different permission sets. For a single bucket, you need to use the access keys of a user that has the ability to control objects within the bucket over the specific bucket - here is an example IAM policy:
1
{
2
"Version": "2012-10-17",
3
"Statement": [
4
{
5
"Sid": "Stmt1568968204280",
6
"Action": [
7
"s3:DeleteObject",
8
"s3:DeleteObjectTagging",
9
"s3:DeleteObjectVersion",
10
"s3:DeleteObjectVersionTagging",
11
"s3:GetBucketTagging",
12
"s3:GetBucketVersioning",
13
"s3:GetObject",
14
"s3:GetObjectRetention",
15
"s3:GetObjectTagging",
16
"s3:GetObjectVersion",
17
"s3:GetObjectVersionTagging",
18
"s3:ListBucket",
19
"s3:ListBucketVersions",
20
"s3:PutObject",
21
"s3:PutObjectTagging",
22
"s3:PutObjectVersionTagging",
23
"s3:RestoreObject"
24
],
25
"Effect": "Allow",
26
"Resource": "arn:aws:s3:::BACKUP_DESTINATION_BUCKET/*"
27
}
28
]
29
}
Copied!
You can also use a predefined role and create a user from the AWS console: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html#Using_CreateAccessKey
Note: It recommended to periodically rotate your access/secret keys. More information can be found here: https://aws.amazon.com/blogs/security/how-to-rotate-access-keys-for-iam-users/. After changing the key in AWS, remember to update it in vProtect as well.

Parameters

See the S3 section in Backup destinations.

Bucket replication

Even though S3 is a highly available service, you may want to be prepared in case of a region failure. We recommend following this guide https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html to set up bucket replication so that your data is replicated to another region in a worst case scenario. Remember to point vProtect to the replicated bucket in case of a disaster.

Glacier/Deep Archive support

Starting from version 3.9, vProtect is able to move older backups to a Glacier/Deep Archive storage tier. In the S3 backup provider settings, you need to enable the Move old versions to other storage class toggle and provide extended retention settings.
Keep in mind that vProtect will try to restore it to S3 with an expiration set to 2 days. You'll notice that although the task is running, no progress is taking place as it is waiting for the object to be restored from Glacier to S3. This may take several hours as Glacier doesn't provide instant access for archival data. Once this part is completed, vProtect will proceed with regular restore from a temporary S3 object.

Costs

When storing backups in S3, additional charges will occur for stored backups. Retention setting in vProtect can limit the storage costs of stored backups. Currently, vProtect doesn't support Glacier (but it will appear in future releases).
Please visit https://aws.amazon.com/s3/pricing/ to check current AWS S3 pricing.

Example

Now we will show you how to quickly create S3 storage and integrate it with vProtect as a backup destination. After logging in, expand the services tab a choose S3 under the Storage section:
Now create a new bucket for your backups:
In "Configure options" activate versioning: (In all other tabs, you can leave the default settings)
After creating a bucket, we need to create a new user with appropriate permissions:
Remember to choose the "Programmatic access" account type:
From the predefined roles, you can choose "AmazonS3FullAccess" or you can create a new one as described in the Permissions section:
Remember to download the .csv or copy the key credentials manually:
Now go to the Backup destination tab on the vProtect dashboard and change the sub-tab to object storage. Provide the bucket name and key credentials, and then configure the remaining options according to your requirements:
Last modified 3mo ago