Page History

...

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

...

• 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 ONAP-ETSI Catalog managementVFC Catalog Manager will be migrated as a common has been migrated as a common component, ETSI Catalog Manager Hereinafter, it is called as "ETSI Catalog Manager"
  • ETSI Catalog Manager will be has been enhanced to handle the vendor package in the ONBOARDINGONBOARDED_PACKAGE directory.

1. ETSI Catalog DB Microservice

...

• vfc-catalog docker                 // vfc prefix should be generalized
• ETSI Catalog Manager REST APIs
  • ETSI Catalog Manager provides the following Package Management and Package Notification APIs:
    • Package Management:

      • View file
        name etsicatalog.swagger.json height 250

    • Package Management Notification:

      • View file
        name etsicatalog.swagger.notification.json height 250

  • API descriptions

    NS Package Management	VNF Package Management	PNF Management
    •GET /nspackages                             /

    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	•

    
    

...

• SDC Stores Service models/templates into the existing SO Catalog DB, and ETSI model will be stored in the ONAP-ETSI Catalog Manager database. 
• Note: SO and other ONAP run-time components could leverage the ONAP-ETSI Catalog Manager function, as a common service.
• Note: in the Frankfurt release, SOL005 Adapter does not support ETSI package management. It is supposed to support the NS package management in Guilin.

