Versions Compared

Old Version 171

changes.mady.by.user Zu Qiang (Ericsson)

Saved on

compared with

New Version Current

changes.mady.by.user Benjamin Cheung

Saved on

Key

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

Authors: Ben Benjamin Cheung Image Removed , Michela Bevilacqua Image Removed , Zu Qiang Image Removed(Ericsson)

Table of Contents

Table of Contents

...

In Casablanca Release, the PnP Use Case covered :

 - manually onboarding a PNF Definition at Design Time

 - PNF Instantiation in ONAP at Run Time

In Casablanca Release, the PnP  Use Case did not cover the PNF Onboarding, the Onboarding process of a Vendor PNF archive including a PNF descriptor and a set of Artifacts pre-onboarding / onboarding.

PNF R4 Dublin SCOPE

This is the scope (what is agreed to be delivered) in Dublin for this Use Case. A vendor provided PNF package/ file archive shall be pre-onboarded in ONAP 

Introduce pre-onboarding and onboarding a vendor PNF onboarding package Introduce PNF package support in ONAP for 5G and other use cases.

...

The pre-onboarding step is optional and it can be used to verify the a vendor PNF onboarding package/Archive format by VNF SDK tools 

...

  • Use Case shall be aligned as much as possible to the ONAP VNF package pre-onboarding UC
  • PNF archive is provided by a vendor and it will include PNFD (based on ETSI SOL001v2.5.1) and all the artifacts required by ONAP (non ETSI NFV artifacts provided managed as Non-MANO artifact (i.e. FM and PM dictionary)). The PNF package structure shall be based on ETSI SOL004v2.6.1.
  • This UC shall be aligned as much as possible to the ONAP VNF package pre-onboarding U/C the artifacts required by ONAP (non-ETSI NFV artifact provided managed as Non-MANO Artifact (i.e. FM Meta Data and PM dictionary)

PNF ONBOARDING SCOPE (R4 Dublin)

 A vendor provided PNF onboarding package /file archive can be on-boarded in ONAP. The onboarding step is mandatory to onboard artifacts and descriptor provided by the vendor.

...

  • ONAP SDC shall also continue to support PNF definition by UI as support manually onboarding a PNF as in Casablanca Release
  • ONAP SDC shall also continue to support VNF onboarding as in Casablanca Release
  • PNF descriptor and artifacts can be onboarded through ONAP and stored artifacts associated to a PNF can be stored in ONAP catalogues in order to be then utilized also at RTrun time. 
  • The PNF Archive can be onboarded through ONAP
  • ONAP SDC shall also continue to support PNF definition by UI as in Casablanca Release.

INTRODUCTION

PNF PRE-ONBOARDING & ONBOARDING OVERVIEW

Image Removed

...

Descriptor, Artifacts and Package Delivery

...

PNF Package

Pre-onboarding

...

ONAP onboarding process,

PNF Package onboarding

...

Technology Specialist

Asset Manager

...

Service Designer

Operations Specialist

...

PNF Package

NF validation Activities

...

PNF Package,

PNF Descriptor

PNF Onboarding

SDC Meta-data added (vendor onboarded CSAR to SDC onboarded CSAR)

...

ONAP Common Information Model

SDC Data Model

5G Service Definition

Service Design

SDC Model mapping

...

5G Service Instantiation

PNF Instance

A&AI PNF Instance

  • package structure shall be based on ETSI SOL004v2.6.1. And the PNFD is based on ETSI SOL001v2.5.1

BUSINESS DRIVER

This section describes Business Drivers needs.

Executive Summary - Pre-onboarding & onboarding is used to "upload" a vendor's PNF onboarding package which contains the descriptor and artifacts for the PNF. (VNFs are handled with a different wiki)

Business Impact - Pre-onboarding & onboarding is a business imperative because it is vital because ONAP needs to be able to "load" PNF descriptor and artifacts which define the PNF capabilities and functionalities.

Business Markets - Applies to PNFs within a service operator's network. Applies to all markets that might use PNFs including Wireless, wireless, optical.

Funding/Financial Impacts - This use case can potentially save a large amount of OPEX because there is a lot of time associated with manually onboarding a PNF which would have to be done if this use case were not implemented.

Organization Mgmt, Sales Strategies - There is no additional organizational management or sales strategies for this use case outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider.

INTRODUCTION

PNF PRE-ONBOARDING & ONBOARDING OVERVIEW


Image Added



Descriptor, Artifacts and Package Delivery

PNF Package

Pre-onboarding

ONAP onboarding process,

PNF Package onboarding

ONAP Design Time activitiesONAP Run Time activities
WHENPNF delivery timePre-Onboarding activitiesOnboarding ActivitiesONAP Design Time ActivitiesONAP Run Time
WHOVendorTechnology Specialist

Technology Specialist

Asset Manager

Service Designer

Operations Specialist

Operations Specialist
WHATDescriptor, Artifacts and Package delivery

PNF Package

NF validation Activities

PNF Package,

PNF Descriptor

PNF Onboarding

SDC Meta-data added (vendor onboarded CSAR to SDC onboarded CSAR)

ONAP Common Information Model

SDC Data Model

5G Service Definition

Service Design

SDC Model mapping

5G Service Instantiation

PNF Instance

A&AI PNF Instance

ETSI NFV reference

SOL001 PNFD

SOL004 Package

ETSI SOL004 Package

ETSI SOL001 PNFD,

SOL004 Package


-


PNF PRE-ONBOARDING & ONBOARDING DUBLIN WORK


Image Added


STAGEDESCRIPTIONDELIVERABLE

(1) Package Delivery

Producing and collecting NF artifacts for a NF package. Vendor provided.

Dublin Priorities are the artifacts & descriptor files of the PNF package. These include:

    1. PNFD,

    2. NF Registration YAML File (for VES event definition),

    3. PM Dictionary & Schema.

PNF Onboarding Package
(2) PNF Pre-Onboarding

VNF SDK: Enhance VNF-SDK to be able to validate (optionally) the on-boarding PNF package. Optionally, create a PNF onboarding package through VNF-SDK.

VNF-SDK can: [1] (optionally) Create a PNF package. VNF-SDK optionally can extend a package and provide as output a new onboarding PNF package the SDC will use. Package,  output of the VNF SDK (as optional step) must be compliant and aligned to the PNF package onboarding format provided by the vendor as both can be used as input to SDC for the ONAP onboarding package.

[2] (optionally) Validate a PNF package. Validate the package according to available VES specifications and onboarding package structure.

SDC/CDS: Load PNF model & Controller blue-print for PNF orchestration and Network communication. Before R3/Casalanca a Preload interim solution was used for Network Assignments.

VNF SDK validates PNF onboarding Package

(3) PNF Onboarding

In PNF Onboarding, SDC takes the PNF vendor-provided package and adds meta-data content and recomposes a new CSAR into the SDC expected directory structure format.

It copies the PNF vendor-provided PNF onboarded package and put it into a vendor-provided directory.

Onboarding the Package: SDC Enhancements need to be made to onboard the PNF Package and enter into the SDC Catalog

The CSAR package provided by SDC as output of the onboarding process.  This work will include the PNF artifacts into CSAR package.

SDC CSAR Package of PNF Onboarded Package (CSAR)
(4) Design Time Activities (SDC)

Design time activities occur where an operator and define services.

A Service is defined, and a new CSAR package is produced with service-related artifacts associated with outputs of SDC ready for distribution to other ONAP run-time components.

SDC CSAR (output)
(5) ONAP RT Component Ingestion of CSAR package & PNF Onboarding package artifacts

Proper Distribution & Reception of SDC CSAR:  The SDC CSAR package is distributed by SDC to ONAP Run-Time Components. Chances need to be made to verify the reception of the CSAR and use of the CSAR by the Components.

We need to insure that the distribution of PNF artifacts does not break the ONAP platform components. (for example SO looked for Heat Templates, which were only applicable for VNFs). Some ONAP RT assume that any package notification only have VNF artifacts. In practice, there is only the subscription of artifacts (listeners) and the distribution of the PNF package, we need to make sure this behaves correctly and that there are no errors. Pre-integration checks and validation that the distribution of PNF artifacts will not cause side effects. Want to insure that FM & PM artifacts are distributed

...

SOL001 PNFD

SOL004 Package

...

ETSI SOL001 PNFD,

SOL004 Package

...

PNF PRE-ONBOARDING & ONBOARDING DUBLIN WORK

Image Removed

Design time activities occur where an operator and define services.

A Service is defined, and a new CSAR package is produced with service-related artifacts associated with outputs of SDC ready for distribution to other ONAP run-time components.
STAGEDESCRIPTIONDELIVERABLE

(1) Package Delivery

Producing and collecting NF artifacts for a NF package. Vendor provided.

Dublin Priorities are the artifacts & descriptor files of the PNF package. These include:

    1. PNFD,

    2. NF Registration YAML File (for VES event definition),

    3. PM Dictionary & Schema.

PNF Onboarding Package
(2) PNF Pre-Onboarding

VNF SDK: Enhance VNF-SDK to be able to validate (optionally) the on-boarding PNF package. Optionally, create a PNF onboarding package through VNF-SDK.

VNF-SDK can: [1] (optionally) Create a PNF package. VNF-SDK optionally can extend a package and provide as output a new onboarding PNF package the SDC will use. Package,  output of the VNF SDK (as optional step) must be compliant and aligned to the PNF package onboarding format provided by the vendor as both can be used as input to SDC for the ONAP onboarding package.

[2] (optionally) Validate a PNF package. Validate the package according to available VES specifications and onboarding package structure.

SDC/CDS: Load PNF model & Controller blue-print for PNF orchestration and Network communication. Before R3/Casalanca a Preload interim solution was used for Network Assignments.

VNF SDK validates PNF onboarding Package

(3) PNF Onboarding

In PNF Onboarding, SDC takes the PNF vendor-provided package and adds meta-data content and recomposes a new CSAR into the SDC expected directory structure format.

It copies the PNF vendor-provided PNF onboarded package and put it into a vendor-provided directory.

Onboarding the Package: SDC Enhancements need to be made to onboard the PNF Package and enter into the SDC Catalog

The CSAR package provided by SDC as output of the onboarding process.  This work will include the PNF artifacts into CSAR package.

SDC CSAR Package of PNF Onboarded Package (CSAR)
(4) Design Time Activities (SDC)
SDC CSAR (output)(5) ONAP RT Component Ingestion of CSAR package & PNF Onboarding package artifacts

Proper Distribution & Reception of SDC CSAR:  The SDC CSAR package is distributed by SDC to ONAP Run-Time Components. Chances need to be made to verify the reception of the CSAR and use of the CSAR by the Components.

We need to insure that the distribution of PNF artifacts does not break the ONAP platform components. (for example SO looked for Heat Templates, which were only applicable for VNFs). Some ONAP RT assume that any package notification only have VNF artifacts. In practice, there is only the subscription of artifacts (listeners) and the distribution of the PNF package, we need to make sure this behaves correctly and that there are no errors. Pre-integration checks and validation that the distribution of PNF artifacts will not cause side effects. Want to insure that FM & PM artifacts are distributed properly. PM dictionary would be used in DCAE & PM Mapper. FM Meta Data is new, and from the start (what is new in Dublin) is that it is being used for both VNFs and PNF.

SDC CSAR (service artifacts from SDC)

...

COMPONENTIMPACT DESCRIPTIONPTL
Service Design & Creation Project
  1. PNF PACKAGE FORMAT
    • Identify current VNF package format constraints in SDC
    • Propose a PNF Package format
    • Evaluate VNF and PNF package alignment
  2. PACKAGE MAPPING - Onboarding PNF package to internal PNF package mapping
  3. PNFD MAPPING - Onboarding PNFD to internal PNFD mapping
    • A new flow to map ETSI SOL001 PNFD in SDC AID model.
  4. ARTIFACT MANAGEMENT
    • Design-time catalog update to associate artifacts to a PNF
    • Run-time catalog update to associate artifacts to a PNF

5. RESOURCE VIEW TO DISPLAY PNF ONBOARDED ARTIFACTS

  •  Displaying the PNF Onboarded Artifacts
  • After onboarding a PNF Package being able to display in SDC UI
  • Possibility to browse PNF artifacts (VF resource creation view)
Ofir Sonsino
VNF SDK Project

PACKAGE VERIFICATION - PNF package format verification

PNF PACKAGE FORMAT

PACKAGE USAGE - Package for PNF Onboarding Package for use in VNF SDK

Weitao Gao
Modelling Subcommittee

PNFD MAPPING - Onboarded PNFD to platform PNFD mapping

THis activity is traced as a sw implementation task in SDC but PNFD mapping will be discussed as part of the ONAP Resource Data Model.

Hui Deng

Anatoly Katzman  

VNF Requirements Project
  1. PACKAGE, DESCRIPTOR, ARTIFACTS - VNF requirements to cover PNF package contents and directory structures and mandatory elements.
  2. PNF DESCRIPTOR - Requirements for the PNF Descriptor
  3. ARTIFACTS - Requirements for Artifacts of PNF and PNF Package

Steven Wright



DEVELOPMENT STATUS


Project / PTLJIRADescriptionStatus

SDC

Michael Lando
Vitaly Emporopulo
Ofir Sonsino
Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keySDC-1970
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-1973
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-1974
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-1975
    • JiraserverONAP JIRAserverId425b2b0a-557c-3c0c-b515-579789cceedbkeySDC-1976


    SDC Development Status

    1. PNF package format
      • Identify current VNF package format constraints in SDC
      • Propose a PNF Package format
      • Evaluate VNF and PNF package alignment
    2. Onboarding PNF package to internal PNF package mapping
      • including adding the manifest file with new key words
      • including adding metadata file with new key words
      • non_Mano artifacts based on the public non_mano_artifact_sets key name
      • Package security to be supported (starting with option 2)
    3. Keep a copy of the original on boarding package under artifact folder (agreed in SDC weekly meeting)
    4. Onboarding PNFD to internal PNFD mapping
      • A new flow will be introduced in SDC to map ETSI SOL001 PNFD into SDC AID model.
    5. Artifact management
      • Design time catalog update to associate artifacts to a PNF
      • Run time catalog update to associate artifacts to a PNF


    PTL notified (11/19 )

    Code is ready for M4(11/04)

    VNF SDK

    Weitao Gao

    VNFSDK Model Package

    Andy Mayer


    VNFSDK Development Status

    1. PNF package format verification

    VNFSDK PTL notified (12/05)

    VNF SDK Model, Package notified (11/30)

    PNF package to ONAP.pptx

    Scope planned for Dublin completed ...except from package security item:


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

    SDC

    VNFSDK-

    1977

    342

    E2E work tracked in this Jira item:

    JiraserverONAP JIRAserverId425b2b0a-557c-3c0c-b515-579789cceedbkeySDC-1978

    Jira
    serverONAP JIRA

    serverId425b2b0a-557c-3c0c-b515-579789cceedb

    keySDC-1979
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-1980
    • JiraserverONAP JIRA

    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    key

    SDC

    VNFSDK-

    2072

    337

  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2108
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2109
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2110
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2111
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2112
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2113
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2165
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyINT-947


    • RESOURCE DATA MODEL

    Anatoly Katzman

    		No JIRA ticket required, project can help to identify the mappings required in SDC in Dublin timeframe
    • Onboarded PNFD to Platform PNFD mapping
    		PTL notified (11/26)

    VNF RQTS

    Steven Wright

    VNF Requirement Development Status

    1. Network Function requirements shall be updated to cover PNF package, descriptor and artifacts
    2. VNF requirements could be reviewed.
    3. Remove or modify the existing package / documentation requirements (some of them is from the RFP or heat template only)
    		PTL notified (01/16)


    USE CASE ANALYSIS, SUPPORTING MATERIAL

    The following material is used during Dublin timeframe as input for discussion. It is subject to updates during Dublin timeframe. A final version will be available by Dublin signoff. 


    PACKAGE DELIVERY: ARTIFACTS & PRODUCTS

    Image Added

    PACKAGE DELIVERYONBOARDING PROCESSDESIGN TIMERUN TIME
    NF DescriptorNF Descriptor Model

    SDC Data Model

    		A&AI PNF Data model, PNF instance

    VES event registration file/
    FM dictionary,

    PM dictionary

    		artifactSDC Catalog

    Run time Catalog


    Informational ArtifactsartifactSDC CatalogRun time Catalog

    Configuration Models and Files,

    (including Ansible Playbooks)

    		artifactSDC CatalogRun time Catalog


    Multiple artifacts can be provided by a vendor in the Package. A list of the supported artifacts by ONAP will be finalized during Dublin timeframe.

    Note about the picture: NF Registration stands for VES event registration file. Info model provided in the picture, just as example 


    PACKAGE DELIVERY: PACKAGE CREATION (VENDOR PROVIDED)

    Image Added

    The PNF Onboarding Package could contain the following things:

    ARTIFACTDESCRIPTION
    PNF Descriptor

    PNF Descriptor. The PNFD is a model which describes the requirements and capabilities of the PNF. The ETSI SOL 001 specification also suggests a model that can be used for a PNFD. This could be a TOSCA definition of the PNF.

    MANDATORY

    NF Registration

    Definition of VES Events. The NF Registration is defined by the VES Registration specification.

    You can read about the VES Event Listener here: Service: VES Event Listener 7.0.1

    MANDATORY

    Licensing

    NF Licensing information that needs to be included in the Package

    N/A for PNF

    Informational Artifacts

    Informational artifacts include:

    • Cloud Questionnaire
    • Features
    • Vendor Test Scripts
    • Resource Security Template
    • HEAT Template (Vendor)
    • Capacity Descriptive
    • Other Informational Artifacts

    OPTIONAL

    Configuration Files

    Configuration Files related to the NF for configuration management

    OPTIONAL



    Ansible Playbooks

    Ansible Playbooks to interact with NF. These are anticipated to be used with the communication of the NF controller to the NF. This can be seen in the PNF Plug and Play Wiki: 5G - PNF Plug and Play

    OPTIONAL

    PACKAGE DELIVERY: PNF PACKAGE FILES & DIRECTORIES

    The onboarding PNF Package must be defined as specified as ETSI SOL004v2.6.1 + NFV CR NFVSOL(18)000746r3 

    The package structure must be a CSAR with TOSCA-Metadata as specified in SOL004 section 4.1.2
    The TOSCA.meta file keyname extension: SOL004 section 4.1.2.3

    EXAMPLE of the TOSCA.meta

    TOSCA-Meta-File-Version: 1.0
    CSAR-Version: 1.1
    Created-By: Ericsson
    Entry-Definitions: Definitions/MainServiceTemplate.yml     
    ETSI-Entry-Manifest: MainServiceTemplate.mf
    ETSI-Entry-Change-Log: Artifacts/ChangeLog.txt

    END of EXAMPLE 


    The PNF manifeat file must contains

    • metadata with following keynames: pnfd_ provider, pnfd_name, pnfd_release_date_time, pnfd_archive_version
    • a list of all files contained in or referenced from the package with their location, expressed using a Source: location/name key-value pair. 
    • Non-mano-artefact tag: ONAP defined tags


    EXAMPLE of the PNF manifeat file

    metadata:                                                      
    pnfd_name: gNB
    pnfd_provider: Ericsson
    pnfd_archive_version:1.0
    pnfd_release_date_time:2018-12-03T08:44:00-05:00

    source: Definitions/MainServiceTemplate.yaml    
    source: Definitions/etsi_nfv_sol001_vnfd_2_5_1_types.yaml
    source: Definitions/etsi_nfv_sol001_pnfd_2_5_1_types.yaml

    non_mano_artifact_sets: 
    onap_ves_events:
      source: Artifacts/Events/VES_registration.yaml
    onap_pm_dictionary:
      source: Artifacts/Measurements/PM_Dictionary.yaml
    onap_yang_module:
      source: Artifacts/Yang_module/Yang_module.yaml

    onap_ansible_playbooks:

      source: Artifacts/Playbooks/playbook.yml

    onap_others:
      source: Artifacts/scripts/install.sh
      source: Artifacts/Informational/user_guide.txt
      source: Artifacts/Other/installation_guide.txt
      source: Artifacts/Other/review_log.txt

    END of EXAMPLE

    The following diagram illustrates a basic PNF package and some suggested file structure and content in the directories.

    Image Added

    The PNF package is expected to be a CSAR package with file extension .csar.

    PNF PACKAGE SECURITY

    According to ETSI SOL004 v2.6.1 the onboarding package shall be signed. ETSI SOL004 provides two options:

    Option 1 - One Digest for each components of the VNF package. The table of hashes is included in the manifest file, which is signed with the VNF provider private key. A signing certificate including the provider’s public key shall be included in the package.  

    Option 2 - The complete CSAR file shall be digitally signed with the provider private key. The provider delivers one zip file consisting of the CSAR file, a signature file and a certificate file that includes the VNF provider public key.

    In Dublin release option 2 is going to be implemented in SDC.

    • The VNF/PNF package authenticity and integrity is ensured by signing the CSAR file with the provider private key. The digital signature is stored in a separate file.
    • The VNF/PNF provider shall also include an X.509 certificate in a separate file with extension .cert or, if the signature format allows it, in the signature file itself. The VNF/PNF provider creates a zip file consisting of the CSAR file with file extension .csar, signature and certificate files. The signature and certificate files shall be siblings of the CSAR file with extensions .cms and .cert respectively.
    • Only CMS signature file format is supported in this release.
    • At pre-onboarding of the PNF/VNF package, VNFSDK tool could verify the signature of the complete CSAR package with the provider’s public key
    • At onboarding of the PNF/VNF package, SDC could verify the signature of the complete CSAR package with the provider’s public key.
    • At onboarding, SDC is expecting package file extension as following:
      • Heat template: .zip
      • TOSCA without package security: .csar
      • TOSCA with package security (option 2): zip file consisting of the CSAR file, a signature file and a certificate file .

    PNF PRE-ONBOARDING: VNF-SDK ENHANCEMENTS

    Image Added

    VNF SDK is (optionally) responsible to validate the PNF package provided by the vendor.

    VNF SDK can also be used (optionally) to create a PNF package.

    Today, optionally, the VNF SDK is also able to provide 

    We expect the VNF SDK development to be able to reuse much of the functionality from VNF SDK, format delivery, processing are all the same except HEAT deployments templates are not used (as they do not apply to PNFs).

    The VNF SDK will be used to VALIDATE the PNF Onboarding Package

    It is possible for a user to bring in the PNF Onboarding Package (provided by a vendor) without the use of the PNF SDK tools.

    Some of the NF artifacts are created by the SDC tool.

    [INVESTIGATE] What are artifacts that SDC adds during the Onboarding process, looking at SDC supported artifact types, possibly VENDOR LICENSE and MODEL INVENTORY (are there others?)

    TASKVNF SDK S/W FUNCTION - DESCRIPTION

    Release

    Priority

    #1: MANIFEST FILE (VNF SDK) vs FILE CHECK

    (Test only)

    Verifies the MANIFEST file (MainServiceTemplate.mf) and  checks that the defined directories of the PNF package against the manifest file. for example the manifest file might say a files should exist: "Measurements: source: Artifacts/Deployment/Measurements/PM_Dictionary.yaml", the VNF SDK would check that the file PM_Dictionary.yaml exists in the actual PNF package.

    (Confirmed that VNF-SDK supports already Feb 14, 2019). Bogumil Zebek

    There are two repositories: Java, Python. (investigate)

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey

    1. PNF package format
      • Identify current VNF package format constraints in SDC
      • Propose a PNF Package format
      • Evaluate VNF and PNF package alignment
    2. Onboarding PNF package to internal PNF package mapping
      • including adding the manifest file with new key words
      • including adding metadata file with new key words
      • non_Mano artifacts based on the public non_mano_artifact_sets key name
      • Package security to be supported (starting with option 2)
    3. Keep a copy of the original on boarding package under artifact folder (agreed in SDC weekly meeting)
    4. Onboarding PNFD to internal PNFD mapping
      • A new flow will be introduced in SDC to map ETSI SOL001 PNFD into SDC AID model.
    5. Artifact management
      • Design time catalog update to associate artifacts to a PNF
      • Run time catalog update to associate artifacts to a PNF

    PTL notified (11/19 )

    Ongoing discussions with SDC project

    VNF SDK

    Weitao Gao

    VNFSDK Model Package

    Andy Mayer
    • Jira
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyVNFSDK-337
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-338
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-339
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-340
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-341
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-342
      • Jira
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyVNFSDK-343
    1. PNF package format verification

    VNFSDK PTL notified (12/05)

    VNF SDK Model, Package notified (11/30)

    PNF package to ONAP.pptx

    RESOURCE DATA MODEL

    Anatoly Katzman

    No JIRA ticket required, project can help to identify the mappings required in SDC in Dublin timeframe
    • Onboarded PNFD to Platform PNFD mapping
    PTL notified (11/26)

    VNF RQTS

    Steven Wright

    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-506
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-496
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-497
  • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-498
    • Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-499
    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-505
    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-507
    Jira
    serverONAP JIRA
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-508
    JiraserverONAP JIRAcolumnskey

    ,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    key

    VNFRQTS

    VNFSDK-

    553
    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-554

    340

    • Adapt unit tests to run in Local DCE
    • Extract common manifest logic to separate module
    • Create PNF Manifest file validator
    • Integrate PNF Manifest file validator in CSAR Reader
    • Add CSAR Type flag to CSAR Validation command line.

    R4

    HIGH

    #2: TOSCA MetaFile LICENSE Term File Exists Check (VNF SDK)

    (Test Only)

    VNF SDK will check a License Term File Check in the PNF package. TOSCA meta file points to a License. Just a check that the file exists no content check at all.

    Note: Related requirements standards from ETSI IFA011, SOL004

    ASSOCIATED DEVELOPMENT:

    QUESTION is the file is not there will the process abort or is a warning given?

    (Already Supported, VNF-SDK already supports this confirmed Feb 14, 2019)

    R4

    HIGH

    #3: TOSCA MetaFile CERTIFICATE Check (VNF SDK)

    (Test Only)

    (Test only) CERTIFICATE check. In the PNF package it is expected that there will be MainServiceTemplate.cert. This is mentioned in the TOSCA MetaFile. For example, in the TOSCA MetaFile, it could be mentioned "Entry-Certificate: Artifacts/resource-gnodeb-template.cert". And VNF SDK would check to make sure that the resource-gnodeb-template.cert file exists in the mentioned directory, the Artifacts in this case. VNF SDK does not look inside this file.

    (Needs Investigation) SOL004 has option 1 (signing each artifact individually / individual digest) and option 2 (sign entire package). It would be nice if VNF SDK supported both Option 1 and Option 2.

    (Needs Investigation) VNF-SDK option 1/2 support still needs investigation (as of Feb 18, 2019). Need to clarify how to do the test.

    ASSOCIATED DEVELOPMENT:

  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-560
    • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-561
    JiraserverONAP JIRAcolumnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolutionserverId425b2b0a-557c-3c0c-b515-579789cceedbkeyVNFRQTS-562

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    key

    VNFRQTS

    VNFSDK-

    563
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-564
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-565
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-566
    • JiraserverONAP JIRAcolumnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolutionserverId425b2b0a-557c-3c0c-b515-579789cceedb

    342

    QUESTION is the file is not there will the process abort or is a warning given?

    R4

    HIGH

    #4: SOL004 PNF TAGS

    Check keywords. needs VNF SDK to check the PNF keywords. in the MainServiceTemplate.mf there are new tags:

    • pnfd_name
    • pnfd_provider,
    • pnfd_archive_version,
    • pnfd_release_date_time

    and the file list

    and the NON ETSI MANO artifact tags public tags. These public tags are under the "non_mano_artifact_sets". This would be NEW development in VNF SDK. An example Manifest file is shown in this diagram:

    metadata:                                                      
    pnfd_name: gNB
    pnfd_provider: Ericsson
    pnfd_archive_version:1.0
    pnfd_release_date_time:2018-12-03T08:44:00-05:00

    source: Definitions/MainServiceTemplate.yaml    
    source: Definitions/etsi_nfv_sol001_vnfd_2_5_1_types.yaml
    source: Definitions/etsi_nfv_sol001_pnfd_2_5_1_types.yaml

    non_mano_artifact_sets: 
    onap_ves_events:
      source: Artifacts/Events/VES_registration.yaml
    onap_pm_dictionary:
      source: Artifacts/Measurements/PM_Dictionary.yaml
    onap_yang_module:
      source: Artifacts/Yang_module/Yang_module.yaml
    onap_others:
      source: Artifacts/scripts/install.sh
      source: Artifacts/Informational/user_guide.txt
      source: Artifacts/Other/installation_guide.txt
      source: Artifacts/Other/review_log.txt

       which shows the use of some of these fields.

    ASSOCIATED DEVELOPMENT:

    keyVNFRQTS-567

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    key

    VNFRQTS

    VNFSDK-

    568

    339

    jira


    R4

    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-570
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-572
    • JiraserverONAP JIRAcolumnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolutionserverId425b2b0a-557c-3c0c-b515-579789cceedb

    High

    #5: VALIDATION FOR META DATA CHECK (ETSI SOL004)

    Following ETSI SOL004 Validation for Meta-Data file and Manufacturer file, this is the TOSCA.meta file that is part of the PNF Package. Both VNF SDK implementing only meta-data option, in the package there is a meta file. Check TOSCA.meta, while this file is not mandatory, when it is included that it follows the SOL004 standard (ETSI). We expect that "TOSCA-Meta-Version" and "CSAR-Version" and "Created by" are already supported, and new checks for "Entry definition, ETSI-Entry-manifest, ETSI-Entry-change-log" would be new VNF SDK development work (needs to be verified).


    TOSCA-Meta-File-Version: 1.0
    CSAR-Version: 1.1
    Created-By: Ericsson
    Entry-Definitions: Definitions/MainServiceTemplate.yml     
    ETSI-Entry-Manifest: MainServiceTemplate.mf
    ETSI-Entry-Change-Log: Artifacts/ChangeLog.txt


    VNF SDK does the check the TOSCA.meta file today, if a few keywords is there.

    ASSOCIATED DEVELOPMENT:

    keyVNFRQTS-573

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    key

    VNFRQTS

    VNFSDK-

    574

    339

    jira

    R4

    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-575
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-576
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-577
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-578
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-579
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-580
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-581
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-582
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-583
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-584
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-585
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-586
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-587
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-588
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-589
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-590
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-594
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-595
  • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-601
    • Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFRQTS-593
      1. Network Function requirements shall be updated to cover PNF package, descriptor and artifacts
      2. VNF requirements could be reviewed.
      3. Remove or modify the existing package / documentation requirements (some of them is from the RFP or heat template only)
    PTL notified (01/16)

    USE CASE ANALYSIS, SUPPORTING MATERIAL

    The following material is used during Dublin timeframe as input for discussion. It is subject to updates during Dublin timeframe. A final version will be available by Dublin signoff. 

    PACKAGE DELIVERY: ARTIFACTS & PRODUCTS

    Image Removed

    ...

    SDC Data Model

    ...

    VES event registration file/
    FM dictionary,

    PM dictionary

    ...

    Run time Catalog

    ...

    Configuration Models and Files,

    (including Ansible Playbooks)

    ...

    Multiple artifacts can be provided by a vendor in the Package. A list of the supported artifacts by ONAP will be finalized during Dublin timeframe.

    Note about the picture: NF Registration stands for VES event registration file. Info model provided in the picture, just as example 

    PACKAGE DELIVERY: PACKAGE CREATION (VENDOR PROVIDED)

    Image Removed

    The PNF Onboarding Package could contain the following things:

    ...

    PNF Descriptor. The PNFD is a model which describes the requirements and capabilities of the PNF. The ETSI SOL 001 specification also suggests a model that can be used for a PNFD. This could be a TOSCA definition of the PNF.

    MANDATORY

    ...

    Definition of VES Events. The NF Registration is defined by the VES Registration specification.

    You can read about the VES Event Listener here: Service: VES Event Listener 7.0.1

    MANDATORY

    ...

    NF Licensing information that needs to be included in the Package

    N/A for PNF

    ...

    Informational artifacts include:

    • Cloud Questionnaire
    • Features
    • Vendor Test Scripts
    • Resource Security Template
    • HEAT Template (Vendor)
    • Capacity Descriptive
    • Other Informational Artifacts

    OPTIONAL

    ...

    Configuration Files related to the NF for configuration management

    OPTIONAL

    ...

    Ansible Playbooks to interact with NF. These are anticipated to be used with the communication of the NF controller to the NF. This can be seen in the PNF Plug and Play Wiki: 5G - PNF Plug and Play

    OPTIONAL

    PACKAGE DELIVERY: PNF PACKAGE FILES & DIRECTORIES

    The onboarding PNF Package must be defined as specified as ETSI SOL004v2.6.1 + NFV CR NFVSOL(18)000746r3 

    The package structure must be a CSAR with TOSCA-Metadata as specified in SOL004 section 4.1.2
    The TOSCA.meta file keyname extension: SOL004 section 4.1.2.3

    EXAMPLE of the TOSCA.meta

    TOSCA-Meta-File-Version: 1.0
    CSAR-Version: 1.1
    Created-By: Ericsson
    Entry-Definitions: Definitions/MainServiceTemplate.yml     
    ETSI-Entry-Manifest: MainServiceTemplate.mf
    ETSI-Entry-Change-Log: Artifacts/ChangeLog.txt

    END of EXAMPLE 

    ...

    • metadata with following keynames: pnfd_ provider, pnfd_name, pnfd_release_date_time, pnfd_archive_version
    • a list of all files contained in or referenced from the package with their location, expressed using a Source: location/name key-value pair. 
    • Non-mano-artefact tag: ONAP defined tags

    EXAMPLE of the PNF manifeat file

    metadata:                                                      
    pnfd_name: gNB
    pnfd_provider: Ericsson
    pnfd_archive_version:1.0
    pnfd_release_date_time:2018-12-03T08:44:00-05:00
    source: Definitions/MainServiceTemplate.yaml    
    source: Definitions/etsi_nfv_sol001_vnfd_2_5_1_types.yaml
    source: Definitions/etsi_nfv_sol001_pnfd_2_5_1_types.yaml
    non_mano_artifact_sets: 
    onap_ves_events:
      source: Artifacts/Events/VES_registration.yaml
    onap_pm_dictionary:
      source: Artifacts/Measurements/PM_Dictionary.yaml
    onap_yang_module:
      source: Artifacts/Yang_module/Yang_module.yaml

    onap_ansible_playbooks:

      source: Artifacts/Playbooks/playbook.yml

    onap_others:
      source: Artifacts/scripts/install.sh
      source: Artifacts/Informational/user_guide.txt
      source: Artifacts/Other/installation_guide.txt
      source: Artifacts/Other/review_log.txt

    HIGH


    #6: PACKAGE SECURITY

    Driven from ETSI GS NFV-SOL 004 v2.7.1 (Dec 2019)

    Option 1 : TOSCA.meta (exists) Meta-directory based, XML based approach. Option 2 (NOT support in R4 Dublin): CSAR without TOSCA.meta. Manifest (.mf) file that has everything (so the TOSCA.meta is redundant). Yaml-based approach. from.  Manifest file has digest (hashes) for each individual file locally stored in the VNF package. The VNF package shall verify the hashes in the manifest file. (Done in R5 El Alto, but released in R6 Frankfurt)

    Option 2 : Package is ensured by signing the CSAR file with the VNF provider private key. The digital signature is stored in a separate file. The provider include X.509 certificate. (Done in R4 Dublin)

    END of EXAMPLE

    The following diagram illustrates a basic PNF package and some suggested file structure and content in the directories.

    Image Removed

    The PNF package is expected to be a CSAR package with file extension .csar.

    PNF PACKAGE SECURITY

    According to ETSI SOL004 v2.6.1 the onboarding package shall be signed. ETSI SOL004 provides two options:

    Option 1 - One Digest for each components of the VNF package. The table of hashes is included in the manifest file, which is signed with the VNF provider private key. A signing certificate including the provider’s public key shall be included in the package.  

    Option 2 - The complete CSAR file shall be digitally signed with the provider private key. The provider delivers one zip file consisting of the CSAR file, a signature file and a certificate file that includes the VNF provider public key.

    In Dublin release option 2 is going to be implemented in SDC.

    • The VNF/PNF package authenticity and integrity is ensured by signing the CSAR file with the provider private key. The digital signature is stored in a separate file.
    • The VNF/PNF provider shall also include an X.509 certificate in a separate file with extension .cert or, if the signature format allows it, in the signature file itself. The VNF/PNF provider creates a zip file consisting of the CSAR file with file extension .csar, signature and certificate files. The signature and certificate files shall be siblings of the CSAR file with extensions .cms and .cert respectively.
    • Only CMS signature file format is supported in this release.
    • At pre-onboarding of the PNF/VNF package, VNFSDK tool could verify the signature of the complete CSAR package with the provider’s public key
    • At onboarding of the PNF/VNF package, SDC could verify the signature of the complete CSAR package with the provider’s public key.
    • At onboarding, SDC is expecting package file extension as following:
      • Heat template: .zip
      • TOSCA without package security: .csar
      • TOSCA with package security (option 2): zip file consisting of the CSAR file, a signature file and a certificate file .

    PNF PRE-ONBOARDING: VNF-SDK ENHANCEMENTS

    Image Removed

    VNF SDK is (optionally) responsible to validate the PNF package provided by the vendor.

    VNF SDK can also be used (optionally) to create a PNF package.

    Today, optionally, the VNF SDK is also able to provide 

    We expect the VNF SDK development to be able to reuse much of the functionality from VNF SDK, format delivery, processing are all the same except HEAT deployments templates are not used (as they do not apply to PNFs).

    The VNF SDK will be used to VALIDATE the PNF Onboarding Package

    It is possible for a user to bring in the PNF Onboarding Package (provided by a vendor) without the use of the PNF SDK tools.

    Some of the NF artifacts are created by the SDC tool.

    [INVESTIGATE] What are artifacts that SDC adds during the Onboarding process, looking at SDC supported artifact types, possibly VENDOR LICENSE and MODEL INVENTORY (are there others?)

    Check keywords. needs VNF SDK to check the PNF keywords. in the MainServiceTemplate.mf there are new tags:

    • pnfd_name
    • pnfd_provider,
    • pnfd_archive_version,
    • pnfd_release_date_time

    and the file list

    and the NON ETSI MANO artifact tags public tags. These public tags are under the "non_mano_artifact_sets". This would be NEW development in VNF SDK. An example Manifest file is shown in this diagram:

    metadata:                                                      
    pnfd_name: gNB
    pnfd_provider: Ericsson
    pnfd_archive_version:1.0
    pnfd_release_date_time:2018-12-03T08:44:00-05:00
    source: Definitions/MainServiceTemplate.yaml    
    source: Definitions/etsi_nfv_sol001_vnfd_2_5_1_types.yaml
    source: Definitions/etsi_nfv_sol001_pnfd_2_5_1_types.yaml
    non_mano_artifact_sets: 
    onap_ves_events:
      source: Artifacts/Events/VES_registration.yaml
    onap_pm_dictionary:
      source: Artifacts/Measurements/PM_Dictionary.yaml
    onap_yang_module:
      source: Artifacts/Yang_module/Yang_module.yaml
    onap_others:
      source: Artifacts/scripts/install.sh
      source: Artifacts/Informational/user_guide.txt
      source: Artifacts/Other/installation_guide.txt
      source: Artifacts/Other/review_log.txt

       which shows the use of some of these fields.

    ASSOCIATED DEVELOPMENT:

    TASKVNF SDK S/W FUNCTION - DESCRIPTION

    Release

    Priority

    #1: MANIFEST FILE (VNF SDK) vs FILE CHECK

    (Test only)

    Verifies the MANIFEST file (MainServiceTemplate.mf) and  checks that the defined directories of the PNF package against the manifest file. for example the manifest file might say a files should exist: "Measurements: source: Artifacts/Deployment/Measurements/PM_Dictionary.yaml", the VNF SDK would check that the file PM_Dictionary.yaml exists in the actual PNF package.

    (Confirmed that VNF-SDK supports already Feb 14, 2019). Bogumil Zebek

    There are two repositories: Java, Python. (investigate)

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-340

    • Adapt unit tests to run in Local DCE
    • Extract common manifest logic to separate module
    • Create PNF Manifest file validator
    • Integrate PNF Manifest file validator in CSAR Reader
    • Add CSAR Type flag to CSAR Validation command line.

    R4

    HIGH

    #2: TOSCA MetaFile LICENSE Term File Exists Check (VNF SDK)

    (Test Only)

    VNF SDK will check a License Term File Check in the PNF package. TOSCA meta file points to a License. Just a check that the file exists no content check at all.

    Note: Related requirements standards from ETSI IFA011, SOL004

    ASSOCIATED DEVELOPMENT:

    QUESTION is the file is not there will the process abort or is a warning given?

    (Already Supported, VNF-SDK already supports this confirmed Feb 14, 2019)

    R4

    HIGH

    #3: TOSCA MetaFile CERTIFICATE Check (VNF SDK)

    (Test Only)

    (Test only) CERTIFICATE check. In the PNF package it is expected that there will be MainServiceTemplate.cert. This is mentioned in the TOSCA MetaFile. For example, in the TOSCA MetaFile, it could be mentioned "Entry-Certificate: Artifacts/resource-gnodeb-template.cert". And VNF SDK would check to make sure that the resource-gnodeb-template.cert file exists in the mentioned directory, the Artifacts in this case. VNF SDK does not look inside this file.

    (Needs Investigation) SOL004 has option 1 (signing each artifact individually / individual digest) and option 2 (sign entire package). It would be nice if VNF SDK supported both Option 1 and Option 2.

    (Needs Investigation) VNF-SDK option 1/2 support still needs investigation (as of Feb 18, 2019). Need to clarify how to do the test.

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-342

    QUESTION is the file is not there will the process abort or is a warning given?

    R4

    HIGH

    #4: SOL004 PNF TAGS
    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-339

    R4

    High

    #5: VALIDATION FOR META DATA CHECK (ETSI SOL004)

    Following ETSI SOL004 Validation for Meta-Data file and Manufacturer file, this is the TOSCA.meta file that is part of the PNF Package. Both VNF SDK implementing only meta-data option, in the package there is a meta file. Check TOSCA.meta, while this file is not mandatory, when it is included that it follows the SOL004 standard (ETSI). We expect that "TOSCA-Meta-Version" and "CSAR-Version" and "Created by" are already supported, and new checks for "Entry definition, ETSI-Entry-manifest, ETSI-Entry-change-log" would be new VNF SDK development work (needs to be verified).

    TOSCA-Meta-File-Version: 1.0
    CSAR-Version: 1.1
    Created-By: Ericsson
    Entry-Definitions: Definitions/MainServiceTemplate.yml     
    ETSI-Entry-Manifest: MainServiceTemplate.mf
    ETSI-Entry-Change-Log: Artifacts/ChangeLog.txt

    VNF SDK does the check the TOSCA.meta file today, if a few keywords is there.

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-339

    R4

    HIGH

    #6: PACKAGE SECURITYDriven from SOL004: Option 1 (Supported in R4 Dublin): TOSCA.meta (exists) Meta-directory based, XML based approach. Option 2 (NOT support in R4 Dublin): CSAR without TOSCA.meta. Manifest (.mf) file that has everything (so the TOSCA.meta is redundant). Yaml-based approach.

    The Public Key a key to open the package. SOL004 Option 1, 2 and use key to open the package - X.509 certificates public key, private key to sign the package and private key correspond to the private key of the package also delivered with the package. a package, a signature, and public key certificate delivered together. There may be more than one signature. Option 1 there is a digest for every file. All of those digests are listed in the manifest file. The manifest file is signed, one signature on the manifest. One signature and one key/pair & 1 certificate. Still optional to sign other files. The signature is a file beside. myimage.iso myimage.xyz but the same file/directory. Every file signed should have a signature files. CSAR file signed in a .sm file, package signature. The public key is signed can be signed by a root certificate.

    An X.509 certificate is a digital certificate that uses the widely accepted international X.509 public key infrastructure (PKI) standard to verify that a public key belongs to the user, computer or service identity contained within the certificate.

    (investigate) if VNF-SDK would like to use AAF as the CA. Can AAF perform the CA functions.

    To open the package need: (1) Public Key (to open the manifest file) (2) file input (3) certificate input. create

    a hash, the hash is verified against the signature. SHA-256

    a hash, the hash is verified against the signature. SHA-256

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keySDC-2161


    #7: PNF DESCRIPTOR

    The descriptor. There is validation of the VNFD. PNF Descriptor: TOSCA descriptor, and validate the node type. Validation of TOSCA PNFD. Following TOSCA rules. Components required are there.  (NEEDS INVESTIGATION)

    VNFSDK check the VNFD based on VNF requirements.

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-341

    R4

    HIGH

    #8: PNF PACKAGE TESTING

    (Test Only)

    Enhancement of Package Testing. A item to make sure that integration testing is performed and that VNF-SDK supports the functions as will be described in the Requirements work. Testing the package against the requirements (a user can enter a requirement#) VNF-RQTS project.

    It would be ideal if the PNF Package used by the VNF-SDK work is shared by the rest of the PNF preonboarding/onboarding development & integration.

    ASSOCIATED DEVELOPMENT:

    Jira
    serverONAP JIRA
    columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
    serverId425b2b0a-557c-3c0c-b515-579789cceedb
    keyVNFSDK-343

    R4

    HIGH

    LOW PRIORITY / PUSHED TO R5 EL ALTO
    #F1: CREATE PACKAGE FUNCTION FOR PNFThe create package function creates the metadata files, and CSAR files. This needs to be modified to support SOL004. (NEEDS INVESTIGATION) [Low Priority]

    R5 EL ALTO

    LOW PRI

    #F2: TOSCA Metafile License Content Check

    SDC license model check. Potential ARTIFACTS: Vendor license model & agreement, features. VNF can have >1 features, entitlement pool, license key pools, actual keys.

    [Low Priority] PUSH TO R5 EL ALTO.


    R5 EL ALTO

    LOW PRI




    ...

    the following diagram illustrates the VNF SDK work to check the new PNF tags in Task #4

    Image RemovedImage Added

    The following diagram illustrates the VNF-SDK Task #5 check of the TOSCA Meta file Checks:

    Image RemovedImage Added



    PNF ONBOARDING PACKAGE: PNF ONBOARDING PACKAGE LOADED

    ...

    In Dublin timeframe, the focus is the onboarding package mapping in the internal package and AID model. 

    Image RemovedImage Added


    DESIGN TIME ACTIVITIES: SDC ONBOARDING PACKAGE

    ...

    For model info about the PNF onboarding package format and an example of the format refer to ONAP R4+ Onboarding PNF package format, non-MANO artifacts set definition and PNF package mapping


    Image RemovedImage Added

    DESIGN TIME ACTIVITIES: SDC ONBOARDING PACKAGE MAPPING INTO INTERNAL PACKAGE

    SDC is used to map the Vendor provided onboarding package & PNF descriptor into the Internal Package & Internal (Platform) Data Model


    Image RemovedImage Added

    DESIGN TIME ACTIVITIES: SDC ONBOARDING PACKAGE INTO SDC CATALOG

    ...

    Before it was assumed that VNFs are distributed, in Dublin PNF artifacts are distributed. So for example SO looked for Heat Templates (which were only applicable for VNFs). We need to insure for VNFs). We need to insure that the distribution of PNF artifacts does not break the ONAP platform components. Some ONAP RT assume that any package notification only have VNF artifacts. In practice, there is only the subscription of artifacts (listeners) and the distribution of the PNF package, we need to make sure this behaves correctly and that there are no errors. Pre-integration checks and validation that the distribution of PNF artifacts does not break the ONAP platform components. Some ONAP RT assume that any package notification only have VNF artifacts. In practice, there is only the subscription of artifacts (listeners) and the distribution of the PNF package, we need to make sure this behaves correctly and that there are no errors. Pre-integration checks and validation that the distribution of PNF artifacts will not cause side effects. Want to insure that FM & PM artifacts are distributed properly. PM dictionary would be used in DCAE & PM Mapper. FM Meta Data is new, and from the start (what is new in Dublin) is that it is being used for both VNFs and PNF.

    The NF Package is composed of Artifacts, Definitions, TOSCA-MetaData.

    Image Removed

    SDC CSAR Package Structure

    Csar Structure

    SDC Support Artifacts:

    ...

    will not cause side effects. Want to insure that FM & PM artifacts are distributed properly. PM dictionary would be used in DCAE & PM Mapper. FM Meta Data is new, and from the start (what is new in Dublin) is that it is being used for both VNFs and PNF.

    The NF Package is composed of Artifacts, Definitions, TOSCA-MetaData.

    Image Added


    SDC CSAR Package Structure

    Csar Structure

    SDC Support Artifacts:

    SDC supported artifact types

    ROADMAP - Pre-Onboarding/Onboarding Evolution per Release

    The following table shows a roadmap of pre-onboarding/onboarding evolution broken down by release and function

    FUNCTIONDUBLIN (R4)

    FRANKFURT (R6)


    		GUILIN (R7)
    Package DeliveryInitial Delivery

    Pre-onboarding:

    VNF-SDK Package Validation

    		Initial Delivery

    Onboarding:

    Package into SDC Catalog

    		Initial Delivery

    Onboarding:

    xNF Descriptor mapped to

    Platform Info/Data Model

    		Initial Delivery

    Design Time:

    Usage of Onboarded Package

    Creation of Resource/Svc

    		Initial Delivery

    Run Time:

    Ingestion of Service CSAR by

    ONAP Run-time components

    		Initial Delivery

    The following table has a list of the references pages for the Roadmap

    ReleaseWiki
    Dublin (R4)5G - PNF Pre-Onboarding & Onboarding
    Frankfurt (R6)PNF/VNF PREONBOARDING / ONBOARDING in R6 Frankfurt

    REQUIREMENTS


    This section describes the requirements that are to be updated & added

    ...

    PNF ONBOARDING ARTIFACTSMOCK-UP
    PNF Descriptor TOSCA

    NF Registration (YAML) 

    Defines records for NF events


    Informational Artifacts

    PNF CSAR (Onboarded) package

    (Dummy mockup)

    View file
    namedummyPnfv2.csar
    height250

    PNF CSAR (Onboarded) package

    (Dummy mockup)

    View file
    namedummyPnfv2.zip
    height250


      - You can find actual onboarding files used for integration at: https://gerrit.onap.org/r/gitweb?p=integration.git;a=tree;f=test/mocks/pnf-onboarding;hb=HEAD


    APPENDIX: PNF ONBOARDING OVERVIEW SLIDE PACKS

    ...