A plugin is a collection of one or more features that can be added to CloudBees CD/RO. A plugin:
Can provide one or more new pages for the UI, including a configuration page used to provide additional information needed to implement the plugin.
Has an associated project that can contain procedures and properties required by the implementation.
Is delivered as a JAR file containing the feature implementation.
When a plugin is installed, the CloudBees CD/RO server extracts the JAR contents into a configurable plugins directory.
The CloudBees CD/RO installation includes numerous bundled plugins. These plugins are created and supported by CloudBees. You can also create your own plugin as described in Creating a plugin.
The complete CloudBees CD/RO plugin catalog is available:
From the CloudBees documentation site: Plugin catalog
In-product: from the main CloudBees CD/RO menu, select
Plugin management is available from CloudBees CD/RO.
From the CloudBees navigation, select CloudBees CD/RO.
From the main menu, select. The Plugin management page displays.
Use plugin management to:
See a list of installed plugins along with their promotion status.
Perform a variety of operations on plugins in the list, such as demoting, configuring, and uninstalling them.
Install plugins from the plugin catalog.
Create, modify, and export custom plugins.
The plugin management main page displays the following tabs and options for viewing the list of plugins. Several filtering options exist to optimize your view.
Displays the list of currently installed plugins. Plugins that you create or install from other sources also appear on this page. See The installed plugins list for further details about this tab.
From this tab you can install a plugin.
Lists plugins for which configurations exist at your site.
Displays the entire CloudBees CD/RO public-facing plugin catalog, or if so configured, a custom catalog with these filters:
Refer to Managing the plugin catalog for information on creating a custom catalog.
The plugins list provides an inventory of plugins currently installed on the CloudBees CD/RO server. Columns in the list of installed plugins provide a variety of details about each plugin.
The name of the plugin. Select the label of an installed plugin to see the list of procedures included with that plugin.
The person or organization who created the plugin.
The plugin version.
Indicates the plugin version is the latest.
The category in which the plugin resides. Use the categories filter to refine the list.
List of plugin tasks. Not all plugins have the same list of tasks. For example, some plugins might perform their own setup during installation and therefore do not need more configuration performed here.
If the action that you need is not in the Actions column, you might not have sufficient modify privileges in the plugins access control for that action.
Plugin management uses the plugin version for the currently installed plugin to determine whether to install or autopromote a new plugin version. The following table uses examples to demonstrate the rules for installation and autopromotion of a new plugin version:
|Existing version||New version||Result||Rule used|
The newer plugin is installed and promoted regardless of the promotion status of the existing plugin.
126.96.36.1995 installed. 188.8.131.520 remains promoted.
The newer plugin is installed but not promoted, because it is a minor-version upgrade.
184.108.40.206 not installed unless forced by the
The newer plugin is not installed if the existing plugin is a newer version than the plugin being installed.
Plugin upgrades can be done manually or through the CloudBees CD/RO upgrade process.
The plugin upgrade process has two steps:
The system uses the new version of the plugin when the promotion logic is executed.
Plugin ACLs and configurations are migrated to the promoted version, but if you had created customized modifications to these plugins, these changes may be lost in the upgrade. If you make coding or structural modifications to a packaged plugin, then renaming the plugin is recommended to prevent this overwrite or loss of modifications when upgrading.
ectool command line interface to install a plugin from the command line. The
ectool CLI contains a full set of commands to perform plugin tasks. For more information on available
ectool plugin commands, refer to Plugin Management.
For instructions on configuring the plugins directory for your CloudBees CD/RO server, remote agents, or remote web servers, refer to the following topics: