2022-10-06 13:35:26 +02:00
<!--
SPDX-FileCopyrightText: Red Hat, Inc.
SPDX-License-Identifier: GPL-2.0-or-later
-->
2017-08-03 19:37:08 +03:00
# ovirt-imageio
2022-10-18 00:41:51 +03:00
[](https://pypi.org/project/ovirt-imageio/)
[](https://pypi.org/project/ovirt-imageio/)
[](https://pypi.org/project/ovirt-imageio/)
[](https://pypi.org/project/ovirt-imageio/)
2021-12-02 00:57:37 +02:00
[](https://github.com/oVirt/ovirt-imageio/actions)
2020-04-20 21:57:04 +03:00
[](https://copr.fedorainfracloud.org/coprs/nsoffer/ovirt-imageio-preview/package/ovirt-imageio/)
2018-05-29 16:09:45 +03:00
ovirt-imageio enables uploading and downloading of disks and snapshots using HTTPS.
2017-08-03 19:37:08 +03:00
2020-05-14 13:40:40 +02:00
The project provides ovirt-imageio service and imageio client library.
2017-08-03 19:37:08 +03:00
2020-05-14 13:40:40 +02:00
ovirt-imageio service can act in two different roles:
2017-08-03 19:37:08 +03:00
2020-05-14 13:40:40 +02:00
- 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.
2017-08-03 19:37:08 +03:00
2018-05-29 16:09:45 +03:00
## How this project is related to other oVirt projects?
2017-08-03 19:37:08 +03:00
2020-05-14 13:40:40 +02:00
- vdsm - control and monitor imageio service, prepare and finalize
2018-05-29 16:09:45 +03:00
upload and download operations.
2017-08-03 19:37:08 +03:00
2018-05-29 16:09:45 +03:00
- engine - manage upload and download operations, communicating with
2020-05-14 13:40:40 +02:00
vdsm and imageio service running on the engine. Engine does not communicate with imageio
service on the hosts.
2018-05-29 16:09:45 +03:00
## Documentation
[http://ovirt.github.io/ovirt-imageio/ ](http://ovirt.github.io/ovirt-imageio/ )
## Installation
2020-05-14 13:40:40 +02:00
- On engine, the imageio service is installed as part of [oVirt engine installation ](https://www.ovirt.org/documentation/install-guide/chap-Installing_oVirt/ )
2018-05-29 16:09:45 +03:00
- Should be enabled during engine-setup.
2020-05-14 13:40:40 +02:00
- On host, the imageio service is installed as part of [oVirt node installation ](https://www.ovirt.org/node/ )
2018-05-29 16:09:45 +03:00
## Contributing
Patches are welcome!
- Refer to [Development Section ](http://ovirt.github.io/ovirt-imageio/development.html ) for build and commit instructions.
2022-03-30 22:56:42 +02:00
- Send a pull request on [GitHub ](https://github.com/oVirt/ovirt-imageio/pulls )
2018-05-29 16:09:45 +03:00
## 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
2022-10-07 10:08:09 +02:00
The project is provided under the terms of the GPL-2.0-or-later License.
2017-08-03 19:37:08 +03:00
2022-10-07 10:08:09 +02:00
Please see the `LICENSES/GPL-2.0-or-later.txt` file for complete license terms.