Management Console
Learn about using with Trilio for Kubernetes with the Management Console
To get started with Trilio via the management console in your environment, the following steps must be performed:
Prerequisites
Authenticate access to the Management Console (UI). Refer toUI Authentication.
Configure access to the Management Console (UI). Refer toConfiguring the UI.
Steps Overview
Install a compatible CSI Driver
Create a Backup Target - A location where backups will be stored.
Create a retention policy (Optional) - To specify how long to keep the backups for.
Run Example:
Label Example
Helm Example
Operator Example
Virtual Machine Example
Namespace Example
Step 1: Install a CSI Driver
Trilio for Kubernetes requires a compatible Container Storage Interface (CSI) driver that provides the Snapshot feature.
Step 2: Create a Target
Create a secret containing the credentials for data stores to store backups. An example is provided below:
You can either create the secret using the above YAML definition or use the management console to create it as part of the workflow for creating the backup target.
Supported values for S3 vendors include:
An Amazon S3 target example is provided below:
Note: With the above configuration, the target would get created in the current user namespace unless specified. Also, additional information on Bucket permissions can be found here: AWS S3 Target Permissions
Step 3: Create a Retention Policy (Optional)
While the example backup custom resources created by following this Getting Started page can be deleted manually via kubectl
commands, Trilio also provides backup retention capability - to automatically delete the backups based on defined time boundaries.
Note: With the above configuration, the policy would get created in the default namespace unless specified.
Step 4: Create a BackupPlan
This section focuses on creating a BackupPlan
to define and manage application backups. A BackupPlan
specifies which resources to back up, such as specific applications or namespaces, and can be configured using labels, Helm, Operators, or namespaces.
Step 4.1: Label Example
This section demonstrates creating a BackupPlan
to back up a sample application using label-based selection.
The following steps will be performed.
1. Deploy a sample application
2. Create a Label-Based BackupPlan
Create a BackupPlan
CR through the management console, specifying the MySQL application by selecting its labels from the UI in the same namespace where the application is deployed.
Step 4.2: Helm Example
This section outlines the steps to create a BackupPlan
for a sample application deployed via Helm.
The following steps will be performed.
1. Deploy a Sample Application Using Helm
2. Create a Helm-Based BackupPlan
Create a BackupPlan
Custom Resource (CR) through the management console, specifying the Helm release of the CockroachDB
application in the BackupPlan
Helm section.
Ensure the name of the release you specify matches the output from the helm ls
command in the previous step.
Step 4.3: Operator Example
This section provides steps for creating a BackupPlan
for a sample ETCD operator application.
Steps to perform:
2. Create a Operator-Based BackupPlan.
Create a BackupPlan
resource to back up the etcd-operator
and its clusters. Use the management console to select the etcd-operator
, which is automatically discovered by T4K and listed under the Operator section.
Step 4.4: Virtual Machine Example
This section outlines the process of creating a BackupPlan
for a sample Virtual Machine.
Steps to perform:
1. Deploy a Sample VirtualMachine
2. Create a BackupPlan For VirtualMachine
Create a BackupPlan
Custom Resource (CR) through the management console, specifying the Virtual Machine for backup. Ensure that the name of the Virtual Machine specified matches the VM created in the previous step.
Step 4.5: Namespace Example
This section outlines the process of creating a BackupPlan
for a k8s namespace.
1. Create a namespace and application
Create a namespace named
wordpress
.Use Helm to deploy a
WordPress
application into thewordpress
namespace.
2. Create a BackupPlan for a Namespace
Create a BackupPlan
Custom Resource (CR) through the management console, specifying the wordpress
namespace for backup.
Step 5: Create Backup or Snapshot
Create a Backup or Snapshot CR through the UI to protect the BackupPlan. The backup can be of type Full or Incremental, while snapshots are always created as Full snapshots.
Note: The first backup into a target location will always be a Full backup.
Steps to perform
Select the
backupPlan
either from the "Backup Plans" tab from the UI and select the "Create Backup" or "Create Snapshot" option from the dropdown.Or by choosing the application from the "Applications" section, the namespace from the "Namespaces" section, or the VM from the "Virtual Machines" section. And by clicking the "Create Backup" or "Create Snapshot" option in the UI. The available
BackupPlans
for the selected application will be displayed. Select the desiredBackupPlan
and proceed with creating the backup or snapshot.
Refer to this example for backing up a Helm application.
The backup details can be viewed by selecting the "View Details" option from the dropdown in the backup details section.
Refer to this example for taking a snapshot of a Virtual Machine.
Step 7: Restore the Application Using a Backup or Snapshot
Finally, create the Restore CR using the UI to restore the backup or snapshot, either in the same or a different namespace.
Restore to the same cluster in a same namespace
Note: If restoring into the same namespace, ensure that the original application components have been removed. Especially the PVC of the application is deleted.
Restore to the same cluster but a different namespace
Before restoring the app in the same cluster, the existing app must be removed if it has cluster-scoped resources. This is necessary to prevent conflicts with cluster-level resources that could interfere with the restore operation.
Restore from Backup
Steps to perform
Select the backup by choosing "View Backup and Restore Summary" from the dropdown in the application selection.
Then, choose the "Restore" option to restore the backup.
See this example for restoring an operator backup.
Refer to this example for a completed restore status.
Restore from Snapshot
Steps to perform
Select the snapshot by choosing "View Backup and Restore Summary" from the dropdown in the application selection.
Then, choose the "Restore" option to restore the snapshot.
See this example for restoring an namespace snapshot.
Step 8: Restore the Application to a Different Cluster
Trilio enables application backups to be restored into a different cluster. This section focuses on the process of restoring a backup to a different cluster.
Note: If restoring to another cluster (migration scenario), ensure that Trilio for Kubernetes is also running in the remote namespace/cluster. To restore into a new cluster (where the Backup CR does not exist), the same target should be created and Target Browsing should be enabled to browse the stored backups.
Steps to perform
Enable Target Browsing for the target.
Use the "Launch Browser" option.
Search for the backup using the BackupPlan name.
Select the backup.
Click on "Restore."
Provide a restore name.
Specify the restore namespace.
Last updated
Was this helpful?