Manage plugins

Rudder is an extensible software. The Plugins menu sums-up information about loaded plugins, their version and their configuration.

A plugin is an .rpkg file (for "Rudder package").

Get plugins

There are two types of Rudder pre-packaged plugins:

  • Integration plugins, that allow linking Rudder to other tools (monitoring, inventory, notification, etc.). They are freely available.

  • Advanced features plugins (reporting, validation workflow, etc.) which are part of the Rudder subscription.

To download free plugins or get information about plugins included in the subscription, read the dedicated page on rudder.io.

Install a plugin

To install a plugin, copy the .rpkg file on your server, and run:

/opt/rudder/bin/rudder-pkg install-file <package.rpkg>

You can list currently installed plugins using:

/opt/rudder/bin/rudder-pkg list

You can also enable or disable, or remove a plugin with:

/opt/rudder/bin/rudder-pkg plugin enable <plugin>
/opt/rudder/bin/rudder-pkg plugin disable <plugin>
/opt/rudder/bin/rudder-pkg remove <package>

See all available commands with:

/opt/rudder/bin/rudder-pkg --help

Summary of binary compatibility for Rudder 5.0 branch

This table shows the binary compatibility for plugins with Rudder 5.0 branch.

api-authorization Rudder

5.0-1.3 to 5.0-1.4

any version

auth-backends Rudder

5.0-1.0 to 5.0-1.1

5.0.0 to 5.0.1

5.0-1.2 to current

5.0.2 to current

branding Rudder

5.0-1.2 to current

any version

centreon Rudder

any version

any version

change-validation Rudder

5.0-1.0

5.0.0

5.0-1.1 to current

5.0.1 to current

datasources Rudder

5.0-1.5

any version

glpi Rudder

any version

any version

node-external-reports Rudder

5.0-1.6

any version

notify Rudder

any version

any version

scale-out-relay Rudder

5.0-1.0 to current

any version

user-management Rudder

5.0-1.0 to current

any version

vault Rudder

any version

any version