LogoLogo
5.0.X
5.0.X
  • About Trilio for Kubernetes
    • Welcome to Trilio For Kubernetes
    • Version 5.0.X Release Highlights
    • Compatibility Matrix
    • Marketplace Support
    • Features
    • Use Cases
  • Getting Started
    • Getting Started with Trilio on Red Hat OpenShift (OCP)
    • Getting Started with Trilio for Upstream Kubernetes (K8S)
    • Getting Started with Trilio for AWS Elastic Kubernetes Service (EKS)
    • Getting Started with Trilio on Google Kubernetes Engine (GKE)
    • Getting Started with Trilio on VMware Tanzu Kubernetes Grid (TKG)
    • More Trilio Supported Kubernetes Distributions
      • General Installation Prerequisites
      • Rancher Deployments
      • Azure Cloud AKS
      • Digital Ocean Cloud
      • Mirantis Kubernetes Engine
      • IBM Cloud
    • Licensing
    • Using Trilio
      • Overview
      • Post-Install Configuration
      • Management Console
        • About the UI
        • Navigating the UI
          • UI Login
          • Cluster Management (Home)
          • Backup & Recovery
            • Namespaces
              • Namespaces - Actions
              • Namespaces - Bulk Actions
            • Applications
              • Applications - Actions
              • Applications - Bulk Actions
            • Virtual Machines
              • Virtual Machine -Actions
              • Virtual Machine - Bulk Actions
            • Backup Plans
              • Create Backup Plans
              • Backup Plans - Actions
            • Targets
              • Create New Target
              • Targets - Actions
            • Hooks
              • Create Hook
              • Hooks - Actions
            • Policies
              • Create Policies
              • Policies - Actions
          • Monitoring
          • Guided Tours
        • UI How-to Guides
          • Multi-Cluster Management
          • Creating Backups
            • Pause Schedule Backups and Snapshots
            • Cancel InProgress Backups
            • Cleanup Failed Backups
          • Restoring Backups & Snapshots
            • Cross-Cluster Restores
            • Namespace & application scoped
            • Cluster scoped
          • Disaster Recovery Plan
          • Continuous Restore
      • Command-Line Interface
        • YAML Examples
        • Trilio Helm Operator Values
    • Upgrade
    • Air-Gapped Installations
    • Uninstall
  • Reference Guides
    • T4K Pod/Job Capabilities
      • Resource Quotas
    • Trilio Operator API Specifications
    • Custom Resource Definition - Application
  • Advanced Configuration
    • AWS S3 Target Permissions
    • Management Console
      • KubeConfig Authenticaton
      • Authentication Methods Via Dex
      • UI Authentication
      • RBAC Authentication
      • Configuring the UI
    • Resource Request Requirements
      • Fine Tuning Resource Requests and Limits
    • Observability
      • Observability of Trilio with Prometheus and Grafana
      • Exported Prometheus Metrics
      • Observability of Trilio with Openshift Monitoring
      • T4K Integration with Observability Stack
    • Modifying Default T4K Configuration
  • T4K Concepts
    • Supported Application Types
    • Support for Helm Releases
    • Support for OpenShift Operators
    • T4K Components
    • Backup and Restore Details
      • Immutable Backups
      • Application Centric Backups
    • Retention Process
      • Retention Use Case
    • Continuous Restore
      • Architecture and Concepts
  • Performance
    • S3 as Backup Target
      • T4K S3 Fuse Plugin performance
    • Measuring Backup Performance
  • Ecosystem
    • T4K Integration with Slack using BotKube
    • Monitoring T4K Logs using ELK Stack
    • Rancher Navigation Links for Trilio Management Console
    • Optimize T4K Backups with StormForge
    • T4K GitHub Runner
    • AWS RDS snapshots using T4K hooks
    • Deploying Trilio For Kubernetes with Openshift ACM Policies
  • Krew Plugins
    • T4K QuickStart Plugin
    • Trilio for Kubernetes Preflight Checks Plugin
    • T4K Log Collector Plugin
    • T4K Cleanup Plugin
  • Support
    • Troubleshooting Guide
    • Known Issues and Workarounds
    • Contacting Support
  • Appendix
    • Ignored Resources
    • OpenSource Software Disclosure
    • CSI Drivers
      • Installing VolumeSnapshot CRDs
      • Install AWS EBS CSI Driver
    • T4K Product Quickview
    • OpenShift OperatorHub Custom CatalogSource
      • Custom CatalogSource in a restricted environment
    • Configure OVH Object Storage as a Target
    • Connect T4K UI hosted with HTTPS to another cluster hosted with HTTP or vice versa
    • Fetch DigitalOcean Kubernetes Cluster kubeconfig for T4K UI Authentication
    • Force Update T4K Operator in Rancher Marketplace
    • Backup and Restore Virtual Machines running on OpenShift
    • T4K For Volumes with Generic Storage
    • T4K Best Practices
Powered by GitBook
On this page
  • Basic Tab
  • Resource Selector
  • Transforms
  • Hooks Configuration

Was this helpful?

  1. Getting Started
  2. Using Trilio
  3. Management Console
  4. UI How-to Guides
  5. Restoring Backups & Snapshots

Namespace & application scoped

PreviousCross-Cluster RestoresNextCluster scoped

Last updated 5 months ago

Was this helpful?

Regardless of from where the Restore operation is initiated, the workflow for the operation is the same, ensuring consistency and simplicity.

For the restore workflow, there are four tabs presented to the user Basic Tab Resource Selector Transforms Hooks Configuration

Basic Tab

This tab cover general restore properties for the backups and snapshots such as name, namespace, secrets (if encrypted) and Restore flags

Name - Enter the meaningful name of Restore in this field.

Namespace - Select the Namespace in which user wants to take Restore of a Backup or a Snapshot. You can create a new Namespace from dropdown option "+ New Namespace"

Encryption Secret - Select the same secret which is selected in Backup plan from which Backup or Snapshot is created. You can create a new Secret from dropdown option "+ New Encryption Secret"

Restore Flags - As part of every restore, users can select different restore flags to define how the restore should happen.

The following flags are provided:

  1. SkipIfAlreadyExists - Specifies whether to skip restoring resources if they are already found in the namespace in which the backup is being restored. This is only applicable for metadata resources and not data resources (PV/PVC).

  2. PatchIfAlreadyExists - Specifies whether to patch the spec section of an already existing resource found in the namespace at the time of restore.

  3. OmitMetadata - Specifies whether to omit metadata labels, annotations of resources while restoring them.

  4. PatchCRD - Specifies whether to patch spec of an already existing CRD

  5. SkipOperatorResources - Specifies whether to omit operator resources at the time of restore (for the use case when an Operator is already present, but the application of that operator needs to be restored)

  6. CleanupOnFailure - Specifies whether to perform cleanup of resources created along with reverting updated resources in case the restore operation fails.

  7. ProtectRestoredApp - Specifies whether to create a backupplan at the destination namespace/cluster to protect the application after it has been restored. With this flag, users can ensure that their application is protected no matter which cluster it runs on.

  8. DisableIgnoreResources - Specifies the behaviour of the default list of resources being ignored at the time of restore. If set to true, those resources will not be ignored.

  9. OnlyData - Restores only the data volume components from a backup.

  10. UseOCPNamespaceUIDRange - Openshift specific flag to restore the data with the ocp namespace UID range.

  11. RestoreStorageClass - This flag specifies whether the storage class should be restored on site instance or not..

  12. ResourcesReadyWaitSeconds - This holds the wait time in seconds for which, TVK application will wait for user application's resources to come up in the restore process.

  13. ImageRestore - Restores the container images from the backup.

Next button - Click on Next if user wants to setup advance configuration in Restore.

Create button - Click on this button to directly create Restore without any advance configuration like Resource selector, transformation and hooks.

Resource Selector

Exclude resources - Restore will done without selected resources in this field. This Restore all other resources available in Backup or Snapshot. This also have Label set selector and Resources selector same as Include Resources.

Transforms

From a resource transform perspective, Trilio provides the ability to transform Helm Charts and transform custom resources. Helm charts can be transformed based on Key:Value pairs whereas custom resources can be transformed by specifying GVKO and Operation (Replace, Move etc.) type.

For both Helm and Custom Transforms - it fetches the metadata and populates it via dropdown menus and tables - to make it easy for the user to manage the granular details of the transforms. User can add custom transformation if Backup or Snapshots are of type operatorTransforms, custom, virtual machine like below.

User can add helm transformation if Backup or Snapshots are of type helm type and if Backup or Snapshot is a Namespace scope, then retainHelmApp flag should enable in the Backup plan.

Hooks Configuration

TVK allows users to inject hooks similar to how they would apply hooks when performing a backup and snapshots. The restore Hooks are applied once the application is restored.

On click on the "+ Add hook" user can add the hook configuration.

When redirects from Basic tab and if Target browsing of Backup or Snapshot namespace is disable, user see a toggle to enable the target browsing.

  1. Hook - user can select anwants existing hook from this listing, user can create a new hook by selecting "+ New Hook" option from dropdown value. For create new hook refer Create Hook

  2. POD Selector - TVK provides the capability for selecting the pods to execute the hook commands. The pod selection can be done either by match labels/expressions or by matching a regex.

    Note: Specifying either match label or a regex is mandatory

    Scenario: User selects both match label and regex

    System Behaviour: The system applies a 2 level filter first on the match labels and then on the regex

    Scenario: If multiple pods are selected as part of the filtering, then which pods would the hook commands be executed on.

    System Behaviour: The hooks commands will be executed on a) If a container regex is entered then it will run on the container within all the pods filtered. b) If no container regex is entered then it will run on all the containers within pods selected as a result of the filter.

  3. Regex - User can manually add the regex to execute inside the pod in this field.

  4. Container Regex - TVK provides the capability for selecting the containers within the pods selected by the pod selector. The container selection can be done by matching a regex.

  5. Cancel - Click on this if user wants to cancel this add hook configuration process.

  6. Add - Click on this if user wants to add the hook configuration.

When redirects from Basic tab and if Target browsing of Backup or Snapshot namespace is disable, user see a toggle to enable the target browsing. click on that toggle to enable the target browsing to set up a resource selector.

Include resources - Restore will done with only selected resources in this field. This wont Restore all other resources available in Backup or Snapshot. 1. Labels set - This tab is used to select the Labels to include In the Restore. 2. Resources - This tab is used to select the Resources to include In the Restore.

Labels set - This tab is used to select the Labels to include In the Restore.

Summary Screen based on Transformsan