Plugin Management

Version 2 by Robin Shen
on Jun 22, 2008 19:16.

<< Changes from 1 to 2
compared with
Current by Robin Shen
on Aug 07, 2009 06:04.

 
Key
These lines were removed. This word was removed.
These lines were added. This word was added.

View page history


There are 4 changes. View first change.

 QuickBuild is designed around [OSGi|http://www.osgi.org] which is a plugin framework. This enables QuickBuild to be extended easily by just installing new plugins. In fact?many of its features are provided through plugins out of box, such as steps, repositories, reports, etc. All QuickBuild plugins are kept in the _plugins_ folder under QuickBuild's installation directory, with each file representing a single plugin.
  QuickBuild is designed around [OSGi|http://www.osgi.org], a plugin framework. This enables QuickBuild to be extended easily by just installing new plugins. In fact many of its features are provided by plugins out of the box, such as steps, repositories, reports, etc. All QuickBuild plugins are kept in the _plugins_ folder under QuickBuild's installation directory, with each file representing a single plugin.
  
*NOTE:* When mentioning plugin management, we are refering to QuickBuild server. You may noticed that the agent installation also has the _plugins_ directory. However, you don't need to care about that, QuickBuild agents will sync its plugins to QuickBuild server automatically when you install/uninstall plugins on the server.
  *NOTE:* When mentioning plugin management, we are referring to QuickBuild server. You may noticed that the agent installation also has the _plugins_ directory. However, you don't need to take care of agent plugins, because QuickBuild agents will sync its plugins with QuickBuild server automatically when you install/uninstall plugins on the server.
  
To get more information on installed plugins, please access the plugin management screen as shown below:
  To get more information on installed plugins, please go to the Plugin Management screen as shown below:
 !pluginmanagement.png!
  
 !plugin-management.png!
  
 As the screen indicates, existing plugin can be configured, enabled, disabled, or uninstalled. The icon before the plugin ID gives status of the plugin:
 * !disable.gif!, this plugin is disabled. If a plugin is disabled, its functionality will not be available to the system. For example, if the plugin _com.pmease.quickbuild.plugin.ant_ is disabled, the ant build step will not appear in the step menu.
 * !enable.gif!, this plugin is enabled
 * !warning.gif!, this plugin can not be enabled as it needs to be configured first. Once it is configured, its status will be changed to _enabled_.
  
 h3. Configure plugins
  
 Plugins can be configured by clicking the _configure_ link on the plugin managemen screen as shown above. After this link is clicked, a plugin setting screen will be shown like below (taking Maven plugin as example here):
 !plugin-setting.png!
  
 h3. Install new plugins
  
 New plugins can be installed by directly drop the plugin file into the _plugins_ folder, followed by a restart of the QuickBuild server. Or you can upload the plugin file at bottom of the plugin management screen as shown below:
  
 !install-new-plugin.png!
  
 You won't need to restart QuickBuild server if you are installing plugin through the plugin management screen.
  
 h3. Uninstall exising plugins
  
 Existing plugins can be uninstalled by directly delete the plugin file in the _plugins_ folder, followed by a restart of the QuickBuild server. Or you can click the _uninstall_ link on the plugin management screen. You won't need to restart QuickBuild server if you are uninstalling plugin through the plugin management screen.
  * The icon before the plugin name indicates the status of the plugin:
 ** !disable.gif! This plugin is disabled. If a plugin is disabled, its functionality will not be available to the system. For example, if the plugin _com.pmease.quickbuild.plugin.ant_ is disabled, the ant build step will not appear in the step menu.
 ** !enable.gif! This plugin is enabled.
 ** !warning.gif! This plugin can not be enabled as it needs to be configured first. Once it is configured, its status will change to _enabled_.
 * For plugins with settings, a _Configure_ link will appear in the operation list. Following this link, plugin setting page will be opened to let the user view/edit settings of the plugin.
 * New plugins can be installed by dropping the plugin file into the _plugins_ folder, followed by restart of the QuickBuild server.
 * Existing plugins can be uninstalled by deleting the plugin file from the _plugins_ folder, followed by restart of the QuickBuild server.