Authors: Benjamin Cheung , Michela Bevilacqua , Zu Qiang

Table of Contents

USE CASES (Scope)

BACKGROUND: (R3 CASABLANCA)

In Casablanca Release, the PnP Use Case covered :

 - manually onboarding a PNF at Design Time

 - PNF Instantiation in ONAP at Run Time

In Casablanca Release, the PnP  Use Case did not cover the PNF pre-onboarding / onboarding.

PNF R4 Dublin SCOPE

This is the scope (what is agreed to be delivered) in Dublin for this Use Case. 

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

Proposed new UCs in Dublin :

• PNF Pre-Onboarding
• PNF Onboarding

Reference Presentation provided to 5G UC meeting (Nov 15th, 2018): ONAP Dublin_PNFOnboarding.pptx

PNF PRE-ONBOARDING SCOPE (R4 Dublin)

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

Use Case Notes

• 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 can be on-boarded in ONAP. The onboarding step is mandatory to onboard artifacts and descriptor provided by the vendor.

 Use Case Notes

• ONAP SDC shall also continue to 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 in ONAP catalogues in order to be then utilized also at run time. 
• The PNF 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

PNF PRE-ONBOARDING & ONBOARDING DUBLIN WORK

PROJECT IMPACT OVERVIEW

The following table gives an overview and summary of the ONAP RT Component Project impacts.

DEVELOPMENT STATUS

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

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)

The PNF Onboarding Package could contain the following things:

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.

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

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?)

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

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

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

PNF ONBOARDING PACKAGE: PNF ONBOARDING PACKAGE LOADED

PNF Onboarding Package (vendor provided) is successfully loaded into ONAP.

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

DESIGN TIME ACTIVITIES: SDC ONBOARDING PACKAGE

SDC takes the Vendor provided package and adds some files or changes files and meta data according to SDC procedure.

The following is the SDC onboarding procedure

The following diagram shows the mapping from the Vendor-provided PNF onboarded package into the SDC Internal PNF 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

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

DESIGN TIME ACTIVITIES: SDC ONBOARDING PACKAGE INTO SDC CATALOG

SDC Design Studio is then used to define a Service, and the output of that is a CSAR package which defines the Service.

Enhancements to SDC to take PNF Onboarding Package into the SDC Catalog

SDC distributes services

NF CSAR package includes the artifacts and information for the resources for a service.

There is one CSAR file which includes all of the definition for that service.

The work-flows are created by SDC DS.

DESIGN TIME ACTIVITIES: LICENSING MANAGEMENT & SCHEMA

DEFINITION: The licensing schema could vary and be dependent upon the service provider. Licensing schema is expected to be used to identify or authorize the existence a particular PNF into the network of the service provider. It might also be possible that multiple licenses are needed for different functions or authentication. It may also be important to provide a license during PNF Plug and Play. This implies that the Service Provider has defined a licensing schema or has licensing management software to manage licenses.

R4 DUBLIN: For Dublin, it is to be determined what will be done (maybe nothing). This is likely to be FUTURE work (El Alto and beyond)

Note: SDC adds files related to Licensing AFTER Onboarding.

Note: this might be able to refreshed yearly. And the file might be updated periodically. e.g. the xNF is properly orchestrated and then a year later the license expires. Artifacts associated w/ a xNF are static except the license file (or license certificate). License file renewal. Part of the recipe communicate w/ central license manager to obtain license to use for the xNF.

Note: In ETSI SOL the license key is not part of the package. The PNF package has a license term file (describes the terms of the license).

Note: (Feb 4) Model team said "this is still a work in Progress for R4" - Potential ARTIFACTS: Vendor license model & agreement, features. VNF can have >1 features, entitlement pool, license key pools, actual keys.

PNF UI (User Interface)

Simulator.

PM/FM (UI) User Interface.

RUN TIME ACTIVITIES: CSAR INGESTION TO ONAP RT PLATFORM COMPONENTS

Inclusion of PNF artifacts into CSAR package, and ingestion of CSAR package by ONAP Run-Time Components and verification of reception and use.

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 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.

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

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

REQUIREMENTS

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

(This section under development)

TESTING

E2E Test

• 5G - PNF Pre-Onboarding, PNF Onboarding

Test per functionality:

• 5G - PNF Pre-Onboarding Test Cases and Status
• 5G - PNF Onboarding Test Cases and Status
• 
  

Master Integration Test Page: Dublin Release Integration Testing Status

Summary Testing Status:

APPENDIX SUPPORTING DOCUMENTS

Supporting documents related to PNF Onboarding

ETSI SOL Standards

The following has the ETSI SOL standards for your convenience

STANDARDS & LICENSING (ETSI SOL004)

In ETSI SOL004 requires a "License.term", but it is still being defined & under discussion.

(this section will be updated when the standards have been finalized)

APPENDIX: PNF Onboarding Artifacts

The following are mock-ups of the PNF Onboarding Artifacts

08 Jul 2020  - 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

APPENDIX: VNF REQUIREMENTS

The PNF Package requirements need to be developed, and the VNF Package Requirements can be used as a guideline for what a PNF might need.

VNF Packaging Requirements - The appropriate Requirements page is at:

https://onap.readthedocs.io/en/beijing/submodules/vnfrqts/requirements.git/docs/Chapter7.html

Requirements Appendix:

https://onap.readthedocs.io/en/beijing/submodules/vnfrqts/requirements.git/docs/Chapter8.html

SDC Repository

https://gerrit.onap.org/r/#/admin/projects/sdc

(Click on BRANCHES, on the "MASTER" row, click on gitweb, click on TREE in the top navigation row)

Path in SDC:

openecomp-be\backend\openecomp-sdc-vendor-software-product-manager\src\main\java\org\openecomp\sdc\vendorsoftwareproduct\impl\orchestration\csar