Uploaded image for project: 'OpenShift Virtualization'
  1. OpenShift Virtualization
  2. CNV-78225

[DOC] - OADP VMFR (VM Single File Restore) CNV

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • CNV Documentation
    • Quality / Stability / Reliability
    • 0.42
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • None

       

      NOTE
      Docs for OCP 4.22 & OADP 1.6.0
      This work will be completed by the OADP team. 
      However, the modules will need to be included in an assembly in the CNV docs

       

       


      Subject: Documentation Request: OADP VM File Restore (VMFR) / Single File Restore

      Feature Overview We need to document the new OADP VM File Restore (VMFR) feature. This capability allows administrators to restore individual files from OADP Virtual Machine (VM) backups without the need to restore the entire Virtual Machine. This granular recovery method is essential for quick remediation of accidental file deletions or corruption within a VM.

      Key Information for Documentation

      • Feature Name: OADP VM File Restore (VMFR).
      • Core Functionality: Enables the extraction and serving of specific files directly from existing VM backups.
      • User Benefit: Drastically reduces recovery time (RTO) for single-file loss scenarios by avoiding full VM restoration.

      Critical Note on Release Status

      • Current State: The reference material notes this is currently a "non-released feature" and the current installation method is "Install from Source."
      • Action for Writer: Please verify with the engineering/product team if this is shipping as a Technology Preview (TP) or Dev Preview in CNV/OADP 4.20. If it is not fully supported (GA), the documentation must clearly label it as such and potentially direct users to specific preview installation steps rather than standard Operator installation.

      Source Materials & References Use the following resources to draft the procedural and architectural documentation:

      • Design Architecture: See the VM File Restore Design Document for diagrams and technical flow.
      • Installation & Setup: Refer to the "VMFR - Quick Start Guide (Install from Source)" for the prerequisite steps.
      • Usage: See the "16-Minute Demo" video (timestamped in the linked Jira) to visualize the CLI/UI workflow for selecting and restoring a file.
      • Validation: "VMFR Testing Notes" contains edge cases and expected behaviors useful for the troubleshooting section.

      Placement in Docs This should likely reside in the Backup and restore > Restoring Virtual Machines section, potentially under a new heading: Restoring individual files from VM backups.

       

      JTBD statement:"As a VM Application Owner, I want to perform encrypt and back up all custom configurations and network share data (e.g., Ceph or NFS) using my own S3 credentials, to achieve full, independent control and ownership of my data and encryption keys, preventing administrator access or reliance for fast restoration."

      Personas

      The Virtual Machine File Restore (VMFR) feature enables faster, simpler, and more efficient file-level recovery directly from VM backups. Based on its capabilities and security controls, here are three distinct personas and their corresponding Jobs to Be Done (JTBD) statements:

      1. The Interactive User

      This persona prioritizes ease of use and quick validation for small, urgent recoveries.

      • As a VM Application User, I want to perform browse and preview the contents of a specific file backup using a familiar web interface, to achieve quickly find and securely download a few lost or corrupted files without needing complex command-line tools.

      2. The Power User / Automation Specialist

      This persona focuses on speed, automation, and bulk operations for large recovery tasks.

      • As a DevOps Engineer, I want to perform transfer a large directory of configuration files from a historical backup using a tool like rsync or SFTP, to achieve automate the bulk recovery process quickly and reliably via the restricted, key-based SSH access channel.

      3. The Recovery / Forensic Specialist

      This persona values security, isolation, and ensuring the integrity of the recovered data.

      • As a Data Recovery Specialist, I want to perform access the backed-up VM files without starting the original VM or affecting any current cluster resources, to achieve ensure that the files I recover are tamper-free and that the recovery operation is completely isolated to a temporary namespace, maintaining data integrity and security.

       

       

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: