Versions Compared

Key

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

1. Scope


DESCRIPTION: What do we mean by onboarding? A design time activity that brings "onboard" a resource into ONAP for later use in services. 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.

...

  • Service Designer
  • Operations Specialist
  • SDC (Deployment Studio)


PREONBOARDING


ONBOARDING

 - TOSCA Onboarding, HEAT Onboarding, Manual Onboarding


For PNFs


PACKAGE DELIVERY - A vendor delivers a package that is to be onboarded. Note: that if you use Manual onboarding in SDC you do not need to have a PNF package.

PRE-ONBOARDING - In VNF-SDK can validate the PNF package (optional).

ONBOARDING - SDC allows you to create a xNF resource without a PNF package (manual onboarding). Before services are created, SDC creates resources. You can (1) use HEAT template, or (2) use TOSCA template, or (3) use a SDC GUI to manually create a resource.


For VNFs:


2. Pre-Conditions

...


ONAP is ready:

  • MODELS IN SDC - SDC contains the verified service and resource descriptor (models)is ready to ingest a package. Platform Information & Platform Data model are available.
  • CERTIFICATION STUDIO - The Certification Studio has certified the Package ready for distribution
  • ONAP SOFTWARE - There is an ONAP installation. Software images loaded in OpenStack installation, where instantiation will happen (since no S/W image repository). Need to be available in Target Cloud Instances.


PACKAGE (Vendor/Optional)

Vendors will prepare the Onboarding package (if you are not manually onboarding) The Onboarding Package Contains:

...

A description of the things in the PNF Onboarding Package SOL004 TOSCA-based Package for PNFs.

  • 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. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • ANSIBLE PLAYBOOKS - Ansible playbooks define the "scripts" that are used for remote ansible communications from ONAP towards a PNF. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • NETCONF YANG MODELS - Defines the NetConf Yang Models that are used for NetConf communications between ONAP and the PNF. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • CHEF COOKBOOKS - When Chef communications are supported between ONAP and the PNF, these define the communication playbooks that are used by Chef. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • 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. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • 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. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • 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. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • 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. This is not included in R4/Dublin.
  • 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. This is not included in R4/Dublin and has been postponed.
  • 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. This is OPTIONAL, a PNF package does NOT necessarily have this artifact.
  • CONTROLLER BLUEPRINT ARTIFACT - From a controller perspective, there is a TOSCA implementation to execute template for configuration. These include Velocity templates, Jinja template. They can be generic or per PNF type (customized). This is OPTIONAL, a PNF package does NOT necessarily have this artifact. In future releases this could be incorporated into the PNF package. In R4/Dublin a ONAP user would manually upload the Controller Blueprint Artifact.

3. Information Flow

The following diagram shows the PNF Pre-onboarding/Onboarding Flow:

...