This skeleton plugin has been created as a starting point for the process of creating a new plugin for the Nanowire platform. The Nanowire platform provides the pipeline, controller and panel for data processing however the data processing is performed by plugins that interact with Nanowire through an API. The plugins that ship with Nanowire are created by Spotlight Data however you can create your own plugins in order to extend or repurpose the platform to your needs. We currently support creating plugins for: python, node
- Installation:
yarn install - Build:
yarn build - Tests:
yarn test
- Change name field in nanowire.json and package.json to the name of your repository
- Update description inside nanowire.json
- Update this readme
The plugin needs the following enviroment variables set:
| Variable name | Expected Value |
|---|---|
| POD_NAME | The name of the kubernetes pod or just a random string to identify this particular instance of the plugin running |
| PLUGIN_ID | The ID of the plugin as stored in the nanowire database. This is used to fetch the next plugin |
| CONTROLLER_BASE_URI | The URI of the controller. You may have to port forward the controller from nanowire's kubernetes cluster if you want to test with the live system |
The src directory has two files. index.js contains basic nanowire library setup and processMessage.js contains a function processMessage which will be run whenever a task appears in the queue for this plugin.