Red Hat Bugzilla – Bug 1108245
Missing things in Backup-Restore API documentation
Last modified: 2017-08-28 19:00:54 EDT
+++ This bug was initially created as a clone of Bug #1063877 +++ Description of problem: Looking at: http://www.ovirt.org/Features/Backup-Restore_API_Integration, 2 things are missing: 1. Explain how to get the configuration of the snapshot using REST API, and how should it be used to create VM which is based on this configuration 2. When attaching disk to VM it seems that it is not activated by default, so we need to mention that it should be activated before we can use in from within the guest Version-Release number of selected component (if applicable): How reproducible: Steps to Reproduce: 1. 2. 3. Actual results: Expected results: Additional info: --- Additional comment from Itamar Heim on 2014-02-16 03:23:57 EST --- Setting target release to current version for consideration and review. please do not push non-RFE bugs to an undefined target release to make sure bugs are reviewed for relevancy, fix, closure, etc. --- Additional comment from Sandro Bonazzola on 2014-03-04 04:20:04 EST --- This is an automated message. Re-targeting all non-blocker bugs still open on 3.4.0 to 3.4.1. --- Additional comment from Sandro Bonazzola on 2014-06-11 02:51:05 EDT --- This is an automated message: This bug has been re-targeted from 3.4.2 to 3.5.0 since neither priority nor severity were high or urgent. Please re-target to 3.4.3 if relevant.
This bug is for tracking the wiki changes requested in the original bug and adding them to the RHEVM docs
The docs haven't been modified - this is a mistake. Moving back to assigned.
I am working on adding some content about this feature to the Red Hat Enterprise Virtualization documentation suite, so I am assigning this bug to myself so that I can track related information.
Hi Allon, I have created a draft of some content on how to back up and restore virtual machines using the backup and restore API here: http://docbuilder.usersys.redhat.com/22765/#sect-Backing_Up_and_Restoring_Virtual_Machines_Using_the_Backup_and_Restore_API Would you be able to provide any feedback on whether this is the correct procedure? In particular, I am interested in how users create new virtual machines based on the configuration of a backed up virtual machine. I have had some success simply copying and pasting the XML from the backed up configuration, and I can see you can use a CDATA block as well. Is this the correct method, or is there a link that users can pass that points to the configuration? Any advice you could provide would be greatly appreciated. Kind regards, Andrew
Liron, can you review Andrew's guide please?
Hi Andrew, Few comments - Backup flow - *"Using the REST API, create a snapshot of the virtual machine to back up:" - perhaps we can add here that you can take a snapshot of only some of the vm disks. *Identify the disk ID and snapshot ID of the snapshot: /api/vms/00000000-0000-0000-0000-000000000000/snapshots/00000000-0000-0000-0000-000000000000 HTTP/1.1 1. that is missing /disks on the path *missing the part to backup the vm configuration (See the wiki page for further details)
Hi Liron, Thank you for your review, and my apologies for the delay in getting back to you. I have made some changes to the documentation to address the points you raised. Namely, by adding '/disks' as noted, adding a step to outline how to retrieve configuration data, and adding an 'important' box to outline that you cannot take snapshots of Direct LUN or shareable disks. http://docbuilder.usersys.redhat.com/22765/#Backing_Up_a_Virtual_Machine Would you be able to take a quick look and let me know if you have any further concerns? Andrew
A couple of minor comments: * Under (1), the warning box: "You cannot take snapshots of disks that are marked as shareable or that are based on direct LUN connections." "LUN connections" should read "LUN disks" * I understand that 00000000-0000-0000-000000000000 is intended as a placeholder, but there actually IS such an object in RHEV - the blank template's images. Can we perhaps use a Guid made up of 1s inteads of 0s (and replace the one with 1s to 2s)? * Once the snapshot is backed up, most customers would probably like to delete (merge) the snapshot that was taken just for backup. Perhaps we can add a reference to sectio 9.12.4, or to the equivilent section in the REST-API guide (sorry, could not locate it).
*** Bug 1127973 has been marked as a duplicate of this bug. ***
Documentation Link ------------------------------ Administration Guide: https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Administration_Guide/index.html#sect-Backing_Up_and_Restoring_Virtual_Machines_Using_the_Backup_and_Restore_API Technical Guide: https://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Technical_Guide/index.html#chap-The_Backup_and_Restore_API What Changed ------------------------------ The following topics were created as outlined below to describe the backup and restore API and provide procedures on how to use the API: The Backup and Restore API [41421-715908] Newly created; contains a condition that displays a 'Note' box in the Administration Guide pointing users to the Technical Guide for information on using the REST API. Backing Up a Virtual Machine [41422-715902] Newly created; appears the same in both guides. Restoring a Virtual Machine [41426-715912] Newly created; contains a condition that directs users to the relevant section of the Administration Guide and Technical Guide for creating a floating disk in accordance with the guide in which the content is being viewed. Updated the revision history topics: [34613-715905] [34616-715913] NVR ------------------------------ Red_Hat_Enterprise_Virtualization-Administration_Guide-3.5-en-US-3.5-28 Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-en-US-3.5-18 Moving to ON_QA.
Reviewed for docs QE. The new topics provide a clear and easy-to-follow outline of using the backup and restore API. The documentation provided satisfies the original bug request, as well as subsequent requests made during technical review. All conditional links and notes appear as appropriate. VERIFIED.
*** Bug 1122277 has been marked as a duplicate of this bug. ***
*** Bug 1043329 has been marked as a duplicate of this bug. ***
Cancelling old needinfo request.