Moonner

Moonner is a Runner management server. It provides methods to distribute tasks to multiple runners, authentificate them and receive computed data.

It uses an OAuth protocol to be used for the Runner authentication. For configuration and storage, we use the following librairies:

• moonauth : OAuth Management for Node
• express : To manage HTTP requests
• mongoose : To store data for Tasks and Runner list
• moontils-config : To read setup configuration

How to use it

Install it with NPM: npm install --save moonner

Simply require the library when you need it, it provides the same instance accross all your project files: import Moonner from 'moonner'

You must setup at least one time the lib by calling: Mooner.setup(config) (only the first call is processed)

You can after:

• Mount the Runner endpoint: app.use(Moonner.runnerEndpoint())
• Get the TaskManager : const manager = Moonner.getTaskManager()
  • Add a task : manager.addTask(uuid, type, data, prefferedRunner)
  • Cancel a task (prior distribution): manager.cancel(uuid)
  • Retrieve the Task object: manager.get(uuid)
• Get the RunnerManager: const manager = Moonner.getRunnerManager()
  • List runners : manager.list()
  • Remove a runner: manager.remove(id)

All methods returns Promise objects.

License

This library is distributed under the X11 license (MIT):

Copyright © 2017, Moonkey SAS

Permission is hereby granted, free of charge, to any person obtaining 
a copy of this software and associated documentation files (the “Software”), 
to deal in the Software without restriction, including without limitation 
the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included 
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the Moonkey SAS shall not 
be used in advertising or otherwise to promote the sale, use or other 
dealings in this Software without prior written authorization from the 
Moonkey SAS.