fiware-facts 2.8.0

Components

Fiware-Cloto

Fiware-Cloto is part of FIWARE Policy Manager. It provides a REST API to create rules associated to servers, subscribe servers to Context Broker to get information about resources consumption of that servers and launch actions described in rules when conditions are met.

Fiware-Facts

Server to process the incoming facts from Orion Context Broker and publish the result into a RabbitMQ queue to be analysed by Fiware-Cloto. The facts are the result of the server resources consumption.

For more information, please refer to the documentation

Top.

Requirements

• Operating systems: CentOS (RedHat) and Ubuntu (Debian), being CentOS 6.3 the reference operating system.

To install this module you have to install some components:

• Python 2.7

• Fiware-Cloto module (https://github.com/telefonicaid/fiware-cloto)

• Redis 2.9.1 or above

• RabbitMQ Server 3.3.0 or above (http://www.rabbitmq.com/download.html)

• MySQL 5.6.14 or above (http://dev.mysql.com/downloads/mysql/)

Please, be sure you have installed mysql-devel package for development of MySQL applications. You should be able to install it from yum or apt-get package managers.

Examples:

centos$ sudo yum install mysql-devel
ubuntu$ sudo apt-get install mysql-devel

Top.

Installation

Using pip Install the component by executing the following instruction:

$ sudo pip install fiware-facts

This operation will install the component in your python site-packages folder.

Top.

Configuration file

The configuration used by the fiware-facts component is read from the file located at /etc/fiware.d/fiware-facts.cfg.

MySQL cloto configuration must be filled before starting fiware-facts component, user and password are empty by default. You can copy the default configuration file to the folder defined for your OS, and complete data about Cloto MySQL configuration (user and password).

In addition, user could have a copy of this file in other location and pass its location to the server in running execution defining an environment variable called FACTS_SETTINGS_FILE.

Options that user could define:

[common]
brokerPort: 5000       # Port listening fiware-facts
clotoPort:  8000       # Port listening fiware-cloto
redisPort:  6379       # Port listening redis-server
redisHost:  localhost  # Address of redis-server
redisQueue: policymanager
rabbitMQ:   localhost  # Address of RabbitMQ server
cloto:      127.0.0.1  # Address of fiware-cloto
clotoVersion: v1.0
name:       policymanager.facts
maxTimeWindowsize: 10

[mysql]
host: localhost        # address of mysql that fiware-cloto is using
charset:    utf8
db: cloto
user:                  # mysql user
password:              # mysql password

[loggers]
keys: root

[handlers]
keys: console, file

[formatters]
keys: standard

[formatter_standard]
class: logging.Formatter
format: %(asctime)s %(levelname)s policymanager.facts %(message)s

[logger_root]
level: INFO            # Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
handlers: console, file

[handler_console]
level: DEBUG
class: StreamHandler
formatter: standard
args: (sys.stdout,)

[handler_file]
level: DEBUG
class: handlers.RotatingFileHandler
formatter: standard
logFilePath: /var/log/fiware-facts
logFileName: fiware-facts.log
logMaxFiles: 3
logMaxSize: 5*1024*1024  ; 5 MB
args: ('%(logFilePath)s/%(logFileName)s', 'a', %(logMaxSize)s, %(logMaxFiles)s)

Top.

Running with supervisor

Optionally you can add a new layer to manage gunicorn process with a supervisor. Just install supervisor on your system:

$ sudo apt-get install supervisor

Copy the file utils/facts_start to /etc/fiware.d. Make this script executable:

$ sudo chmod a+x /etc/fiware.d/facts_start

Copy the file utils/fiware-facts.conf to /etc/supervisor/conf.d.

Start fiware-facts using supervisor:

$ sudo supervisorctl reread
$ sudo supervisorctl update
$ sudo supervisorctl start fiware-facts

To stop fiware-facts just execute:

$ sudo supervisorctl stop fiware-facts

NOTE: Supervisor provides an “event listener” to subscribe to “event notifications”. The purpose of the event notification/subscription system is to provide a mechanism for arbitrary code to be run (e.g. send an email, make an HTTP request, etc) when some condition is satisfied. That condition usually has to do with subprocess state. For instance, you may want to notify someone via email when a process crashes and is restarted by Supervisor. For more information check also the Supervisor Documentation.

Top.

API Reference Documentation

• FIWARE Policy Manager v1 (Apiary)

Top.

Unit tests

To execute the unit tests you must have a redis-server and a rabbitmq-server up and running. Please take a look to the installation manual in order to configure those components.

After that, you can execute this folloing commands:

$ pip install -r requirements_dev.txt
$ export PYTHONPATH=$PWD
$ nosetests -s -v --cover-package=facts --with-cover

Top.

End-to-end tests

Once you have fiware-facts running you can check the server executing:

$ curl http://$HOST:5000/v1.0

Where:

$HOST: is the url/IP of the machine where fiware facts is installed, for example: (policymanager-host.org, 127.0.0.1, etc)

The request before should return a response with this body if everything is ok:

{"fiware-facts":"Up and running..."}

Please refer to the Installation and administration guide for details.

Top.

Acceptance tests

All detailed documentation about acceptance tests can be consulted in FACTS Acceptance Test Project

Requirements

• Python or newer (2.x).

• pip.

• Virtualenv.

• FIWARE Facts.

Environment preparation

1. Create a virtual environment somewhere:

   $ virtualenv $WORKON_HOME/venv

2. Activate the virtual environment:

   $ source $WORKON_HOME/venv/bin/activate)

3. Go to $FACTS_HOME/tests/acceptance folder in the project.

4. Install the requirements for the acceptance tests in the virtual environment:

   $ pip install -r requirements.txt --allow-all-external)

Execution

Execute the following command in the acceptance test project directory:

$ cd $FACTS_HOME/tests/acceptance
$ behave features/component --tags ~@skip

Before executing, you shoud configure properly the project settings file in $FACTS_HOME/tests/acceptance/settings/settings.json. Take a look at the FACTS Acceptance Test Project documentation.

Top.