A plugin is a collection of one or more automation features that can be added to CloudBees CD/RO. A plugin:
-
Can provide integration with third-party tools or other automation functionality.
-
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 Create plugins.
The complete CloudBees CD/RO plugin catalog is available:
-
From the CloudBees documentation site: Plugin catalog
-
In the product: from the main CloudBees CD/RO menu, select
Accessing plugin management
Use plugin management to:
-
View 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.
To access the plugin management page:
-
From the CloudBees navigation, select CloudBees CD/RO.
-
From the main menu, select .
The Plugin management page displays the following tabs and options for viewing the list of plugins. Several filtering options exist to optimize your view.
Tab Description Installed plugins
Displays the list of currently installed plugins. Plugins that you create or install from other sources also appear on this page. Refer to Installed plugins for further details about this tab.
Configurations
Lists plugins for which configurations exist at your site.
If you are migrating to CloudBees CD/RO v10.3 or later from a pre-v10.3 version, you must migrate all existing configurations. Refer to Migrating plugin configurations for details. Plugins catalog
Displays the entire CloudBees CD/RO public-facing plugin catalog, or if so configured, a custom catalog with these filters:
-
All categories: Select a category from drop-down list to filter the plugin list.
-
Ready for upgrade: Check this box to view only those plugins ready for upgrade.
Refer to Manage the plugin catalog for information on creating a custom catalog.
The Plugins catalog tab is not present if the CloudBees CD/RO server lacks internet access. In this case, plugin management displays the following : Catalog not found : Catalog URL is https://downloads.cloudbees.com/cloudbees-cd/plugins/catalog.xml. -
Installed plugins
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.
| Column name | Description |
|---|---|
Name |
The name of the plugin. Select the label of an installed plugin to view the list of procedures included with that plugin. |
Supported by |
The person or organization who created the plugin. |
Version |
The plugin version. |
Promoted |
Indicates the plugin version is the latest. |
Category |
The category in which the plugin resides. Use the categories filter to refine the list. |
Actions |
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. |
About plugin versions
Plugin management uses the plugin version for the currently installed plugin to determine whether to install or auto-promote a new plugin version. The following table uses examples to demonstrate the rules for installation and auto-promotion of a new plugin version:
| Existing version | New version | Result | Rule used |
|---|---|---|---|
1.2.3.300 (promoted) |
1.2.8.1234 |
1.2.8.1234 (promoted) |
The newer plugin is installed and promoted regardless of the promotion status of the existing plugin. |
1.2.3.300 (promoted) |
1.3.4.1235 |
1.3.4.1235 installed. 1.2.3.300 remains promoted. |
The newer plugin is installed but not promoted, because it is a minor-version upgrade. |
1.2.3.300 (promoted) |
1.2.2.124 |
1.2.2.124 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. |
Upgrading plugins
Plugin upgrades can be done manually or through the CloudBees CD/RO upgrade process.
The plugin upgrade process has two steps:
-
Plugin download
-
Plugin promotion
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 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, CloudBees recommends that you rename the plugin to prevent overwriting or loss of modifications when upgrading.
Managing plugins from the command line
Use the 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 the CloudBees CD/RO Perl API documentation.