Fix typo in documentation

[nfvbench.git] / docs / testing / user / userguide / quickstart_docker.rst

diff --git a/docs/testing/user/userguide/quickstart_docker.rst b/docs/testing/user/userguide/quickstart_docker.rst
index 98d4d25..01b5d7d 100644 (file)
--- a/docs/testing/user/userguide/quickstart_docker.rst
+++ b/docs/testing/user/userguide/quickstart_docker.rst
@@ -18,7 +18,7 @@ To pull the latest NFVbench container image:
 
 .. code-block:: bash
 
-    docker pull opnfv/nfvbench/nfvbench
+    docker pull opnfv/nfvbench
 
 2. Docker Container configuration
 ---------------------------------
@@ -38,15 +38,56 @@ The NFVbench container requires the following Docker options to operate properly
 |                                                      | /tmp/nfvbench director in the container but any      |
 |                                                      | other similar mapping can work as well               |
 +------------------------------------------------------+------------------------------------------------------+
-| --net=host                                           | (optional) needed if you run the NFVbench REST       |
+| --net=host                                           | (optional) needed if you run the NFVbench ok         |
 |                                                      | server in the container (or use any appropriate      |
 |                                                      | docker network mode other than "host")               |
 +------------------------------------------------------+------------------------------------------------------+
-| --privilege                                          | (optional) required if SELinux is enabled on the host|
+| --privileged                                         | (optional) required if SELinux is enabled on the host|
++------------------------------------------------------+------------------------------------------------------+
+| -e HOST="127.0.0.1"                                  | (optional) required if REST server is enabled        |
++------------------------------------------------------+------------------------------------------------------+
+| -e PORT=7556                                         | (optional) required if REST server is enabled        |
++------------------------------------------------------+------------------------------------------------------+
+| -e CONFIG_FILE="/root/nfvbenchconfig.json            | (optional) required if REST server is enabled        |
 +------------------------------------------------------+------------------------------------------------------+
 
 It can be convenient to write a shell script (or an alias) to automatically insert the necessary options.
 
+The minimal configuration file required must specify the openrc file to use (using in-container path), the PCI addresses of the 2 NIC ports to use
+for generating traffic and the line rate (in each direction) of each of these 2 interfaces.
+
+Here is an example of mimimal configuration where:
+the openrc file is located on the host current directory which is mapped under /tmp/nfvbench in the container (this is achieved using -v $PWD:/tmp/nfvbench)
+the 2 NIC ports to use for generating traffic have the PCI addresses "04:00.0" and "04:00.1"
+
+.. code-block:: bash
+
+    {
+        "openrc_file": "/tmp/nfvbench/openrc",
+        "traffic_generator": {
+            "generator_profile": [
+                {
+                    "interfaces": [
+                        {
+                            "pci": "04:00.0",
+                            "port": 0,
+                        },
+                        {
+                            "pci": "04:00.1",
+                            "port": 1,
+                        }
+                    ],
+                    "intf_speed": "10Gbps",
+                    "ip": "127.0.0.1",
+                    "name": "trex-local",
+                    "tool": "TRex"
+                }
+            ]
+        }
+    }
+
+The other options in the minimal configuration must be present and must have the same values as above.
+
 3. Start the Docker container
 -----------------------------
 As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run)
@@ -57,11 +98,18 @@ The second approach is more responsive as the delay is only incurred once when s
 
 We will take the second approach and start the NFVbench container in detached mode with the name "nfvbench" (this works with bash, prefix with "sudo" if you do not use the root login)
 
+To run NFVBench without server mode
+
 .. code-block:: bash
 
-    docker run --detach --net=host --privileged -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) --name nfvbench opnfv/nfvbench tail -f /dev/null
+    docker run --detach --net=host --privileged -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) --name nfvbench opnfv/nfvbench
+
+To run NFVBench enabling REST server (mount the configuration json and the path for openrc)
+
+.. code-block:: bash
+
+    docker run --detach --net=host --privileged -e HOST="127.0.0.1" -e PORT=7556 --e CONFIG_FILE="/tmp/nfvbench/nfvbenchconfig.json -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) --name nfvbench opnfv/nfvbench start_rest_server
 
-The tail command simply prevents the container from exiting.
 
 The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt:
 
@@ -146,12 +194,7 @@ Alternatively, the full template with comments can be obtained using the --show-
 Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting)
 
 
-5. Upload the NFVbench loopback VM image to OpenStack
------------------------------------------------------
-[TBP URL to NFVbench VM image in the OPNFV artifact repository]
-
-
-6. Run NFVbench
+5. Run NFVbench
 ---------------
 
 To do a single run at 10,000pps bi-directional (or 5kpps in each direction) using the PVP packet path: