docs/drools/tutorial_vFW.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 vFW flow in a standalone PDP-D
   7 ****************************************************
   8
   9 .. contents::
  10     :depth: 3
  11
  12 High Level Architecture
  13 ^^^^^^^^^^^^^^^^^^^^^^^
  14 The vFW flow begins with an onset message that is sent from DCAE notifying the PDP-D that an action needs to be taken on a VNF. Once the PDP-D has inserted the onset into drools memory, rules begin to fire to start processing the onset for the vFW policy that exists in drools memory. If the onset is not enriched with A&AI data, Policy will query A&AI for the VNF data otherwise the PDP-D will get the A&AI data needed directly from the onset. Then an A&AI named query is executed on the source VNF entity from the onset to find the target VNF entity that the PDP-D will take action on. Once the target entity is retrieved from A&AI, a Guard query is executed to determine if the action to be taken is allowed. If Guard returns a permit, the PDP-D will then send an APPC ModifyConfig recipe request to modify pg-streams as specified in the request payload. If APPC is successful then the PDP-D will send a final success notification on the POLICY-CL-MGT topic and gracefully end processing the event.
  15
  16 Initial Setup
  17 ^^^^^^^^^^^^^
  18
  19 For this tutorial, it is assumed that the set up steps from section
  20 *Using the Control Loop PDP-D docker image for standalone testing* has been followed.
  21
  22 Running the Flow
  23 ^^^^^^^^^^^^^^^^
  24
  25 **Step 1:** Deploy the vFW Operational Policy.
  26
  27    .. code-block:: bash
  28
  29        cat pdp-update-vfw.json
  30         {
  31           "policies": [
  32              {
  33              "type": "onap.policies.controlloop.Operational",
  34              "type_version": "1.0.0",
  35              "properties": {
  36              "content": "controlLoop%3A%0A++++version%3A+2.0.0%0A++++controlLoopName%3A+ControlLoop-vFirewall-135835e3-eed7-497a-83ab-8c315f37fa4a%0A++++trigger_policy%3A+unique-policy-id-1-modifyConfig%0A++++timeout%3A+1200%0A++++abatement%3A+false%0Apolicies%3A%0A++++-+id%3A+unique-policy-id-1-modifyConfig%0A++++++name%3A+modify_packet_gen_config%0A++++++description%3A%0A++++++actor%3A+APPC%0A++++++recipe%3A+ModifyConfig%0A++++++target%3A%0A++++++++++resourceID%3A+Eace933104d443b496b8.nodes.heat.vpg%0A++++++++++type%3A+VNF%0A++++++payload%3A%0A++++++++++streams%3A+%27%7B%22active-streams%22%3A5%7D%27%0A++++++retry%3A+0%0A++++++timeout%3A+300%0A++++++success%3A+final_success%0A++++++failure%3A+final_failure%0A++++++failure_timeout%3A+final_failure_timeout%0A++++++failure_retries%3A+final_failure_retries%0A++++++failure_exception%3A+final_failure_exception%0A++++++failure_guard%3A+final_failure_guard%0A"
  37              },
  38              "name": "operational.modifyconfig",
  39              "version": "1.0.0"
  40              }
  41            ],
  42            "messageName": "PDP_UPDATE",
  43            "requestId": "a7a32d3b-37b4-4fb7-9322-b90c6a6fe365",
  44            "timestampMs": 1556125347251,
  45            "name": "pdpd",
  46            "pdpGroup": "controlloop",
  47            "pdpSubgroup": "drools"
  48         }
  49
  50         http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/POLICY-PDP-PAP/events @pdp-update-vfw.json Content-Type:'text/plain'
  51
  52         telemetry
  53         > get controllers/usecases/drools/facts/usecases/controlloops
  54         > get controllers/usecases/drools/facts/usecases/controlloops/ControlLoop-vFirewall-135835e3-eed7-497a-83ab-8c315f37fa4a
  55
  56 **Step 2:** Inject a simulated *ONSET* message.
  57
  58     .. code-block:: bash
  59
  60        cat dcae.vfw.onset.json
  61         {
  62           "closedLoopControlName": "ControlLoop-vFirewall-135835e3-eed7-497a-83ab-8c315f37fa4a",
  63           "closedLoopAlarmStart": 1463679805324,
  64           "closedLoopEventClient": "microservice.stringmatcher",
  65           "closedLoopEventStatus": "ONSET",
  66           "requestID": "c7c6a4aa-bb61-4a15-b831-ba1472dd4a65",
  67           "target_type": "VNF",
  68           "target": "generic-vnf.vnf-id",
  69           "AAI": {
  70             "generic-vnf.is-closed-loop-disabled": "false",
  71             "generic-vnf.prov-status": "ACTIVE",
  72             "generic-vnf.vnf-id": "fw0002vm002fw002"
  73           },
  74           "from": "DCAE",
  75           "version": "1.0.2"
  76         }
  77
  78         # activate NOOP sources
  79
  80         http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/DCAE_TOPIC/switches/activation
  81
  82         http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/APPC-CL/switches/activation
  83
  84         http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/DCAE_TOPIC/events @dcae.vfw.onset.json Content-Type:'text/plain'  # send onset
  85
  86 Using the telemetry API, a simulated onset can be injected by the user.
  87 For demo purposes, this is the simulated onset that will be used:
  88
  89     .. image:: Tut_vFW_simulated_onset.JPG
  90
  91 **NOTE:** The onset that gets injected has to have a closedLoopControlName that matches
  92 the pushed policy's closedLoopControlName.
  93
  94 There should be 8 objects present. Two timers exist to put a time limit on the operation and on
  95 the overall control loop (in the case of retries or policy chaining).
  96 The event and it's associated manager and operation manager are also present in memory.
  97 A lock on the target entity is inserted to ensure no other events try to take action on
  98 the VNF that is currently processing.
  99
 100 The network log will be used to monitor the activity coming in and out of the PDP-D.
 101 This log is located at *$POLICY_HOME/logs/network.log*.
 102 This will show the notifications that the PDP-D sends out at different stages of processing.
 103 The order of successful processing begins with an ACTIVE notification to show that the onset
 104 was acknowledged and the operation is beginning transit.
 105
 106     .. image:: Tut_vFW_policy_active.JPG
 107
 108 Next a query will be sent to A&AI to get information on the VNF specified from the onset. The picture below shows the query going OUT of the PDP-D and the response coming IN.
 109
 110 **NOTE:** Policy does A&AI queries for VNF information when the onset is not enriched with A&AI data. In this example only the generic-vnf.vnf-name was provided so a query to A&AI is necessary to retrieve data that is needed in the APPC request.
 111
 112     .. image:: Tut_vFW_aai_get.JPG
 113
 114 For the vFW use case, the source entity reported in the onset message may not be the target entity that the APPC operation takes action on. To determine the true target entity, an A&AI named query is performed. The request is shown in the network log.
 115
 116     .. image:: Tut_vFW_aai_named_query_request.JPG
 117
 118 The response is also displayed in the network log.
 119
 120     .. image:: Tut_vFW_aai_named_query_response.JPG
 121
 122 Once the target entity is found, the PDP-D consults Guard to determine if this operation should be allowed, a series of operation notifications are sent for starting the Guard query, obtaining a PERMIT or DENY, and beginning the operation.
 123
 124     .. image:: Tut_vFW_policy_guard_start.JPG
 125
 126 |
 127
 128     .. image:: Tut_vFW_policy_guard_result.JPG
 129
 130 |
 131
 132     .. image:: Tut_vFW_policy_operation_start.JPG
 133
 134 **Step 3:** Inject an APPC response in the APPC-CL topic
 135
 136 A simulated APPC response will be injected to the APPC-CL topic.
 137
 138     .. code-block:: bash
 139
 140        cat appc.legacy.success.json
 141         {
 142           "CommonHeader": {
 143             "TimeStamp": 1506051879001,
 144             "APIver": "1.01",
 145             "RequestID": "c7c6a4aa-bb61-4a15-b831-ba1472dd4a65",
 146             "SubRequestID": "1",
 147             "RequestTrack": [],
 148             "Flags": []
 149           },
 150           "Status": {
 151             "Code": 400,
 152             "Value": "SUCCESS"
 153           },
 154           "Payload": {
 155             "streams": {
 156               "active-streams": 5.0
 157             },
 158             "generic-vnf.vnf-id": "7da01f3d-1e1f-374f-b049-f6385fe8d067"
 159           }
 160         }
 161
 162         http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/APPC-CL/switches/activation   # activate noop source
 163
 164        http --verify=no -a "${TELEMETRY_USER}:${TELEMETRY_PASSWORD}" PUT https://localhost:9696/policy/pdp/engine/topics/sources/noop/APPC-CL/events @appc.legacy.success.json Content-Type:'text/plain'
 165
 166 The network log will show the PDP-D sent an operation success notification.
 167
 168     .. image:: Tut_vFW_policy_operation_success.JPG
 169
 170 Then a final success notification is sent.
 171
 172     .. image:: Tut_vFW_policy_final_success.JPG
 173
 174 After processing there should only be 2 facts left in memory.
 175
 176 End of Document