Add tooling page to integration project

[integration.git] / docs / docs_vlb.rst

diff --git a/docs/docs_vlb.rst b/docs/docs_vlb.rst
index ded308f..5044d2a 100644 (file)
--- a/docs/docs_vlb.rst
+++ b/docs/docs_vlb.rst
@@ -15,7 +15,7 @@ Source files
 
 Description
 ~~~~~~~~~~~
-The use case is composed of three VFs: packet generator, load balancer, and DNS server. These VFs run in three separate VMs. The packet generator issues DNS lookup queries that reach the DNS server via the load balancer. DNS replies reach the packet generator via the load balancer as well. The load balancer reports the average amount of traffic per DNS over a time interval to the DCAE collector. When the average amount of traffic per DNS server crosses a predefined threshold, the closed-loop is triggered and a new DNS server is instantiated. 
+The use case is composed of three VFs: packet generator, load balancer, and DNS server. These VFs run in three separate VMs. The packet generator issues DNS lookup queries that reach the DNS server via the load balancer. DNS replies reach the packet generator via the load balancer as well. The load balancer reports the average amount of traffic per DNS over a time interval to the DCAE collector. When the average amount of traffic per DNS server crosses a predefined threshold, the closed-loop is triggered and a new DNS server is instantiated.
 
 To test the application, make sure that the security group in OpenStack has ingress/egress entries for protocol 47 (GRE). The user can run a DNS query from the packet generator VM:
 
@@ -23,7 +23,7 @@ To test the application, make sure that the security group in OpenStack has ingr
 
   dig @vLoadBalancer_IP host1.dnsdemo.onap.org
 
-The output below means that the load balancer has been set up correctly, has forwarded the DNS queries to one DNS instance, and the packet generator has received the DNS reply message. 
+The output below means that the load balancer has been set up correctly, has forwarded the DNS queries to one DNS instance, and the packet generator has received the DNS reply message.
 
 ::
 
@@ -34,26 +34,26 @@ The output below means that the load balancer has been set up correctly, has for
     ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 31892
     ;; flags: qr aa rd; QUERY: 1, ANSWER: 1, AUTHORITY: 1, ADDITIONAL: 2
     ;; WARNING: recursion requested but not available
-    
+
     ;; OPT PSEUDOSECTION:
     ; EDNS: version: 0, flags:; udp: 4096
     ;; QUESTION SECTION:
     ;host1.dnsdemo.onap.org.           IN      A
-    
+
     ;; ANSWER SECTION:
     host1.dnsdemo.onap.org.    604800  IN      A       10.0.100.101
-    
+
     ;; AUTHORITY SECTION:
     dnsdemo.onap.org.  604800  IN      NS      dnsdemo.onap.org.
-    
+
     ;; ADDITIONAL SECTION:
     dnsdemo.onap.org.  604800  IN      A       10.0.100.100
-    
+
     ;; Query time: 0 msec
     ;; SERVER: 192.168.9.111#53(192.168.9.111)
     ;; WHEN: Fri Nov 10 17:39:12 UTC 2017
     ;; MSG SIZE  rcvd: 97
- 
+
 
 Closedloop for vLoadBalancer/vDNS
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -70,9 +70,9 @@ To change the volume of queries generated by the packet generator, run the follo
 ::
 
 
-  curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"dns1", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"  
- 
-- {"id":"dns1", "is-enabled":"true"} shows the stream "dns1" is enabled. The packet generator sends requests in the rate of 100 packets per 10 seconds;  
+  curl -X PUT -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{"pg-streams":{"pg-stream": [{"id":"dns1", "is-enabled":"true"}]}}' "http://PacketGen_IP:8183/restconf/config/sample-plugin:sample-plugin/pg-streams"
+
+- {"id":"dns1", "is-enabled":"true"} shows the stream "dns1" is enabled. The packet generator sends requests in the rate of 100 packets per 10 seconds;
 - To increase the amount of traffic, you can enable more streams. The packet generator has 10 streams, "dns1", "dns2", "dns3" to "dns10". Each of them generates 100 packets per 10 seconds. To enable the streams, please add {"id":"dnsX", "is-enabled":"true"} to the pg-stream bracket of the curl command, where X is the stream ID.
 
 For example, if you want to enable 3 streams, the curl command will be:
@@ -86,7 +86,7 @@ When the VNF starts, the packet generator is automatically configured to run 5 s
 
 Running the Use Case
 ~~~~~~~~~~~~~~~~~~~~
-Automated closed loop via Robot Framework is not supported at this time. For documentation about running the use case manually for previous releases, please look at the videos and the material available at this `wiki page`__.
+Automated closed loop via Robot Framework is not supported at this time. For documentation about running the use case manually for previous releases, please look at the videos and the material available at this `wiki page`_.
 
 __ https://wiki.onap.org/display/DW/Running+the+ONAP+Demos
 
@@ -102,4 +102,4 @@ Known issues and resolution
 
   b) The SDNC preload for the scaling VF module must set the VF module name to "vDNS\_xyz", where "xyz" is the same as the base module. This is required because during closed loop Policy looks for "Vfmodule\_" and replaces it with "vDNS\_"
 
-3) Only one scaling operation is supported.
\ No newline at end of file
+3) Only one scaling operation is supported.