> Essential > Big Data > YugabyteDB > Getting Started

Complete the Big Data Guided Setup for YugabyteDB

The big data guided setup guides you through creating a server plan and configuring the YugabyteDB cluster.

Go to the Big Data Guided Setup

  1. From the navigation pane, go to Guided setup.

    The Welcome page appears.

  2. On the Protect tab, at the bottom right of the page, click More.

  3. In the Big data apps tile, when you click the ellipsis (...) icon, the following options are displayed:

    • Configure: Select this to go to the Big Data App setup page.

    • Go to App: Select this to go to the Big data app page if you have already completed the guided setup.

Create a Server Plan That You Can Use for YugabyteDB

If you already have a server plan that you can use, you can skip this step.

To create a server plan, you must have the Plan Creator Role assigned to your user account.

  1. On the Create server backup plan page and specify the settings for a server plan that you can use for YugabyteDB.

Settings

Steps

Plan name

  1. Fill in the following plan information:

    1. Choose whether to create a new plan or use a base plan.

    2. If you selected Create a new plan, in the Plan name, enter a name for the server plan.

    3. If you selected Use existing base plan, specify the plan name and select a base plan.

Backup destinations

  1. Click Add copy.

    The Add copy dialog box appears.

  2. In Name, enter a name for the backup destination.

  3. From the Storage list, select the storage to use for the backups.

    You can use the Air Gap Protect cool storage class for creating secondary copies, but not for creating primary copies.

  4. To specify the start time for backups on a specific date and later, move the Backups On and After toggle key to the right.

  5. For Retention rules, enter the amount of time to retain the backups.

  6. To specify additional backups, such as weekly full backups, move the Extended retention rules toggle key to the right, and then add rules.

  7. Click Save.

  8. To add additional regions to the backup destination, move the Multi-region toggle key to the right, and then select the regions.

    You can also add more regions and associate the storage copy to the region.

RPO

  1. For Backup frequency, click Add.

    The Add backup frequency dialog box appears.

    1. From the Backup type list, select the backup type, and from the for list, select All agents or Databases.

    2. Specify the frequency of the backup.

    3. To specify the client time zone, full backup database frequency, or to add exceptions, move the Advanced toggle key to the right, and do the following:

      • From the time zone list, select the time zone according to which the backups must run.

      • If you select incremental or differential backup type for all agents or databases, to modify the full backup frequency of the database, specify a value for Run full backup on databases every option.

      • To add exceptions when the backups must not run, click Exceptions, and then add exceptions for any day of a month or week or schedule an exception for any week of the month.

        Exceptions repeat every week or month according to the selected exception.

  2. For Backup window (if incremental and differential backups are supported for the workload), specify when you want incremental and differential backups to run.

  3. For Full backup window, specify when you want full backups to run.

Folders to back up

These settings do not apply to YugabyteDB.

Database options

These settings do not apply to YugabyteDB.

Override restrictions
  • Leave the Allow plan to be overridden check box cleared.

2. Click Save.

Add a YugabyteDB Cluster

When you add a cluster, a default namespace group (subclient) is automatically created. You can create more namespace groups for data that has different backup requirements.

Before You Begin

  • To configure a YugabyteDB instance, make the following entries while adding a YugabyteDB cluster:

    • Host: Load balancer full name, a public IP address, or a YugabyteDB Anywhere (YBA) host.

    • API token: API token of the user with the following privileges:

      • Admin

      • SuperAdmin

      • BackupAdmin

      You can find the API token by logging on to the YugabyteDB Anywhere console.

    • Storage configuration : The YugabyteDB storage configuration which will be used for backups and restores.

  • Network configuration requirement for YugabyteDB deployed on AWS EC2 or Azure Blob Storage:

    If the access node is outside of the YugabyteDB virtual private cloud (VPC), then complete the following steps:

    • Create a peering connection between the access node VPC and the YugabyteDB VPC.

    • For YugabyteDB VPC security group, the port 443 must be open.

    • Both access node and the YugabyteDB Anywhere host must be able to access the S3 bucket or Azure Blob Storage.

  • The following keys and tokens for authentication:

    • Amazon S3: IAM or access key and secret key

    • Azure Blob Storage: SAS token

Procedure

  1. From the navigation pane, go to Protect > Big data.

    The Big data page appears.

  2. Click Add cluster.

    The Configure Big Data App appears.

  3. Select YugabyteDB, and then Click Next.

    The Configure YugabyteDB Cluster page opens.

  4. Select existing access nodes from Access node list or add a new access node, and then click Next.

  5. Select a plan from the list of plan, and then click Next.

    The Add YugabyteDB Universe page appears.

  6. In the Name box, enter a name for the YugabyteDB cluster in the CommCell environment.

  7. In Host box, enter the IP address or hostname of the YugabyteDB host.

    If High Availability is configured for YBA, then enter the IP address or hostname of the active instance, or the load balancer name, if configured.

  8. In API token box, enter the API token of the YugabyteDB console user, and then click Next.

    The Storage Configuration page appears.

  9. From the Universe name list, select a universe name to back up.

  10. From the Storage configuration list, select an existing storage configuration or create a new storage configuration.

    To create a storage location, do the following:

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

      The Add storage configuration dialog box appears.

    2. From the Storage type list, select Amazon S3, or Microsoft Azure Storage.

      Note

      Only Amazon S3 and Microsoft Azure storage are supported.

      • If you select Amazon S3, do the following:

        1. In the Configuration name box, enter a name for the cloud storage.

        2. From the Authentication list, select the type of the authentication to use.

          • If you select Access and secret keys, do the following:

            1. From the Credentials list, select existing credentials or create new credentials

            2. To create credentials, click the add button add/plus button - gray - no border.

              The Add credential dialog box appears.

            3. Enter values for the authentication method that you are using:

              • Credential name: Enter a name for the credentials that you are creating.

              • Access key ID: Enter the access key ID.

              • Secret access key: Enter the secret key.

              • Description: Enter a description for the credentials.

          • If you select IAM role, do the following:

            1. Create an IAM role on the EC2 console with following minimal permissions, and assign it to the YBA host and Commvault access nodes.

               
              {
   "Version": "2012-10-17",
   "Statement": [
      {
            "Sid": "Statement1",
            "Effect": "Allow",
            "Action": [
               "s3:DeleteObject",
               "s3:PutObject",
               "s3:GetObject",
               "s3:ListBucket",
               "s3:ListBucketVersions",
               "s3:GetBucketLocation",
               "s3:ListAllMyBuckets",
               "s3:GetObjectAcl"
            ],
            "Resource": "*"
      }
   ]
}

        3. In the Bucket box, enter the Amazon S3 bucket name.

        4. Click Save.

      • If you selected Microsoft Azure Storage, do the following:

        1. In Configuration name, enter a descriptive name for the cloud storage.

        2. For Credentials, select existing credentials or create new credentials.

          To create credentials, do the following:

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

            The Add credential dialog box appears.

          2. In Credential name, enter a descriptive name for the credentials.

          3. In Account name, enter the name of the storage account to use.

          4. In Access key ID, enter the SAS token of the storage account.

          5. In Description, enter a description of the credentials.

          6. Click Save.

        3. In the Staging path box, enter the staging path for backups.

        4. Click Save.

    3. Click Next.

      The Backup content page appears.

  11. Select the namespaces to back up, and then click Save.

  12. Click Next.

    The Summary page appears.

  13. Click Finish.

Loading...