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 onboarding and 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.
Casablanca Work
- FM Meta Data critical fields proposed to provide needed information on alarms/faults presented to the Modeling Community August 2018
- YAML Registration proposal to DCAE September 2018
Next Steps:
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 provide support in ONAP for a common FM Meta Data artifact. Below are steps envisioned
- Review and finalize VES Event Listener Specification and VES Event Registration Specification which contains the FM Meta Data format and content.
- 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.
- 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.
- Update VNF Requirements for FM Meta Data artifact.
Display of FM Meta Data
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 image shows a conceptual diagram of what we are aiming to achieve with the DISPLAY (GUI) aspect of this Use Case:
(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:
PROJECT | IMPACT |
---|---|
VES Specifications | Review and finalize VES Event Listener Specification and VES Event Registration Specification with the FM Meta Data format and content |
Design Time GUI | 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. The user Design (role) will be able to see the FM Meta Data & PM dictionary on the SDC Resource Creation screen (GUI). This is accessed by a user after PNF package is loaded. The SDC resource creation screen is used to customize an onboard xNF package (by vendor). This GUI is used to reconfigure or create resources from the onboarded xNFs.. The GUI will be able to filter based on content on the column. In the future, would like to also have this in the DCAE-DS part of uS or Closed loop configuration (probably in R5 El Alto). |
VNF Requirements | Update to VNF requirements for FM Meta Data artifact creation |
Associated Files:
File Description | File |
---|---|
FM Meta Data proposed content including how some elements are mapped to the existing fault event | |
FM event registration YAML example showing how FM Meta Data fields can be supplied via the comment capability in VES Registration |
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:
- SDC – Aug 14 2018
- Modeling Subcommittee Resource Info Model – Sep 10 2018
- 5G Use Case Subcommittee – Sep 20 2018
- Received comments from Ericsson and incorporated them into the proposal
- VES – Oct 10 2018
All comments have been incorporated into the proposal.
Next Steps:
- Review and finalize VES Event Listener Specification and VES Event Registration Specification which contains the PM Dictionary format and content.
- 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.
- 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.
- Update VNF Requirements for PM Dictionary artifact.
Projects Impacted:
PROJECT | IMPACT |
---|---|
VES Specifications | Review and finalize VES Event Listener Specification and VES Event Registration Specification with the PM Dictionary format and content |
Design Time GUI | 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. The user Design (role) will be able to see the FM Meta Data & PM dictionary on the SDC Resource Creation screen (GUI). This is accessed by a user after PNF package is loaded. The SDC resource creation screen is used to customize an onboard xNF package (by vendor). This GUI is used to reconfigure or create resources from the onboarded xNFs.. The GUI will be able to filter based on content on the column. In the future, would like to also have this in the DCAE-DS part of uS or Closed loop configuration (probably in R5 El Alto). |
VNF Requirements | Update to VNF requirements for PM Dictionary artifact creation |
Development Status for FM Meta Data & PM Dictionary
Item | PTL | JIRA Ticket |
---|---|---|
FM Meta-Data SDC development (GUI) display JIRA: R4 5G U/C SDC: FM Meta Data GUI Display from PNF Onboarded Package | ||
PM Dictionary SDC development (GUI) display JIRA: R4 5G U/C SDC: PM Dictionary GUI Display from PNF Onboarded Package | ||
VNFRQTS - FM Meta Data Support | ||
VNFRQTS - PM Dictionary Support | ||
(VES Specification was finished and reviewed) | COMPLETED | |
PM Dictionary Proposal:
PM Dictionary Example: