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