docs/platform/tutorial_VOLTE.rst

   1
   2 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4
   5 **********************************************************
   6 Tutorial: Testing the VOLTE Use Case in a standalone PDP-D
   7 **********************************************************
   8
   9 .. contents::
  10     :depth: 3
  11
  12 In this tutorial we will go over how to access and start up the PDP-D, setup the prerequisites for the VOLTE flow, enable/disable the VFC Simulator that will be used in the VOLTE flow, and inject messages to trigger the VOLTE flow.
  13
  14 Accessing and starting the PDP-D
  15 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  16
  17 The first step is to access the docker container of name *drools*.
  18
  19     .. code-block:: bash
  20
  21         docker exec -it -u 0 drools su - policy
  22
  23 The PDP-D software is installed under the *policy* account, the policy root directory is under *${POLICY_HOME}* environment variable and it may be changed on a per installation basis.   It is typically set up under the */opt/app/policy* directory but can be changed during installation.   All PDP-D software runs with non-root privileges as *policy* is a regular user account.
  24
  25 Once within the drools container, the running status can be observed by using the *policy* command:
  26
  27     .. code-block:: bash
  28
  29         policy [--debug] status|start|stop
  30
  31 The running status of the PDP-D can be observed with *policy status*
  32
  33     .. code-block:: bash
  34
  35         policy@drools:~$ policy status [drools-pdp-controllers]  L []: Policy Management (pid 1500) is running  1 cron jobs installed.
  36
  37
  38 Prerequisites for the VOLTE flow
  39 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  40
  41 In order to trigger the VOLTE flow we will need to inject an ONSET message via curl command. We're going to create a temporary *util* directory to store a file that contains the VOLTE ONSET message.
  42
  43 Navigate to */tmp* and create directory *util*.  *util* is just a temporary folder we've created to use as our 'workspace'.
  44
  45     .. code-block:: bash
  46
  47         cd /tmp
  48         mkdir util
  49
  50
  51 Next, we're going to create a file named *dcae.volte.onset.json* and edit it to paste the VOLTE ONSET message contents.
  52
  53     .. code-block:: bash
  54
  55         touch dcae.volte.onset.json
  56         vi dcae.volte.onset.json
  57
  58 Here are the contents of the VOLTE ONSET message. Copy/paste this into dcae.volte.onset.json:
  59
  60     .. code-block:: json
  61
  62         {
  63             "closedLoopEventClient": "DCAE.HolmesInstance",
  64             "policyVersion": "1.0.0.5",
  65             "policyName": "vVOLTE",
  66             "policyScope": "resource=volte,service=VolteSErvice,type=SampleType,closedLoopControlName=CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8",
  67             "target_type": "VM",
  68             "AAI": {
  69                 "vserver.vserver-name": "dfw1lb01lb01",
  70                 "service-instance.service-instance-id" : "TBD",
  71                 "generic-vnf.vnf-id" : "TBD",
  72                 "generic-vnf.vnf-name" : "TBD"
  73             },
  74             "closedLoopAlarmStart": 1484677482204798,
  75             "closedLoopEventStatus": "ONSET",
  76             "closedLoopControlName": "ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b",
  77             "version": "1.0.2",
  78             "target": "vserver.vserver-name",
  79             "requestID": "97964e10-686e-4790-8c45-bdfa61df770f",
  80             "from": "DCAE"
  81         }
  82
  83
  84 Enabling the VFC Simulator
  85 ^^^^^^^^^^^^^^^^^^^^^^^^^^
  86
  87 Enabling the *controlloop-utils* feature will enable the simulators. To do this, simply stop the drools pdp, enable the feature, and restart the drools pdp like so:
  88
  89     .. code-block:: bash
  90
  91         policy stop
  92         features enable controlloop-utils
  93         policy start
  94
  95 Now, in */opt/app/policy/config/* directory, you should see a new properties file named *simulators.properties.environment*. In here you will find the credentials for the VFC simulator.
  96
  97 Injecting an ONSET to trigger the VOLTE Flow
  98 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  99
 100 We are now ready to inject an ONSET message to trigger the VOLTE flow. Simply navigate back to the directory *dcae.volte.onset.json* file is saved (i.e. cd /tmp/util) and run this curl command:
 101
 102     .. code-block:: bash
 103
 104         http -a @1b3rt:31nst31n PUT :9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_CL_OUTPUT/events @dcae.volte.onset.json Content-Type:"text/plain"
 105
 106 You should see some output similar to this:
 107
 108 .. image:: tutorial_VOLTE_1.png
 109
 110 You can view the logs to see the network activity or find any errors that may have occurred. Logs are located in */opt/app/policy/logs*.
 111
 112 Reading the logs
 113 ^^^^^^^^^^^^^^^^
 114
 115 Once you've injected the onset message, this should appear in the network.log:
 116
 117 .. image:: tutorial_VOLTE_2.png
 118
 119
 120 End of Document
 121
 122 .. SSNote: Wiki page ref. https://wiki.onap.org/display/DW/Tutorial%3A+Testing+the+VOLTE+Use+Case+in+a+standalone+PDP-D