Gitiles
Code Review Sign In
gerrit.nordix.org / onap / dcaegen2 / 6bf5834cd5c7a70ea22072594042c7604a8d2fb1 / . / docs / sections / apis / PRH.rst
blob: 2a7d0eaeafea61744f13453f7d8cde01663d89b3 [file] [log] [blame]
Tomek Kaminski7782f9b2018-11-07 15:12:44 +0100[diff] [blame]1.. _prh_api:
2
pwielebs3d7081f2018-09-13 13:49:33 +0200[diff] [blame]3==============================
4PRH (PNF Registration Handler)
5==============================
6
7:Date: 2018-09-13
8
9.. contents::
10 :depth: 3
11..
12
13Overview
14========
15
16Physical Network Function Registration Handler is responsible for registration of PNF (Physical Network Function) to
17ONAP (Open Network Automation Platform) in plug and play manner.
18
19Introduction
20============
21
22PRH is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.
23
24Functionality
25=============
26.. image:: ../images/prhAlgo.png
27
28
29Paths
30=====
31
32GET /events/unauthenticated.VES_PNFREG_OUTPUT
Tomek Kaminski7782f9b2018-11-07 15:12:44 +0100[diff] [blame]33---------------------------------------------
pwielebs3d7081f2018-09-13 13:49:33 +0200[diff] [blame]34
35Description
36~~~~~~~~~~~
37
38Reads PNF registration fromD DMaaP (Data Movement as a Platform)
39
40
41Responses
42~~~~~~~~~
43
44+-----------+-------------------------------------------+
45| HTTP Code | Description |
46+===========+===========================================+
47| **200** | successful response |
48+-----------+-------------------------------------------+
49
50
51PATCH /aai/v12/network/pnfs/{pnf-name}
52--------------------------------------
53
54Description
55~~~~~~~~~~~
56
57Update AAI (Active and Available Inventory) PNF's specific entries:
58 - ipv4 to ipaddress-v4-oam
59 - ipv6 to ipaddress-v6-oam
60
61Parameters
62~~~~~~~~~~
63
64+----------+---------------+---------------------------------+------------------+
65| Type | Name | Description | Schema |
66+==========+===============+=================================+==================+
67| **Path** | | **pnf-name**| Name of the PNF. | string (text) |
68| | | *required* | | |
69+----------+---------------+---------------------------------+------------------+
70| **Body** | **patchbody** | Required patch body. | |
71+----------+---------------+---------------------------------+------------------+
72
73
74Responses
75~~~~~~~~~
76
77+-----------+-------------------------------------------+
78| HTTP Code | Description |
79+===========+===========================================+
80| **200** | successful response |
81+-----------+-------------------------------------------+
82
83
84POST /events/unauthenticated.PNF_READY
85--------------------------------------
86
87Description
88~~~~~~~~~~~
89
90Publish PNF_READY to DMaaP and set:
91 - pnf-id to correlationID
92 - ipv4 to ipaddress-v4-oam
93 - ipv6 to ipaddress-v6-oam
94
95Parameters
96~~~~~~~~~~
97
98+----------+----------------+---------------------------------+------------------+
99| Type | Name | Description | Schema |
100+==========+================+=================================+==================+
101| **Body** | | **postbody** | Required patch body. | `hydratorappput |
102| | | *required* | | <#_hydratorapppu |
103| | | | t>`__ |
104+----------+----------------+---------------------------------+------------------+
105
106
107Responses
108~~~~~~~~~
109
110+-----------+-------------------------------------------+
111| HTTP Code | Description |
112+===========+===========================================+
113| **200** | successful response |
114+-----------+-------------------------------------------+
115
116Compiling PRH
117=============
118
119Whole project (top level of PRH directory) and each module (sub module directory) can be compiled using
120`mvn clean install` command.
121
122Main API Endpoints
123==================
124
125Running with dev-mode of PRH
126 - Heartbeat: **http://<container_address>:8100/heartbeat** or **https://<container_address>:8443/heartbeat**
127 - Start PRH: **http://<container_address>:8100/start** or **https://<container_address>:8433/start**
128 - Stop PRH: **http://<container_address>:8100/stopPrh** or **https://<container_address>:8433/stopPrh**
129
130Maven GroupId:
131==============
132
133org.onap.dcaegen2.services
134
135Maven Parent ArtifactId:
136========================
137
138dcae-services
139
140Maven Children Artifacts:
141=========================
142
1431. prh-app-server: Pnf Registration Handler (PRH) server
1442. prh-aai-client: Contains implementation of AAI client
1453. prh-dmaap-client: Contains implementation of DmaaP client
1464. prh-commons: Common code for whole prh modules
147
148