Plugin catalogue¶
The plugins of this repository, generated from their READMEs and changelogs
(see docs/hooks.py); the latest release is the topmost version in a
plugin's CHANGELOG.md. Each links to its README, with its settings, parameters,
phases and data transfers. The groups and subgroups are described in
plugins/README.md.
| Plugin ID | Distribution | Latest release | Summary |
|---|---|---|---|
generic.example.noop |
foca-plugin-generic-example-noop |
never | Example plugin that changes nothing: it leaves inbound requests and the candidate backends as they are and records what it saw. It is the template of new plugins (python scripts/new_plugin.py <group> <subgroup> <name>) and is not published. |
generic.routing.random |
foca-plugin-generic-routing-random |
0.1.3 |
Routes requests to the candidate backends in random order, so that they spread over all backends without round-robin state. The successor of proTES's random task distribution. |
tes.data.crypt4gh |
foca-plugin-tes-data-crypt4gh |
not yet released | Decrypts the Crypt4GH inputs of TES tasks, which TES implementations can't read themselves: adds an executor before the task's own ones that decrypts the Crypt4GH inputs with the secret keys among the task's inputs to a volume of its own, points the task's executors to the decrypted files, and adds an executor after them that empties that volume again. The successor of the Crypt4GH middleware of proTES. |
tes.routing.distance |
foca-plugin-tes-routing-distance |
0.1.3 |
Routes TES tasks to the backends closest to their input data: ranks the candidate backends by their distance to the locations of the task's inputs. Locations come from the backend list or from a local GeoIP database (offline, the default); online lookups are an explicit opt-in. The successor of proTES's distance-based task distribution. |
Plugins of other repositories work the same way; they use IDs with a prefix of their own (see Writing a plugin).