1. Scope
DESCRIPTION: This flow describes the the onboarding of resources into SDC. This can apply to a new resource or an upgraded resource. A resource can be a VNF or PNF. Resources are onboarded into the SDC catalog during design time. This flow will describe what happens when a resource is brought into SDC. A resource in the SDC catalog can then be used in design time to define a service.
WHEN EXECUTED: During Design Time (before Run Time). When SDC Service imports a Resource into the SDC catalog.
PURPOSE: To bring in a VNF or PNF resource into SDC during design time.
INFORMATION PASSED: Vendor provided PNF onboarding package.
ACTORS:
- Service Designer
- Operations Specialist
- SDC (Deployment Studio)
2. Pre-Conditions
Vendors will prepare the Onboarding package:
- MODELS IN SDC - SDC contains the verified service and resource descriptor (models). These resource descriptors are provided by the vendor (PNFD and VNFD).
- xNFs ONBOARDED - Associated resources (PNF, VNF, ANF) used by services have been properly onboarded.
- SERVICE DEFINED - Services have been defined in design time, and associated templates, control loops, blueprints have been incorporated into the service CSAR package.
- SERVICE CSAR PACKAGE - SDC has composed the Service Design CSAR package ready for distribution.
- CERTIFICATION STUDIO - The Certification Studio has certified the Package ready for distribution
- DEPLOYMENT STUDIO - The Deployment Studio operator has identified the Service Design CSAR package for distribution.
- SOFTWARE - Software images loaded in OpenStack installation, where instantiation will happen (since no S/W image repository). Need to be available in Target Cloud Instances.
- USER & CATALOG - The User at OSS or VID has knowledge of the Service Model Identifier that they wish to create a service instance of. The Service is seen as available in the catalog.
The Onboarding Package Contains:
The following shows a diagram of the PNF Onboarding package which must be put together
A description of the things in the PNF Onboarding Package
- PNF DESCRIPTORS (PNFD) - (Instantiation/Design Time) PNFD and VNFD have been mapped to ONAP platform data/information model. That is, the onboarded descriptor models (vendor provided) have been mapped onto ONAP platform data & information models that are useable and known to ONAP.
- TOSCA METADATA - This file provided by the vendor describes the meta-information about the package. Notably it gives the key files in the package and their locations in the package as directory paths.
- MANIFEST FILE - The Manifest file include basic information about the package itself.
- VES EVENT REGISTRATION - This file describes all of the events that are supported by the PNF. It defines the possible events that the PNF can support, such as faults, heartbeating, Performance measurements. These are defined in the VES Event specification document available in the repository. The Event Registration also defines all of the fields that each of these events have also
- PM DICTIONARY - Performance Measurements definitions.
- ANSIBLE PLAYBOOKS - Ansible playbooks define the "scripts" that are used for remote ansible communications from ONAP towards a PNF.
- NETCONF YANG MODELS - Defines the NetConf Yang Models that are used for NetConf communications between ONAP and the PNF.
- CHEF COOKBOOKS - When Chef communications are supported between ONAP and the PNF, these define the communication playbooks that are used by Chef
- MANUALS - Manuals can be included as informational artifacts in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
- HELP FILES - Help files can be included as informational artifacts in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
- CUSTOMER DOCUMENTATION PRODUCTS - Customer documentation products can be included as informational artifacts in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
- TEST FILES - Manuals can be included as informational artifacts in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
- LICENSING AGREEMENTS - Licensing agreements can be included as informational artifacts in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
- RESOURCE CONFIGURATION INFORMATION - Resource Configuration Information can be included in the PNF onboarding package provided by the vendor. These are optional files and are not necessarily included in a package. They can be viewed by an ONAP operator in design time.
3. Information Flow
The following diagram shows the PNF Pre-onboarding/Onboarding Flow: