Bug 2015017 - Document image upload/download process
Summary: Document image upload/download process
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: ovirt-imageio
Classification: oVirt
Component: Documentation
Version: 2.3.0
Hardware: All
OS: All
high
high
Target Milestone: ovirt-4.5.3
: ---
Assignee: rhev-docs@redhat.com
QA Contact: Shir Fishbain
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-10-18 08:48 UTC by Janos Bonic
Modified: 2023-08-03 07:26 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-08-03 07:26:57 UTC
oVirt Team: Docs
Embargoed:
sbonazzo: ovirt-4.5+
pelauter: planning_ack+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHV-43824 0 None None None 2021-10-18 08:51:11 UTC

Description Janos Bonic 2021-10-18 08:48:34 UTC
Description of problem:

The current documentation of ImageIO[1] does not properly describe the process of uploading an ImageIO. When implementing an ImageIO client in a different language than Python, the details need to be scraped together from various sources [2][3][4][5][6][7][8][9][10].

Suggested fix:

Please add a HTTP call-flow description to the ImageIO documentation[1] or the oVirt documentation that covers all recent oVirt/RHV versions.

Justification:

We keep running into surprises when using this API. Every time we think we fix the API, the "disk locked" issue resurfaced. We need a documentation that covers the process of uploading a disk image properly which is valid for multiple RHV/oVirt versions, not just the latest.

[1] https://ovirt.github.io/ovirt-imageio/images.html
[2] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-precheck.py
[3] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-vmcheck.py
[4] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-transfer.py
[5] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-finalize.py
[6] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-cancel.py
[7] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-createvm.py
[8] https://github.com/libguestfs/virt-v2v/blob/master/output/rhv-upload-plugin.py
[9] https://github.com/libguestfs/virt-v2v/blob/7ce5df273be304ec3ba87e46319cf78275eb4990/output/rhv-upload-finalize.py#L111
[10] https://github.com/oVirt/python-ovirt-engine-sdk4/blob/eb59751367ce29e364386b8eeac35f0d53e95362/examples/helpers/imagetransfer.py#L269

Comment 1 Steve Goodman 2021-10-19 11:46:13 UTC
User story:

The user can restore a disk and upload it to oVirt.
This is the main flow to dowload and upload disks from/to oVirt
And there are a lot of different component that uses this API and missing the information on how to perform the entire flow (for example - backup vendors, OCP on RHV, Ansible, QE, etc..)
We need to have a single documentation page that contains all the data in a single place.


We need to document:

upload and download related to incremental backup flow and standalone flow.

SMEs: Eyal Shenitzky, Nir Soffer, Pavel Bar

Comment 2 Steve Goodman 2021-10-19 11:47:41 UTC
This will go in the RHV Admin Guide in the Backup/Restore section.

Comment 5 Casper (RHV QE bot) 2022-09-06 12:31:33 UTC
This bug has low overall severity and is not going to be further verified by QE. If you believe special care is required, feel free to properly align relevant severity, flags and keywords to raise PM_Score or use one of the Bumps ('PrioBumpField', 'PrioBumpGSS', 'PrioBumpPM', 'PrioBumpQA') in Keywords to raise it's PM_Score above verification threashold (1000).

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


Note You need to log in before you can comment on or make changes to this bug.