Skip to main content
BlueXP backup and recovery
All cloud providers
  • Amazon Web Services
  • Google Cloud
  • Microsoft Azure
  • All cloud providers

Back up Cloud Volumes ONTAP data to Amazon S3

Contributors amgrissino netapp-tonacki netapp-bcammett

Complete a few steps to get started backing up volume data from your Cloud Volumes ONTAP systems to Amazon S3.

Quick start

Get started quickly by following these steps or scroll down to the remaining sections for full details.

One Verify support for your configuration
  • You're running Cloud Volumes ONTAP 9.8 or later in AWS (ONTAP 9.8P13 and later is recommended).

  • You have a valid cloud provider subscription for the storage space where your backups will be located.

  • You have subscribed to the BlueXP Marketplace Backup offering, an AWS annual contract, or you have purchased and activated a BlueXP backup and recovery BYOL license from NetApp.

  • You have a Connector installed in AWS:

    • The Connector can be installed in a site with full internet access ("standard mode") or with limited internet connectivity ("restricted mode").

    • The IAM role that provides the BlueXP Connector with permissions includes S3 permissions from the latest BlueXP policy.

Two Prepare your BlueXP Connector

If you already have a Connector deployed in an AWS region, then you're all set. If not, then you'll need to install a BlueXP Connector in AWS to back up Cloud Volumes ONTAP data to AWS. The Connector can be installed in a site with full internet access ("standard mode") or with limited internet connectivity ("restricted mode").

Three Verify license requirements

You'll need to check license requirements for both AWS and BlueXP.

Four Verify ONTAP networking requirements for replicating volumes

Ensure that the primary and secondary storage systems meet ONTAP version and networking requirements.

Five Enable BlueXP backup and recovery

Select the working environment and click Enable > Backup Volumes next to the Backup and recovery service in the right-panel.

Six Activate backups on your ONTAP volumes

Follow the setup wizard to select the replication and backup policies that you'll use and the volumes you want to back up.

Verify support for your configuration

Read the following requirements to make sure that you have a supported configuration before you start backing up volumes to S3.

The following image shows each component and the connections that you need to prepare between them.

Optionally, you can connect to a secondary ONTAP system for replicated volumes using the public or private connection as well.

A diagram showing how BlueXP backup and recovery communicates with the volumes on the source systems and the destination storage where the backup files are located.

The VPC gateway endpoint must exist in your VPC already. Learn more about gateway endpoints.

Supported ONTAP versions

Minimum of ONTAP 9.8; ONTAP 9.8P13 and later is recommended.

Required information for using customer-managed keys for data encryption

You can choose your own customer-managed keys for data encryption in the activation wizard instead of using the default Amazon S3 encryption keys. In this case you'll need to have the encryption managed keys already set up. See how to use your own keys.

Verify license requirements

For BlueXP backup and recovery PAYGO licensing, a BlueXP subscription is available in the AWS Marketplace that enables deployments of Cloud Volumes ONTAP and BlueXP backup and recovery. You need to subscribe to this BlueXP subscription before you enable BlueXP backup and recovery. Billing for BlueXP backup and recovery is done through this subscription.

For an annual contract that enables you to back up both Cloud Volumes ONTAP data and on-premises ONTAP data, you need to subscribe from the AWS Marketplace page and then associate the subscription with your AWS credentials.

For an annual contract that enables you to bundle Cloud Volumes ONTAP and BlueXP backup and recovery, you must set up the annual contract when you create a Cloud Volumes ONTAP working environment. This option doesn't enable you to back up on-prem data.

For BlueXP backup and recovery BYOL licensing, you need the serial number from NetApp that enables you to use the service for the duration and capacity of the license. Learn how to manage your BYOL licenses. You must use a BYOL license when the Connector and Cloud Volumes ONTAP system are deployed in a dark site.

And you need to have an AWS account for the storage space where your backups will be located.

Prepare your BlueXP Connector

The Connector must be installed in an AWS region with full or limited internet access ("standard" or "restricted" mode). See BlueXP deployment modes for details.

Verify or add permissions to the Connector

The IAM role that provides BlueXP with permissions must include S3 permissions from the latest BlueXP policy. If the policy does not contain all of these permissions, see the AWS Documentation: Editing IAM policies.

Here are the specific permissions from the policy:

