Configure backup storage

Store your backups in the cloud or on NFS

Before you can back up universes, you need to configure a storage location for your backups.

Depending on your environment, you can save your YugabyteDB universe data to a variety of storage solutions.

Local storage

If your YugabyteDB universe has one node, you can create a local directory on a T-Server to which to back up, as follows:

  1. Navigate to Universes, select your universe, and then select Nodes.

  2. Click Connect.

  3. Take note of the services and endpoints information displayed in the Connect dialog, as shown in the following illustration:

    Connect dialog

  4. While connected using ssh, create a directory /backup and then change the owner to yugabyte, as follows:

    sudo mkdir /backup; sudo chown yugabyte /backup

If there is more than one node, you should consider using a network file system mounted on each server.

Amazon S3

You can configure Amazon S3 as your backup target, as follows:

  1. Navigate to Configs > Backup > Amazon S3.

  2. Click Create S3 Backup to access the configuration form shown in the following illustration:

    S3 Backup

  3. Use the Configuration Name field to provide a meaningful name for your backup configuration.

  4. Enable IAM Role to use the YugabyteDB Anywhere instance's Identity Access Management (IAM) role for the S3 backup. See Required S3 IAM permissions.

  5. If IAM Role is disabled, enter values for the Access Key and Access Secret fields.

  6. Enter values for the S3 Bucket and S3 Bucket Host Base fields.

    For information on how to obtain AWS credentials, see Understanding and getting your AWS credentials.

  7. Click Save.

You can configure access control for the S3 bucket as follows:

  • Provide the required access control list (ACL), and then define List, Write permissions to access Objects, as well as Read, Write permissions for the bucket, as shown in the following illustration:

    S3

  • Create Bucket policy to enable access to the objects stored in the bucket.

Required S3 IAM permissions

The following S3 IAM permissions are required:

"s3:DeleteObject",
"s3:PutObject",
"s3:GetObject",
"s3:ListBucket",
"s3:GetBucketLocation"

Network File System

You can configure Network File System (NFS) as your backup target, as follows:

  1. Navigate to Configs > Backup > Network File System.

  2. Click Create NFS Backup to access the configuration form shown in the following illustration:

    NFS Configuration

  3. Use the Configuration Name field to provide a meaningful name for your backup configuration.

  4. Complete the NFS Storage Path field by entering /backup or another directory that provides read, write, and access permissions to the SSH user of the YugabyteDB Anywhere instance.

  5. Click Save.

Google Cloud Storage

You can configure Google Cloud Storage (GCS) as your backup target, as follows:

  1. Navigate to Configs > Backup > Google Cloud Storage.

  2. Click Create GCS Backup to access the configuration form shown in the following illustration:

    GCS Configuration

  3. Use the Configuration Name field to provide a meaningful name for your backup configuration.

  4. Complete the GCS Bucket and GCS Credentials fields.

    For information on how to obtain GCS credentials, see Cloud Storage authentication.

  5. Click Save.

You can configure access control for the GCS bucket as follows:

  • Provide the required access control list (ACL) and set it as either uniform or fine-grained (for object-level access).
  • Add permissions, such as roles and members.

Azure Storage

You can configure Azure as your backup target, as follows:

  1. Create a storage account in Azure, as follows:

    • Navigate to Portal > Storage Account and click Add (+).

    • Complete the mandatory fields, such as Resource group, Storage account name, and Location, as per the following illustration:

      Azure storage account creation

  2. Create a blob container, as follows:

    • Open the storage account (for example, storagetestazure, as shown in the following illustration).

    • Navigate to Blob service > Containers > + Container and then click Create.

      Azure blob container creation

  3. Obtain the container URL by navigating to Container > Properties, as shown in the following illustration:

    Azure container properties

  4. Generate an SAS Token, as follows:

    • Navigate to Storage account > Shared access signature, as shown in the following illustration. (NOTE: the SAS Token must be generated on the Storage Account, not the Container. Generating the SAS Token on the container will prevent the configuration from being applied.)

    • Under Allowed resource types, select Container and Object.

    • Click Generate SAS and connection string and copy the SAS token. Note that the token should start with ?sv=.

      Azure Shared Access Signature page

  5. On your YugabyteDB Anywhere instance, provide the container URL and SAS token for creating a backup, as follows:

    • Navigate to Configs > Backup > Azure Storage.

    • Click Create AZ Backup to access the configuration form shown in the following illustration:

      Azure Configuration

    • Use the Configuration Name field to provide a meaningful name for your backup configuration.

    • Enter values for the Container URL and SAS Token fields, and then click Save.