Skip to content

lack of documentation for pre-built plugins #480

@matthieumarrast

Description

@matthieumarrast

Problem

From metwork v1.0, mfdata templates have been replaced by "pre-built" (or pre-released) plugins locaded on directory /opt/metwork-mfdata/share/plugins/ on target installation:

$ ll /opt/metwork-mfdata/share/plugins/
total 168
-rw-r--r--. 1 root root  7876  1 déc.  09:49 amqplistener-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  5347  1 déc.  09:49 archive-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  4658  1 déc.  09:49 copy-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  4511  1 déc.  09:49 delete-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  5140  1 déc.  09:49 fork-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  6056  1 déc.  09:49 ftpsend-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root 10795  1 déc.  09:49 guess_file_type-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  5695  1 déc.  09:49 httpsend-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  4958  1 déc.  09:49 move-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root 64689  1 déc.  09:49 mqttlistener-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  6786  1 déc.  09:49 sftpsend-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  3545  1 déc.  09:49 switch-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  4610  1 déc.  09:49 unbzip2-2.2.0-1.metwork.mfdata.plugin
-rw-r--r--. 1 root root  4608  1 déc.  09:49 ungzip-2.2.0-1.metwork.mfdata.plugin

There is nothing in the documentation about these plugins.
Indeed it is documented how to install a plugin and how to configure it externally but nothing about theses pre-built plugins (ex templates).

Note 1: Most of them need extra configuration.
Note 2: We must provide a way to "make develop" a pre-built plugin.

Proposed solution

In documentation, provide the list of pre-built plugins and the way to install them with command - ex:

plugins.install --new-name ftpsend_temp /opt/metwork-mfdata/share/plugins/ftpsend-2.2.0-1.metwork.mfdata.plugin

Then refer to the chapter for configuring it.

Workaround - Make develop pre-built plugin

plugins.install --new-name ftpsend_temp /opt/metwork-mfdata/share/plugins/ftpsend-2.2.0-1.metwork.mfdata.plugin
bootstrap_plugin.py create my_own_ftpsend
cp ~/var/plugins/ftpsend_temp/main.py ~/var/plugins/ftpsend_temp/config.ini my_own_ftpsend/
plugins.uninstall ftpsend_temp
cd my_own_ftpsend && make develop
## then you can git init, add, commit, push your plugin to a git repository

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions