From 55eb2e1e09d8538e641b57a965a23ea239763b36 Mon Sep 17 00:00:00 2001 From: krzysztof kuzmicki Date: Thu, 29 Nov 2018 16:35:56 +0100 Subject: Integration doc for 5g pnp pnf use case Issue-ID: INT-748 Change-Id: I5d150d3ac666ab9a278ee75f39f2f003f538b8ba Signed-off-by: krzysztof kuzmicki --- docs/docs_5g_pnf_pnp.rst | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 docs/docs_5g_pnf_pnp.rst diff --git a/docs/docs_5g_pnf_pnp.rst b/docs/docs_5g_pnf_pnp.rst new file mode 100644 index 000000000..1874bae80 --- /dev/null +++ b/docs/docs_5g_pnf_pnp.rst @@ -0,0 +1,61 @@ +5G - PNF Plug and Play +---------------------- + +Source files +~~~~~~~~~~~~ + +- Base PnP PNF Simulator heat template file: https://git.onap.org/integration/tree/test/mocks/pnfsimulator/deployment/PnP_PNF_sim_heat_template_Ubuntu_16_04.yml + +Description +~~~~~~~~~~~ + +The PNF PnP flow is a method, which allows to register within ONAP/AAI a PNF resource instance. +This PNF resource instance is correlated with an existing service instance. +PNF Plug and Play is used to register a PNF when it comes on-line. +This use case is intended to be applicable to a variety of PNFs such as routers and 5G base stations. +The steps and descriptions have been drafted to be as general as possible and to be applicable +to a relatively wide variety of PNFs. However, the use case was originally developed with a consideration +for 5G PNF Distributed Units (DU). + +**Useful Links** + +- `5G - PNF Plug and Play use case documentation `_ +- `5G - PNF Plug and Play - Integration Test Cases `_ +- `5G - PNF Plug and Play test cases status for Casablanca release `_ +- `Instruction how to setup PnP PNF Simulator `_ + +How to Use +~~~~~~~~~~ + +1) `Create and distribute service model which contains PNF `_ +2) `Create service for PNF and wait for PNF Ready message in DmaaP topic `_ +3) `Send PNF Registartion request from PnP PNF Simualtor and finish registration `_ + + +Known Issues and Resolutions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +In SO BPMN in mechanism making re-subscription to /events/unauthenticated.PNF_READY topic there is an issue `SO-1253 `_. +By default after ONAP and PRH deploy DMaaP topic /events/unauthenticated.PNF_READY is not present. +It is created by PRH after first expected PNF registration event arrival to ONAP system. +If service for PNF will be created before topic /events/unauthenticated.PNF_READY will be present then service will not be able to read from the topic. + + +**Workaround** + +- Before starting any PNF service verify if unauthenticated.PNF_READY topic exists using command: + +:: + + curl --header "Content-type: application/json" --request GET http://:30227/topics/listAll + +- If it doesn't exists send following curl in order to create topic: + +:: + + curl --header "Content-type: application/json" --request POST --data '[{"correlationId": "test"}]' http://:30227/events/unauthenticated.PNF_READY + +- Once again verify if topic exists +- If the PNF service will be started before unauthenticated.PNF_READY topic creation, then there will be a need to restart SO-BPMN docker container + + -- cgit 1.2.3-korg