sonata-nfv/tng-api-gtw

The API Gateway for the 5GTANGO Verification&Validation and Service Platforms (built on top of SONATA).

5GTANGO API Gateway

This is the 5GTANGO API Gateway for the Verification&Validation and Service Platforms (built on top of SONATA) repository.

Please see details on the overall 5GTANGO architecture here.

How does this work?

This component has the follwoing architecture:

All external requests enter the security gateway, where they are redirected to the adequate port and to the router component, where the request is delivered to the pre-defined component.

For further details on those components, please check their README files

• Security Gateway README;
• Router README.

Versioning

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

Licensing

For licensing issues, please check the Licence file.

Feedback-Channel

• Please use the GitHub issues to report bugs.
• You may use the mailing list [email protected]

tng-api-gtw's Issues

Improve routing capabilities

Now that there's a basic capability of routing input to output, let's improve it

Add fetch single package

Check w/ @peusterm how to deal with process_uuid simultaneously with package_uuid

Complete the README

Do a README-Driven-Design...

Improve integration tests

Integrate with the SLA Manager

Fix logging error

Add fetch multiple packages

Include page and page_size query parameters

Build a configurable router

From user story #225

Define a schema for the routing config file

Add travis support for unit tests

Add /pings API

This endpoint shall provide to it's consumers a list of available endpoints.

This features creates a strong dependency with those modules... a WiP.

Fix build_path (L78)

When the path is not found, [400, {}, ["Error finding GET"]] is being returned, instead of raising an exception

Improve Travis

Improve logging

Currently still going to a file, we want it in the STDOUT (STDERR)

Add rake to support format tests

Redirect /functions endpoint route to tng-gtk-common

Was to tng-gtk-sp

Include current versions of User Management, Rate limiter and KPIs

Fix path translation

.../api/v3/packages/status/1234... is not being correctely translated into .../packages/status/1234...

Improve file management (for bigger files)

Include an NGINx webser

Default base_path to empty string

Create the vnv_routes.yml file

Provide integration tests for package uploading

The feature is developed, we need to test it's integration

Include a default root router

Validate users' tokens

Depends on #32

Integrate with the Slice Manager

To create an NST do this:

curl -i -H "Content-Type:application/json" -X POST -d'{"name":"Rubik_NST", "version":"<version_number>", "author":"<author_name>", "vendor":"<vendor_name>", "nstNsdIds":[{"NsdId":"<network_service_ID>"}]}' pre-int-sp-ath.5gtango.eu:32002/api/nst/v1/descriptors

Valid NST example:

{
  "designer": "Pol",
  "id": "30ef541d-24ee-4ec3-8c00-f53b4a3791cb",
  "name": "Rubik_NST",
  "notificationTypes": "",
  "nstNsdIds": [
    "6a01afdc-9d42-4bc9-866c-a8a3868fdf5e"
  ],
  "onboardingState": "ENABLED",
  "operationalState": "ENABLED",
  "usageState": "NOT_IN_USE",
  "userDefinedData": "",
  "vendor": "5gTango",
  "version": "1.0"
}

Check why is passing parameters failing

E.g., http "pre-int-vnv-bcn.5gtango.eu:32002/api/v3/packages?name=ns-package-example&vendor=eu.5gtango&version=0.1" returns []

Integrate with SLA Manager (agreements endpoint)

tng-sla-mgmt/api/slas/v1/agreements/
GET and DELETE

Add /functions API

• update the README
• write integration tests

Provide /users API

Depends on #32

Design, implement and test an API key mechanism

Depends on #32. Current implementation gives modules/mico-services the same mechanism as human users: a token that expires with time. This is not practical: we want users to be able to generate API tokens that can be used without such time restrictions. The user can renew his/her API keys in the Portal or through the API (with the old key). These API tokens can then be used to authenticate/authorize the user's module (e.g., SDK, OSS, ...) to access the V&V/SP.

Include Slice Manager routes

According to the 2018-03-12 call:

• POST /descriptors (where JSON object is a nst_content)
• GET /descriptors/{nstId}
• DELETE /descriptors/{nstId}
• POST /nsi
• GET /nsi
• GET /nsi/{nsiId}
• DELETE /nsi/{nsiId}
• POST /nsi/{nsiId}/terminate

Extract son-gtkusr from son-gkeeper

Extract son-gtkusr from son-gkeeper, as well as its dependencies, to be used here.

Integrate with Policy Manager

Add a /tests route

Include /files endpoint documentation

Include package download test

Add a /records/services and a /records/functions route

These two need to be distinguished from the later to be added /records/test-results

Update VnV routes

• add /services andpoint
• use /api/v1 (instead of v3)

Add /services API

Add OPTIONS method

The Portal needs the options method. In SONATA we did the following:

    options '/?' do
      response.headers['Access-Control-Allow-Origin'] = '*'
      response.headers['Access-Control-Allow-Methods'] = 'POST,PUT'      
      response.headers['Access-Control-Allow-Headers'] = 'Content-Type, Access-Control-Allow-Headers, Authorization, X-Requested-With'
      halt 200
    end

Add OPTIONS to /requests route

Add an /options endpoint to the SLA templates

Include a /requests route

Include file saving on GETs

Provide a list of roles as a service

developer, customer or admin are currently hard-coded, and shouldn't

Create the Jenkinsfile

Integrate with SLA Manager (management endpoints)

Consider this endpoint: curl -H "Content-type:application/json" http://localhost:8080/tng-sla-mgmt/api/slas/v1/mgmt/guaranteesList

Add package uploading status query

Endpoint agreed with @mpeuster: …/packages/status/:process_uuid (sonata-nfv/tng-sdk-package#49 and sonata-nfv/tng-gtk-common#22)

Provide /sessions API

Depends on #32