Details
{
            "Sid": "backupPolicy",
            "Effect": "Allow",
            "Action": [
                "s3:DeleteBucket",
                "s3:GetLifecycleConfiguration",
                "s3:PutLifecycleConfiguration",
                "s3:PutBucketTagging",
                "s3:ListBucketVersions",
                "s3:GetObject",
                "s3:DeleteObject",
                "s3:PutObject",
                "s3:ListBucket",
                "s3:ListAllMyBuckets",
                "s3:GetBucketTagging",
                "s3:GetBucketLocation",
                "s3:GetBucketPolicyStatus",
                "s3:GetBucketPublicAccessBlock",
                "s3:GetBucketAcl",
                "s3:GetBucketPolicy",
                "s3:PutBucketPolicy",
                "s3:PutBucketOwnershipControls"
                "s3:PutBucketPublicAccessBlock",
                "s3:PutEncryptionConfiguration",
                "s3:GetObjectVersionTagging",
                "s3:GetBucketObjectLockConfiguration",
                "s3:GetObjectVersionAcl",
                "s3:PutObjectTagging",
                "s3:DeleteObjectTagging",
                "s3:GetObjectRetention",
                "s3:DeleteObjectVersionTagging",
                "s3:PutBucketObjectLockConfiguration",
                "s3:DeleteObjectVersion",
                "s3:GetObjectTagging",
                "s3:PutBucketVersioning",
                "s3:PutObjectVersionTagging",
                "s3:GetBucketVersioning",
                "s3:BypassGovernanceRetention",
                "s3:PutObjectRetention",
                "s3:GetObjectVersion",
                "athena:StartQueryExecution",
                "athena:GetQueryResults",
                "athena:GetQueryExecution",
                "glue:GetDatabase",
                "glue:GetTable",
                "glue:CreateTable",
                "glue:CreateDatabase",
                "glue:GetPartitions",
                "glue:BatchCreatePartition",
                "glue:BatchDeletePartition"
            ],
            "Resource": [
                "arn:aws:s3:::netapp-backup-*"
            ]
        },
Note When creating backups in AWS China regions, you need to change the AWS Resource Name "arn" under all Resource sections in the IAM policies from "aws" to "aws-cn"; for example arn:aws-cn:s3:::netapp-backup-*.
Required AWS Cloud Volumes ONTAP permissions

When your Cloud Volumes ONTAP system is running ONTAP 9.12.1 or greater software, the IAM role that provides that working environment with permissions must include a new set of S3 permissions specifically for BlueXP backup and recovery from the latest Cloud Volumes ONTAP policy.

If you created the Cloud Volumes ONTAP working environment using BlueXP version 3.9.23 or greater, these permissions should be part of the IAM role already. Otherwise you'll need to add the missing permissions.

Supported AWS regions

BlueXP backup and recovery is supported in all AWS regions where Cloud Volumes ONTAP is supported, including AWS GovCloud regions.

Required setup for creating backups in a different AWS account

By default, backups are created using the same account as the one used for your Cloud Volumes ONTAP system. If you want to use a different AWS account for your backups, you must:

  • Verify that the permissions "s3:PutBucketPolicy" and "s3:PutBucketOwnershipControls" are part of the IAM role that provides the BlueXP Connector with permissions.

  • Add the destination AWS account credentials in BlueXP. See how to do this.

  • Add the following permissions in the user credentials in the second account:

    "athena:StartQueryExecution",
    "athena:GetQueryResults",
    "athena:GetQueryExecution",
    "glue:GetDatabase",
    "glue:GetTable",
    "glue:CreateTable",
    "glue:CreateDatabase",
    "glue:GetPartitions",
    "glue:BatchCreatePartition",
    "glue:BatchDeletePartition"
Create your own buckets

By default, the service creates buckets for you. If you want to use your own buckets, you can create them before you start the backup activation wizard and then select those buckets in the wizard.

Verify ONTAP networking requirements for replicating volumes

If you plan to create replicated volumes on a secondary ONTAP system using BlueXP backup and recovery, ensure that the source and destination systems meet following networking requirements.

On-premises ONTAP networking requirements

  • If the cluster is in your premises, you should have a connection from your corporate network to your virtual network in the cloud provider. This is typically a VPN connection.

  • ONTAP clusters must meet additional subnet, port, firewall, and cluster requirements.

    Because you can replicate to Cloud Volumes ONTAP or an on-premises systems, review peering requirements for on-premises ONTAP systems. View prerequisites for cluster peering in the ONTAP documentation.

Cloud Volumes ONTAP networking requirements

  • The instance's security group must include the required inbound and outbound rules: specifically, rules for ICMP and ports 11104 and 11105. These rules are included in the predefined security group.

  • To replicate data between two Cloud Volumes ONTAP systems in different subnets, the subnets must be routed together (this is the default setting).

