Complete the Big Data Guided Setup for Couchbase


The big data guided setup guides you through creating a server plan and adding the Couchbase 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 of the page, click More.

  3. Click the Big data apps tile.

    The Big data app setup page appears.

    If you already completed the guided setup, the Apps page appears.

Create a Server Plan That You Can Use for Couchbase

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

Before You Begin

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, click Create a new plan, and then specify the settings for a server plan that you can use for Couchbase.



Plan name

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

  2. In Plan name, enter a name for the server 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 MRR cool storage class (Metallic Recovery Reserve) 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.


  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 or to add exceptions, move the Advanced toggle key to the right.

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

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

        These exceptions will repeat every month.

  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 Couchbase.

Snapshot options

  1. Under Snapshot options, do the following:

    1. Specify how to retain snapshots:

      • To specify a number of jobs to retain on a snapshot copy, select Number of snap recovery points, and then enter the number of jobs to retain.

      • To specify a retention period, select Retention period, and then enter the amount of time to retain the jobs.

    2. If you don't want to create backup copies, move the Enable backup copy toggle key to the left to turn it off.

    3. For Backup copy frequency, enter how often to run backup copy jobs.

Database options

These settings do not apply to Couchbase.

Override restrictions

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

  1. Click Save.

Add the Couchbase Cluster

When you add a cluster, an instance, an app, and a default subclient are automatically created. You can create additional subclients for content that has different backup requirements.

  1. On the Add a big data app page, from the Application type list, select Couchbase.

  2. In Cluster name, enter a name for the cluster.

  3. From the Access nodes list, select the server or servers that you want to be data access nodes for Couchbase.

  4. In Port number, type the port number used for Couchbase connection.

  5. In User name and password, enter the Couchbase user name and password to connect to the cluster.

    The Couchbase user should have Backup Full Admin role to perform backup and restore operations.

  6. Select the staging path type to use for backups:

    • Click File system to select a staging path on a local file system.

    • Click S3 to select a staging path on Amazon S3, and then complete the following:

      1. From the Authentication list, select Access and secret keys.

      2. Do one of the following:

      • Select the credentials to use.

      • To add credentials to the Credential Manager, do the following:

      1. Click the plus button (+).

        The Add Credential dialog box appears.

      2. Enter the following information:

      • Credential name: Enter a name for the credentials.

      • Access key ID: Enter the access key ID for the Amazon S3 account.

      • Secret access key: Enter the secret key for the Amazon S3 account.

      • Description: Enter a description of the credentials.

      1. Click Save.

      1. In the Service host box, enter the Amazon S3 endpoint in the format

  7. In Path, enter the full path to the staging location to use for backups.

    Note: The path must be a shared path among all nodes for both File system and S3 staging types.

  8. From Plan, select the server plan to use for the cluster.

  9. Click Save.