Overview
PM-Mapper provides ONAP Operators with the ability to define flexible, customizable Performance events. VES Events are generated from PM XML Files and are targeted for analytics applications in ONAP.
Bulk PM Flow:
- NF notifies DCAE that a PM file is available for upload.
- File Collector uploads PM Files from NF and stores them in Data Router.
- PM Mapper creates custom Performance events (VES) from the PM File data according to PM Mapping File.
- Analytics Applications use these performance events for targeted analysis of network operations.
Blueprint/model/image
|
|---|
Deployment Prerequisite/dependencies
DCAE and DMaaP pods should be up and running.
- DMaaP Bus Controller PostInstalls job should have completed successfully (executed as part of an OOM install).
- Make sure that cfy is installed and configured to work with the Cloudify deployment.
Deployment Steps
Execute bash on the Cloudify manager Kubernetes pod.
kubectl -n onap exec -it <dev-dcaegen2-dcae-cloudify-manager> bash
Download the pm-mapper blueprint.
- Create an inputs file (see the configuration section for more information).
Run the Cloudify Install command to install the pm-mapper with the recently downloaded blueprints, and the newly created inputs files.
cfy install --blueprint-id pm-mapper --deployment-id pm-mapper -i inputs.yaml <pm-mapper-blueprint-path>
Validation
curl <dcaegen2-dcae-healthcheck> and check if pm-mapper is in 'ready' state.
Configuration
Configuration of the service consists of generating an inputs file which will be used as part of the Cloudify install. The PM-Mapper blueprints were designed with sane defaults for the majority of the fields.
Below you will find some examples of fields which can be configured, and some of the fields which must be configured.
In the Dublin release information about the AAF user must be provided to enable publishing to authenticated topics. An Inputs file with this information included can look like:
aaf_username: dcae@dcae.onap.org aaf_password: <dcae_password>
where <dcae_password> is replaced with a real password.
By default, the PM-Mapper will only allow inbound queries over HTTPS, however its possible to configure it to enable HTTP also. This configuration can look like:
enable_http: true
The default behavior of the PM-Mapper is to map all measType in the received PM XML files, however, it's possible to provide filtering configuration which will reduce the VES event to the counters that the designer has expressed interest in. An example of this configuration:
pm-mapper-filter: {"filters":[{"pmDefVsn":"targetVersion","nfType":"targetNodeType","vendor":"targetVendor","measTypes":["targetMeasType"]}]}
In this provided example a VES event containing the "targetMeasType" will only be generated and published if the following conditions are true:
- The type of the node sending the file is "targetNodeType"
- The vendor of the node sending the file is "targetVendor"
Additional Information on the filter model can be found here.
By default the latest Docker Images will be used when deploying the PM-Mapper, however, this attribute can also be configured like: