fiware-cloto 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 7 the reference operating system.

Software dependencies:

• Python 2.7

• PyClips 1.0 (http://sourceforge.net/projects/pyclips/files/)

• 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/)

• pip 7.0.0 or above (https://pip.pypa.io/en/stable/installing/)

• gcc-c++ and gcc libraries

This module also needs the installation of these other components:

• Fiware-facts module installed (https://github.com/telefonicaid/fiware-facts)

• A running instance of Orion Context Broker v0.28 (https://github.com/telefonicaid/fiware-orion/releases/tag/0.28.0)

• Fiware-monitoring connected to the Orion instance to provide information about servers (https://github.com/telefonicaid/fiware-monitoring).

Top.

Pre-Installation

You must create a database named cloto in your MySQL server before installing this component.

In addition, be sure you have installed MySQL development libraries and tools (using package managers such as yum or apt-get):

centos$ sudo yum install mysql-devel
ubuntu$ sudo apt-get install mysql-client libmysqlclient-dev

Top.

Configuration file

The configuration used by this component is read from the file located at /etc/fiware.d/fiware-cloto.cfg, unless otherwise specified by environment variable CLOTO_SETTINGS_FILE.

MySQL settings of this configuration must be adjusted before starting the fiware-facts component (for instance, user and password are empty by default): please check section [mysql].

A sample configuration file may include the following (see default here):

[openstack]
# OPENSTACK information about KEYSTONE to validate tokens received
OPENSTACK_URL: http://cloud.lab.fi-ware.org:4731/v2.0
ADM_USER:
ADM_PASS:
ADM_TENANT_ID:
ADM_TENANT_NAME:
USER_DOMAIN_NAME: Default
AUTH_API: v2.0

[policy_manager]
SECURITY_LEVEL: LOW
SETTINGS_TYPE: production
DEFAULT_WINDOW_SIZE: 5
MAX_WINDOW_SIZE: 10
LOGGING_PATH: /var/log/fiware-cloto

[context_broker]
CONTEXT_BROKER_URL: http://130.206.115.92:1026/v1
# Public IP of fiware-facts module
NOTIFICATION_URL: http://127.0.0.1:5000/v1.0
NOTIFICATION_TYPE: ONTIMEINTERVAL
NOTIFICATION_TIME: PT5S

[rabbitmq]
# URL Where RabbitMQ is listening (no port needed, it uses default port)
RABBITMQ_URL: localhost

[mysql]
DB_CHARSET: utf8
DB_HOST: localhost
DB_NAME: cloto
DB_USER:
DB_PASSWD:

[django]
DEBUG: False
DATABASE_ENGINE: django.db.backends.mysql
ALLOWED_HOSTS: ['127.0.0.1', 'localhost']
### Must be a unique generated value. keep that key safe.
SECRET_KEY: TestingKey+faeogfjksrjgpjaspigjiopsjgvopjsopgvj

[logging]
level: INFO

Top.

Installation

Once pre-installation requirements are satisfied, please install fiware-cloto package from PyPI repository:

$ sudo pip install fiware-cloto

Running with supervisor

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

centos$ sudo yum install supervisor
ubuntu$ sudo apt-get install supervisor

Copy the file utils/cloto_start to /etc/fiware.d and ensure it has execution permissions:

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

Then copy the file utils/fiware-cloto.conf to /etc/supervisor/conf.d and start fiware-cloto using supervisor:

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

To stop fiware-cloto just execute:

$ sudo supervisorctl stop fiware-cloto

NOTE: Supervisor provides an “event listener” to subscribe to the so-called “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

Download source code from github

$ git clone https://github.com/telefonicaid/fiware-cloto.git

To execute the unit tests, you must set the environment variable pointing to the settings_test file. Then you can use coverage to execute the tests and obtain the percentage of lines coveved by the tests. You must execute the tests from project folder fiware-cloto. Once you were inside the right location, execute the required commands:

$ export DJANGO_SETTINGS_MODULE=fiware_cloto.cloto_settings.settings_tests
$ export CLOTO_SETTINGS_FILE=$PWD/fiware_cloto/cloto_settings/fiware-cloto.cfg
$ python fiware_cloto/manage.py test

Top.

End-to-end tests

There are two ways to check that fiware-cloto is up and running:

The first one does not need authentication and you will get the server details:

$ curl -v -H 'X-Auth-Token: $AUTH_TOKEN' http://$HOST:8000/v1.0/$TENANT_ID/

Response should be similar to:

{
    "owner": "Telefonica I+D",
    "doc": "http://docs.policymanager.apiary.io",
    "runningfrom": "16/02/03 16:16:27",
    "version": "2.3.0"
}

The second one need authentication. You can execute a GET request similar to:

$ curl -v -H 'X-Auth-Token: $AUTH_TOKEN' http://$HOST:8000/v1.0/$TENANT_ID/

Where:

• $AUTH_TOKEN: is a valid token owned by the user. You can request this token from keystone.

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

• $TENANT_ID: is a tenantId of the user, for example: 6571e3422ad84f7d828ce2f30373b3d4

The response should be similar to:

{
    "owner": "Telefonica I+D",
    "doc": "http://docs.policymanager.apiary.io",
    "runningfrom": "16/02/03 16:16:27",
    "version": "2.3.0"
    "windowsize": 10
}

Please refer to the Installation and administration guide for details.

Top.

Acceptance tests

Requirements

• Python 2.7

• pip 7.0.0 or above (https://pip.pypa.io/en/stable/installing/)

• virtualenv installed (pip install virtalenv)

• Git installed (yum install git-core / apt-get install git)

Environment preparation:

• Create a virtual environment somewhere, e.g. in ENV (virtualenv ENV)

• Activate the virtual environment (source ENV/bin/activate)

• Change to the test/acceptance folder of the project

• Install the requirements for the acceptance tests in the virtual environment (pip install -r requirements.txt –allow-all-external).

• Configure file in fiware_cloto/cloto/tests/acceptance/commons/configuration.py adding the keystone url, and a valid, user, password and tenant ID.

Tests execution

Change to the fiware_cloto/cloto/tests/acceptance folder of the project if not already on it and execute:

$ behave

In the following document you will find the steps to execute automated tests for the Policy Manager GE:

• Policy Manager acceptance tests

Top.