Bug 1855473

Summary: [DOCs] [RFE] ovirt-imageio incremental backup guide
Product: [oVirt] ovirt-imageio Reporter: Nir Soffer <nsoffer>
Component: DocumentationAssignee: rhev-docs <rhev-docs>
Status: CLOSED WONTFIX QA Contact: rhev-docs <rhev-docs>
Severity: high Docs Contact:
Priority: unspecified    
Version: 2.0.9CC: aefrat, bugs, nsoffer, sfishbai, tnisan
Target Milestone: ---Keywords: Documentation, FutureFeature
Target Release: ---Flags: sbonazzo: ovirt-4.4?
pm-rhel: planning_ack?
pm-rhel: devel_ack?
pm-rhel: testing_ack?
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-08-03 07:22:03 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Docs RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Nir Soffer 2020-07-09 23:51:50 UTC
Description of problem:

We need a guide covering everything backup developer needs to peform full
and incremental backup and restore backups.

Most of the content exists in the devconf/fosdem/deep dive slides.

Some content is available in devel mailing list.

We have lot of example code spread in ovirt-engine-sdk examples and
ovirt-imageio examples. We need one document linking all examples.

We also have lot of outdated docs for image transfer API, spread in various
places in ovirt-engine-api-model. This documentation is unusable and hard
to maintain.

Topics:

- How incremental backup works

Starting and stopping backups:
- Managing backups using engine API/SDK
- Managing image transfers using engine API/SDK
- Managing checkpoints using engine API/SDK

High level python API using files:
- Using client.upload() to restore from files
- Using clinet.download() to backup to files

Lower level API supporting streaming:
- Using ImageioClient to full backup
- Using ImageioClient to incremental backup
- Using ImageioClient to restore disks

HTTP API:
- How to do full backup using the API
- How to do incremental backup using the API
- How to restore backups using the API

This should be the base for official documentation later.

Not sure what is the right component or best place to keep this guide, but
lets create some content first and then find the best place.

Related examples:
- https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/backup_vm.py
- https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/upload_disk.py
- https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/download_disk.py
- https://github.com/oVirt/ovirt-engine-sdk/blob/master/sdk/examples/helpers/imagetransfer.py
- https://github.com/oVirt/ovirt-imageio/blob/master/examples/imageio-client
- https://github.com/oVirt/ovirt-imageio/blob/master/examples/sparse-stream

Comment 1 Sandro Bonazzola 2020-11-17 13:39:03 UTC
4.4.2 and 4.4.3 have been released, re-targeting to 4.4.4

Comment 2 Sandro Bonazzola 2021-02-04 12:34:12 UTC
4.4.4 has been released and this wasn't re-planned for 4.4.5. resetting target milestone for being re-evaluated.

Comment 8 Sandro Bonazzola 2023-08-03 07:22:03 UTC
No updates in the last 3 years, closing as won't fix.
If still relevant please open an issue on https://github.com/oVirt/ovirt-site/issues