Manage plugins

Rudder is an extensible software. The Plugins menu sums-up information about loaded plugins, their version and their configuration. 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 plugins with a subscription

First, you need to configure your Rudder technical account (username and password) in /opt/rudder/etc/rudder-pkg/rudder-pkg.conf.

[Rudder]
url = https://download.rudder.io/plugins
username = USERNAME
password = PASSWORD

Plugin management uses the rudder package command. Start by updating the repository index:

rudder package update

Then download your licenses:

rudder package licenses

List available packages:

rudder package list --all

You can then install a plugin with:

rudder package install <package_name>

The application will restart if necessary. Please read install output carefully as some plugins require additional dependencies.

To update a plugin, refresh repository index with rudder package update and run the install command again.

You will need to update your licenses with rudder packages licenses before their expiration. An alert will appear in Rudder’s menu bar when a license is close to expiration.

Install plugins without a subscription

Plugin management uses the rudder package command. You need to download the .rpkg package file of the plugin on your Rudder server, then install it with:

rudder package install-file <package.rpkg>

To update a plugin, you need to reinstall it with the same command, but in the newer version.

More about plugins

A plugin is an .rpkg file (for "Rudder package"), see the dedicated documentation for more information about the format.

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 manage installed plugins with:

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

See all available commands with:

rudder package --help

Summary of binary compatibility for Rudder 6.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.5

< 6.0.3

1.6

>= 6.0.3

auth-backend

Rudder

1.3

< 6.0.3

1.4

>= 6.0.3

branding

Rudder

1.4

< 6.0.3

1.5

>= 6.0.3

centreon

Rudder

1.1 - 1.2

All Versions

change-validation

Rudder

1.4

< 6.0.3

1.5

>= 6.0.3

create-node-api

Rudder

1.1

< 6.0.3

1.3

>= 6.0.3

cve

Rudder

0.2

>= 6.0.3

datasources

Rudder

1.6

< 6.0.3

1.7

>= 6.0.3

dsc

Rudder

1.17

>= 6.0.3

glpi

Rudder

1.1

All versions

node-external-reports

Rudder

1.6

< 6.0.3

1.7

>= 6.0.3

notify

Rudder

1.0

All versions

reporting

Rudder

1.3

>= 6.0.3

scale-out-relay

Rudder

1.2

< 6.0.3

1.3

>= 6.0.3

user-management

Rudder

1.5

< 6.0.3

1.6

>= 6.0.3

vault

Rudder

1.1

All versions

zabbix

Rudder

1.0

All versions


← Integrate Rudder thanks to its APIs Install plugins with a subscription →