Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction

CloudBees CD/RO plugins

5 minute readExtensibilityDeveloper productivity

This section provides documentation for plugins currently supported by CloudBees CD/RO. Additionally, on this page, you can find general information about CloudBees CD/RO plugins.

This section only contains documentation specifically for using supported plugins. For information about:

Find a plugin

This section documents currently supported plugins. Search for specific plugin documentation using the Filter in the left navigation panel.

If the plugin you are searching for is not found, or you are not sure of the name, you can either:

  • Navigate to CloudBees CD/RO plugins catalog and search the site catalog using general terms and phrases associated with the integration.

    • In plugin’s catalog page, select the Documentation link.

  • To search the CloudBees CD/RO catalog, navigate to DevOps Essentials  Plugin Management  Plugins Catalog to search by specific categories, such as Application Server or Source Code Management.

    • In the CloudBees CD/RO catalog, for the plugin, select More details…​, and then select .

When searching for plugins, you may find the Tier or Support level for the plugin is listed as Community. In this case, the plugin is not currently supported by CloudBees, and the documentation for the plugin is located in its community repository. For more information on community plugins, refer to CloudBees CD/RO plugin support policy.

Find plugin release notes

All plugin releases include a summary of the changes since the last release in the plugin’s release notes. Additionally, all plugins released between CloudBees CD/RO releases are summarized in the CloudBees CD/RO release notes.

To find plugin release notes, you can either search for the plugin in the CloudBees CD/RO plugins catalog, and then select Release Notes on the plugin page, or:

  1. Locate the plugin in the left navigation.

  2. To navigate to the plugin release notes, either:

    • Select the , and then select the <PLUGIN-NAME> plugin release notes page.

    • If the plugin does not have a , select the plugin page, and in the right-side navigation panel, select Release notes.

The plugin release notes section contains a record, from newest to oldest, of the previous releases of the plugin, and changes between each release.

Find bundled plugin information

Bundled plugins are used internally by CloudBees CD/RO to provide critical functions for the platform. They are version-specific and automatically installed when you install or upgrade CloudBees CD/RO.

To get version information for plugins bundled with a specific CloudBees CD/RO release:

  1. Navigate to the CloudBees CD/RO release notes.

  2. Select the release you want to view the bundled plugin report for.

  3. On the main release notes page for the release, select the Plugin release notes tab.

    For CloudBees CD/RO v2023.10.0 and earlier, the bundled plugin report is located in the Bundled plugin report tab.

  4. Navigate to the Bundled plugin report.

The Bundled plugin report includes a list of all bundled plugins for that specific CloudBees CD/RO release, the version of the plugin, and the status of the plugin since the last CloudBees CD/RO release.

Bundled plugin is a term that only applies to delivering a plugin as part of a CloudBees CD/RO release. However, any plugin may be released independent of a CloudBees CD/RO release, and in some cases several times between releases. For more information, refer to Plugin releases.

Plugin releases

In an effort to constantly improve CloudBees CD/RO integration capabilities, most plugin versions are released independent of CloudBees CD/RO releases. When a plugin is released, a New version is available. banner appears on the plugin in the CloudBees CD/RO along with an Upgrade button.

Typically, unless otherwise stated in the plugin documentation, newly released plugins can be immediately upgraded in compatible CloudBees CD/RO versions. For more information on upgrading plugins, refer to Manage plugins.

CloudBees strongly suggests to review all plugin prerequisites before installing new plugins, or release notes before upgrading plugins, on your platform. Plugin prerequisites, if applicable, can be found on the plugin’s main documentation page. For information on finding plugin release notes, refer to Find plugin release notes.

CloudBees CD/RO plugin support policy

This section describes the plugin support policy for CloudBees CD/RO plugins.

Plugin support levels

CloudBees CD/RO classifies plugins into two support levels.

  • CloudBees: These plugins are fully supported by CloudBees.

  • Community: These plugins are not supported by CloudBees. Use them with caution in a given installation because their stability is unknown.

The following table describes how CloudBees supports plugin fixes and features.

CloudBees Community

Bug and security fixes

Yes

Not supported by CloudBees

New features

Subject to CloudBees priorities

Not supported by CloudBees

Verified compatibility

Yes

No

Verified upgrades

Yes

No

If you are having any issues with a CloudBees supported plugin or its documentation, please open a support request using CloudBees support, and select the Product area option including CD.

Differences in plugin UI behavior

Over the years, the CloudBees CD/RO UI and plugin development frameworks have undergone several major changes. When these changes occur, CloudBees attempts to accommodate backward compatibility and continue to support existing automations, where possible.

However, these efforts occasionally result in differences in UI and plugin behavior. These differences are not considered bugs or known issues, since they are typically required implementation decisions and expected behavior. Nevertheless, CloudBees understands how these differences can create uncertainty while you are trying to accomplish tasks.

This section provides information on some common scenarios where the plugin UI may behave differently.

Key terms

CloudBees CD/RO UIs

  • Current UI: The default CloudBees CD/RO UI model used on pages such as Release orchestration  Pipelines.

  • Legacy UI: The UI model used on pages such as DevOps essentials  Platform home page.

Plugin configurations

  • New plugin configurations: Plugin configurations that were created in the current UI. These include the plugin configurations found on DevOps essentials  Plugin management  Plugin configurations.

  • Legacy plugin configurations: Plugin configurations that were created in the legacy UI. To view these configurations for specific plugins:

    View legacy plugin configurations

    1. Navigate to DevOps Essentials  Platform Home page.

    2. Select the Administration link. The Event Logs page displays.

    3. Select the Plugins page link. The Plugins Manager page displays.

    4. Select the name of the plugin name in the Plugin Label column. The Project Details page displays.

    5. Select the Properties tab.

    6. In the property <PluginName>_cfgs, you can find all configurations for the plugin.

    You can migrate your legacy plugin configurations to new configurations, by following Migrate your plugin configurations.

Running plugin procedures

In the current UI, plugin procedures can only be run as part of CloudBees CD/RO objects, such as procedure steps, process steps, and pipeline tasks. However, in the legacy UI, you can run "standalone" plugin procedures directly from the plugin project from either:

  • DevOps essentials  Platform home page  Project  PLUGIN-PROJECT

  • DevOps essentials  Plugin management  Installed plugins  PLUGIN-PROJECT

    There may be differences in the required parameter inputs when running "standalone" plugin procedures. For more information, refer to Differences in plugin configuration parameter input.

Differences in plugin configuration parameter input

When configuring plugin procedure parameters, depending on which CloudBees CD/RO UI you are using, and if you are using a new or legacy plugin configuration, when you set the Input Parameters  Configuration name, there are different behaviors. The following table and notes explain these behaviors.

UI Current UI Legacy UI

New plugin configuration

Dropdown menu with existing new plugin configurations.

Select the plugin configuration from the list.

New plugin configurations do not appear in the dropdown menu.

Provide the full path to the new plugin configuration.1,2

Legacy plugin configuration

Legacy plugin configurations do not appear in the dropdown menu.

Provide the name of the legacy plugin configuration. 2

Dropdown menu with existing legacy plugin configurations.

Select the plugin configuration from the list.

1 You must provide the full path for the new plugin configuration. For example:

/projects/<projectName>/pluginConfigurations/<configName>
▼

2 There is no pre-runtime validation of plugin configuration names or paths. If you fail to provide a valid plugin configuration for the plugin, your plugin configuration will not be found, and cause the plugin procedure to fail.