Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Backup Targets

This document explains the concepts of Backup Targets and Backup Target Types in Trilio, their purpose, and how they provide additional flexibility and control for backup storage management.

1. Backup Targets (BTs)

Definition:

Backup Targets are storage backends where backups are stored. These can be any of the supported storage systems such as NFS (Network File System) or S3 (Simple Storage Service). Backup Targets act as the foundational layer for storing backup data.

Key Characteristics of Backup Targets:

  • They are storage systems connected to Trilio.

  • Supported storage types include:

    • NFS: A shared file system accessible over a network.

    • S3: An object storage service typically offered by cloud providers.

  • Multiple Backup Targets can be defined within a single environment to provide storage flexibility.

How to configure Backup Target(s):

The Admin user will have to plan and make the desired Backup Targets available before deploying Trilio. Backup Targets need to be configured during the deployment of Trilio that will get mounted on the required hosts.

The below-mentioned entries need to be defined in the configuration file of the workloadmgrservices to enable the required Backup Targets, however, these parameters need not be populated manually. The deployment scripts will take care of it.

  • Define all the enabled backup target names separated by a comma under the DEFAULTsection of the config file and the config parameter enabled_backends

    • Example:

[DEFAULT]
.
.
enabled_backends = NFS_BT1, S3_BT1, S3_BT2, S3_BT3
.
.

where, NFS_BT1, S3_BT1, S3_BT2, and S3_BT3 are unique names of the Backup Targets and will have their own config sections with the same names in the configuration file, as mentioned below.

  • Define each of the Backup Target sections using all required parameters. These required parameters are based on the type of storage.

    • For NFS storage:

      • vault_storage_type = nfs

      • vault_storage_filesystem_export = <NFS_SHARE>

      • vault_storage_nfs_options = nolock,soft,timeo=600,intr,lookupcache=none,retrans=10

    • For S3 storage:

      • vault_storage_type = s3

      • vault_s3_endpoint_url = <S3_ENDPOINT_URL>

        • In the case of AWS S3, this parameter should be kept blank.

      • vault_s3_bucket = <S3_BUCKET_NAME>

      • vault_storage_filesystem_export = <S3_ENDPOINT_HOSTNAME>/<S3_BUCKET_NAME>

        • In the case of AWS S3, only the bucket name should be provided.

      • immutable = 1

        • If the Object-Lockis enabled on the S3 Bucket, else this parameter can be set to 0

    • Apart from the above-mentioned storage-specific parameters, the user must mention which among these Backup Targets should be the default one by defining the below parameter under that storage section:

      • is_default = 1

    • Example:

List & Show Configured BTs

Using Horizon Dashboard

  1. Log in to the OpenStack Horizon Dashboard as an Admin user.

  2. Navigate to the Admin-> Backups-Admin -> Backup Targets

  3. On the page, click the Backup Targets tab to see the list of Backup Target Types.

Using CLI

Create Backup Target:

  • Command:

  • Alias:

  • Options:

  • Example:

Delete Backup Target:

  • Command:

  • Alias:

  • Options:

  • Example:

List the available Backup Targets:

  • Command:

  • Alias:

  • Options:

  • Example:

Show Details of a Backup Target:

  • Command:

  • Alias:

  • Options:

  • Example:

Backup Target Set Default:

  • Command:

  • Alias:

  • Options:

  • Example:

2. Backup Target Types (BTTs)

Definition:

Backup Target Types are an abstraction layer over Backup Targets. They provide additional administrative controls and can be categorized based on their scope and access permissions.

Types of Backup Target Types:

  1. Public:

    • Accessible by all users and projects in the system.

    • Suitable for shared storage scenarios where multiple teams or tenants use the same backup infrastructure.

  2. Private:

    • Restricted to specific projects.

    • Private Backup Target Types can be assigned to one or multiple projects, allowing project-specific control over backup storage.

Relationship Between Backup Targets and Backup Target Types:

  • A many-to-one relationship exists between Backup Target Types and Backup Targets.

    • Multiple Backup Target Types can map to a single Backup Target.

    • This allows administrators to define different policies or access levels for a shared storage backend.

Pre-created Backup Target Types

  • Trilio creates the BTTs of all the Backup Targets that are configured during deployment with the same name as the Backup Targets.

  • It inherits the provided configuration options for each Backup Target and creates the Public Backup Target Types by default.

List Available BTTs

Using Horizon Dashboard

  1. Log in to the OpenStack Horizon Dashboard as an Admin user.

  2. Navigate to the Admin-> Backups-Admin -> Backup Targets

  3. On the page, click the Backup Target Types tab to see the list of Backup Target Types.

Using CLI

  • Command:

  • Alias:

  • Options:

  • Example:

Show Details of a BTT

Using Horizon Dashboard

  • Most of the relevant information about the BTT can be seen while Listing the BTTs.

  • Trilio does not provide a separate GUI for showing the additional details of the BTTs.

  • But, Trilio does provide a CLI command to get the additional details.

Using CLI

  • Command:

  • Alias:

  • Options:

  • Example:

Create a BTT

Using Horizon Dashboard

  1. Log in to the OpenStack Horizon Dashboard as an Admin user.

  2. Navigate to the Admin-> Backups-Admin -> Backup Targets

  3. On the page, click the Backup Target Types tab to see the list of Backup Target Types.

  4. Click on the button to open the Backup Target Type Create wizard, and follow the instructions to create the BTT.

Using CLI

  • Command:

  • Alias:

  • Options:

  • Example:

Modify a BTT

Modification of the Default Backup Target Type is not allowed.

Using Horizon Dashboard

  1. Log in to the OpenStack Horizon Dashboard as an Admin user.

  2. Navigate to the Admin-> Backups-Admin -> Backup Targets

  3. On the page, click the Backup Target Types tab to see the list of Backup Target Types.

  4. Click on the button under the Actions column of the BTT List table of the desired BTT to open the Edit Backup Target Type wizard.

  5. Once the required changes are done, click on the Edit button on the wizard to save the changes.

Using CLI

  • Command:

  • Alias:

  • Options:

  • Example:

Assign/Unassign Project(s) to/from a BTT

Project assignment is allowed only to the Private Backup Target Types.

Using Horizon Dashboard

  • Log in to the OpenStack Horizon Dashboard as an Admin user.

  • Navigate to the Admin-> Backups-Admin -> Backup Targets

  • On the page, click the Backup Target Types tab to see the list of Backup Target Types.

  • Click the dropdown button under the Actions column of the BTT List table of the desired Private BTT and click on the button to open the Edit Backup Target Type Access wizard.

  • Select the Projects to be assigned, unselect the projects to be unassigned, and click on the Save button on the wizard to save the changes.

Using CLI

Assigning Projects:

  • Command:

  • Alias:

Options:

Example:

Unassigning Projects:

  • Command:

  • Alias:

Options:

Example:

Add/Remove BTT Metadata

Using Horizon Dashboard

Metadata updates are only possible through CLI

Using CLI

Adding Metadata:

  • Command:

  • Alias:

Options:

  • Example:

Removing Metadata:

  • Command:

  • Alias:

  • Options:

Example:

Delete a BTT

Removing Backup Target Types from an active Workload can lead to inconsistent behavior and potential backup operation failures.

Using Horizon Dashboard

  • Log in to the OpenStack Horizon Dashboard as an Admin user.

  • Navigate to the Admin-> Backups-Admin -> Backup Targets

  • On the page, click the Backup Target Types tab to see the list of Backup Target Types.

  • Click the dropdown button under the Actions column of the BTT List table of the desired Private BTT, click on the button, and confirm the deletion once prompted.

  • Deletion of multiple BTTs can be done by selecting the check boxes of the desired BTTs and then clicking the button at the top-right corner.

Using CLI

  • Command:

  • Alias:

  • Options:

  • Example:

3. User Interaction with Backup Target Types

How Users Choose Backup Storage:

  • Any user can select a Public Backup Target Type for storing backups, as these are universally accessible.

  • For Private Backup Target Types, users can only select them if the Backup Target Type is explicitly assigned to their project.

  • The user will have the option to select these Backup Target Types while creating a workload.

  • Please note that once the workload is created with the chosen Backup Target Type, it can not be modified. The user has to recreate the workload if the Backup Target Type needs to be changed.

PreviousBackups-Admin AreaNextAdd a new dynamic backup target on RHOSO

Last updated

Was this helpful?