Skip to main content

Alignak REST backend

Project description

This module is an Alignak REST backend
Home-page: http://alignak-backend.readthedocs.org
Author: Alignak team
Author-email: david.durieux@alignak.net
License: GNU Affero General Public License, version 3
Download-URL: https://github.com/Alignak-monitoring-contrib/alignak-backend
Project-URL: Presentation, http://alignak.net
Project-URL: Documentation, http://docs.alignak.net/en/latest/
Project-URL: Source, https://github.com/alignak-monitoring-contrib/alignak-backed/
Project-URL: Tracker, https://github.com/alignak-monitoring-contrib/alignak-backend/issues
Project-URL: Contributions, https://github.com/alignak-monitoring-contrib/
Description: Alignak Backend
===============

*Python Eve REST Backend for Alignak monitoring framework*

.. image:: https://travis-ci.org/Alignak-monitoring-contrib/alignak-backend.svg?branch=develop
:target: https://travis-ci.org/Alignak-monitoring-contrib/alignak-backend
:alt: Develop branch build status

.. image:: https://landscape.io/github/Alignak-monitoring-contrib/alignak-backend/develop/landscape.svg?style=flat
:target: https://landscape.io/github/Alignak-monitoring-contrib/alignak-backend/develop
:alt: Development code static analysis

.. image:: https://coveralls.io/repos/Alignak-monitoring-contrib/alignak-backend/badge.svg?branch=develop&service=github
:target: https://coveralls.io/github/Alignak-monitoring-contrib/alignak-backend?branch=develop
:alt: Development code coverage

.. image:: http://readthedocs.org/projects/alignak-backend/badge/?version=latest
:target: http://alignak-backend.readthedocs.io/en/latest/?badge=latest
:alt: Latest documentation Status

.. image:: http://readthedocs.org/projects/alignak-backend/badge/?version=develop
:target: http://alignak-backend.readthedocs.io/en/latest/?badge=develop
:alt: Development documentation Status

.. image:: https://badge.fury.io/py/alignak_backend.svg
:target: https://badge.fury.io/py/alignak_backend
:alt: Most recent PyPi version

.. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat
:target: http://webchat.freenode.net/?channels=%23alignak
:alt: Join the chat #alignak on freenode.net

.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
:target: http://www.gnu.org/licenses/agpl-3.0
:alt: License AGPL v3


Short description
-----------------

This package is an Alignak Backend.

It is used to:

* manage monitoring configuration (hosts, services, contacts, timeperiods...)

end user (WebUI, alignak-backend-cli, python/php client, curl command line,...) can get, add, edit monitoring configurations elements
inner templating system to easily create new hosts, services, users, ...
Alignak gets this configuration when its arbiter module starts

* manage retention

Alignak saves and loads retention information for checks/hosts/services from the backend

* manage the monitoring live state

Alignak add/update states for hosts and services
end user (webui, command line...) can get these information

* manage the metrics from the checks performance data

Alignak backend automatically send metrics to Graphite / InfluxDB timeseries databases
Alignak backend automatically creates Grafana panels for hosts / services metrics


Installation
------------

From Alignak packages repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

More information in the online Alignak backend documentation. Here is only an abstract...

Debian::

# Alignak DEB stable packages
sudo echo deb https://dl.bintray.com/alignak/alignak-deb-stable xenial main | sudo tee -a /etc/apt/sources.list.d/alignak.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv D401AB61

sudo apt-get update
sudo apt install alignak-backend

CentOS::

sudo vi /etc/yum.repos.d/alignak-stable.repo:
[Alignak-rpm-stable]
name=Alignak RPM stable packages
baseurl=https://dl.bintray.com/alignak/alignak-rpm-stable
gpgcheck=0
repo_gpgcheck=0
enabled=1

sudo yum repolist

sudo yum install python-alignak-backend

From PyPI
~~~~~~~~~
To install the package from PyPI::

sudo pip install alignak-backend


From source files
~~~~~~~~~~~~~~~~~
To install the package from the source files::

git clone https://github.com/Alignak-monitoring-contrib/alignak-backend
cd alignak-backend
sudo pip install .


Documentation
-------------

The Alignak backend documentation is available on `Read the docs <http://alignak-backend.readthedocs.io/en/latest/?badge=develop>`_ or in the */docs* folder of this repository.

To build the doc::

cd docs
python models_to_rst.py
make clear
make html


Release strategy
----------------

Alignak backend and its *satellites* (backend client, and backend import tools) must all have the
same features level. As of it, take care to install the same minor version on your system to
ensure compatibility between all the packages. Use 0.4.x version of Backend import and Backend
client with a 0.4.x version of the Backend.

Bugs, issues and contributing
-----------------------------

Please report any issue using the project `issues page <https://github.com/Alignak-monitoring-contrib/alignak-backend/issues>`_.



Keywords: python monitoring alignak nagios shinken
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: POSIX :: BSD :: FreeBSD
Classifier: Topic :: System
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Description-Content-Type: text/x-rst

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for alignak_backend, version 1.4.14
Filename, size File type Python version Upload date Hashes
Filename, size alignak_backend-1.4.14-py3-none-any.whl (1.2 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size alignak_backend-1.4.14.tar.gz (1.2 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page