plugin-catalog.yaml file reference

plugin-catalog.yaml

This file is only part of CasC controller configuration bundles.

This file contains the plugin catalog definitions that can be installed on the controller. The plugin catalog widens the scope of plugins beyond those defined by CloudBees Assurance Program (CAP). Because the plugins.yaml file only installs plugins within CAP, the plugins-catalog.yaml file can install plugins outside of CAP on the controller. An optional location can also be specified for plugins that are not available in the standard update centers. For more information on plugin catalogs, refer to Install non-CAP plugins with plugin catalogs.

Plugins will not be actually installed to the controller unless they are listed in the plugins.yaml file. Transitive dependencies are not automatically added.

The plugin catalog feature can be also used separately (non-CasC) on CloudBees CI controllers as described in the documentation. However, when using it inside a CasC bundle there are some limitations.

For more information, refer to Plugin catalog limitations in CasC.

Example plugin-catalog.yaml file

The plugin-catalog.yaml file is only part of a CasC bundle for bundles describing a controller configuration.

type: "plugin-catalog"
version: "1"(1)
name: "my-plugin-catalog"
displayName: "My Plugin Catalog"
configurations:
  - description: "Extensions to CAP"
    includePlugins:
      manage-permission:(2)
        version: 1.0.1(3)
      #my-custom-plugin:
        #url: http://www.example.org/jenkins-plugins/my-custom-plugin-1.2.3.hpi
    beekeeperExceptions:
      support-core:
        version: "2.70"▼

1	`version` (required) - must currently have the value 1, which defines the current metadata format for the plugin catalog.
2	Add the `manage-permission` plugin to enable the Overall/Manage permission.
3	Replace 1.0.1 with the most recent version.