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
Skip this step if your environment already has a CSI driver installed with snapshot capability.
Trilio for Kubernetes requires a compatible Container Storage Interface (CSI) driver that provides the Snapshot feature.
You should check the Kubernetes CSI Developer Documentation to select a driver appropriate for your backend storage solution. See the selected CSI driver's documentation for details on the installation of the driver in your cluster.
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.
Please use one of the Target examples provided in the Custom Resource Definition section as a template for creating an NFS, Amazon S3, or any S3-compatible storage 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.
A retention policy is referenced in the backupPlan CR.
Note: With the above configuration, the policy would get created in the default namespace unless specified.
Step 4: Run Example
The following section will cover creating a sample application and backup/restore of it via labels, Helm, Operator, or a namespace-based backup.
More details about CRDs and their usage/explanation can be found in the Custom Resource Definition Section.
Note:
Backup and BackupPlan should be created in the same namespace.
For the restore operation, the resources will get restored in the namespace where restore CR is created.
If there is more than one backup created for the same application, users can select any existing backup information to perform the restore.
Step 4.1: Label Example
The following sections will create a sample application (tag it with labels), backup the application via labels, and then restore the application.
The following steps will be performed.
Create a sample MySQL application
Create a BackupPlan CR using a management console that specifies the MySQL application via labels
Create a Backup CR using the management console with a reference to the BackupPlan CR created above
Create a Restore CR using the management console with a reference to the Backup CR created above.
Create a Sample Application
Use the following screenshot to assist in the deployment of the MySQL application using the label.
Create a BackupPlan
Create a BackupPlan CR by selecting the application created in the previous step via UI labels in the same namespace where the application resides.
Create a Backup
Create a Backup CR using UI to protect the BackupPlan. Type
of the backup can be either full or incremental.
Note: The first backup into a target location will always be a Full backup.
Restore the Backup/Application
Finally create the Restore CR using UI to restore the Backup, in the same or different namespace using the Backup. In the example provided below, MySQL-label-backup is being restored into the "restore" namespace.
Restore to the same cluster but a different namespace
Note: If restoring into the same namespace, ensure that the original application components have been removed. If restoring into another namespace in the same cluster, ensure that the resources which cannot be shared like ports should be freed or transformation should be used to avoid conflict. More information about transformation can be found at Restore Transformation.
Restoring to a different cluster
Note: If restoring to another cluster (migration scenario), ensure that Trilio for Kubernetes is running in the remote namespace/cluster as well. 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.
Step 4.2: Helm Example
The following sections will create a sample application via Helm, backup the application via Helm selector fields and then restore the application using management UI.
The following steps will be performed.
Create a cockroachdb instance using Helm
Create a BackupPlan CR using a management console that specifies the cockroachdb application to protect.
Create a Backup CR using the management console with a reference to the BackupPlan CR create above
Create a Restore CR using the management console with a reference to the Backup CR created above.
Create a sample application via Helm
Use the following screenshot to assist in the deployment of the "Cockroachdb" application using the helm chart.
Create a BackupPlan
Use the following to create a BackupPlan. Ensure the name of the release you specify matches the output from the helm ls command in the previous step.
Create a Backup
Use the following screenshot to create a backup CR
Restore Backup/Application
After the backup has been completed successfully, create a Restore CR to restore the application in the same or different namespace where BackupPlan and Backup CRs are created.
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
Note: If restoring into another namespace in the same cluster, ensure that the resources which cannot be shared like ports should be freed or transformation should be used to avoid conflict. More information about transformation can be found at Restore Transformation.
Before restoring the app, we need to clean the existing app from the same cluster. This is required cluster-level resources of the app can create conflict during the restore operation.
Restore to the different cluster
Note: If restoring to another cluster (migration scenario), ensure that Trilio for Kubernetes is running in the remote namespace/cluster as well. 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.
After following the above note then follow the instructions same as Restore the backup/application by label section to choose the namespace backup stored at the target repository and perform the helm backup restore.
Step 4.3: Operator Example
The following steps will be performed.
Install a sample etcd Operator
Create an etcd cluster
Create a BackupPlan CR using the management console that specifies the etcd application to protect.
Create a Backup CR using the management console with a reference to the BackupPlan CR created above
Create a Restore CR using the management console with a reference to the Backup CR created above.
We are demonstrating standard 'etcd-operator' here. First, we need to deploy the operator using its helm chart. Then we need to deploy the etcd cluster. Follow Install etcd-operator and Create an etcd cluster using the following yaml definition section to install and create an etcd cluster.
Create a BackupPlan
Create a 'BackupPlan' resource to protect 'etcd-operator' and it's clusters. Use the management console to select the etcd-operator auto-discovered by T4K and shown under the Operator section.
Create a Backup
Take a backup of the above 'BackupPlan'. Use the following screenshot to proceed and create a 'Backup' resource.
Restore the Backup/Application
After the backup completes successfully, you can perform the Restore of it.
To restore the etcd-operator and its clusters from the above backup, use the screenshots shown below.
Note: If restoring into the same namespace, ensure that the original application components have been removed.
Restore to the same cluster but the different namespace
Note: If restoring into another namespace in the same cluster, ensure that the resources which cannot be shared, for example, ports - should be available or transformation should be used to avoid conflict. More information about transformation can be found at Restore Transformation.
Before restoring the app, we need to clean the existing app from the same cluster. This is required cluster-level resources of the app can create conflict during the restore operation.
Step 4.4: Virtual Machine Example
The following sections will describe the steps to create a sample Virtual Machine, backup the Virtual Machine like any other Helm and Operator application, and then restore the Virtual Machine using the management UI.
The following steps will be performed.
Create a Virtual Machine using OpenShift Virtualization Operator.
Users can follow the Red Hat demo here to learn how to deploy a VM.\
Create a BackupPlan CR using a management console that specifies the
centos9
Virtual Machines to protect.Create a Backup CR using the management console referencing the BackupPlan CR created in step 1.
Create a Restore CR using the management console again referencing the Backup CR created in step 1.
Create a Backupplan
Use the following screenshot to assist in the creation of a BackupPlan for the Virtual Machine, ensuring that the name of the Virtual Machine you specify matches the VM created in the previous step.
Create a Backup
Create a backup CR as shown in the following screenshots.
Restore Backup/Virtual Machine
Restore to the same cluster
After the backup has been completed successfully, create a Restore CR to restore the Virtual Machine in the same or different namespace where BackupPlan and Backup CRs are created.
Restore to the different cluster
Note: If restoring to another cluster (migration scenario), ensure that Trilio for Kubernetes is running in the remote namespace/cluster as well. To restore into a new cluster (where the Backup CR does not exist), the same backup target should be created and Target Browsing should be enabled to browse the stored backups.
After following the above note then follow the instructions same as Restore the backup/application by label section to choose the namespace backup stored at the target repository and perform the helm backup restore.
Validate the Restored Virtual Machine
Once the restore is complete, you can log in to the OpenShift Container Platform and go to the restore namespace and check that the Virtual Machine is restored correctly and is in the Running
state.
Step 4.5: Namespace Example
Create a namespace called 'wordpress'
Use Helm to deploy a wordpress application into the namespace.
Perform a backup of the namespace using the management console
Delete the namespace/application from the kubernetes cluster
Create a new namespace 'wordpress-restore'
Perform a Restore of the namespace using the management console
Create a namespace and application
Follow the Create a namespace and application section to create an application.
Create a BackupPlan
Create a backupPlan to backup the namespace using the management console
Backup the Namespace
Use the following screenshot to build the Backup CR using the management console
Restore the Backup/Namespace
Perform a restore of the namespace backup using the management console
Restore to the same cluster but the different namespace
Note: If restoring into the same namespace, ensure that the original application components have been removed. If restoring into another namespace in the same cluster, ensure that the resources which cannot be shared like ports should be freed or transformation should be used to avoid conflict. More information about transformation can be found at Restore Transformation.
Validate Restore
Validate Application Pods
Restore to the different cluster
If you are trying to restore into a different cluster then follow the guidelines same asRestoring to a different cluster section to choose the namespace backup stored at the target repository and perform the namespace restore.
Last updated