Skip to content

Latest commit

 

History

History
128 lines (79 loc) · 3.97 KB

README.md

File metadata and controls

128 lines (79 loc) · 3.97 KB
Raw

Build Status Gitter

5GTANGO Transport API (T-API) WIM wrapper

This is a component in SONATA 5GTANGO service platform responsible to manage the interface between MANO and WAN managers implementing TAPI.

T-API plugin is integrated in the Infrastructure Abstraction component and manages WIMs using T-API protocol. It is using an extended version of T-API, that allows the use of flow matching parameters (e.g., match per link-layer address or per IP address). Also, MPLS tags are used for each virtual link.

Installing / Getting started

To install

python -m pip install --upgrade pip setuptools wheel
python setup.py install

To execute it

tng-sp-ia-wtapi

To run it integrated with the rest of SONATA as a docker container:

docker pull registry.sonata-nfv.eu:5000/tng-sp-ia-wtapi
docker run -d --name tng-sp-ia-wtapi registry.sonata-nfv.eu:5000/tng-sp-ia-wtapi

It is recommended to use the quick guide to install the whole SONATA Service Platform.

Developing

Built with

The application is developed in python 3.6 and has subscribing threads assigned to IA-message queue channels, and when a message arrives the attached logic is executed.

The whole list of python libraries uses is included in setup.py:

  • amqpstorm
  • pytest
  • PyYAML
  • requests
  • pycodestyle
  • coloredlogs
  • psycopg2-binary

Prerequisites

It is needed python3.6 It is recommended to have virtualenv installed and setup a workspace separated from the whole system.

Setting up Dev

Setting up a development environment is easy

git clone https://github.com/sonata-nfv/tng-sp-ia-wtapi.git
cd tng-sp-ia-wtapi/

# Optionally setup a virtual environment
virtualenv -p python3 venv
source venv/bin/activate

python -m pip install --upgrade pip setuptools wheel

Building

To install the module (after seting up dev)

python setup.py develop

Deploying / Publishing

tng-sp-ia-wtapi

Versioning

For the versions available, see the link to tags on this repository.

Api Reference

There is no REST API but there are three channels used by plugin to communicate with IA core module:

  • infrastructure.tapi.management.wan.list
  • infrastructure.tapi.service.wan.configure
  • infrastructure.tapi.service.wan.deconfigure

Dependencies

docker (18.x)

Contributing

For contributing to the T-API plugin 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, below).

Licensing

This 5GTANGO component is published under Apache 2.0 license. Please see the LICENSE file for more details.

Lead Developers

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

Reviewers:

Feedback-Channel