Enable BlueXP backup and recovery on Cloud Volumes ONTAP

Enabling BlueXP backup and recovery is easy. The steps differ slightly depending on whether you have an existing Cloud Volumes ONTAP system or a new one.

Enable BlueXP backup and recovery on a new system

BlueXP backup and recovery is enabled by default in the working environment wizard. Be sure to keep the option enabled.

See Launching Cloud Volumes ONTAP in AWS for requirements and details for creating your Cloud Volumes ONTAP system.

Steps
  1. From the BlueXP Canvas, select Add Working Environment, choose the cloud provider, and select Add New. Select Create Cloud Volumes ONTAP.

  2. Select Amazon Web Services as the cloud provider and then choose a single node or HA system.

  3. Fill out the Details & Credentials page.

  4. On the Services page, leave the service enabled and select Continue.

    Shows the BlueXP backup and recovery option in the working environment wizard.

  5. Complete the pages in the wizard to deploy the system.

Result

BlueXP backup and recovery is enabled on the system. After you've created volumes on these Cloud Volumes ONTAP systems, launch BlueXP backup and recovery and activate backup on each volume that you want to protect.

Enable BlueXP backup and recovery on an existing system

Enable BlueXP backup and recovery on an existing system at any time directly from the working environment.

Steps
  1. From the BlueXP Canvas, select the working environment and select Enable next to the Backup and recovery service in the right-panel.

    If the Amazon S3 destination for your backups exists as a working environment on the Canvas, you can drag the cluster onto the Amazon S3 working environment to initiate the setup wizard.

    A screenshot that shows the Backup and recovery Enable button which is available after you select a working environment.

Tip To modify backup settings or add replication, refer to Manage ONTAP backups.

Activate backups on your ONTAP volumes

Activate backups at any time directly from your on-premises working environment.

A wizard takes you through the following major steps:

You can also Show the API commands at the review step, so you can copy the code to automate backup activation for future working environments.

Start the wizard

Steps
  1. Access the Activate backup and recovery wizard using one of the following ways:

    • From the BlueXP canvas, select the working environment and select Enable > Backup Volumes next to the Backup and recovery service in the right-panel.

      A screenshot that shows the Backup and recovery Enable button that is available after you select a working environment.

      If the AWS destination for your backups exists as a working environment on the Canvas, you can drag the ONTAP cluster onto the AWS object storage.

    • Select Volumes in the Backup and recovery bar. From the Volumes tab, select the Actions Actions icon icon option and select Activate Backup for a single volume (that does not already have replication or backup to object storage already enabled).

    The Introduction page of the wizard shows the protection options including local Snapshots, replication, and backups. If you did the second option in this step, the Define Backup Strategy page appears with one volume selected.

  2. Continue with the following options:

    • If you already have a BlueXP Connector, you're all set. Just select Next.

    • If you don't already have a BlueXP Connector, the Add a Connector option appears. Refer to Prepare your BlueXP Connector.

Select the volumes that you want to back up

Choose the volumes you want to protect. A protected volume is one that has one or more of the following: Snapshot policy, replication policy, backup to object policy.

You can choose to protect FlexVol or FlexGroup volumes; however, you cannot select a mix of these volumes when activating backup for a working environment. See how to activate backup for additional volumes in the working environment (FlexVol or FlexGroup) after you have configured backup for the initial volumes.

Note
  • You can activate a backup only on a single FlexGroup volume at a time.

  • The volumes you select must have the same SnapLock setting. All volumes must have SnapLock Enterprise enabled or have SnapLock disabled. (Volumes with SnapLock Compliance mode require ONTAP 9.14 or later.)

Steps

Note that if the volumes you choose already have Snapshot or replication policies applied, then the policies you select later will overwrite these existing policies.

  1. In the Select Volumes page, select the volume or volumes you want to protect.

    • Optionally, filter the rows to show only volumes with certain volume types, styles, and more to make the selection easier.

    • After you select the first volume, then you can select all FlexVol volumes (FlexGroup volumes can be selected one at a time only). To back up all existing FlexVol volumes, check one volume first and then check the box in the title row. (button backup all volumes).

    • To back up individual volumes, check the box for each volume (button backup 1 volume).

  2. Select Next.

Define the backup strategy

Defining the backup strategy involves setting the following options:

  • Whether you want one or all of the backup options: local Snapshots, replication, and backup to object storage

  • Architecture

  • Local Snapshot policy

  • Replication target and policy

    Note If the volumes you choose have different Snapshot and replication policies than the policies you select in this step, the existing policies will be overwritten.
  • Backup to object storage information (provider, encryption, networking, backup policy, and export options).

