Bug 1488434 - RestAPI documentation doesn't mention the image parameter for the upgrade call
Summary: RestAPI documentation doesn't mention the image parameter for the upgrade call
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: ovirt-engine
Classification: oVirt
Component: RestAPI
Version: 4.1.5.2
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ovirt-4.1.7
: 4.1.7.4
Assignee: Ori Liel
QA Contact: Radim Hrazdil
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-09-05 11:41 UTC by Lev Veyde
Modified: 2017-11-13 12:28 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-11-13 12:28:45 UTC
oVirt Team: Infra
Embargoed:
rule-engine: ovirt-4.1+
rule-engine: exception+
lsvaty: testing_ack+


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
oVirt gerrit 81676 0 master MERGED Host Upgrade - Document Image Parameter 2017-10-13 10:22:54 UTC
oVirt gerrit 81678 0 model_4.1 ABANDONED Upgrade Host - Add Image Parameter 2017-10-16 05:51:05 UTC
oVirt gerrit 82747 0 model_4.2 MERGED Host Upgrade - Document Image Parameter 2017-10-13 10:24:02 UTC
oVirt gerrit 82748 0 model_4.1 MERGED Host Upgrade - Document Image Parameter 2017-10-13 10:27:53 UTC
oVirt gerrit 82758 0 master MERGED restapi: Update to model 4.2.21 2017-10-13 11:52:14 UTC
oVirt gerrit 82759 0 ovirt-engine-4.1 MERGED restapi: Update to model 4.1.40 2017-10-13 12:31:37 UTC
oVirt gerrit 83082 0 master MERGED Update to model 4.2.23 2017-10-23 08:20:35 UTC
oVirt gerrit 83574 0 sdk_4.1 MERGED Update to model 4.1.40 2017-11-03 10:24:57 UTC

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.


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