Table of Contents

• Description
• Features Implemented
• Installation Manual
• Installation Verification
• User Manual
• API Documentation
• License
• Getting Started
• Installing Dependencies
• Executing the listener API
• External Dependencies
• Validation Process
• Example Client
• Image generation

This project is part of [FIWARE] (http://fiware.org).

A FIWARE validator for testing deployment artifacts implemented as a Web UI/Restful API pair.

A RESTful API for deployment artifacts validation A backbone.js based WebUI for FIWARE Lab user interaction.

The installation manual is provided in rst format in the Installation and Administration manual

The sanity check procedures are detailed in the Installation and Administration manual

The user manual is provided in rst format in the User and Programmers manual

The API definition can be found at http://docs.uservalidatorapi.apiary.io/#

Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0

To run the code you can clone the git repo with:

git clone git@github.com:ging/fiware-validator.git

To install package dependencies you must run:

pip install -r requirements.txt

The listener api can be manually launched with the following command:

validator_api/manage.py <<URL:PORT>>

The listener api can be manually launched with the following command:

validator_webui/manage.py <<URL:PORT>>

The system deployment depends on several external services for successful completion. The dependency list reads as follows:

• FIWARE Identity Manager: Used for issuing user tokens for several OpenStack services
• Docker Server: Used for managing the chef server image

The validation process consists on the following steps:

1. The User interacts with the WEB UI, indicating:

   • Authentication credentials.
   • Github Reposity to get a new deployment artifact.
   • Deployment artifact placed in current server user Git repository.
   • Desired Operating System against which to validate.

2. The WEB UI sends a POST request to the service API, containing all the pertaining data.

3. The API receives the request and takes the following steps:

   • Checks the user permissions to take the next steps by validating against the IdM
   • Downloads the needed dependencies
   • Deploys the selected container image
   • Instructs the Deployment Server to deploy the artifact in the given container
   • Responds to the Client request informing of the status of the validation process

4. The User can also choose to upload the validated artifact to the official Github project repository.

All available dockerfile-based images can be generated by calling the RESTful command

http://<<API_URL>>:<<API_PORT>>/images/refresh