Page History

...

Jira

server	ONAP Jira
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	425b2b0a-557c-3c0c-b515-579789cceedb
key	CPS-393

Spike Description

...

Investigate A&AI interface, especially how to register and receive DMaaP Events from A&AI. Investigate filter-options and consider some PoC code.
...
# Description Notes Decision
1 AAI failed to send DMaaP notification after xNF was created
Jira
server ONAP Jira
columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key AAI-3350

The bug causing this error was fixed and changes have been merged.
2 DMaap Client failed because of dependency Issues
Jira
server ONAP Jira
columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId 425b2b0a-557c-3c0c-b515-579789cceedb
key DMAAP-1627
The bug causing this error was fixed and changes have been submitted.
3
setFilter() is not documented
Fiachra Corcoran (DMaaP) advised any existing documentation is out of date and this should not be used
Toine Siebelink 02 Jul 2021
Based on input from (DMaaP) team and possible lack of future support we will do filtering on client side
4 Decide on which property to filter on Which property from the DMaaP event should we filter on?
5 Update Events for address information is it possible for address information to change ie. does CPS need to listen to these? Address information might change but we don't need to worry about it for our use case as we use SDN-C and only the pnf-id to identify the resource

Background

...

When a xNF object is added to A&AI, a DMaaP event, AAI-EVENT is created. A&AI handles the publishing of this event. To be notified of the AAI-EVENT, CPS will need to register on DMaaP Message Router.
DMaaP offers a client plugin called DMaaP Client, which can be found here. This Client can be used to register to a DMaaP event. The PoC code will use this client to show that CPS can listen for and receive DMaaP events.

Filtering of AAI-EVENT

...

Based on input from the DMaaP team, the filtering will be done on client side. From looking at the DMaaP event that is created when a xNF is created, we can filter on the following properties:
equip-type
equip-vendor
equip-model
pnf-id

AAI-EVENT received from DMaaP

AAI-EVENT received from DMaaP can have different event-header.action values. These are:

CREATE
UPDATE
DELETE

Each action value refers to the type of operation happening to a xNF on A&AI. When a xNF is added to A&AI, the event-header.action value is CREATE. When a xNF is updated in A&AI, the event-header.action value is UPDATE. When a xNF is deleted in A&AI, the event-header.action value is DELETE.Note* The exact property to filter on is still being decided

Example of DMaaP Event when a xNF is added to A&AI:

Code Block

theme	RDark
title	DMaaP Event: action=CREATE
linenumbers	true
collapse	true

{
	"cambria.partition":"AAI",
    	"event-header":{
        "severity":"NORMAL",
        "entity-type":"pnf",
        "top-entity-type":"pnf",
        "entity-link":"/aai/v23/network/pnfs/pnf/dummyTest30",
        "event-type":"AAI-EVENT",
        "domain":"dev",
        "action":"CREATE",
        "sequence-number":"0","id":"577eb229-7c74-4cf8-84ab-79f66f4899b2",
        "source-name":"SO",
        "version":"v23",
        "timestamp":"20210701-12:45:09:351"
    },
    "entity":{
        "ipaddress-v4-oam":"100.10.20.20",
        "equip-type":"example-equip-type-val-20348",
        "equip-vendor":"example-equip-vendor-val-52182",
        "ipaddress-v6-oam":"",
        "orchestration-status":"Active",
        "pnf-name2":"dummypnf-1597953056126",
        "equip-model":"example-equip-model-val-8370",
        "in-maint":false,
        "resource-version":"1625143508438",
        "pnf-id":"927b2580-36d9-4f13-8421-3c9d43b7a75e",
        "management-option":"example-management-option-val-72881",
        "spare-equipment-indicator":false,
        "pnf-name":"dummyTest30"
	}
}

Example of DMaaP Event when a xNF is updated in A&AI:

Code Block

theme	RDark
title	DMaaP Event: action=UPDATE
linenumbers	true
collapse	true

{
	"cambria.partition":"AAI",
	"event-header":{
		"severity":"NORMAL",
		"entity-type":"pnf",
		"top-entity-type":"pnf",
		"entity-link":"/aai/v23/network/pnfs/pnf/dummyTest16",
		"event-type":"AAI-EVENT","domain":"dev","action":"UPDATE",
		"sequence-number":"0","id":"51a99267-83ec-4f4f-a676-690ba527bf78",
		"source-name":"SO","version":"v23","timestamp":"20210705-15:18:37:452"
	},
	"entity":{
		"ipaddress-v4-oam":"100.10.20.20",
		"equip-type":"example-equip-type-val-20348",
		"equip-vendor":"example-equip-vendor-val-52182",
		"ipaddress-v6-oam":"",
		"orchestration-status":"Active",
		"pnf-name2":"dummypnf-1597953056126",
		"equip-model":"example-equip-model-val-8370",
		"in-maint":false,
		"resource-version":"1625498316100",
		"pnf-id":"927b2580-36d9-4f13-8421-3c9d43b7a75e",
		"management-option":"example-management-option-val-72881",
		"spare-equipment-indicator":false,
		"pnf-name":"dummyTest16"
	}
}

...

Example of DMaaP Event when a xNF is deleted in A&AI:

Code Block

theme	RDark
title	DMaaP Event: action=DELETE
linenumbers	true
collapse	true

