docs/docs_5g_pnf_pnp.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0
   2    International License. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _docs_5g_pnf_pnp:
   5
   6 5G - PNF Plug and Play
   7 ----------------------
   8
   9 Source files
  10 ~~~~~~~~~~~~
  11
  12 - 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
  13
  14 Description
  15 ~~~~~~~~~~~
  16
  17 The PNF PnP flow is a method, which allows to register within ONAP/AAI a PNF resource instance.
  18 This PNF resource instance is correlated with an existing service instance.
  19 PNF Plug and Play is used to register a PNF when it comes on-line.
  20 This use case is intended to be applicable to a variety of PNFs such as routers and 5G base stations.
  21 The steps and descriptions have been drafted to be as general as possible and to be applicable
  22 to a relatively wide variety of PNFs. However, the use case was originally developed with a consideration
  23 for 5G PNF Distributed Units (DU).
  24
  25 **Useful Links**
  26
  27 - `5G - PNF Plug and Play use case documentation <https://wiki.onap.org/display/DW/5G+-+PNF+Plug+and+Play>`_
  28 - `5G - PNF Plug and Play - Integration Test Cases <https://wiki.onap.org/display/DW/5G+-+PNF+PnP+-+Integration+Test+Cases>`_
  29 - `5G - PNF Plug and Play test cases status for Casablanca release <https://wiki.onap.org/display/DW/5G+-+PNF+PnP+-+Test+Status>`_
  30 - `Instruction how to setup PnP PNF Simulator <https://wiki.onap.org/display/DW/PnP+PNF+Simulator>`_
  31
  32 How to Use
  33 ~~~~~~~~~~
  34
  35 1) `Create and distribute service model which contains PNF <https://wiki.onap.org/display/DW/5G+-+PNF+PnP+-+Integration+Test+Cases#id-5G-PNFPnP-IntegrationTestCases-CreateanddistributeservicewhichcontainsPNF>`_
  36 2) `Create service for PNF and wait for PNF Ready message in DmaaP topic <https://wiki.onap.org/display/DW/5G+-+PNF+PnP+-+Integration+Test+Cases#id-5G-PNFPnP-IntegrationTestCases-PNFReady>`_
  37 3) `Send PNF Registartion request from PnP PNF Simualtor and finish registration <https://wiki.onap.org/display/DW/5G+-+PNF+PnP+-+Integration+Test+Cases#id-5G-PNFPnP-IntegrationTestCases-PNFregistrationacceptingwhenAAIentrycreatedinadvance>`_
  38
  39
  40 Known Issues and Resolutions
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42
  43 In SO BPMN in mechanism making re-subscription to /events/unauthenticated.PNF_READY topic there is an issue `SO-1253 <https://jira.onap.org/projects/SO/issues/SO-1253>`_.
  44 By default after ONAP and PRH deploy DMaaP topic /events/unauthenticated.PNF_READY is not present.
  45 It is created by PRH after first expected PNF registration event arrival to ONAP system.
  46 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.
  47
  48
  49 **Workaround**
  50
  51 - Before starting any PNF service verify if unauthenticated.PNF_READY topic exists using command:
  52
  53 ::
  54
  55    curl --header "Content-type: application/json" --request GET http://<kubernetes slave IP>:30227/topics/listAll
  56
  57 - If it doesn't exists send following curl in order to create topic:
  58
  59 ::
  60
  61    curl --header "Content-type: application/json" --request POST --data '[{"correlationId": "test"}]' http://<kubernetes slave IP>:30227/events/unauthenticated.PNF_READY
  62
  63 - Once again verify if topic exists
  64 - 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
  65
  66