SONATA's Service Platform Gatekeeper
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
son-gtkapi
son-gtkfnct
son-gtkkpi
son-gtklic
son-gtkpkg
son-gtkrec
son-gtkrlt
son-gtksrv
son-gtkusr
son-gtkvim
son-keycloak
son-sec-gw
tests
.gitignore
Jenkinsfile
LICENSE
README.md
docker-compose.yml
test_levels.md

README.md

Build Status

SON-GKEEPER

This is SONATA's Service Platform Gatekeeper's repository.

The Gatekeeper is the component that implements all the Northbound Interface (NBI) of the Servive Platform.

This NBI provides systems like the son-cli, son-gui and son-bss access to the Service Platform, for features like:

  • accepting new developers' to be part of the contributors of new developed services;
  • accepting new services, in the package format, to be deployed in the platform;
  • validating submited packages, both in terms of file format and developer submitting the package;
  • accepting new service instance requests from customers interested in instantiating a service;
  • following a service performance through automatically monitoring each on-boarded service or function;
  • etc..

Development

This section details what is needed for developing the Gatekeeper.

This repository is organized by micro-service (one folder to one micro-service).

Micro-services currently implemented are the following:

  1. son-gtkapi: the only 'door' to the Gatekeeper, where the API is exposed and requests are validated and dispached to the other micro-services of the Gatekeeper;
  2. son-gtkpkg: where packages are opened, validated and submited to the Catalogues;
  3. son-gtksrv: where requests for services' meta-data are forwarded to the Catalogues and service instantiation requests are sent to the MANO Framework;
  4. son-gtkfnct: where requests for functions' meta-data are forwarded to the Catalogues and requests for function metrics are sent to the Monitoring Framework;
  5. son-gtkvim: through which the GUI accesses VIMs and WIMs configurations;
  6. son-gtkrec: where requests for services' or functions' records are forwarded to the Repositories;
  7. son-gtklic: where Licences' are managed;
  8. son-gtkusr: where all User Management's features are implemented;
  9. son-gtkkpi: where all KPIs' features are implemented;
  10. son-sec-gw: the front-end implementing external secured (HTTPS) access;
  11. son-keycloak: the back-end of the User Management micro-service;
  12. son-gtkrlt: the implemented simple rate limiter;

Most of these micro-services have been implemented using ruby programming language and the sinatra framework. The two exceptions are the son-gtklic, which is implemented in python and son-keycloak, implemented in java (son-sec-gw is just a NGINx fron-end, adequately configured). The only need is that the micro-service to be implemented provides a REST API, whatever the language it is implemented in.

Building

'Building' the Gatekeeper, given the approach mentioned above, is more like 'composing' it from the available micro-services. So:

  • each micro-service is provided in its own container (we're using docker);
  • the Dockerfile in each folder specifies the environment the container needs to work;
  • the docker-compose.yml file in the root of this repository provides the linking of all the micro-services.

Dependencies

The libraries the Gatekeep depends on are the following:

For the micro-services implemented in ruby these dependencies can be checked in each folder's Gemfile.

Contributing

Contributing to the Gatekeeper is really easy. You must:

  1. Clone this repository;
  2. Work on your proposed changes, preferably through submiting issues;
  3. Submit a Pull Request;
  4. Follow/answer related issues (see Feedback-Chanel, below).

Installation

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

Tests

We do three kinds of automated tests:

  • Unit tests, which are done with the RSpec framework (see the ./spec/folder);
  • Integration tests, which are done with a set of shell scripts and the curl command (see the son-tests);
  • White-box tests, which are done by using the ci_reporter gem, generating XML reports by executing the command
$ bundle exec rake ci:all

everytime a pull request is done.

Please see the several levels of tests that may be considered.

Usage

Please refer to the Usage documentation wiki pages for all the usage details.

License

The license of the SONATA Gatekeeper is Apache 2.0 (please see the license file).


Lead Developers

The following lead developers are responsible for this repository and have admin rights. They can, for example, merge pull requests.

Feedback-Chanels

Please use the GitHub issues and the SONATA development mailing list sonata-dev@lists.atosresearch.eu for feedback.