TABLE OF CONTENTS
USE CASE OBJECTIVES
PNF Pre-Onboarding Use Case Objectives:
- PNF package/archive shall be pre-onboarded (provided by Vendor)
- PNF package is verified by xNF SDK tools
- This Use Case shall be aligned as much as possible to the ONAP VNF package pre-onboarding UC
- This Use Case will update the requirements for a xNF Package in the VNF Requirements project
- 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)
- The Structure of the PNF package shall be defined (the artifacts to be supported, and a package directory structure)
- (Optional) The xNF SDK may also be used to add Artifacts to the PNF Package.
- Updates to the VNF SDK shall be made to accommodate PNF packages. (Possibly re-title the project to PNF SDK)
PNF Onboarding Use Case Objectives:
- PNF archive can be on-boarded through ONAP
- ONAP SDC shall also continue to support PNF definition by UI as in Casablanca Release
- SDC needs to support an on-boarded PNF package and allow it to be used in service definitions.
- SDC shall add the appropriate meta-data to the PNF package for storage into the SDC design Catalog.
- ONAP RT Components must be able to successfully ingest utilized PNF on-boarded artifacts.
IMPACTED PROJECTS
| PROJECTED | DESCRIPTION OF IMPACT |
|---|---|
| VNF requirements | |
| SDC | |
| VNF-SDK | |
PNF PRE-ONBOARDING & ONBOARDING OVERVIEW
| PACKAGE DELIVERY | ONBOARDING PROCESS | DESIGN TIME | RUN TIME | |
|---|---|---|---|---|
| WHEN | PNF Package | Onboarding Activities | Design Time Activities | ONAP Run Time |
| WHO | Vendor | Technology Specialist Asset Manager | Service Designer Operations Specialist | Operations Specialist |
| WHAT | On-Boarding Package | PNF Descriptor Model PNF SDK PNF Onboarding | Platform Information Model Platform Data Model 5G Service Definition | 5G Service Instantiation PNF Instance A&AI PNF Instance |
| ETSI | SOL001 PNFD | SOL004 Package | - | - |
PRE-ONBOARDING: ARTIFACTS & PRODUCTS
| PACKAGE DELIVERY | ONBOARDING PROCESS | DESIGN TIME | RUN TIME |
|---|---|---|---|
| NF Descriptor | PNF Onboarding Package | Platform Information Model | A&AI PNF Entry |
| NF Registration | NF Descriptor Model | Platform Data Model | PNF Instance |
| Informational Artifacts | SDC Catalog | PNF Discovery & Plug and Play | |
| Configuration Files | 5G Service Definition | 5G Service Instantiation | |
| Ansible Playbooks |
DUBLIN ACTIVITIES FOR PNF PRE-ONBOARDING & ONBOARDING
| 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 | Develop PNF-SDK (or 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. |
| 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 |
| Distribution of 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. |
PNF PRE-ONBOARDING: 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 MANDATORY |
| 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 |
Michela Bevilacqua - Add the PNF Onboarding diagram here
PNF PRE-ONBOARDING: PNF-SDK DEVELOPMENT
PNF SDK development is needed to take PNF artifacts and add them to a PNF Onboarding Package in Dublin.
We expect the PNF 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 PNF 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: PNF ONBOARDING PACKAGE LOADED
PNF Onboarding Package (vendor provided) is successfully loaded into ONAP.
PNF-D Information Model:
PNF ONBOARDING: 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
PNF ONBOARDING: 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.
PNF ONBOARDING: CSAR INGESTION TO ONAP RT COMPONENTS
Inclusion of PNF artifacts into CSAR package, and ingestion of CSAR package by ONAP Run-Time Components and verification of reception and use.
The NF Package is composed of Artifacts, Definitions, TOSCA-MetaData.
SDC CSAR Package Structure
SDC Support Artifacts:
APPENDIX: PLATFORM MODELING
A Platform Information Model and Platform Data Model should be settled on and approved to represent resources that ONAP needs to work with such as a PNF and VNF that will be used to represent a 5G DU and 5G CU / VNF.
The was formerly known as a Internal Data Model, but has subsequently been renamed "Platform Data Model".
There are still a number of fundamental decisions that need to be made before finalizing on the Platform Data model for example, the separate of a PNF Device Object.
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) | |
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 | |
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)