Steps
  1. In the Define backup strategy page, choose one or all of the following. All three are selected by default:

    • Local Snapshots: If you are performing replication or back up to object storage, local Snapshots must be created.

    • Replication: Creates replicated volumes on another ONTAP storage system.

    • Backup: Backs up volumes to object storage.

  2. Architecture: If you chose replication and backup, choose one of the following flows of information:

    • Cascading: Information flows from the primary storage system to the secondary, and from secondary to object storage.

    • Fan out: Information flows from the primary storage system to the secondary and from the primary to object storage.

      For details about these architectures, refer to Plan your protection journey.

  3. Local Snapshot: Choose an existing Snapshot policy or create a new one.

    Tip To create a custom policy before activating the Snapshot, refer to Create a policy.

    To create a policy, select Create new policy and do the following:

    • Enter the name of the policy.

    • Select up to 5 schedules, typically of different frequencies.

    • Select Create.

  4. Replication: Set the following options:

    • Replication target: Select the destination working environment and SVM. Optionally, select the destination aggregate or aggregates and prefix or suffix that will be added to the replicated volume name.

    • Replication policy: Choose an existing replication policy or create one.

      Tip To create a custom policy, refer to Create a policy..

      To create a policy, select Create new policy and do the following:

      • Enter the name of the policy.

      • Select up to 5 schedules, typically of different frequencies.

      • Select Create.

  5. Back up to Object: If you selected Backup, set the following options:

    • Provider: Select Amazon Web Services.

    • Provider settings: Enter the provider details and region where the backups will be stored.

      Enter the AWS Account used to store the backups. This can be a different account than where the Cloud Volumes ONTAP system resides.

      If you want to use a different AWS account for your backups, you must add the destination AWS account credentials in BlueXP, and add the permissions "s3:PutBucketPolicy" and "s3:PutBucketOwnershipControls" to the IAM role that provides BlueXP with permissions.

      Select the region where the backups will be stored. This can be a different region than where the Cloud Volumes ONTAP system resides.

      Either create a new bucket or select an existing one.

    • Encryption key: If you created a new bucket, enter encryption key information given to you from the provider. Choose whether you'll use the default AWS encryption keys, or choose your own customer-managed keys from your AWS account, to manage encryption of your data. (See how to use your own encryption keys).

      If you choose to use your own customer-managed keys, enter the key vault and key information.

    Note If you chose an existing bucket, encryption information is already available, so you don't need to enter it now.
    • Backup policy: Select an existing backup-to-object storage policy or create one.

      Tip To create a custom policy before activating the backup, refer to Create a policy.

      To create a policy, select Create new policy and do the following:

      • Enter the name of the policy.

      • Select up to 5 schedules, typically of different frequencies.

      • For backup-to-object policies, set the DataLock and Ransomware Protection settings. For details on DataLock and Ransomware Protection, refer to Backup-to-object policy settings.

  • Select Create.

    • Export existing Snapshot copies to object storage as backup copies: If there are any local Snapshot copies for volumes in this working environment that match the backup schedule label you just selected for this working environment (for example, daily, weekly, etc.), this additional prompt is displayed. Check this box to have all historic Snapshots copied to object storage as backup files to ensure the most complete protection for your volumes.

      1. Select Next.

Review your selections

This is the chance to review your selections and make adjustments, if necessary.

Steps
  1. In the Review page, review your selections.

  2. Optionally check the box to Automatically synchronize the Snapshot policy labels with the replication and backup policy labels. This creates Snapshots with a label that matches the labels in the replication and backup policies.

  3. Select Activate Backup.

Result

BlueXP backup and recovery starts taking the initial backups of your volumes. The baseline transfer of the replicated volume and the backup file includes a full copy of the primary storage system data. Subsequent transfers contain differential copies of the primary storage system data contained in Snapshot copies.

A replicated volume is created in the destination cluster that will be synchronized with the primary storage volume.

An S3 bucket is created in the service account indicated by the S3 access key and secret key you entered, and the backup files are stored there.

The Volume Backup Dashboard is displayed so you can monitor the state of the backups.

You can also monitor the status of backup and restore jobs using the Job Monitoring panel.

Show the API commands

You might want to display and optionally copy the API commands used in the Activate backup and recovery wizard. You might want to do this to automate backup activation in future working environments.

Steps
  1. From the Activate backup and recovery wizard, select View API request.

  2. To copy the commands to the clipboard, select the Copy icon.

What's next?