[Users] Fwd: oVirt UI plugins feature announcements

[Vojtech Szocs]

----- Original Message -----
> From: "René Koch (ovido)" <r.koch at ovido.at>
> To: "Vojtech Szocs" <vszocs at redhat.com>
> Cc: "users" <users at ovirt.org>
> Sent: Friday, November 8, 2013 10:32:24 AM
> Subject: Re: [Users] Fwd: oVirt UI plugins feature announcements
> 
> On Thu, 2013-11-07 at 17:24 -0500, Vojtech Szocs wrote:
> > Hi guys, sharing some updates on oVirt UI plugins feature, see below for
> > details.
> > 
> > Let me know if you have any questions.
> > 
> > Vojtech
> > 
> > 
> > ----- Forwarded Message -----
> > From: "Vojtech Szocs" <vszocs at redhat.com>
> > To: "engine-devel" <engine-devel at ovirt.org>
> > Cc: "Einav Cohen" <ecohen at redhat.com>, "Itamar Heim" <iheim at redhat.com>
> > Sent: Thursday, November 7, 2013 11:21:21 PM
> > Subject: oVirt UI plugins feature announcements
> > 
> > Hello everyone,
> > 
> > I'd like to share some important updates on oVirt UI plugins feature.
> > 
> > First of all, UI plugins wiki [1] is finally complete. API reference
> > (application events, API functions, API options, entity types) now
> > includes all the details and snippets of example code. I've also added
> > section "Why load plugins via iframe element?" explaining reasons behind
> > this design decision.
> > 
> > [1] http://www.ovirt.org/Features/UIPlugins
> 
> 
> Great! Thanks a lot for the documentation - this makes life much easier!
> 
> 
> > 
> > You might have noticed the changes in oVirt Engine URI layout [2], these
> > are already reflected in UI plugins wiki. For existing plugins, this means
> > changing URLs like this:
> > 
> >   /webadmin/webadmin/plugin/ExamplePlugin/start.html
> > 
> > to this:
> > 
> >   /ovirt-engine/webadmin/plugin/ExamplePlugin/start.html
> > 
> > [2] http://gerrit.ovirt.org/#/c/20473/
> 
> 
> Which version of oVirt uses the new URI - I assume 3.4? (and do you know
> if the URI will be changed in RHEV as well)?

Correct, new URI layout takes effect in oVirt 3.4, not sure about RHEV but I think "ovirt-engine" in URI might change there.

> 
> I think it's important to mention this change in oVirt upgrade/release
> notes to let users know that they have to change the UI plugin URI. When
> packaging an UI plugin it's not a problem to check the oVirt version in
> a %post section and run a sed command over the JSON file...

I assume the URI layout change BZ [https://bugzilla.redhat.com/961677] will have some release notes attached.

For UI plugins, I was talking with Alon about this, we could promote the use of relative URIs to make UI plugins unaware of absolute URI layout.

For example, in plugin descriptor:

  "url": "plugin/ExamplePlugin/start.html" // relative to WebAdmin base context path, i.e. /ovirt-engine/webadmin

would result in:

  <iframe src="plugin/ExamplePlugin/start.html">

custom content could be added like this:

  api.addMainTab('Example Tab', 'example-tab', 'plugin/ExamplePlugin/tab.html');

and any content within the iframe (either start.html or tab.html) could use:

  <script src="dir-relative-to-plugin-resources/custom-script.js">
  <link href="dir-relative-to-plugin-resources/custom-stylesheet.css">

I'll verify this and update the UI plugins wiki accordingly. Should have thought about relative URIs in the first place :)

> 
> 
> I also have a question (not related to this topic) too:
> In webadmin I select e.g. a vm and click on Disks webadmin displays disk
> details for this vm. When selecting another vm I can see the disk infos
> for this vm (webadmin keeps me in Disks subtab which is what I would
> expect).
> When I click on Monitoring Details (which is a subtab created by my
> monitoring UI plugin) and I select another vm webadmin doesn't show me
> the content of the ui plugin subtab (Monitoring Details) but instead the
> Disks subtab (always the last clicked non-ui-plugin subtab).
> Didn't test in in oVirt 3.3 yet, only in oVirt 3.2 and RHEV 3.2...
> Is it possible to let subtabs created by ui pugins behave in the same
> way as subtabs provided by webadmin?

Right, this is a known issue with dynamic sub tabs. I've created RFE BZ [https://bugzilla.redhat.com/1028968] to track this issue.

Thanks for your feedback!

> 
> 
> Regards,
> René
> 
> 
> > 
> > We're planning to merge patch "Improve UI Plugin vs. REST API integration"
> > [http://gerrit.ovirt.org/#/c/20404/] soon, please review the change
> > outlined in commit message, let me know if you have any questions.
> > 
> > Last but not least, oVirt Space Shooter (a.k.a UI plugins crash course)
> > wiki [3] has been updated to reflect changes mentioned above.
> > 
> > [3] http://www.ovirt.org/Tutorial/UIPlugins/CrashCourse
> > 
> > Regards,
> > Vojtech
> > _______________________________________________
> > Users mailing list
> > Users at ovirt.org
> > http://lists.ovirt.org/mailman/listinfo/users
> 
>