Bug 1488434

Summary:	RestAPI documentation doesn't mention the image parameter for the upgrade call
Product:	[oVirt] ovirt-engine	Reporter:	Lev Veyde <lveyde>
Component:	RestAPI	Assignee:	Ori Liel <oliel>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Radim Hrazdil <rhrazdil>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	4.1.5.2	CC:	bugs, lsvaty, lveyde, mperina, sbonazzo
Target Milestone:	ovirt-4.1.7	Flags:	rule-engine: ovirt-4.1+ rule-engine: exception+ lsvaty: testing_ack+
Target Release:	4.1.7.4
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-11-13 12:28:45 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Infra	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Lev Veyde 2017-09-05 11:41:48 UTC

Description of problem:
The documentation doesn't mention the image parameter for the upgrade call for RHEVH.

How reproducible:
100%

Actual results:
Documentation is missing.

Expected results:
All parameters should be documented, including the "image" parameter.

Comment 1 Juan Hernández 2017-09-05 11:44:03 UTC

Martin, who in the infra team knows better host installation/upgrade?

Comment 2 Martin Perina 2017-09-06 13:03:36 UTC

Lev, what image parameter are you talking about? AFAIK we don't have any image parameter in host upgrade manager

Comment 3 Juan Hernández 2017-09-06 13:11:50 UTC

We have an "action.image" parameter in the "install" and "upgrade" methods of the host:

  POST /ovirt-engine/api/hosts/123
  <action>
    <image>whatever.iso</image>
  </action>

This is used here, for example:

  https://github.com/oVirt/ovirt-engine/blob/f8bd9eda8cf58ca16c4d7d6915f0579dcc2b4150/backend/manager/modules/restapi/jaxrs/src/main/java/org/ovirt/engine/api/restapi/resource/BackendHostResource.java#L155-L157

But it isn't declared in the specification of the API, which is bad in itself, but it also means that it can't be used with the SDKs.

Comment 4 Juan Hernández 2017-09-06 13:12:19 UTC

Sorry, the URL should have been:

  POST /ovirt-engine/api/hosts/123/upgrade

Comment 5 Martin Perina 2017-09-06 14:00:31 UTC

Ahh, found it. The image parameter is used only when upgrading vintage node, it has no usage when upgrading NGN or RHEL host.

Sandro, are we still officially supporting installation/upgrades of vintage node in 4.1/4.2? If not, then I don't see a reason why we should invest time to fix that documentation issue ..

Comment 6 Sandro Bonazzola 2017-09-08 09:27:59 UTC

We are not supporting it in general, but we have engine-host-update tool which is used to help upgrading legacy clusters to 4.1 / 4.2 which is supposed to be able to work with legacy RHEV-H. Lev found the missing doc while working on it.

If it doesn't cost too much time, I would like above info provided by Juan added to the documentation for next time we need them.

Comment 7 Martin Perina 2017-09-08 11:39:46 UTC

(In reply to Sandro Bonazzola from comment #6)
> We are not supporting it in general, but we have engine-host-update tool
> which is used to help upgrading legacy clusters to 4.1 / 4.2 which is
> supposed to be able to work with legacy RHEV-H. Lev found the missing doc
> while working on it.
> 
> If it doesn't cost too much time, I would like above info provided by Juan
> added to the documentation for next time we need them.

OK, makes sense.

Ori, could you please add the required documentation for image parameter and backport the doc patch to 4.1.7?

Comment 8 Radim Hrazdil 2017-10-20 08:25:44 UTC

Verified that image parameter is documented.