aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/docs_vfw.rst36
1 files changed, 33 insertions, 3 deletions
diff --git a/docs/docs_vfw.rst b/docs/docs_vfw.rst
index 373348644..87658a3cc 100644
--- a/docs/docs_vfw.rst
+++ b/docs/docs_vfw.rst
@@ -31,6 +31,12 @@ automatic page refresh by clicking the "Off" button. You can see the traffic vol
The packet generator includes a script that periodically generates different volumes of traffic. The closed-loop
policy has been configured to re-adjust the traffic volume when high-water or low-water marks are crossed.
+Since Casablanca, we have used a vFWCL service tag for this testing instead of the vFW service tag. vFW servic tag
+is a regression for onboard and instantiation of a single VNF service (all three VMs in the same VNF) where as the
+vFWCL is a two VNF service (vFW+ vSNK and separeate vPKG)
+
+./demo-k8s.sh onap instantiateVFWCL can be used to onboard and instantiate a vFWCL via robot scripts or follow the procedure to use the GUI that is available in the documentation.
+
Closed-Loop for vFirewall Use Case
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -71,15 +77,33 @@ the HTTP argument with localhost (if you run it in the packet generator VM) or t
The command above enables 5 streams.
+
+Preconditions
+~~~~~~~~~~~~
+
+The control loop name in DCAE's TCA micro-service needs to match the Operational Policy control loop name.
+Due to timing robot scripts that setup the operational policy do not change the control loop name in DCAE.
+Do the following to update DCAE's consul entry for TCA to match the name assigned by robot to the operational
+policy. The control loop name generated by policy can be viewed in the log.html page on robot from the
+instantiateVFWCL.
+
+- Connect to Consul: http://<k8s_host_ip>/ui/#/dc1/services (change the IP based on the K8S cluster IP assignment)
+- Click Key/Value on the bar at the top of the Consul menu
+- Select “dcaegen2-analytics-tca” microservice from the list on the left
+- Search for "closedLoopControlName" key in the configuration policy JSON object
+- Replace the standard closed loop name with the one generated by robot
+- Click “Update” button to update the configuration policy
+
Running the Use Case
~~~~~~~~~~~~~~~~~~~~
-Users can run the use case using the automated Robot Framework or manually. For using the Robot Framework in an ONAP instance installed with OOM, users have to connect to the Rancher VM and run the following command:
+
+Users can run the use case using the automated Robot Framework or manually. For using the Robot Framework in an ONAP instance installed with OOM, users have to ssh to the Rancher VM and run the following command:
::
bash oom/kubernetes/robot/demo-k8s.sh <namespace> vfwclosedloop <pgn-ip-address>
-The script sets the packet generator to high and low rates, and checks whether the policy kicks in to modulate the rates back to medium.
+The script sets the packet generator to high and low rates, and checks whether the policy kicks in to modulate the rates back to medium. At the end of the test , robot sets the streams back to Medium so that it is setup for the next test.
For documentation about running the use case manually for previous releases, please look at the videos and the material available at this `wiki page`__.
@@ -89,4 +113,10 @@ Although videos are still valid, users are encouraged to use the Heat templates
Known issues and resolution
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The packet generator may become unresponsive to external inputs like changing the number of active streams. To solve the problem, reboot the packet generator VM. \ No newline at end of file
+The packet generator may become unresponsive to external inputs like changing the number of active streams. To solve the problem, reboot the packet generator VM.
+
+Policy can lock the target VNF if there are too many failed attempts due to mis-configuration etc. Set the streams to medium and wait 30 minutes or so and the lock in policy will expire. Monitoring the DMaaP topic for DCAE_CL_OUTPUT can be used to confirm that no TCA events are coming in from the VNF through VES/TCA.
+
+::
+ http://<k8s-host>:30227/events/unauthenticated.DCAE_CL_OUTPUT/g1/c3?timeout=5000
+