Table of Contents

FM META DATA / 5G BUSINESS DRIVER

This section describes Business Drivers for the FM Meta Data and PM DIctionary Use cases.

Executive Summary - Service Providers need to have vendor information for alarms raised by NFs and information on the meaining of measurements provided by NFs that they integrate into their networks.  THe FM Meta data provides a consistent way that vendors provide this information into ONAP thereby enabling the use of Analytics applications and potentially CLAMP to use this data across vendors to create policies

Business Impact - consistent format of meta data enable the introduction of automated analytics applications that can pull information out of the FM meta data to support data analysis and policy creation

Business Markets - needed by all service providers

Funding/Financial Impacts - n/a

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.

for PM related Business Drivers, see the Performance Measurement Overview Page: PERFORMANCE MEASUREMENTS USE CASES: Bulk, RT, Dictionary

5G NF FM Meta Data:

Scope: 

Gain approval for the content and delivery of the FM Meta Data as part of the FM YAML Registration for a 5G NF to ONAP.  This assumes that the work to support the collection onboarding and publication of PNF artifacts processing of the FM meta data in the YAML registration artifact is covered under the PNF Onboarding Package 5G USE Case Work Item—it is not addressed here.

...

The Fault Event will carry key information about a fault that is occurring.  However, for efficiency sake, information that does not change but is still important for understanding the fault and determining an appropriate response should be available to the Policy creators and potentially analytics applications.  In legacy RAN products, this information was provided in an FM Dictionary/Meta Data File.  In ONAP, the information is recommended to be provided as part of the YAML Registration.  In this exercise, the goal is to identify fields and provide common names and definitions for the content of those fieldsprovide support in ONAP for a common FM Meta Data artifact. Below are steps envisioned

• Finalize the fields applicable for FM meta-data (those that were provided in dictionaries in the past) and gain agreement that this information should be provided by the NF.
• Identify which fields are mandatory and with fields are optional. 
• Review with the community the meta data content including which fields are already covered in the fault event. 
• Present again the proposal to have the fault event include this information in the registration YAML.
• Publish requirements on NFs to provide the FM Dictionary information in the Fault Event registration YAML (NOTE this approach means that there is NOT a separate FM Dictionary artifact that is delivered as part of NF onboarding.

Projects Impacted:

VNF Requirements, DCAE (VES Registration Document needs to be updated), potentially policy so that the processing of the YAML with the use of the dictionary fields is automated (stretch goal).  This approach does not require SDC or modeling changes because NFs already have to provide registration YAMLs.  This is extending what that YAML provides.  No new things have to be catalogued or defined.

1. Review and finalize VES Event Listener Specification and VES Event Registration Specification which contains the FM Meta Data format and content. 
2. Onboard the FM Meta Data for an xNF as part of the VES Event Registration YAML file and store in the SDC Catalog. Note that the work to support the onboarding and processing of the FM metadata artifact is covered under the PNF Onboarding Package 5G Use Case Work Item.  It is not addressed here.
3. Display the FM Meta Data in a Design Time GUI (for example SDC-DS, Policy Designer or DCAE-DS) to allow an ONAP User to create Policies for handling alarms.
4. Update VNF Requirements for FM Meta Data artifact.

Display of FM Meta Data (GUI)

The following image shows the SDC Deployment Artifact screen where you will be able to see the PNF Onboarded Meta Data located in the VES Registration Yaml file.

The following is from SDC GUI, in the Deployment Artifact Screen:

Image Added

The following image shows a conceptual diagram of what we are aiming to achieve with the DISPLAY (GUI) aspect of this Use Case:

Image Added

(1) The User is able to open and select a PNF resource and its associated FM Meta-Data file.

(2) The User selects the appropriate VES Registration YAML artifact from the onboarded PNF package.

(3) In the SDC Deployment Artifact GUI, a User will be able to make the appropriate selections and view the selected VES Registration YAML.

(4) The diagram shows how the columns of the FM Meta-Data would be show across the columns (vertically) and each row (horizontally) would contain information for one alarm. Note: in R4 (Dublin) the comment fields will be show all in one column, not ideal but a key first step towards a more human readable GUI. In R5 it is anticipated that the fields will each have their own columns.

(5) The user would then be able to do some simple filtering on the data.

(6) Eventually this interface could be used for Control Loops and DCAE-DS in a future release.

Projects Impacted:

xNF Requirements for FM Meta-Data

A requirement must be added which requires an xNF that produces fault events needing to provide the FM Meta-Data as defined in the VES Event Registration Guidelines.  The Jira ticket has been updated with proposed requirement text.

Associated Files:

5G PM Dictionary:

Scope:

...

• What fields are in the PM Dictionary and whether they are mandatory or optional

...

• YAML schema
• Whether PM Dictionary is in the Event Registration YAML or is a separate artifact

...

• Support the onboarding and cataloging of PM Dictionary for VNFs and PNFs

...

TESTING

Test Environment:  xx

Integration Team Liaison: xx

Resources Needed: xx

Contributing Resources: Nokia

Current Status:

1. x
2. x

Integration Wiki Test Cases: x

Integration Wiki (BBS U/C): x.

Master Integration Test Page: Dublin Release Integration Testing Status

Summary Testing Status:

_______________________________________________________________________________________________________

5G PM Dictionary:

Scope:

Gain approval for the content and delivery of the PM Dictionary as a YAML document for a 5G NF to ONAP.  This assumes that the work to support the onboarding and processing of the PM Dictionary in a YAML artifact is covered under the PNF Onboarding Package 5G USE Case Work Item—it is not addressed here.

Casablanca Progress:

PM Dictionary proposal has been presented to ONAP community on multiple occasions:

...

All comments have been incorporated into the proposal.

Next Steps:

1. Determine the process to get approval for this proposal
2. Present to Modeling subcommittee to approve content and format
3. Present to other Impacted Projects for commitment

Projects Impacted:

• Modeling – agreement on content and format
• SDC – onboarding and cataloging of PM Dictionary artifact
• VES – document the PM Dictionary format and content
• NF Requirements – requirement for 3GPP compliant NFs to provide a PM Dictionary in the proper format and content as part of NF package at onboarding
• GUI – display PM Dictionary in human-readable form (What GUI? What project?)

1. Review and finalize VES Event Listener Specification and VES Event Registration Specification which contains the PM Dictionary format and content. 
2. Onboard the PM Dictionary for an xNF as a YAML file. It is expected that the PM Dictionary will be in its own YAML file for ease of processing.  Note that the work to support the onboarding and processing of the PM Dictionary artifact is covered under the PNF Onboarding Package 5G Use Case Work Item.  It is not addressed here.
3. Display the PM Dictionary in a Design Time GUI (for example SDC-DS or DCAE-DS) to allow an ONAP User to create PM Mapper configuration files for Perf3gpp event generation.
4. Update VNF Requirements for PM Dictionary artifact.

Projects Impacted:

xNF Requirements for PM Dictionary U/C

A requirement must be added which requires an xNF that produces performance measurements to provide a new on-boarding artefact to provide PM Dictionary information as specified in the VES Event Listener and VES Event Registrations Guidelines.  The Jira ticket has been updated with proposed requirement text.

Development Status for FM Meta Data & PM Dictionary

TESTING

Test Environment:  xx

Integration Team Liaison: xx

Resources Needed: xx

Contributing Resources: Nokia

Current Status:

1. x
2. x

Integration Wiki Test Cases: x

Integration Wiki (BBS U/C): x.

Master Integration Test Page: Dublin Release Integration Testing Status

Summary Testing Status:

PM Dictionary Proposal:

PM Dictionary Example: