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
• Chef Image generation

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

A FIWARE validator for the deployment of chef cookbooks implemented as a service with an OpenStack-native Rest API

A RESTful API for chef cookbook validation

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.chefvalidatorapi.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/fi-ware-chef_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:

chef_validator/cmd/chef-validator-api.py --config-dir etc/chef_validator

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

• OpenStack Keystone server: Used for issuing user tokens for several OpenStack services
• Docker Server: Used for managing the chef server image
• OpenStack Glance server: Used for listing the available virtual machine images
• OpenStack Nova server: Used for deploying the selected virtual machine

The cookbook validation process consists on the following steps:

1. The Client sends a POST request to the service API, containing:

   • The name of the cookbook to be tested
   • The chef supermarket repository from which to obtain the cookbook
   • The virtual machine name for deployment

2. The Server receives the request and takes the following steps:

   • Checks the user permissions to take the next steps by validating against Keystone
   • Downloads the needed cookbook
   • Deploys the selected Virtual Machine image
   • Instructs the Chef Server to deploy the cookbook in the given Virtual Machine
   • Responds to the Client request informing of the status of the validation process

An example client is provided in cmd/chef-validator-client. It can be run with the following command:

chef_validator/cmd/chef-validator-client.py --validator_url=${url_of_the_validator_api} --username=${username} --password=${password} --image=${author/image_name} --cookbook=${cookbook_name}

A default chef-solo image can be automatically generated and uploaded to the glance server with the following command:

chef_validator/cmd/generate_image.py --username=${username} --password=${password} --auth_url={$auth_url} --tag=${author/image_tag} --config-dir {configuration_dir}