summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 82159cbce771a92cec8ed17e6135628755c72d8e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# PRH (PNF Registration Handler)

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. 

## Introduction 

PRH is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.

## Functionality

![](docs/prhAlgo.png)
        
## 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:
1. prh-app-server: Pnf Registration Handler (PRH) server
2. prh-commons: Common code for whole prh modules


## License

Copyright (C) 2018-2020 NOKIA Intellectual Property. All rights reserved.
[License](http://www.apache.org/licenses/LICENSE-2.0)