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, you can use the rudder package command. You can configure it in /opt/rudder/etc/rudder-pkg/rudder-pkg.conf

It can retrieve plugins and their licenses from the Rudder repository.

# Update the repository index
rudder package update

# Download and install the latest release of a plugin
rudder package install-file <package_name>

# Download and install the latest nightly of a plugin
rudder package install-file <package_name> --nightly

# Install a local .rpkg file
rudder package install-file <package.rpkg>

# Download all your license from the plugin repository
rudder package licenses

You can get information about available plugins with:

# List currently installed plugins
rudder package list
# List currently available plugins
rudder package list --all
# List all available versions of a plugin
rudder package search <package_name>
# Display details of a plugin
rudder package show <package_name>

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

rudder package plugin enable <plugin>
rudder package plugin disable <plugin>
rudder package remove <package>

See all available commands with:

rudder package --help

Install your licenses

Some plugins needs a license to work properly. All your licenses are signed with a key (license.key file) and there is one file per licensed plugin (<plugin-name>.license). You may have downloaded them from https://download.rudder.io/plugins/licenses

You need to put all files in /opt/rudder/etc/plugins/licenses folder, if that directory does not exist please create it.

If the plugin is installed, no need to restart Rudder, it will read the new license and check its compatibility immediatly

Summary of binary compatibility for Rudder 5.0 branch

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

Compatibility of plugins was tested with Rudder 5.0.13, so the upper bound of "All versions" is 5.0.13 This does not mean that the plugin is not valid with a newer version, but it has not been tested

aix

Rudder

1.3

All versions

api-authorization

Rudder

1.3 - 1.4

All versions

auth-backend

Rudder

1.0 1.1

< 5.0.2

1.2

>= 5.0.2

branding

Rudder

1.2 - 1-3

< 5.0.6

1.4

>= 5.0.6

centreon

Rudder

1.1 - 1.2

All Versions

change-validation

Rudder

1.0

5.0.0

1.1

5.0.1

1.2

>= 5.0.2

1.3

>= 5.0.6

create-node-api

Rudder

1.0 - 1.1

>= 5.0.6

cve

Rudder

0.1

>= 5.0.6

datasources

Rudder

1.5

< 5.0.6

1.6

>= 5.0.6

glpi

Rudder

1.1

All versions

node-external-reports

Rudder

1.6

All versions

notify

Rudder

1.0

All versions

reporting

Rudder

1.0 - 1.1 - 1.2

>= 5.0.6

scale-out-relay

Rudder

1.0 - 1.1

All versions

user-management

Rudder

1.0 - 1.1

< 5.0.2

1.2

>= 5.0.2

vault

Rudder

1.1

All versions

zabbix

Rudder

1.0

All versions


← Integrate Rudder thanks to its APIs Get plugins →