4.3.2. Managing plugins

Warning

This feature is currently in alpha.

4.3.2.1. Enabling your plugin

To enable worker plugin behaviour, the enable_plugins setting needs to be set to true in the /etc/ngenea/ngenea-worker.conf file

enable_plugins=true

By default, this setting will be false

After plugins have been created, they can be managed using the following scripts.

4.3.2.2. Installing your plugin

All the plugins that have been created within /var/lib/ngenea-/worker/plugins can be installed through running:

ngenea-worker plugins install

This will install all of the plugin packages within the plugins directory. These packages will not update within the Ngenea Worker unless it has had a version number increase in the setup.py.

Single plugins can also be installed by providing the name of the package explicitly:

ngenea-worker plugins install PACKAGE_NAME

After installing the desired plugins, the Ngenea Worker service will need to be restarted:

systemctl restart ngenea-worker

4.3.2.3. Uninstalling your plugin

Uninstalling any of the plugins can be done through the uninstall script:

Warning

This can remove any modules within the environment that Ngenea Worker runs within, use caution when uninstalling any modules that aren't directly within /var/lib/ngenea-worker/plugins as it could cause Ngenea Worker to not function correctly.

ngenea-worker plugins uninstall <PACKAGE_NAME>

To uninstall all of the modules in the plugin directory it can be done through:

pushd /var/lib/ngenea-worker/plugins/
ngenea-worker plugins uninstall * -y
popd