ARC Modeling Component Description - Jakarta-R10

Page Status: Updated for R9 - Mar 29, 2021 
Component Status: Pending  PTL updates and ArchCom Review

Last Reviewed on:

Certified by:

1 High Level Component Definition and Architectural Relationships 





The etsicatalog project provides package management service and parser service by Micro Service. It can be used to store packages distributed by the SDC, and can be consumed by other projects or components such as UUI, VF-C, etc. It also includes a TOSCA parser service.

2. API definitions

Modeling esticatalog provides the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

etsicatalogAPIE-1

Catalog API

Provide catalog management interface

  • Fetch VNF package from SDC

  • Fetch NS package from SDC

  • Fetch Service package from SDC

  • Search VNF/NS/Service

Wiki page: Etsicatalog API Document


Swagger file:
https://lf-onap.atlassian.net/wiki/download/attachments/16456039/etsicatalog_API.yaml?version=1&modificationDate=1609901842000&api=v2

etsicatalogAPIE-2

NSD Management API

Provide NSD management interface (Align with ETSI SOL005 specification)

  • Create NSD Info

  • Upload NSD

  • Query NSD Info

  • Fetch NSD

  • Delete NSD

  • Create PNFD Info

  • Upload PNFD

  • Query PNFD Info

  • Fetch PNFD

  • Delete PNFD

  • Subscribe & Notify

etsicatalogAPIE-3

VNF Management API

Provide VNF management interface (Align with ETSI SOL003 specification)

  • Create VNF Package Info

  • Upload VNF Package

  • QueryVNF Package Info, include obtaining the VNFD

  • Fetch VNF Package

  • Fetch VNF Package Artifacts

  • Delete VNF Package

  • Subscribe & Notify

etsicatalogAPIE-4

Parser API

Provide Parse interface:

  • Parse VNF

  • Parse PNF

  • Parse NS

  • Parse Service

The current  esticatalog API documents can be found at:

Etsicatalog API Document

Modeling esticatalog consumes the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

Interface Name

Interface Definition

 Interface Capabilities

API Spec (Swagger)

SDCE-6

SDC Interface

Distribution Engine publishes service notification to DMaaP.

ONAP components subscribe to service notification from DMaaP

https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html

SDCE-7

SDC Interface

ONAP components retrieve service models from the Design Catalog

https://docs.onap.org/projects/onap-sdc/en/latest/offeredapis.html

DMaaP-3

DMaaP Message Router Consuming Interface

Provides a message receiving service to the DMaaP user

https://docs.onap.org/en/casablanca/submodules/dmaap/messagerouter/

messageservice.git/docs/offeredapis/offeredapis.html

MSBE-1

Micro Service Bus Interface

An interface for registration and discovery with the ONAP Micro Service Bus

Microservice Bus API Documentation



3. Component Description:

Etsicatalog is a web application based on python3 and Django framework. It is a  standalone microservice which provides:

  • Package Management Service

  • Parser Service

4. known system limitations

Now the component Redundancy and scaling depends on Kubernetes.

5. Used Models

Modeling etsicatalog use the following models:

  •  TOSCA  - VNF Descriptor/NS Descriptor  ETSI NFV SOL001  v2.4.1 & v2.5.1 

6. System Deployment Architecture

Modeling etsicatalog consists of 2 containers:

  • etsicatalog - The Catalog & Parser microservice 

  • etsicatalog-db - The etsicatalog DB service

7. New Release Capabilities

  • Support Container Images Management to CIR ( stretched goal )

  • Improve platform maturity: enhance scalability, manageability, security

8. References