Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Use Cases

  • ETSI Package Management Use CaseOnboarding and Distribution
    • SOL004 VNF/PNF /NS Package includes SOL001 VNFD/PNFD with the original vendor package will be distributed from SDC to SVNFM/External NFVO.
    • SOL007 NS Package includes SOL001 NSD with the original vendor package will be distributed from SDC to External NFVO.
    • SOL003 and SOL005 Package Management APIs will be used for the distribution.
    • SOL004 VNF/PNF /Package Security will be supported by the package signature and certificate.
    • SOL007 NS Package Security SO ETSI Catalog DB enhancement, by leveraging ETSI Catalog Management Microservicewill be supported by the package signature and certificate
  • ETSI Package Pre-onboarding validation
    • VNF SDK will support SOL004 VNF package pre-onboarding
    • VNF SDK will support SOL007 NS package pre-onboarding 

Feature Descriptions

Feature

Description

ETSI Package Management

Package Management of SOL004 including SOL001, based on SOL005 and SOL003 Package Management APIs

  • SOL004 Package Structure
  • SOL004 Package Security
    • SOL004 VNF/PNF Package includes SOL001 VNFD/PNFD with the original vendor package will be distributed from SDC to SVNFM/External NFVO.
    • SOL007 NS Package includes SOL001 NSD with the original vendor package will be distributed from SDC to SVNFM/External NFVO.
    • SOL003 and SOL005 Package Management APIs will be used for the distribution.
      • SOL003/SOL005 Adapters passes vendor packages to SVNFM/NFVO
    ETSI Package Security

    If the vendor package includes signature and certificate, ONAP supports the package security.

    • SOL004 VNF/PNF Package security will be supported by the package signature and certificate
    • SOL007 NS Package security will be supported by the package signature and certificate
    • SDC will store the vendor package with signature and certificate in a zip format in the ONBOARDED_PACKAGE directory.
    • SO stores ONBOARDED_PACKAGE zip files in the ONAP-ETSI Catalog DB through ONAP-ETSI Catalog Manager APIs.
    • SVNFM/NFVO extracts the CSAR file from the vendor package 
      • For Frankfurt, extracting the CSAR without validation is allowed
    ETSI Package Validation
    • VNF SDK will support SOL004 VNF package pre-onboarding for validation - optional
    • VNF SDK will support SOL007 NS package pre-onboarding for validation - optional

    Epic and User Story

    Epic

    User Story

    Description

    Frankfurt?JIRA
    Support ETSI Package Management

    Package Management of SOL004 including SOL001, based on SOL005 and SOL003 Package Management APIs

    onboarding and distribution


    SDC supports ETSI package management (onboarding and distribution) and package securityPartially Done

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2610


    SDC supports onboarding of the SOL004 VNF package includes SOL001 VNFD

    • VNFD onboarding is testing in El Alto, and its regression testing will be done
    • SOL004 VNF package onboarding is tested in El Alto
      • Further testing is necessary in Frankfurt
      • Mapping from SOL001 VNFD to SDC internal TOSCA template
      • Mapping from SOL001 VNFD to SDC AID DM is under consideration
    No

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2611


    SDC supports onboarding of the SOL004 PNF package includes SOL001 PNFD

    • PNFD onboarding is done and its regression testing will be done
    • SOL004 PNF package onboarding is done in Dublin
      • Mapping from SOL001 PNFD to SDC AID DM is done
    YesDone

    SDC supports onboarding of the SOL007 NS package includes SOL001 NS
    • SOL007 NS package onboarding will be supported
      • Mapping from SOL001 NSD to SDC internal TOSCA template needs to be done
      • Mapping from SOL001 NSD to SDC AID DM is under consideration
    No

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2612


    SDC VSP and Resource CSAR files include the original vendor package

    • This is done in Dublin and its regression testing will be done
    • Storing the original vendor package in the SDC CSAR is done
    YesDone

    The vendor package will be distributed from SDC to SVNFM/External NFVO

    • The vendor package will be stored at the ONAP-ETSI Catalog DB
    • SOL003 and SOL005 Package Management APIs will be used for the distribution
    • SOL003/SOL005 Adapters passes vendor packages to SVNFM/NFVO
    • Refer to the ONAP-ETSI Catalog Manager, SO ETSI Catalog Manager and SOL003/SOL005 Package Management use cases
    Yes-

    Support ETSI Package Security and validation
    • ONAP supports vendor ETSI Package Security and validation

      • If the vendor package includes signature and certificate, ONAP supports the package security
    Yes

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2613


    • SOL004 VNF/PNF Package security will be supported by SDC, based on the package signature and certificate
    • ONAP SDC supports the package security
    Done-

    • SOL007 NS Package security will be supported by SDC, based on the package signature and certificate
    • ONAP SDC supports the package security
    No

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2614


    • SDC will store the vendor package with signature and certificate in a zip format in the ONBOARDED_PACKAGE directory.
    • It is done in El Alto
    Done-

    • SO stores ONBOARDED_PACKAGE zip files in the ONAP-ETSI Catalog DB through ONAP-ETSI Catalog Manager APIs.
    • Refer to the ONAP-ETSI Catalog Manager and SO ETSI Catalog Manager use cases
    Yes-

    • SVNFM/NFVO extracts the CSAR file from the vendor package 
      • For Frankfurt, extracting the CSAR without validation is allowed
    • SVNFM and External NFVO requirements on how to handle the zip-format packages
      • For Frankfurt, extracting the CSAR file without validation is allowed
    Yes-
    Support of ETSI Package Validation
    VNF SDK will support ETSI package validation for VNF and NSTBD

    VNF SDK will support ETSI VNF package pre-onboarding for validationVNF SDK will support ETSI VNF package pre-onboarding for validationTBD

    VNF SDK will support ETSI NS package pre-onboarding for validationVNF SDK will support ETSI NS package pre-onboarding for validationTBD
  • SOL004 Package Structure
  • SOL004 Package Security

    ETSI Package Management Architecture

    ...

    1. SDC supports SOL004 VNF/PNF package onboarding, and stores the original vendor VNF/PNF package inside the SDC package – Ericsson contribution in Dublinpackage
      1. SOL004 package includes SOL001 VNFD/PNFD
      2. PNF onboarding was has been tested
      3. VNF onboarding is being will be tested in El Alto / Frankfurt
    2. SDC will support SOL007 NS package onboarding and store the original vendor NS package inside the SDC package
      1. NS onboarding will be supported
      2. This feature is postponed to the Guilin release
    3. SDC supports supports VNF/PNF package onboarding and/or accepts VNF/PNF package management interfaces from OSS/BSS via SOL005 Package Management APIs (TBD)
    4. SO supports NS package management interfaces from OSS via SOL005 Package Management APIs (TBD)
    5. ONAP Runtime components store SOL004 Packages as neededfor their operations
      1. For the SO case, SO stores SOL004 packages for NS, VNF and PNF by leveraging the ETSI Catalog DB microservicesONAP-ETSI Catalog Manager
      2. For the SO case, SO stores SOL007 packages for NS by leveraging the ONAP-ETSI Catalog Manager
    6. SOL003 VNFM Adapter provides VNFMs Query/Fetch VNF packages/contents/artifacts, Reading VNFD and subscription/notification services
    7. SOL005 Adapter provides NSD/PNFD management and SOL005 VNF package management
    • Note: 
    1. SOL007 (NS package) support is under discussion.
    2. To simplify the package distribution and storage, the Runtime Catalog Manager is suggested for the future.
    1. NS/PNF/VNF package management to VF-C/External NFVO by leveraging SOL005 package management APIs


    Gliffy Diagram
    nameONAP ETSI Package Management
    pagePin17
    Image Removed


    • ETSI Package Distribution Flows
    PlantUML Macro
    typedot
    @startuml
    participant OSS_BSS
    participant SDC
    participant SO
    participant ONAP_ETSI_Catalog_Mgr
    participant SOL003_Adapter
    participant SOL005_Adapter
    participant VNFM
    participant VFC
    participant Ext_NFVO
    autonumber 
    
    	OSS_BSS -> SDC : Vendor SOL004/SOL007 package onboarding,\nincluding SOL001 VNFD
    
    group VNF PACKAGE TO SVNFM
    	SDC -> SO : SDCONAP VNFinternal package including\nthe original vendor SOL004 VNF packagewith the \noriginal vendor CSAR/Zip
    	SO -> ONAP_ETSI_Catalog_Mgr : Storeinvoke VNFETSI package including\n the original vendor package
    opt
    	VNFMCatalog Manager, passing
    	ONAP_ETSI_Catalog_Mgr -> SOL003_AdapterSDC : Request for a VNF package
    	SOL003_Adapter ->  query the SDC CSAR with the SDC CSAR id
        ONAP_ETSI_Catalog_Mgr --> ONAP_ETSI_Catalog_Mgr : Request for a VNF package
    	 extract SOL004 package CSAR/Zip from the SDC CSAR \nand store it
    	ONAP_ETSI_Catalog_Mgr -> SOL003_Adapter : Responseretrieve withthe aoriginal VNFvendor packageCSAR/Zip
    	SOL003_Adapter -> VNFM : Responseforward withthe aoriginal VNFvendor packageCSAR/Zip
    end
    opt
    	NFVO -> SOL005_Adapter : Request for a NS package
    	SOL005_Adapter -> 
    
    group VNF PACKAGE TO Ext NFVO
    	SDC -> SO : ONAP internal package with the original vendor CSAR/Zip
    	SO -> ONAP_ETSI_Catalog_Mgr : store ONAP internal package with the original vendor CSAR/Zip
        ONAP_ETSI_Catalog_Mgr -> SDC : query the SDC CSAR with the SDC CSAR id
        ONAP_ETSI_Catalog_Mgr --> ONAP_ETSI_Catalog_Mgr : Request for a NS package
    	 extract SOL007 package CSAR/Zip from the SDC CSAR \and store it
    	ONAP_ETSI_Catalog_Mgr -> SOL005_Adapter : Responseretrieve withthe aoriginal NSvendor packageCSAR/Zip
    	SOL005_Adapter -> Ext_NFVO : forward the original vendor CSAR/Zip
    end
    
    group VNF PACKAGE TO VFC 
    	SDC -> VFC : ONAP Responseinternal package with athe original NSvendor packageCSAR/Zip
    end	
    	
    @enduml


    • Open Issues:
      • Will the external NFVO get the NS package thru ONAP-ETSI Catalog Mgr and SOL005 Adapter?   <need input from Verizon>
      • Does the SOL002 Adapter need packages?


    SDC VNF/PNF Onboarding and Distribution

    ...

    • Enhancement (Ericsson contribution) was made to the SDC Dublin to support SOL004 PNF onboarding with .zip and .csar file extensions.
      • The enhancement can be used for VNF onboarding – it is being tested.
      • SDC VSP and Resource csar files have the ONBOARDINGONBOARDED_PACKAGE, which contains the original vendor VNF package.
        • The VNFM and external NFVO use the original vendor VNF/NS packages.
        • ONAP-ETSI Catalog Manager will be changed for the location of the original vendor package.

    ...

    1. At onboarding, SDC checks the file extension and performs the following procedures
      1. If the file is .zip, SDC unzips
        1. If it has .cert & .cms, it is a package with security and security validation will be performed.
        2. If it does not include .cert & .cms, it is an existing Heat template onboarding, and SDC follows the Heat template onboarding procedure
    2. If the file is .csar, it is a package without security.
    3. Next, SDC will check the TOSCA.meta file.
    4. If it contains SOL004v2.?.1 keywords, the package will be handled as SOL004v2.?.1.
    5. Otherwise, it will be handled as existing TOSCA (non-SOL004) package onboarding which will not have the ONBOARDINGONBOARDED_PACKAGE artifact.

    SDC SOL004/SOL007 VNF Package Security

    Among the SOL004/SOL007 VNF package security options, the SDC supports the option2 as depicted below. In the option 2, there are two ways to zip the VNF packages, and SDC supports both.

    SDC validates the VNF packages based on the embedded signature and certificate by leveraging CA.

    • Vendor SOL004/SOL007 VNF Package with certificate and signature is onboarded into SDC
      • ZIP-format VNF package includes CSAR, Signature and Certificate
    • SDC validates VNF package based on the certificate and signature
    • SDC generates SDC internal model plus the vendor SOL004/SOL007 package CSAR and ZIP (with certificate and signature) – the supported format is TBD based on the security requirement

    ...

    • The original vendor package contents between the Adapters and SVNFMs/NFVOs could be one of the following.
      • Vendor package including certificate and signature (Zip format)
      • Vendor package without certificate and signature (CSAR format)
    • Open Issues:
      1. Distribution of vendor VNF packages with certificates and signatures to SVFNM need to be sorted out.
      2. Currently, VF-C supports CSAR-format without certificate or signature – TBD
    • The following diagram depicts the ETSI package distribution. 



    • The following sequence diagram depicts the Package Information Flows.
    PlantUML Macro
    typedot
    @startuml
    participant SDC
    participant SO
    participant ONAP_ETSI_Catalog_Mgr
    participant SOL003_Adapter
    participant SOL005_Adapter
    participant VNFM
    participant VFC
    participant Ext_NFVO
    autonumber 
    
    	SDC --> SDC : ASDC Distribution Engine\nsends a distribution notification
    	SDC -> SO : ASDC Distribution Message Broker\n sends a distribution notification
    	SO -> SDC : SO sends a distribution status
    	SO -> SDC : SO pulls needed artifacts from ASDC Catalog 
    group VNF PACKAGE TO SVNFM
    	SDC -> SO : ONAP internal package with the \noriginal vendor CSAR/Zip
    	SO -> ONAP_ETSI_Catalog_Mgr: store ONAP internal package \nwith the original vendor CSAR/Zip
    	ONAP_ETSI_Catalog_Mgr -> SOL003_Adapter : retrieve the original vendor CSAR/Zip
    	SOL003_Adapter -> VNFM : forward the original vendor CSAR/Zip
    end
    
    group VNF PACKAGE TO Ext NFVO
    	SDC -> SO : ONAP internal package with the original vendor CSAR/Zip
    	SO -> ONAP_ETSI_Catalog_Mgr: store ONAP internal package with the original vendor CSAR/Zip
    	ONAP_ETSI_Catalog_Mgr -> SOL005_Adapter : retrieve the original vendor CSAR/Zip
    	SOL005_Adapter -> Ext_NFVO : forward the original vendor CSAR/Zip
    end
    
    group VNF PACKAGE TO VFC 
    	SDC -> VFC : ONAP internal package with the original vendor CSAR/Zip
    end	
    	
    @enduml

    ...

    • Transform SOL001-based VNFD into SDC internal models
    • Store the original Vendor package into the ONBOARDINGONBOARDED_PACKAGE directory
      • If the original vendor package is a zip file with signature and certificate, the ONBOARDINGONBOARDED_PACKAGE directory will contain the zip file. 
    • VNFM and VF-C will receive the zip-format file.
    • For Frankfurt release, VNFM and VF-C will unzip the file and take the CSAR file from the zip file without validationthe SVNFM and external NFVO will receive a zip-format package with signature and certificate if the original vendor package contains signature and certificate.
      • SVNFM and NFVO will unzip the incoming zip package files and extract CSAR files from the zip package files without validation.
      • After the Frankfurt release, it is assumed that SVNFM and NFVO validate the incoming packages based on signature and certificate.