https://github.com/ovirt/ovirt-imageio

The oVirt image transfer daemon and clients.
https://github.com/ovirt/ovirt-imageio

backup disk-image download nbd ovirt python3 upload virtualization

Last synced: about 1 year ago
JSON representation

The oVirt image transfer daemon and clients.

• Host: GitHub
• URL: https://github.com/ovirt/ovirt-imageio
• Owner: oVirt
• License: gpl-2.0
• Created: 2016-04-19T15:33:13.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2025-01-24T15:23:16.000Z (over 1 year ago)
• Last Synced: 2025-03-29T15:04:41.040Z (about 1 year ago)
• Topics: backup, disk-image, download, nbd, ovirt, python3, upload, virtualization
• Language: Python
• Homepage:
• Size: 2.38 MB
• Stars: 20
• Watchers: 15
• Forks: 25
• Open Issues: 34
• Metadata Files:
  • Readme: README.md
  • License: LICENSES/GPL-2.0-or-later.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          


# ovirt-imageio

[![Package version](https://img.shields.io/pypi/v/ovirt-imageio)](https://pypi.org/project/ovirt-imageio/)

[![Python versions](https://img.shields.io/pypi/pyversions/ovirt-imageio)](https://pypi.org/project/ovirt-imageio/)

[![Downloads per month](https://img.shields.io/pypi/dm/ovirt-imageio)](https://pypi.org/project/ovirt-imageio/)

[![License](https://img.shields.io/github/license/oVirt/ovirt-imageio)](https://pypi.org/project/ovirt-imageio/)

[![CI status](https://github.com/oVirt/ovirt-imageio/actions/workflows/ci.yml/badge.svg)](https://github.com/oVirt/ovirt-imageio/actions)

[![Copr build status](https://copr.fedorainfracloud.org/coprs/nsoffer/ovirt-imageio-preview/package/ovirt-imageio/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/nsoffer/ovirt-imageio-preview/package/ovirt-imageio/)

ovirt-imageio enables uploading and downloading of disks and snapshots using HTTPS.

The project provides ovirt-imageio service and imageio client library.

ovirt-imageio service can act in two different roles:

- as a service exposing images over HTTPS, allowing clients to read and write images.

- as a proxy service, allowing clients without access to the host network to read and write images.

imageio client library provides wrapper around REST API provided by ovirt-imageio.

Besides making REST API easy to use, it also provides other features like on-the-fly image

format conversion or support for incremental backup out of the box. It can also be used

as a reference implementation of imageio client.

## How this project is related to other oVirt projects?

- vdsm - control and monitor imageio service, prepare and finalize

  upload and download operations.

- engine - manage upload and download operations, communicating with

  vdsm and imageio service running on the engine. Engine does not communicate with imageio

  service on the hosts.

## Documentation

[http://ovirt.github.io/ovirt-imageio/](http://ovirt.github.io/ovirt-imageio/)

## Installation

- On engine, the imageio service is installed as part of [oVirt engine installation](https://www.ovirt.org/documentation/install-guide/chap-Installing_oVirt/)

    - Should be enabled during engine-setup.

- On host, the imageio service is installed as part of [oVirt node installation](https://www.ovirt.org/node/)

## Contributing

Patches are welcome!

- Refer to [Development Section](http://ovirt.github.io/ovirt-imageio/development.html) for build and commit instructions.

- Send a pull request on [GitHub](https://github.com/oVirt/ovirt-imageio/pulls)

## Getting Help

Please send mail to one of the following lists for help.

 - For discussion about usage and general help:

   http://lists.ovirt.org/mailman/listinfo/users

 - For technical discussion about the project and its code:

   http://lists.ovirt.org/mailman/listinfo/devel

## Licensing

The project is provided under the terms of the GPL-2.0-or-later License.

Please see the `LICENSES/GPL-2.0-or-later.txt` file for complete license terms.