Usage documentation

This page has the usage documentation of the Gatekeeper module of the SONATA Platform.

The son-gkeeper REST API endpoints are coded in these files. The following pages give the details of the implemented REST API.

The base URL used throughout this documentation (<base URL> from here on) is in the form of http://<service platform url>/api/v2.

• Authentication
• Packages
• Services
• Functions
• Records
• Requests
• VIMs/WIMs
• KPIs
• Licences
• Administration

Build and install

Install

Installing the Gatekeeper is really easy. You'll need:

1. the ruby programming language: we prefer doing this by using a version manager tool such as rvm or rbenv (we are using version 2.2.3);
2. in each one of the subfolders, just run:
3. bundle install
4. please follow each specific folder's instructions on which environment variables to set
5. foreman start

Installation can also be done using son-install.

Configuration

In the ruby modules, configuration is in a services.yml (or services.yml.erb) file (e.g., this one), in the config folder of each one of the modules. The exception is the Licence Management module, built in python, which has that configuration in the settings.py file, at the root of the module.

Needed ENV variables are also set in each one of the module's Dockerfile (e.g., this one from the Gatekeeper's API).