Bug 885391 - PRD32 - webadmin: support ui-plugins
PRD32 - webadmin: support ui-plugins
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: ovirt-engine-webadmin-portal (Show other bugs)
Unspecified Unspecified
high Severity unspecified
: ---
: 3.2.0
Assigned To: vszocs
Jiri Belka
: FutureFeature
: 803248 (view as bug list)
Depends On:
Blocks: 889107 915537
  Show dependency treegraph
Reported: 2012-12-08 20:13 EST by Einav Cohen
Modified: 2013-08-19 00:14 EDT (History)
9 users (show)

See Also:
Fixed In Version: sf1
Doc Type: Release Note
Doc Text:
Support has been added for extending the administration portal user interface with custom plugins. This includes a dedicated API for discovering and loading plugins, and providing notification of the plugin's key events to the administration portal.
Story Points: ---
Clone Of:
: 889107 (view as bug list)
Last Closed: 2013-06-10 17:27:01 EDT
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---

Attachments (Terms of Use)

  None (edit)
Description Einav Cohen 2012-12-08 20:13:40 EST
Support extending the web-admin's view/functionality via externally-written plug-ins.
Comment 2 vszocs 2013-01-04 12:18:37 EST
The scope of oVirt UI Plugins feature introduced in RHEVM 3.2 is to provide a solid base for extending Web Admin user interface:

(1) client and server side infrastructure for discovering and loading plugins, and enforcing standard plugin lifecycle at runtime
(2) exposing dedicated API to plugins, providing various Web Admin user interface extension points
(3) providing standard events for plugins to hook into, in order to be notified of key events during Web Admin rutime

(1) is pretty much complete and working, no major design changes expected in near future.
(2) and (3) represent the actual functionality offered to plugins, and is therefore likely to be improved/extended in near future.

UI Plugins feature currently supports:
- API: Add custom {main|sub} tab
- API: Control custom {main|sub} tab properties
- API: Add custom main tab action button
- API: Show custom dialog
- Event: User login and logout
- Event: oVirt Engine REST API session acquired
- Event: Main tab {entity} selection change
Comment 3 Itamar Heim 2013-01-07 03:12:30 EST
*** Bug 803248 has been marked as a duplicate of this bug. ***
Comment 5 vszocs 2013-01-18 05:58:35 EST
Hi, http://www.ovirt.org/wiki/Features/UIPlugins should include step-by-step walkthrough to create simple UI plugin.

A minimalistic UI plugin:

helloWorld.json (plugin descriptor)
  "name": "HelloWorld",
  "url": "/webadmin/webadmin/plugin/HelloWorld/start.html",
  "resourcePath": "helloWorld-files"

start.html (plugin host page)
<!DOCTYPE html>
  var api = parent.pluginApi('HelloWorld');
    UiInit: function() {
      window.alert('Hello world');
Comment 7 Jiri Belka 2013-02-18 05:34:25 EST
ok, sf7. BZ912298 opened for unicode characters handling.
Comment 8 errata-xmlrpc 2013-06-10 17:27:01 EDT
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.


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