PRH (PNF Registration Handler)
- Date:
2018-09-13
Overview
Physical Network Function Registration Handler is responsible for registration of PNF (Physical Network Function) to ONAP (Open Network Automation Platform) in plug and play manner.
API name |
Swagger JSON |
Swagger YAML |
|---|---|---|
PNF Registration Handler |
heartbeat-controller
GET /heartbeat
Returns liveness of PRH service
Produces: [‘*/*’]
Responses
200 - PRH sevice is living
401 - You are not authorized to view the resource
403 - Accessing the resource you were trying to reach is forbidden
404 - The resource you were trying to reach is not found
schedule-controller
GET /start
Start scheduling worker request
Produces: [‘*/*’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
GET /stopPrh
Stop scheduling worker request
Produces: [‘*/*’]
Responses
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
Introduction
PRH is delivered as one Docker container which hosts application server and can be started by docker-compose.
Functionality
Paths
GET /events/unauthenticated.VES_PNFREG_OUTPUT
Description
Reads PNF registration fromD DMaaP (Data Movement as a Platform)
Responses
HTTP Code |
Description |
|---|---|
200 |
successful response |
PATCH /aai/v12/network/pnfs/{pnf-name}
Description
- Update AAI (Active and Available Inventory) PNF’s specific entries:
ipv4 to ipaddress-v4-oam
ipv6 to ipaddress-v6-oam
Parameters
Type |
Name |
Description |
Schema |
|---|---|---|---|
Path |
pnf-name
required
|
Name of the PNF. |
string (text) |
Body |
patchbody |
Required patch body. |
Responses
HTTP Code |
Description |
|---|---|
200 |
successful response |
POST /events/unauthenticated.PNF_READY
Description
- Publish PNF_READY to DMaaP and set:
pnf-id to correlationID
ipv4 to ipaddress-v4-oam
ipv6 to ipaddress-v6-oam
Parameters
Type |
Name |
Description |
Schema |
|---|---|---|---|
Body |
postbody
required
|
Required patch body. |
Responses
HTTP Code |
Description |
|---|---|
200 |
successful response |
Compiling PRH
Whole project (top level of PRH directory) and each module (sub module directory) can be compiled using mvn clean install command.
Main API Endpoints
- Running with dev-mode of PRH
Heartbeat: http://<container_address>:8100/heartbeat or https://<container_address>:8443/heartbeat
Start PRH: http://<container_address>:8100/start or https://<container_address>:8433/start
Stop PRH: http://<container_address>:8100/stopPrh or https://<container_address>:8433/stopPrh
Maven GroupId:
org.onap.dcaegen2.services
Maven Parent ArtifactId:
dcae-services
Maven Children Artifacts:
prh-app-server: Pnf Registration Handler (PRH) server
prh-aai-client: Contains implementation of AAI client
prh-dmaap-client: Contains implementation of DmaaP client
prh-commons: Common code for whole prh modules