ETSI Catalog Management

<<Note: this is a working draft. The contents will be added/deleted/corrected/updated as needed.>>

Use Case

• ETSI Catalog Manager Use Case
  • ETSI Catalog API Manager
  • ETSI Catalog Database
• SO ETSI Catalog Management
  • SDC - SO SDC Controller - ETSI Catalog Manager
• SOL003/SOL005 Adapter Interaction with ETSI Catalog Manager

Feature Descriptions

Epic and User Story

SO ETSI Catalog DB Support for NS, VNF and PNF Packages

For the ETSI package storage, SO does the following:

• SO (SDC Controller component) queries the package from SDC
• SO stores ETSI (including SDC AID DM) + vendor VNF package CSAR or ZIP
  • If the onboarding vendor package is a zip file with signature and certificate, SO stores the vendor VNF package as a zip format.
  • Not all VNFD needs to be transformed to the SDC AID DM - TBD
• For Non-ETSI models (Service + Non-ETSI Resource), SO will use the existing SO embedded Catalog DB

Instead of building ETSI Catalog management in SO, SO will leverage the existing ETSI Catalog Manager function.

• Use VF-C Catalog Microservices for the NS, VNF and PNF catalog support, https://wiki.onap.org/pages/viewpage.action?pageId=63996543
  • VFC Catalog Manager function consists of two microservices: VF-C DB and VF-C Catalog. Deployment of these microservices is independent of VF-C, and the microservices have no dependency on other VF-C components – a good stepping stone towards common ETSI Catalog management
  • VFC Catalog Manager will be enhanced to handle the vendor package in the ONBOARDING_PACKAGE directory.

1. VF-C Catalog DB Microservice

