Alignak - Receiver module for the Web services
Project description
Alignak Web services module
Installation
The installation of this module will copy some configuration files in the Alignak default configuration directory (eg. /usr/local/etc/alignak). The copied files are located in the default sub-directory used for the modules (eg. arbiter/modules).
From PyPI
To install the module from PyPI:
sudo pip install alignak-module-ws
From source files
To install the module from the source files (for developing purpose):
git clone https://github.com/Alignak-monitoring-contrib/alignak-module-ws cd alignak-module-ws sudo pip install . -e
Note: using `sudo python setup.py install` will not correctly manage the package configuration files! The recommended way is really to use `pip`;)
Short description
This module for Alignak exposes some Alignak Web Services:
GET /alignak_map that will return the map and status of all the Alignak running daemons
POST /alignak_command that will notify an external command to the Alignak framework
Installation
From PyPI
To install the module from PyPI:
pip install alignak-module-web-services
From source files
To install the module from the source files:
git clone https://github.com/Alignak-monitoring-contrib/alignak-module-ws cd alignak-module-ws pip install -r requirements python setup.py install
Configuration
Once installed, this module has its own configuration file in the /usr/local/etc/alignak/arbiter/modules directory. The default configuration file is mod-ws.cfg. This file is commented to help configure all the parameters.
To configure an Alignak daemon to use this module:
edit your daemon configuration file
add your module alias value (web-services) to the modules parameter of the daemon
Note that currently the SSL part of this module as not yet been tested!
Bugs, issues and contributing
Contributions to this project are welcome and encouraged … issues in the project repository are the common way to raise an information.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.