From: Saryu Shah Date: Thu, 18 Oct 2018 01:19:03 +0000 (+0000) Subject: Documentation: Eclipse, vCPE, VoLTE, ModTemplate X-Git-Tag: 1.3.1~10^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=policy%2Fengine.git;a=commitdiff_plain;h=65640a2968358a74033451ea65efd8987cf2ee55 Documentation: Eclipse, vCPE, VoLTE, ModTemplate Documentation: Eclipse, vCPE, VoLTE, ModTemplate ------------------------------------------------------------- Issue-ID: POLICY-1169 Change-Id: Id501913db5be23f97e5ea5a635e27511546a042a Signed-off-by: Saryu Shah --- diff --git a/docs/platform/RunEcl_telemetry.png b/docs/platform/RunEcl_telemetry.png index 38e361fc8..ae4f65ccc 100755 Binary files a/docs/platform/RunEcl_telemetry.png and b/docs/platform/RunEcl_telemetry.png differ diff --git a/docs/platform/Tut_vCPE_appc_request.JPG b/docs/platform/Tut_vCPE_appc_request.JPG index fd9d11e2b..75d8848a5 100755 Binary files a/docs/platform/Tut_vCPE_appc_request.JPG and b/docs/platform/Tut_vCPE_appc_request.JPG differ diff --git a/docs/platform/Tut_vCPE_final_memory.JPG b/docs/platform/Tut_vCPE_final_memory.JPG index 2f9661e47..f68aac796 100755 Binary files a/docs/platform/Tut_vCPE_final_memory.JPG and b/docs/platform/Tut_vCPE_final_memory.JPG differ diff --git a/docs/platform/Tut_vCPE_get_facts.JPG b/docs/platform/Tut_vCPE_get_facts.JPG index 2b9198efb..276372574 100755 Binary files a/docs/platform/Tut_vCPE_get_facts.JPG and b/docs/platform/Tut_vCPE_get_facts.JPG differ diff --git a/docs/platform/Tut_vCPE_guard_not_queried.JPG b/docs/platform/Tut_vCPE_guard_not_queried.JPG index b30a4aa0e..14e52e790 100755 Binary files a/docs/platform/Tut_vCPE_guard_not_queried.JPG and b/docs/platform/Tut_vCPE_guard_not_queried.JPG differ diff --git a/docs/platform/Tut_vCPE_guard_result.JPG b/docs/platform/Tut_vCPE_guard_result.JPG index 8e32dc0c6..b1818d39c 100755 Binary files a/docs/platform/Tut_vCPE_guard_result.JPG and b/docs/platform/Tut_vCPE_guard_result.JPG differ diff --git a/docs/platform/Tut_vCPE_insert_abatement.JPG b/docs/platform/Tut_vCPE_insert_abatement.JPG index f850d12b9..d0da4d5d4 100755 Binary files a/docs/platform/Tut_vCPE_insert_abatement.JPG and b/docs/platform/Tut_vCPE_insert_abatement.JPG differ diff --git a/docs/platform/Tut_vCPE_insert_onset.JPG b/docs/platform/Tut_vCPE_insert_onset.JPG index e0aea9f6a..0316609a8 100755 Binary files a/docs/platform/Tut_vCPE_insert_onset.JPG and b/docs/platform/Tut_vCPE_insert_onset.JPG differ diff --git a/docs/platform/Tut_vCPE_policy_active.JPG b/docs/platform/Tut_vCPE_policy_active.JPG index c9ccd9d53..02544f417 100755 Binary files a/docs/platform/Tut_vCPE_policy_active.JPG and b/docs/platform/Tut_vCPE_policy_active.JPG differ diff --git a/docs/platform/Tut_vCPE_policy_final_success.JPG b/docs/platform/Tut_vCPE_policy_final_success.JPG index ed0e78509..f063d09cd 100755 Binary files a/docs/platform/Tut_vCPE_policy_final_success.JPG and b/docs/platform/Tut_vCPE_policy_final_success.JPG differ diff --git a/docs/platform/Tut_vCPE_policy_operation.JPG b/docs/platform/Tut_vCPE_policy_operation.JPG index dd4186652..1666ea623 100755 Binary files a/docs/platform/Tut_vCPE_policy_operation.JPG and b/docs/platform/Tut_vCPE_policy_operation.JPG differ diff --git a/docs/platform/Tut_vCPE_policy_operation_success.JPG b/docs/platform/Tut_vCPE_policy_operation_success.JPG index 9362cc29b..9206847f1 100755 Binary files a/docs/platform/Tut_vCPE_policy_operation_success.JPG and b/docs/platform/Tut_vCPE_policy_operation_success.JPG differ diff --git a/docs/platform/Tut_vCPE_policy_start.JPG b/docs/platform/Tut_vCPE_policy_start.JPG index a33a24cd0..91be90e68 100755 Binary files a/docs/platform/Tut_vCPE_policy_start.JPG and b/docs/platform/Tut_vCPE_policy_start.JPG differ diff --git a/docs/platform/Tut_vCPE_simulated_abatement.JPG b/docs/platform/Tut_vCPE_simulated_abatement.JPG index 06f173fbe..2133ff859 100755 Binary files a/docs/platform/Tut_vCPE_simulated_abatement.JPG and b/docs/platform/Tut_vCPE_simulated_abatement.JPG differ diff --git a/docs/platform/Tut_vCPE_simulated_appc_response.JPG b/docs/platform/Tut_vCPE_simulated_appc_response.JPG index 69699f4f2..3d90e04d8 100755 Binary files a/docs/platform/Tut_vCPE_simulated_appc_response.JPG and b/docs/platform/Tut_vCPE_simulated_appc_response.JPG differ diff --git a/docs/platform/Tut_vCPE_simulated_onset.JPG b/docs/platform/Tut_vCPE_simulated_onset.JPG index 5ee0901b6..a50b3c298 100755 Binary files a/docs/platform/Tut_vCPE_simulated_onset.JPG and b/docs/platform/Tut_vCPE_simulated_onset.JPG differ diff --git a/docs/platform/Tut_vCPE_simulators_enabled.JPG b/docs/platform/Tut_vCPE_simulators_enabled.JPG index f350e2c25..8cd9902df 100755 Binary files a/docs/platform/Tut_vCPE_simulators_enabled.JPG and b/docs/platform/Tut_vCPE_simulators_enabled.JPG differ diff --git a/docs/platform/mat_hello_world.JPG b/docs/platform/mat_hello_world.JPG index 04cf799ce..d52e4c754 100755 Binary files a/docs/platform/mat_hello_world.JPG and b/docs/platform/mat_hello_world.JPG differ diff --git a/docs/platform/runningEclipse.rst b/docs/platform/runningEclipse.rst index b2bcd88fa..136efe736 100644 --- a/docs/platform/runningEclipse.rst +++ b/docs/platform/runningEclipse.rst @@ -36,7 +36,7 @@ To interact with the PDP-D, the Telemetry API can be used. A simple GET on the e .. code-block:: bash - curl --silent --user @1b3rt:31nst31n -X GET http://localhost:9696/policy/pdp/engine/ | python -m json.tool + curl -k --silent --user @1b3rt:31nst31n -X GET https://localhost:9696/policy/pdp/engine/ | python -m json.tool .. image:: RunEcl_telemetry.png diff --git a/docs/platform/tutorial_VOLTE.rst b/docs/platform/tutorial_VOLTE.rst index 3ccb02704..2dc846282 100644 --- a/docs/platform/tutorial_VOLTE.rst +++ b/docs/platform/tutorial_VOLTE.rst @@ -58,28 +58,27 @@ Next, we're going to create a file named *dcae.volte.onset.json* and edit it to Here are the contents of the VOLTE ONSET message. Copy/paste this into dcae.volte.onset.json: .. code-block:: json - + { + "closedLoopControlName": "ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b", + "closedLoopAlarmStart": 1484677482204798, "closedLoopEventClient": "DCAE.HolmesInstance", - "policyVersion": "1.0.0.5", - "policyName": "vVOLTE", - "policyScope": "resource=volte,service=VolteSErvice,type=SampleType,closedLoopControlName=CL-VOLTE-SIG-d925ed73-8231-4d02-9545-db4e101f88f8", + "closedLoopEventStatus": "ONSET", + "requestID": "97964e10-686e-4790-8c45-bdfa61df770f", "target_type": "VM", + "target": "vserver.vserver-name", "AAI": { + "vserver.is-closed-loop-disabled": "false", + "vserver.prov-status": "ACTIVE", "vserver.vserver-name": "dfw1lb01lb01", - "service-instance.service-instance-id" : "TBD", - "generic-vnf.vnf-id" : "TBD", - "generic-vnf.vnf-name" : "TBD" + "service-instance.service-instance-id" : "vserver-name-16102016-aai3255-data-11-1", + "generic-vnf.vnf-id" : "vnf-id-16102016-aai3255-data-11-1", + "generic-vnf.vnf-name" : "vnf-name-16102016-aai3255-data-11-1" }, - "closedLoopAlarmStart": 1484677482204798, - "closedLoopEventStatus": "ONSET", - "closedLoopControlName": "ControlLoop-VOLTE-2179b738-fd36-4843-a71a-a8c24c70c55b", - "version": "1.0.2", - "target": "vserver.vserver-name", - "requestID": "97964e10-686e-4790-8c45-bdfa61df770f", - "from": "DCAE" + "from": "DCAE", + "version": "1.0.2" } - + Enabling the VFC Simulator ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -101,7 +100,7 @@ We are now ready to inject an ONSET message to trigger the VOLTE flow. Simply na .. code-block:: bash - 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" + http --verify=no --default-scheme=https -a @1b3rt:31nst31n PUT :9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_CL_OUTPUT/events @dcae.volte.onset.json Content-Type:"text/plain" You should see some output similar to this: diff --git a/docs/platform/tutorial_VOLTE_1.png b/docs/platform/tutorial_VOLTE_1.png index c1ce8e4be..938604df3 100755 Binary files a/docs/platform/tutorial_VOLTE_1.png and b/docs/platform/tutorial_VOLTE_1.png differ diff --git a/docs/platform/tutorial_VOLTE_2.png b/docs/platform/tutorial_VOLTE_2.png index 51f7e7aeb..53ee78026 100755 Binary files a/docs/platform/tutorial_VOLTE_2.png and b/docs/platform/tutorial_VOLTE_2.png differ diff --git a/docs/platform/tutorial_vCPE.rst b/docs/platform/tutorial_vCPE.rst index 7c6c9fb05..8c65aabc3 100644 --- a/docs/platform/tutorial_vCPE.rst +++ b/docs/platform/tutorial_vCPE.rst @@ -32,7 +32,7 @@ The telemetry API is used to see what is in memory. There should only be 1 fact, .. code-block:: bash - curl --silent --user @1b3rt:31nst31n -X GET http://localhost:9696/policy/pdp/engine/controllers/amsterdam/drools/facts/amsterdam | python -m json.tool + curl -k --silent --user @1b3rt:31nst31n -X GET https://localhost:9696/policy/pdp/engine/controllers/amsterdam/drools/facts/amsterdam | python -m json.tool .. image:: Tut_vCPE_get_facts.JPG @@ -47,7 +47,7 @@ Inject the onset using the Telemetry API. .. code-block:: bash - curl --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @dcae.vcpe.onset.json -X PUT http://localhost:9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_EVENT_OUTPUT/events | python -m json.tool + curl -k --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @dcae.vcpe.onset.json -X PUT https://localhost:9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_EVENT_OUTPUT/events | python -m json.tool .. image:: Tut_vCPE_insert_onset.JPG @@ -55,7 +55,6 @@ Inject the onset using the Telemetry API. Now check the facts in memory, there should be 7 objects present. Two timers exist to put a time limit on the operation and on the overall control loop (in the case of retries or policy chaining). The event and it's associated manager and operation manager are also present in memory. A lock on the target entity is inserted to ensure no other events try to take action on the VM/VNF that is currently processing. - .. image:: Tut_vCPE_get_facts_2.JPG The network log will be used to monitor the activity coming in and out of the PDP-D. This log is located at *$POLICY_HOME/logs/network.log*. This will show the notifications that the PDP-D sends out at different stages of processing. The order of successful processing begins with an ACTIVE notification to show that the onset was acknowledged and the operation is beginning transit. @@ -82,7 +81,7 @@ Inject the response using the Telemetry API. .. code-block:: bash - curl --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @appc.lcm.success.json -X PUT http://localhost:9696/policy/pdp/engine/topics/sources/ueb/APPC-LCM-WRITE/events | python -m json.tool + curl -k --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @appc.lcm.success.json -X PUT https://localhost:9696/policy/pdp/engine/topics/sources/ueb/APPC-LCM-WRITE/events | python -m json.tool .. image:: Tut_vCPE_inject_appc_response.JPG @@ -98,7 +97,7 @@ Inject the abatement message using the Telemetry API. .. code-block:: bash - curl --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @dcae.vcpe.abatement.json -X PUT http://localhost:9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_EVENT_OUTPUT/events | python -m json.tool + curl -k --silent --user @1b3rt:31nst31n --header "Content-Type: text/plain" --data @dcae.vcpe.abatement.json -X PUT https://localhost:9696/policy/pdp/engine/topics/sources/ueb/unauthenticated.DCAE_EVENT_OUTPUT/events | python -m json.tool .. image:: Tut_vCPE_insert_abatement.JPG