Bug 1264275 - [Docs] [REST][RFE] Add examples to the REST API Guide for Cinder Integration
Summary: [Docs] [REST][RFE] Add examples to the REST API Guide for Cinder Integration
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine
Version: 3.6.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Daniel Erez
QA Contact: rhev-docs@redhat.com
URL:
Whiteboard: docs-accepted
Depends On:
Blocks: 1148393
TreeView+ depends on / blocked
 
Reported: 2015-09-18 05:38 UTC by Megan Lewis
Modified: 2022-03-25 14:19 UTC (History)
11 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-01-28 16:27:10 UTC
oVirt Team: Storage
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHV-45448 0 None None None 2022-03-25 14:19:13 UTC

Description Megan Lewis 2015-09-18 05:38:52 UTC
In BZ#1252748 Daniel Erez requested we add some REST-API examples for Cinder Integration. More information is available here: http://www.ovirt.org/Features/Cinder_Integration

Comment 1 Sandro Bonazzola 2015-10-26 12:43:16 UTC
this is an automated message. oVirt 3.6.0 RC3 has been released and GA is targeted to next week, Nov 4th 2015.
Please review this bug and if not a blocker, please postpone to a later release.
All bugs not postponed on GA release will be automatically re-targeted to

- 3.6.1 if severity >= high
- 4.0 if severity < high

Comment 2 Yaniv Lavi 2016-05-09 10:58:01 UTC
oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target.

Comment 3 Juan Hernández 2016-11-08 13:52:01 UTC
As far as I know this hasn't been addressed in the specification of the API for 4.0.5, so I am re-targeting to 4.0.6.

Comment 4 Sandro Bonazzola 2017-12-20 13:47:47 UTC
oVirt 4.2.0 has been released on Dec 20th 2017. Please consider re-targeting this bug to next milestone.

Comment 6 Ondra Machacek 2018-09-18 08:13:05 UTC
Well Daniel requested to have some examples of cinder integration in api-model documentation. The new correct link is:

 https://ovirt.org/develop/release-management/features/storage/cinder-integration/

You can find the examples of usage there.

Comment 7 Martin Perina 2019-01-17 08:26:39 UTC
Daniel, could you please create a patch for https://gerrit.ovirt.org/#/admin/projects/ovirt-engine-api-model and add examples as JavaDoc comment to relevant interfaces? 
If that's not enough please sync with Avital if it's needed to create new section in https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/html/rest_api_guide/documents-004_quick_start_example

Comment 8 Daniel Erez 2019-01-17 09:21:14 UTC
(In reply to Martin Perina from comment #7)
> Daniel, could you please create a patch for
> https://gerrit.ovirt.org/#/admin/projects/ovirt-engine-api-model and add
> examples as JavaDoc comment to relevant interfaces? 
> If that's not enough please sync with Avital if it's needed to create new
> section in
> https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> html/rest_api_guide/documents-004_quick_start_example

I'm not sure it's still relevant as we already have a new Cinder integration (Managed Block Storage)
Anyway, from a quick look I don't see anything missing from the api-model.

@Tal - do we still support the old integration? Shouldn't we document the new CinderLib integration instead?

Comment 9 Sandro Bonazzola 2019-01-28 09:41:38 UTC
This bug has not been marked as blocker for oVirt 4.3.0.
Since we are releasing it tomorrow, January 29th, this bug has been re-targeted to 4.3.1.

Comment 11 Tal Nisan 2019-01-28 16:27:10 UTC
(In reply to Daniel Erez from comment #8)
> (In reply to Martin Perina from comment #7)
> > Daniel, could you please create a patch for
> > https://gerrit.ovirt.org/#/admin/projects/ovirt-engine-api-model and add
> > examples as JavaDoc comment to relevant interfaces? 
> > If that's not enough please sync with Avital if it's needed to create new
> > section in
> > https://access.redhat.com/documentation/en-us/red_hat_virtualization/4.2/
> > html/rest_api_guide/documents-004_quick_start_example
> 
> I'm not sure it's still relevant as we already have a new Cinder integration
> (Managed Block Storage)
> Anyway, from a quick look I don't see anything missing from the api-model.
> 
> @Tal - do we still support the old integration? Shouldn't we document the
> new CinderLib integration instead?

We still support the old Cinder integration but the existing documentation seems thorough enough, I wouldn't spend more resources on improving it as we are moving to Cinderlib.


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