The Brooklyn UI leverages OSGi to build a modular user interface: each UI module is an OSGi bundle (which effectively is a simple webapp running at a particular path context. Each UI module implements the Java interface
UiModule which is then used to register the module onto the UI modules registry (that runs on the OSGi container) upon bundle installation.
The registration process is as follow:
Similarly, the UI module is unregistered when the bundle is uninstall.
Beside the UI modules registry, there is also a special API (available at v1/ui-module-registry) which returns all currently registered UI modules. This endpoint is then used by the home page (as well as the navigation drawer) to display the right links.
modularity-structurecontains server-side things
ui-modulesare UI modules bundled with Brooklyn (including home) and utils they use/share
featuresis the osgi dist
If you have a Karaf distribution, you can install the Brooklyn UI simply by running the following:
# use the correct BROOKLYN_VERSION_BELOW feature:repo-add mvn:org.apache.brooklyn.ui/brooklyn-ui-features/1.0.0-SNAPSHOT/xml/features feature:install brooklyn-ui
You should now have see the bundles if you run
bundle:list and web modules with
web:list, and the app home page should now be available at http://localhost:8081.
Similarly to the full distribution, you can install each UI module separately as they provide their own feature:
feature:repo-add mvn:org.apache.brooklyn.ui/brooklyn-ui-feature/<brooklyn-version>/xml/features feature:install brooklyn-ui-<module-name>
For example, to install the
One can register external UI modules thanks to the OSGi container. See
modularity-server/external-modules for more information.
NOTE you must have protractor installed (see http://www.protractortest.org/)
Any module that has a
protractor.conf.js file at its root has e3e tests.
Steps to Run:
This can happen if you have built
brooklyn-ui-core manually with an old version of node (< 4). In this case, delete the
node_modules in all UI modules, upgrade
node to the latest version and try again.
If there are npm build errors (e.g. in brooklyn-ui-home), try editing
ui-modules/home/package.json to remove the
--bail from the
"build": "rimraf ... line, and re-run
npm run build (in the
ui-modules/home directory). This can give better errors about what is going wrong.
The error below means that libpng is not installed:
Module build failed: Error: dyld: Library not loaded: /usr/local/opt/libpng/lib/libpng16.16.dylib
On os-x, try installing it (with the command below), and try again:
brew install libpng