Configuring Backups for Amazon EC2 Instances for a Single AWS Account with Access Key and Secret Key Authentication

You can configure backups for Amazon EC2 instances for a single AWS account using access key/secret key authentication for dev/test or proof-of-concept environments.

Important

As a best practice, AWS recommends using IAM roles instead of access keys. For more information, see Security best practices in IAM in the AWS documentation.

Start the Configuration Wizard

  1. From the Command Center navigation pane, go to Protect > Virtualization.

    The Virtual machines page appears.

  2. In the upper-right area of the page, click Add hypervisor.

    The Configure Hypervisor page appears.

  3. Select Amazon Web Services.

  4. Click Next.

    The Amazon EC2 Backup Overview page appears.

  5. Review the information.

  6. Click Next.

    The Configure permissions page of the configuration wizard appears.

Configure Permissions

  1. From the Authentication method list, select Access and secret key.

  2. Verify an existing CommvaultUserGroup IAM user group or create a new CommvaultUserGroup IAM user group:

    • If the CommvaultUserGroup IAM user group was previously created for another AWS workload, do the following:

      1. Verify that the IAM policies for the AWS workload are still attached to the CommvaultUserGroup IAM user group.

      2. At the bottom of the page, select the confirmation check box.

      3. Click Next.

        The Region page of the configuration wizard appears.

    • If the CommvaultUserGroup IAM user group does not exist yet, create it in AWS.

      Steps to create CommvaultUserGroup IAM user group
      1. Click the Launch CloudFormation Stack link to open the AWS console.

        Important

        If you do not have permission to create a role in the AWS account, copy the Launch CloudFormation Stack link and share it with your AWS IAM administrator.

      2. Log on to the AWS console.

        The Quick create stack page appears.

      3. Under Capabilities, read the information about the template, and then select the acknowledgment check box.

      4. Click Create stack.

        Wait for the CloudFormation Stack to finish creating the CommvaultUserGroup IAM user group. The CloudFormation Stack creates IAM policies for all supported AWS workloads, and then attaches the policies to CommvaultUserGroup.

      5. Go to the IAM dashboard.

        The IAM dashboard page appears.

      6. Select Users, and then click Add users.

        The Add user page appears.

      7. Enter a name for the user (for example, MetallicSvcUser).

      8. Select the Access key - Programmatic access check box.

        Commvault Cloud does not need AWS Console Access.

        This setting creates an access key for each new user.

      9. Click Next to set permissions.

      10. Select Add user to group, and then select the CommvaultUserGroup IAM user group.

      11. Optionally, you can set IAM tags which are key-value pairs you can add to your user.

      12. Click Review to display the user details.

      13. Click Create user.

        A message confirms that the user is created successfully. From here, you can download the .csv file and view details about the access and secret key for the new user.

      14. Verify that the IAM policies for the AWS workload are still attached to the CommvaultUserGroup IAM user group.

      15. At the bottom of the page, select the confirmation check box.

      16. Click Next.

        The Region page of the configuration wizard appears.

Region

  1. Select the region that the instances reside in.

  2. Click Next.

    The Backup Gateway page of the configuration wizard appears.

Backup Gateway