{
	"cambria.partition":"AAI",
	"event-header":{
		"severity":"NORMAL",
		"entity-type":"pnf",
		"top-entity-type":"pnf",
		"entity-link":"/aai/v23/network/pnfs/pnf/dummyTest15",
		"event-type":"AAI-EVENT",
		"domain":"dev",
		"action":"DELETE",
		"sequence-number":"0",
		"id":"bd5eabee-24fa-4567-999a-f35814e8c6c2",
		"source-name":"SO",
		"version":"v23",
		"timestamp":"20210705-13:34:08:464"
	},
	"entity":{
		"ipaddress-v4-oam":"100.10.20.20",
		"equip-type":"example-equip-type-val-20348",
		"equip-vendor":"example-equip-vendor-val-52182",
		"ipaddress-v6-oam":"",
		"orchestration-status":"Active",
		"pnf-name2":"dummypnf-1597953056126",
		"equip-model":"example-equip-model-val-8370",
		"in-maint":false,
		"resource-version":"1623155630173",
		"pnf-id":"927b2580-36d9-4f13-8421-3c9d43b7a75e",
		"management-option":"example-management-option-val-72881",
		"spare-equipment-indicator":false,
		"pnf-name":"dummyTest15"
	}
}

Proof Of Concept Code

Adding DMaaP Client dependency

To use the DMaaP Client we need the following dependency in our pom.xml file.

Code Block

language	xml
theme	RDark
title	DMaaP Client dependency in pom.xml
linenumbers	true

    <dependency>
        <groupId>org.onap.dmaap.messagerouter.dmaapclient</groupId>
        <artifactId>dmaapClient</artifactId>
        <version>1.1.12</version>
    </dependency>

Creating DMaaP consumer client

The following builder method is used to create an instance of a DMaaP Consumer Client:

...

Attribute name

Attribute Description

Example

setHostPart

The host and port of the DMaaP server in the format <host:port>. This method takes a collection of strings, check example.

Code Block

language	java
theme	RDark
title	Example of HostPart
linenumbers	true

final Collection<String> hosts = new ArrayList<>();
hosts.add("message-router.onap:3904");

setTopic

The topic name to consume from

"AAI-EVENT"

setConsumerGroup

A name that uniquely identifies the subscriber's group

"onap-cps"

setConsumerId

Within the subscriber's group, a name that uniquely identifies the subscriber's process

"cps-ncmp"

setTimeoutMs

Time in ms to wait for messages on the server before returning

10000

setLimit

Maximum number of messages that is returned per fetch

1000

setFilter

A customizable message filter, or null if no filtering is required

null

setApiKey_username

The username of the client application

null

setApiSecret_password

The password for the username

null

Adding required properties to the consumer

The consumer also takes in the following properties:

...

Code Block

language	java
theme	RDark
title	Setting the Protocol property
linenumbers	true

# The http protocol to use:
# http
# https

final Properties props = new Properties();
props.setProperty("Protocol", "http");
mrConsumer.setProps(props);

Fetching DMaaP event using the consumer object

To fetch, the following method needs to be called on the consumer object:

Code Block

language	java
theme	RDark
title	Fetch Method Example
linenumbers	true

mrConsumer.fetch()

...

POC code used in the demo

...

Code Block

language	java
theme	RDark
title	Demo POC code
linenumbers	true
collapse	true

public static void main(String[] args) throws Exception {
	final Collection<String> hosts = new ArrayList<>();
    hosts.add("message-router.onap:3904");
    final MRConsumerImpl mrConsumer = new MRConsumerImpl.MRConsumerImplBuilder().setHostPart(hosts)
    	.setTopic("AAI-EVENT").setConsumerGroup("cg").setConsumerId("cid").setTimeoutMs(10000)
        .setLimit(1000).setFilter("").setApiKey_username(null)
        .setApiSecret_password(null).createMRConsumerImpl();
	mrConsumer.setProtocolFlag("HTTPNOAUTH");
    final Properties props = new Properties();
    props.setProperty("Protocol", "http");
    mrConsumer.setProps(props);
    log.info("fetch {}", mrConsumer.fetch());
}

...

Space shortcuts

Page tree

Versions Compared

Old Version 15

New Version Current

Key

Spike Description

Background

Filtering of AAI-EVENT

Based on input from the DMaaP team, the filtering will be done on client side. From looking at the DMaaP event that is created when a xNF is created, we can filter on the following properties:
equip-type
equip-vendor
equip-model
pnf-id

AAI-EVENT received from DMaaP

Proof Of Concept Code

Adding DMaaP Client dependency

Creating DMaaP consumer client

Adding required properties to the consumer

Fetching DMaaP event using the consumer object

POC code used in the demo

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 15

New Version Current

Key

Spike Description

Background

Filtering of AAI-EVENT

Based on input from the DMaaP team, the filtering will be done on client side. From looking at the DMaaP event that is created when a xNF is created, we can filter on the following properties: equip-typeequip-vendorequip-modelpnf-id

AAI-EVENT received from DMaaP

Proof Of Concept Code

Adding DMaaP Client dependency

Creating DMaaP consumer client

Adding required properties to the consumer

Fetching DMaaP event using the consumer object

POC code used in the demo

Based on input from the DMaaP team, the filtering will be done on client side. From looking at the DMaaP event that is created when a xNF is created, we can filter on the following properties:
equip-type
equip-vendor
equip-model
pnf-id