Configuring Backups to and from S3

Vertica supports backing up to Amazon (AWS) S3 in both Enterprise Mode and Eon Mode. To back up to AWS, you add parameters to your backup configuration file. You can create these backups from your local cluster or from Amazon EC2 virtual servers.

In Eon Mode, if your cluster runs on-premise, meaning your communal storage is not on AWS, you can back up to AWS or to another destination supporting the S3 protocol. Some additional configuration is required.

See Additional Considerations for AWS for information about configuring authentication and encryption on AWS.

Creating an S3 Configuration File (Required for All Database Types)

To back up any cluster to an S3 destination, you must add an [S3] section to your backup configuration file. This section describes the backup location. For more information, refer to [S3]. Vertica also provides a sample S3 configuration file that you can copy and edit.

For Eon Mode databases running on-premise, see the additional requirements in the next section.

Backing up an on-premise database in Eon Mode

You can back up an Eon Mode database that is running on-premise to either AWS or a Pure Storage FlashBlade appliance, both of which support the S3 protocol. You must specify the following in environment variables:

  • The endpoint for your communal storage, VBR_COMMUNAL_STORAGE_ENDPOINT_URL. Include the scheme (http or https).
  • If the backup location is not on AWS, the endpoint for the backup location, VBR_BACKUP_STORAGE_ENDPOINT_URL. Include the scheme (http or https).
  • Credentials for your communal storage, VBR_COMMUNAL_STORAGE_ACCESS_KEY_ID and VBR_COMMUNAL_STORAGE_SECRET_ACCESS_KEY.
  • Credentials for your backup location, VBR_BACKUP_STORAGE_ACCESS_KEY_ID and VBR_BACKUP_STORAGE_SECRET_ACCESS_KEY.

If the backup location is on AWS, do not set VBR_BACKUP_STORAGE_ENDPOINT_URL.

For on-premise databases you must specify your credentials via these environment variables. You cannot use other methods of credentialing with cross-endpoint backups.

Following is a summary of the environment variables:

$ export VBR_COMMUNAL_STORAGE_ENDPOINT_URL=communal_storage_endpoint

# For backups to non-AWS S3 destinations only:				
$ export VBR_BACKUP_STORAGE_ENDPOINT_URL=backup_storage_endpoint_not_AWS

$ export VBR_COMMUNAL_STORAGE_ACCESS_KEY_ID=communal_storage_access_key

$ export VBR_COMMUNAL_STORAGE_SECRET_ACCESS_KEY=communal_storage_secret_key

$ export VBR_BACKUP_STORAGE_ACCESS_KEY_ID=backup_storage_access_key

$ export VBR_BACKUP_STORAGE_SECRET_ACCESS_KEY=backup_storage_secret_key