• ONAP-ETSI Catalog Manager Interfaces:
  • Supports its NBI for create and update ONAP-ETSI catalog. SDC Controller will uses the NBI.
  • Retrieves model artifact files from SDC
  • Stores the data to the ONAP-ETSI Catalog DB.
    • Supports its Query operations for SOL003/SOL005 Adapters
    • • For now, both SDC AID DM and original vendor package will be stored
    • Supports its Query operations for SOL003/SOL005 Adapters
      • The Catalog Manager will provide the original vendor packages to SOL003/SOL005 Adapters

  SO Package Management ( SDC - SO SDC Controller - ONAP-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 ONAP-ETSI Catalog Manager, ETSI VNF/PNF/NS-level catalogs (i.e., original vendor packages) will be stored in ONAP-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 and NS package management will be supported.
  • The following diagram depicts the component interactions for VNF Package store for ONAP runtime.

  ...

  • 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 and Catalog_Softwareimage will be resided in the ONAP-ETSI Catalog DB.
    • Based on the CSAR UUID, the ONAP-ETSI Catalog Manager gets all the artifacts and files from SDC to fulfill the Catalog_***Package and Catalog_Softwareimage.fulfill the Catalog_***Package and Catalog_Softwareimage.

  
  

  PlantUML Macro
  type dot
  @startuml ' hide the spot hide circle ' avoid problems with angled crows feet skinparam linetype ortho entity "service" as service { *MODEL_UUID : varchar(200) <<PK>> -- *MODEL_NAME : varchar(200) *MODEL_INVARIENT_UUID varchar(200) <<generated>> *MODEL_VERSION varchar(20) DESCRIPTION varchar(1200) SERVICE_TYPE varchar(200) SERVICE_ROLE varchar (200) ENVIRONMENT_CONTEXT varchar(200) WORKLOAD_CONTEXT varchar(200) *CREATION_TIMESTAMP datetime *TOSCA_CSAR_ARTIFACT_UUID varchar(200) <<FK>> SERVICE_CATEGORY varchar(200) } entity "tosca_csar" as tosca_csar { *ARTIFACT_UUID varchar(200) <<PK>> -- *NAME varchar(200) *VERSION varchar(20) DESCRIPTION varchar(1200) *ARTIFACT_CHECKSUM varchar(200) *URL varchar(200) *CREATION_TIMESTAMP datatime } entity "vnf_resource_customization_to_service" as vrcts { *SERVICE_MODEL_UUID varchar(200) <<PK>> *RESOURCE_MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> } entity "pnf_resource_customization_to_service" as prcts { *SERVICE_MODEL_UUID varchar(200) <<PK>> *RESOURCE_MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> } entity "service_receipe" as service_receipe { *id int(11) <<PK>> -- *ACTION varchar(50) *VERSION_STR varchar(20) *DESCRIPTION varchar(1200) *ORCHESTRATION_URI varchar(256) *SERVICE_PARAM_XSD varchar(2048) RECIPE_TIMEOUT int(11) *SERVICE_TIMEOUT_INTERIM int(11) *CREATION_TIMESTAMP datetime *SERVICE_MODEL_UUID varchar(200) <<FK>> } entity "vnf_resource" as vnf_resource
  PlantUML Macro
  type dot
  @startuml ' hide the spot hide circle ' avoid problems with angled crows feet skinparam linetype ortho entity "service" as service { *MODEL_UUID : varchar(200) <<PK>> -- *MODEL_NAMEINVARIENT_UUID : varchar(200) *MODEL_INVARIENT_UUIDVERSION varchar(200) <<generated>> *MODEL_VERSIONNAME varchar(20200) DESCRIPTION*TOSCA_NODE_TYPE varchar(1200200) SERVICE_TYPEDESCRIPTION varchar(2001200) SERVICE*ORCHESTRATION_ROLEMODE varchar (20020) ENVIRONMENT_CONTEXT*AIC_VERSION_MIN varchar(20020) WORKLOAD_CONTEXT*AIC_VERSION_MAX varchar(20020) *CREATION_TIMESTAMPTIME datetime *TOSCAHEAT_CSARTEMPLATE_ARTIFACT_UUID varchar(200) <<FK>> *RESOURCE_CATEGORY varchar(200) SERVICE*RESORCE_SUB_CATEGORY varchar(200) VNF_PACKAGE_CSAR_UUID } entity "toscavnf_resource_csarcustomization" as toscavnf_resource_csarcustomization { *ARTIFACTMODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> -- *MODEL_INSTANCE_NAME varchar(200) *VERSIONMIN_INSTANCES varcharint(2011) DESCRIPTION varchar(1200*MAX_INSTANCES int(11) *ARTIFACT_CHECKSUM varchar(200AVAILABILITY_ZONE_MAX_COUNT int(11) *URLNF_TYPE varchar(200) *CREATIONNF_TIMESTAMP datatime } entity "vnf_resource_customization_to_service" as vrcts {ROLE varchar(200) *NF_FUNCTION varchar(200) *SERVICENF_MODELNAMING_UUIDCODE varchar(200) <<PK>> *CREATION_TIMESTAMP datetime *VNF_RESOURCE_MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> } entity "pnf_resource_customization_to_service" as prcts {<<FK>> *MULTI_STAGE_DESIGN varchar(20) *CDS_BLUEPRINT_NAME varchar(200) *SERVICECDS_MODELBLUEPRINT_UUIDVERSION varchar(20020) <<PK>> *RESOURCESKIP_MODELPOST_CUSTOMIZATIONINITIATION_UUIDCONFIGURATION varchar(20020) <<PK>> } entity "servicepnf_receiperesource" as servicepnf_receiperesource { *id int(11MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> -- *ACTIONMODEL_INVARIANT_UUID varchar(50200) *MODEL_VERSION_STR varchar(20) *DESCRIPTION varchar(1200) *ORCHESTRATION_URIMODEL_NANME varchar(256200) *SERVICETOSCA_PARAMNODE_XSDTYPE varchar(2048200) RECIPE_TIMEOUTDESCRIPTION intvarchar(111200) *SERVICEORCHESTRATION_TIMEOUT_INTERIMMODE intvarchar(1120) *CREATION_TIMESTAMP datetime *SERVICE_MODEL_UUID varchar(200) <<FK>> } entity "vnfpnf_resource_customization" as vnfpnf_resource_customization { *MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> -- *MODEL_INVARIENT_UUID_INSTANCE_NAME varchar(200) *AVAILABILITY_ZONE_MAX_COUNT int(11) *NF_TYPE varchar(200) *MODELNF_VERSIONROLE varchar(200) *MODELNF_NAMEFUNCTION varchar(200) *TOSCANF_NODENAMING_TYPECODE varchar(200) DESCRIPTION varchar(1200)*CREATION_TIMESTAMP datetime *ORCHESTRATIONMULTI_STAGE_MODEDESIGN varchar(20) *AICCDS_VERSIONBLUEPRINT_MINNAME varchar(20200) *AICCDS_BLUEPRINT_VERSION_MAX varchar(20) } entity "catalog_vnfpackage" *CREATION_TIME datetime *HEAT_TEMPLATE_ARTIFACT_UUID varchar(200) *RESOURCE_CATEGORY varchar(200) *RESORCE_SUB_CATEGORY varchar(200) VNF_PACKAGE_CSAR_UUID } entity "vnf_resource_customization" as vnf_resource_customization { *MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> -- *MODEL_INSTANCE_NAME varchar(200) *MIN_INSTANCES int(11) *MAX_INSTANCES int(11) *AVAILABILITY_ZONE_MAX_COUNT int(11) *NF_TYPE varchar(200) *NF_ROLE varchar(200) *NF_FUNCTION varchar(200) *NF_NAMING_CODE varchar(200) *CREATION_TIMESTAMP datetime *VNF_RESOURCE_MODEL_UUID varchar(200) <<FK>> *MULTI_STAGE_DESIGN varchar(20) *CDS_BLUEPRINT_NAME varchar(200) *CDS_BLUEPRINT_VERSION varchar(20) *SKIP_POST_INITIATION_CONFIGURATION varchar(20) } entity "pnf_resource" as pnf_resource { *MODEL_CUSTOMIZATION_UUID varchar(200) <<PK>> -- *MODEL_INVARIANT_UUID varchar(200) *MODEL_VERSION varchar(20) *MODEL_NANME varchar(200) *TOSCA_NODE_TYPE varchar(200) DESCRIPTION varchar(1200) *ORCHESTRATION_MODE varchar(20) *CREATION_TIMESTAMP datetime } entity "pnf_resource_customization" as pnf_resource_customization { *MODEL_CUSTOMIZATION_UUID varchar(200as catalog_vnfpackage { *VNFPACKAGEID` varchar(50) <<PK>> -- VNFPACKAGEURI` varchar(300) NULL, SDCCSARURI` varchar(300) NULL, CHECKSUM` varchar(50) NULL, ONBOARDINGSTATE` varchar(20) NULL, OPERATIONALSTATE` varchar(20) NULL, USAGESTATE` varchar(20) NULL, DELETIONPENDING` varchar(20) NULL, VNFDID` varchar(50) NULL, VENDOR` varchar(50) NULL, VNFDPRODUCTNAME` varchar(50) NULL, VNFDVERSION` varchar(20) NULL, VNFSOFTWAREVERSION` varchar(20) NULL, USERDEFINEDDATA` longtext NULL, LOCALFILEPATH` varchar(300) NULL, VNFDMODEL` longtext NULL } entity "catalog_nspackage" as catalog_nspackage { *NSPACKAGEID` varchar(50) <<PK>> -- NSPACKAGEURI varchar(300) CHECKSUM varchar(50) SDCCSARID varchar(50) ONBOARDINGSTATE varchar(20) OPERATIONALSTATE varchar(20) USAGESTATE varchar(20) DELETIONPENDING varchar(20) NSDID varchar(50) NSDNAME varchar(50) NSDDESIGNER varchar(50) NSDDESCRIPTION varchar(100) NSDVERSION varchar(20) USERDEFINEDDATA longtext LOCALFILEPATH varchar(300) NSDMODEL longtext INVARIANTID varchar(50) } entity "catalog_pnfpackage" as catalog_pnfpackage { *PNFPACKAGEID varchar(50) <<PK>> -- PNFPACKAGEURI varchar(300) *MODEL_INSTANCE_NAMESDCCSARURI varchar(200300) *AVAILABILITY_ZONE_MAX_COUNT int(11CHECKSUM varchar(50) *NF_TYPEONBOARDINGSTATE varchar(20020) *NF_ROLEUSAGESTATE varchar(20020) *NF_FUNCTIONDELETIONPENDING varchar(20020) *NF_NAMING_CODEPNFDID varchar(20050) *CREATION_TIMESTAMP datetimeVENDOR varchar(50) *MULTI_STAGE_DESIGNPNFDPRODUCTNAME varchar(2050) *CDS_BLUEPRINT_NAMEPNFDVERSION varchar(20020) *CDS_BLUEPRINT_VERSIONPNFSOFTWAREVERSION varchar(20) } entity "catalog_vnfpackage" as catalog_vnfpackage {USERDEFINEDDATA longtext *ARTIFACT_UUIDLOCALFILEPATH varchar(200) <<PK>> --300) ...PNFDMODEL longtext *CREATION_TIMESTAMP datatimePNFDNAME varchar(100) } entity "catalog_nspackagesoftwareimage" as catalog_nspackagesoftwareimage { *ARTIFACT_UUIDIMAGEID varchar(20050) <<PK>> -- ... *CREATION_TIMESTAMP datatime } entity "catalog_pnfpackage" as catalog_pnfpackage { *ARTIFACT_UUID varchar(200) <<PK>> -- ... *CREATION_TIMESTAMP datatime } entity "catalog_softwareimage" as catalog_softwareimage { *ARTIFACT_UUID varchar(200) <<PK>> -- ... *CREATION_TIMESTAMP datatimeCONTAINERFORMAT varchar(20) DISKFORMAT varchar(20) MINDISK varchar(20) MINRAM varchar(20) USAERMETADATA varchar(1024) VNFPACKAGEID varchar(50) FILEPATH varchar(300) STATUS varchar(10) VIMID varchar(50) } service }|--|| tosca_csar service ||--|{ service_receipe service ||--|{ vrcts service ||--|{ prcts vnf_resource ||--|{ vnf_resource_customization pnf_resource ||--|{ pnf_resource_customization vrcts }|--|| vnf_resource_customization prcts }|--|| pnf_resource_customization tosca_csar .. catalog_vnfpackage tosca_csar .. catalog_nspackage tosca_csar .. catalog_pnfpackage tosca_csar .. catalog_softwareimage @enduml

  ...