Bug 1264275
| Summary: | [Docs] [REST][RFE] Add examples to the REST API Guide for Cinder Integration | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Megan Lewis <melewis> |
| Component: | ovirt-engine | Assignee: | Daniel Erez <derez> |
| Status: | CLOSED WONTFIX | QA Contact: | rhev-docs <rhev-docs> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 3.6.0 | CC: | adahms, apinnick, juan.hernandez, lsurette, mperina, omachace, ratamir, rhev-docs, Rhev-m-bugs, srevivo, tnisan |
| Target Milestone: | --- | Keywords: | FutureFeature |
| Target Release: | --- | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | docs-accepted | ||
| Fixed In Version: | Doc Type: | Enhancement | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2019-01-28 16:27:10 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Storage | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
| Bug Depends On: | |||
| Bug Blocks: | 1148393 | ||
|
Description
Megan Lewis
2015-09-18 05:38:52 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 oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target. 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. oVirt 4.2.0 has been released on Dec 20th 2017. Please consider re-targeting this bug to next milestone. 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. 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 (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? 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. (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. |