Authors: Ben Cheung , Michela Bevilacqua , Zu Qiang
Table of Contents
USE CASES (Scope)
BACKGROUND: (R3 CASABLANCA)
In Casablanca Release, the PnP Use Case covered :
- 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.
PNF PRE-ONBOARDING SCOPE (R4 Dublin)
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 PNF package support in ONAP for 5G and other use cases.
Proposed UC to focus on in Dublin :
- PNF Pre-Onboarding
- PNF Onboarding
- Reference Presentation provided to 5G UC meeting (Nov 15th, 2018): ONAP Dublin_PNFOnboarding.pptx
The pre-onboarding step can be used to verify the PNF package format by VNF SDK tools
Use Case Notes
- This 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 SOL004) and all the artifacts required by ONAP (non ETSI NFV artifacts provided managed as Non-MANO artifact (i.e. FM and PM dictionary))
- PNF Package/Archive shall be pre-onboarded & Verified by VNF SDK tools
- 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)
This is the scope (what is agreed to be delivered) in Dublin for this Use Case.
- A vendor provided PNF package/file archive can be on-boarded in ONAP
Use Case Notes
- ONAP SDC shall also continue to support PNF definition by UI as in Casablanca Release
- ONAP artifacts associated to a PNF can be stored in ONAP catalogues in order to be then utilized also at RT.
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
Descriptor, Artifacts and Package Delivery | PNF Package Pre-onboarding | ONAP onboarding process, PNF Package onboarding | ONAP Design Time activities | ONAP Run Time activities | |
---|---|---|---|---|---|
WHEN | PNF delivery time | NF validation Activities | Onboarding Activities | ONAP Design Time Activities | ONAP Run Time |
WHO | Vendor | Technology Specialist | Technology Specialist Asset Manager | Service Designer Operations Specialist | Operations Specialist |
WHAT | Descriptor, Artifacts and Package delivery | PNF Package | PNF Package, PNF Descriptor PNF Onboarding | ONAP Common Information Model SDC Data Model 5G Service Definition | 5G Service Instantiation PNF Instance A&AI PNF Instance |
ETSI NFV reference | SOL001 PNFD SOL004 Package | SOL004 Package | SOL001 PNFD, SOL004 Package | - | - |
PNF PRE-ONBOARDING & ONBOARDING DUBLIN WORK
DELIVERABLE | DESCRIPTION |
---|---|
NF Package | Producing and collecting NF artifacts for a NF package. Vendor provided. Dublin Priorities are the PNFD and NF Registration YAML File. |
PNF-SDK | Enhance VNF-SDK to be able to create a PNF onboarding Package. The SDK is a set of tool which can take the NF Package and create the PNF onboarding package the SDC will use. Under discussion: the development a PNF-SDK for PNFs as opposed to using VNF-SDK for PNFs. |
PNF Onboarding Package | Create a PNF onboarding package through PNF-SDK. This is the output of the PNF-SDK. |
Onboard the Package | SDC Enhancements need to be made to onboard the PNF Package and enter into the SDC Catalog |
Proper Distribution & Reception of SDC CSAR | SDC creates a CSAR package for the PNF including artifacts, and TOSCA definitions. This work will include the PNF artifacts into CSAR package. The 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. 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. |
PROJECT IMPACT OVERVIEW
The following table gives an overview and summary of the ONAP RT Component Project impacts.
COMPONENT | IMPACT DESCRIPTION | PTL |
---|---|---|
Service Design & Creation Project |
| Ofir Sonsino |
VNF SDK Project | PACKAGE VERIFICATION - PNF package format verification MODEL - VNF SDK Model, PACKAGE USAGE - Package for PNF Onboarding Package for use in VNF SDK | Weitao Gao |
Modeling Project | PNFD MAPPING - Onboarded PNFD to platform PNFD mapping | Hui Deng |
VNF Requirements Project |
|
DEVELOPMENT STATUS
INVESTIGATE: is there impact to SO (for Runtime PNF artifact & SDC CSAR package ingestion)
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
PACKAGE DELIVERY | ONBOARDING PROCESS | DESIGN TIME | RUN TIME |
---|---|---|---|
NF Descriptor | NF Descriptor Model | SDC Data Model | A&AI PNF Data model, PNF instance |
VES event registration file/ PM dictionary | artifact | SDC Catalog | Run time Catalog |
Informational Artifacts | artifact | SDC Catalog | Run time Catalog |
Configuration Models and Files, (including Ansible Playbooks) | artifact | SDC Catalog | Run 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)
The NF Onboarding Package could contain the following things:
ARTIFACT | DESCRIPTION |
---|---|
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 OPTIONAL |
Informational Artifacts | Informational artifacts include:
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 PNF Package files and directories is described in this section.
There are some "Basic" files that should be included with each PNF package. (?? what are they ??)
There (may) be some mandatory files/directories that SDC expects within each PNF package (?? to be investigated ??)
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.
PNF PACKAGE & FILE - "BASELINE"
The following things are agreed and will be targeted for delivery in Dublin:
PNF PACKAGE & FILE - UNDER DISCUSSION
The following things are still under discussion and investigation:
PACKAGE DELIVERY: PNF PACKAGE LICENSING
The PNF package "shall" have a Licensing.term (file)
This is also still under discussion (driven from the standards)
This section will be updated with what is contained in the actual PNF package.
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?)
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 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.
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
SDC Support Artifacts:
SDC supported artifact types
TESTING
Test Environment: TBD
Integration Team Liasion: TBD
Current Status:
- The Use Case is not functional yet, nor in the test laps and is not yet ready for the Dublin release
- Testing has not begun yet to show the test case works
Summary Testing Status:
GOAL | TEST CASE | STATUS |
---|---|---|
SDC1: PNF Package Format. | ## | NOT IMPLEMENTED |
SDC2: Package Mapping | ## | NOT IMPLEMENTED |
SDC3: PNFD Mapping | ## | NOT IMPLEMENTED |
SDC4: Artifact Management | ## | NOT IMPLEMENTED |
VNFSDK1: PNF Package Verification | ## | NOT IMPLEMENTED |
VNFSDK2: PNFD Model | ## | NOT IMPLEMENTED |
MODEL1: Mapping PNFD Model to PNFD Platform Model | ## | NOT IMPLEMENTED |
VNFRQT1: PNF Package Descriptor, Artifacts requirements | ## | NOT IMPLEMENTED |
APPENDIX SUPPORTING DOCUMENTS
Supporting documents related to PNF Onboarding
ETSI SOL Standards
The following has the ETSI SOL standards for your convenience
STANDARD | FILE |
---|---|
ETSI SOL1 (PNF/VNF Descriptor) | |
ETSI SOL 4 (NF Package) | |
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
PNF ONBOARDING ARTIFACTS | MOCK-UP |
---|---|
PNF Descriptor TOSCA | |
NF Registration (YAML) Defines records for NF events | |
Informational Artifacts |
APPENDIX: PNF ONBOARDING OVERVIEW SLIDE PACKS
Package | Slides |
---|---|
PNF Onboarding Package | |
PNF Packaging Discussion |
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