• Database: nfvocatalog (vfc-nfvo-catalog-createdb.sql // create db scripts)
• Database Table (vfc-nfvo-catalog-createobj.sql // create tables scripts)
• Catalog_NSPackage
• Catalog_VNFPackage
• Catalog_PNFPackage
• Catalog_SoftwareImageModel

2.VF-C Catalog (API) Microservice

• vfc-catalog docker
• VFC Catalog REST APIs

  • The following APIs are part of VF-C Swagger REST APIs. For the complete ApIs, https://docs.onap.org/en/latest/_downloads/0fea611e8b07fb4042e1a66ce202898c/CATALOG_API_Specification_v1.json

    NS Package Management	VNF Package Management	PNF Management
    •GET /nspackages                             // query NS package info •POST /nspackages                           // NS package distribute / create •GET /nspackages/{csarId}              // query NS package info •DELETE /nspackages/{csarId}        // delete NS package	•GET /vnfpackages                        //query vnf package info •POST /vnfpackages                      // vnf package distribute / create •GET /vnfpackages/{csarId}         // query vnf package info •DELETE /vnfpackages/{csarId}   // delete vnf package •PUT /vnfpackages/{csarId}.        // create/upload vnf package	•GET /pnf_descriptors •POST /pnf_descriptors •GET /pnf_descriptors/{pnfdInfoId} •DELETE /pnf_descriptors/{pnfdInfoId}
    Model Parsing	Job Management (used for async LCM)	More…
    •POST /parsernsd                             // NS package model •POST /parservnfd                            // VNF package model	•GET /jobs/{jobId}                         // Job Status •POST /jobs/{jobId}                       // Update Job Status	•

The following diagram depicts a possible ETSI Catalog DB handling for NS, VNF and PNF Packages.

• SDC Stores Service models/templates into the existing SO Catalog DB, and ETSI Catalog will be stored in the ETSI Catalog Manager database. 
• Note: the ETSI Catalog Manager function could be realized by the VFC (or equivalent) ETSI Catalog API and ETSi Catalog DB Microservices - To be discussed further.
  • VF-C DB and Catalog are two Microservices, which they can be deployed independently from VF-C, and they don't have dependency with other VF-C components.
  • SO and other ONAP run-time components could leverage the ETSI Catalog Manager function, as a common service.

• ETSI Catalog Manager Interfaces
  • Supports its NBI for create and update ETSI catalog. SDC Controller will uses the NBI.
  • Retrieves model artifact files from SDC
  • Stores the data to the ETSI Catalog DB.
  • Supports its Query operations for SOL003/SOL005 Adapters

SO Package Management ( SDC - SO SDC Controller - ETSI Catalog Manager)

• SO SDC Controller module (ASDCController and ToscaResourceInstall) needs to be updated for handling SOL004 packages including SOL001 VNFD and PNFD.
• Service-level catalog and other non-ETSI catalog (SDC AID DM) will be stored in SO Catalog DB.
• VNF/PNF/NS-level catalog handling would be simplified:
  • By using the ETSI Catalog Manager, ETSI VNF/PNF/NS-level catalogs (i.e., original vendor packages) will be stored in ETSI Catalog DB
  • SO itself does not need to manage ETSI-based VNF LCM; i.e., delegates the LCM to VNFM through the SOL003 VNFM Adapter
• In Frankfurt, VNF package management will be supported.
• The following diagram depicts the component interactions for VNF Package store for ONAP runtime.

• Interfaces between SDC Controller and ETSI Catalog Manager

• ETSI Catalog Manager POST API will be used to store the VNF packages
  • POST /api/catalog/v1/vnfpackages // passing csarId, vimIds and labVimId

• SO Catalog Model

<describe relationship/association between the existing SO catalog database (service catalog, VNF catalog , Vnf_Resource_customization) and the ETSI Catalog database > 

• Q&A:
  • How does VFC handle VNF packages from SDC? Does it use SDC AID DM? Does it use VF-Modules?
  • Answer:
    • VF-C supports SDC internal models with the original vendor package and ETSI-based VNF package
    • Currently, no VF-Module support from VF-C and SOL003 VNFM Adapter
    • VF-Module mapping and handling need to be sorted out.

SO Catalog Modelling

• The service database table has TOSCA_CSAR_ARTIFACT_UUID column. We continue to use this column to link the TOSCA CSAR.
• The TOSCA_CSAR database has a logical relationship with Catalog_NSPackage, Catalog_PNFPackage and Catalog_VNFPackage.
  • When a record is entered in the TOSCA_CSAR,
    • if the CSAR artifact type is NS, add a NS package into Catalog_NSPackage
    • if the CSAR artifact type is VNF, add a VNF package into Catalog_VNFPackage
    • if the CSAR artifact type is PNF, add a PNF package into Catalog_NSPackage
• For the SOL004 VNF onboarding into SO,
  • SO does not populate data info the VF-Module database table if the VF-Module is not populated in the modeling.
    • It depends on the SOL001 VNFD mapping to SDC AID DM whether it populates VF-Modules or not.
  • SO does not populate data into the HEAT-Template database table
    • Heat-Template is part of the VNF package
  • SO invokes the ETSI Catalog Manager APIs with the CSAR UUID.
  • The ETSI Catalog Manager receives VNF packages and stores them into the ETSI Catalog Database Catalog_VNFPackage
    • It stores the VNF package as a whole and its APIs can extract the VNFD, artifacts, softwareImage, etc.

• SO Catalog models and relationships are as follows:
  • Note: the relationship between TOSCA_CSAR and Catalog_NSPackage/Catalog_VNFPackage/Catalog_PNFPackage is logical since the Catalog_***Package will be resided in the ETSI Catalog DB.

ETSI Catalog Manager - SOL003/SOL005 Adapter

As the diagram depicts, ETSI Catalog Manager consists of two microservices:

• ETSI Catalog API
• ETSI Catalog DB

• Interfaces between ETSI Catalog Manager and SOL003/SOL005 Adapters

• ETSI Catalog Manager provides RESTful services to Adapters:
  • ETSI package management for the Adapters.
    • GET /api/catalog/v1/vnfpackages/{csarId}

• • • Need to pass artifacts (images) to VIM thru the Adapter
    • Get the original vendor VNF package
  • Retrieving VNFD for SOL003 Adapter
  • Retrieving NSD/VNFD for SOL005 Adapter
    • GET /nspackages/{csarId} // query NS package info
    • More SOL005 Adapter requirements are being collected.