Backup gateways run backups and other operations.

  • If AWS EBS encryption is enabled for your region in your AWS account, the user who uses the backup gateway template must be a key user for the default encryption key. To see if EBS encryption is enabled, in your AWS account, go to EC2 > EC2 Dashboard > Settings > EBS encryption. To see a list of key users for the default encryption key, in your AWS account, go to Key Management Service > Customer managed keys. If you do not have the correct level of access to use the template, you can copy the Launch Cloud Formation Stack link and share it with someone who has the correct level of access, such as your security administrator.

  • Determine the region of your AWS S3 storage. The backup gateway must reside in the same region as the primary storage.

  • Select an existing backup gateway or create a new backup gateway.

    Steps to create a backup gateway
    1. Click the add button add/plus button - gray - no border.

      The Add a new backup gateway dialog box appears.

    2. For Platform, select the OS for the backup gateway.

    3. Click Generate link.

      An AWS CloudFormation template is created based on the region and the operating system that you selected.

    4. Click the Launch CloudFormation Template link to open the AWS console.

      Note

      If AWS EBS encryption is enabled for your region in your AWS account, to use the template, you must be a key user for the default encryption key. If you are not a key user for the default encryption key, copy the Launch Cloud Formation Template link and share it with someone who is a key user, such as your security administrator.

    5. Log on to the AWS console.

      The Quick create stack page appears.

    6. Under Parameters, enter the following information:

      1. From the EC2 Instance Type list, select the type of EC2 instance to use for the backup gateway.

      2. From the EC2 Key Pair list, select a key pair to use to access the Commvault Cloud backup gateway.

      3. From the VPC ID list, select an Amazon Virtual Private Cloud (VPC).

      4. From the Subnet ID list, select a subnet.

      5. From the VPC CIDR list, select a VPC CIDR.

      Note

      Port 8403 opens on backup gateways only when the request comes from the IP ranges that are listed in the VPC CIDR field.

    7. Click Create stack.

      Wait for the Commvault Cloud backup gateway to be created.

    8. Return to the Commvault Cloud configuration wizard.

    9. Refresh the list of backup gateways, and then select the backup gateway that you created.

  • Click Next.

    The Cloud Storage page of the configuration wizard appears.

Cloud Storage

To review the supported combinations of primary and secondary storage, see Commvault Cloud Storage Options.

Primary Copy

  1. For the primary copy of the backup data, select an existing S3 storage bucket or create a new S3 storage bucket.

    Steps to create an Amazon S3 storage bucket
    1. Click the add button add/plus button - gray - no border.

      The Add cloud storage dialog box appears.

    2. In Name, enter a descriptive name for the cloud storage.

    3. In Access key ID, enter the access key ID.

    4. In Secret access key, enter the secret access key.

    5. In Bucket, enter the Amazon S3 bucket name.

    6. For Storage Class, select the storage class for the type of access that you want to have for the data.

    7. Click Save.

  2. Click Next.

Secondary Copy

  1. Decide whether to store a secondary copy of the backup data for long-term retention.

    Steps to create a secondary copy
    1. Move the Secondary copy toggle key to the right.

    2. For Storage location, select an existing storage location or create a new storage location.

      To create a storage location, do the following:

      1. Click the add button add/plus button - gray - no border.

        The Add cloud storage dialog box appears.

        From Type, select the storage provider, and then enter the necessary values:

        Storage provider

        Values

        Air Gap Protect

        • Cloud storage provider: Select Azure Blob Storage or OCI Object Storage.

        • Storage class: Select the storage class for the type of access that you want to have for the data.

        • Region: Select the region for the cloud storage.

        OCI Object Storage

        • Name: Enter a descriptive name for the cloud storage.

        • Credentials: Select existing credentials or create new credentials.

        • Region: Select the region for the cloud storage.

        • Bucket: Enter the name of the bucket.

        • Storage class: Select the storage class for the type of access that you want to have for the data.

        Amazon S3

        • Name: Enter a descriptive name for the cloud storage.

        • Region: Select the region for the cloud storage.

        • Authentication: Select the type of authentication to use.

          • Access keys and secret keys: Enter the access key ID and the secret access key.

          • STS assume role with IAM role: Enter the ARN of the CommvaultRole.

        • Bucket: Enter the name of the bucket.

        • Storage class: Select the storage class for the type of access that you want to have for the data.

      2. Click Save.

  2. Click Next.

    The Plan page of the configuration wizard appears.

Plan

