Plugin setup

This guide allows you to deploy a REGARDS backend plugin thanks to your inventory.

info

When a REGARDS microservice boots, it scans on the disk for plugins (jar files) to make them available on the service.
You need to configure the plugin to make it usable.

Inventory configuration

To deploy a plugin, you need to add the image name and tag inside group_docker_plugins:

# Plugins
group_docker_plugins:
  - image: <a plugin image name>
    tag: <a plugin image tag>
  - image: <another plugin image name>
    tag: <another pluginimage tag>
  - ...

If you want to add the aip-datasource plugin to allow the microservice DataManagement to crawl OAIS products, you need to add the image plugin in the group_docker_plugins property, like this:

# Plugins
group_docker_plugins:
  - image: rs-aip-datasource-plugin
    tag: "{{ group_docker_tags.plugins }}"

Plugin list

The documentation of every microservice list all available OSS plugins and their image name.
Here is some examples:

• rs-dam or DataManagement plugins
• rs-notifier plugins
• rs-ingest plugins
• rs-catalog plugins
• ...

Activate a plugin

To activate a plugin, you need to run the playbook:

# cd regards-docker/
ansible-playbook -i inventories/<inventory name> regards.yml <additional parameters>

This task will copy the plugin on the disk.

If your service did not reboot after the deployment, you need to reboot the service:

# go to cli folder, then run the folowing command:
./status.sh
# if the service did not reboot, run the folowing command:
./reboot.sh <name of the service>

Remove all plugins

To remove all plugins, first shutdown REGARDS. Then you need to run the playbook:

# cd regards-docker/
ansible-playbook -i inventories/<inventory name> regards-delete-plugins.yml <additional parameters>

Install or update all plugins

There is a direct Ansible task that copy all plugins:

# cd regards-docker/
ansible-playbook -i inventories/<inventory name> regards-plugins.yml <additional parameters>