A backup plan specifies the storage to back up the data to and other settings such as recovery point objective (RPO) settings.

  1. Select an existing backup plan or create a new backup plan.

    Steps to create a backup plan
    1. Click the add button add/plus button - gray - no border.

      The Add plan dialog box appears.

    2. In the Plan name box, enter a descriptive name for the backup plan.

    3. For the backup plan settings, select pre-defined settings or create custom settings:

      • To select pre-defined settings, under Retention rules, select one of the following:

        • Select Standard retention to retain the incremental backups for 1 month.

        • Select Extended retention for optimized storage where the incremental backups of primary and secondary copies are retained for 1 month, and extended retention for monthly and yearly full backups.

          Note

          The Extended retention option is available only when the secondary copy backup is selected.

      • To create custom settings, select Custom plan, and then specify the following:

        • For Snapshot retention, specify the number of snapshots to retain.

        • For Retention, specify the amount of time to retain the backup jobs.

        • For Retention monthly full (Secondary copy), specify the amount of time to retain the monthly full backup on secondary copy.

        • For Retention yearly full (Secondary copy), specify the amount of time to retain the yearly full backup on secondary copy.

        • For Backups run every, specify how often to run backups.

    4. Click Done.

  2. Click Next.

    The Hypervisor page of the configuration wizard appears.

Hypervisor

The hypervisor, which represents your AWS cloud account, is used to access the instances for discovery, backups, and other operations.

  1. Select an existing hypervisor or create a new hypervisor.

    Steps to create a hypervisor
    1. Select Add a new hypervisor.

    2. In Name, enter a descriptive name for the account.

    3. For Credential, select an existing access key and secret key credential or create a new credential.

  2. Click Next.

    The Add VM Group page of the configuration wizard appears.

Add VM Group

A VM group is a set of VMs that you want to back up with the same settings.

You can add content to the VM group by using rules that auto-discover content, by selecting specific instances, and by other ways. When you first create the VM group, you can add a cluster that is relatively small, and then later you can update the VM group by adding more content.

  1. In Name, enter a descriptive name for the VM group.

  2. To create rules that auto-discover and select instances to back up, do the following:

    1. Click Add, and then select Rules.

      The Add rule dialog box appears.

    2. From the list, select the type of rule to create, and then specify the rule:

      • Browse: Select specific instances. (Selecting this option changes the Add rule dialog box to the Add content dialog box.)

      • Guest DNS hostname: Select instances based on a hostname or a domain. For example, to select hosts on the "mycompany.com" domain, enter Guest DNS hostname | Ends with | mycompany.com.

      • Guest OS: Select instances based on operating system. For example, to select instances that are not Windows, enter Guest OS | Does not contain | Windows.

      • Instance name or pattern: Select instances based on their names. For example, to select instances that have a name that includes "east", enter Instance name or pattern | Contains | east.

      • Power state: Select instances based on a power status of Running or Stopped.

      • Region: Select instances based on the region that they reside in.

      • Tag name: Select instances based on the names of tags that are assigned to them. Enter the tag name in the region\tag_name format. For example, to select instances in the eastern US region that are for a department, enter Tag name | Equals | us-east-1\department.

      • Tag value: Select instances based on the values of tags that are assigned to them. Enter the tag value in the region\tag_name\tag_value format. For example, to select instances in the eastern US region for the human resources department, enter Tag value | Equals | us-east-1\department\HR.

      • Zone: Select instances based on the zone that they reside in. For example, to select instances that reside in any eastern US zone, enter Zone | Contains | us-east. You can enter the zone value by typing or browsing to select.

    3. Click Save.

  3. To select instances in other ways, do the following:

    1. Click Add, and then select Content.

      The Add content dialog box appears.

    2. From the Browse and select VMs list, select one of the following:

      • By region: Select instances based on the region that they reside in.

      • By zone: Select instances based on the zone that they reside in.

      • By tags: Select instances based on tags that are assigned to them.

      • By instance type: Select instances based on their type, such as t2.micro or c5.large.

    3. Select the instances to add to the VM group.

    4. Click Save.

  4. To see the instances that are selected for the VM group, click the Preview button.

  5. Click Next.

    The Summary page of the configuration wizard appears.

Summary

  1. Review the summary.

  2. Click Finish.

Loading...