aboutsummaryrefslogtreecommitdiffstats
path: root/vpp-userdemo/README.md
diff options
context:
space:
mode:
authorPadraig Connolly <padraig.connolly@intel.com>2016-11-21 10:10:07 +0000
committerPadraig Connolly <padraig.connolly@intel.com>2016-11-21 10:10:07 +0000
commit51e00de1e4a4102e5d15c2e219787f8565f51019 (patch)
tree9761fb3b816904dcac0ed2f6285a3875f534ec38 /vpp-userdemo/README.md
parent08e0618fef8173d3c94d64bce69f34d26f6a1f1c (diff)
vpp-userdemo: Small changes to README/GUI
Changes to README: *README flow changed (i.e intro first, setup next, then running) *Changed CLI command help (tutorials directory needed to run demo) Changes to GUI: *Added fd.io colors to GUI interface *Added more relevent icons to each tutorial *Capitalized tutorial file names (Looks better on GUI) Change-Id: Ib6c1347e24687d489f3b0be3808aefb4bbb622f2 Signed-off-by: Padraig Connolly <padraig.connolly@intel.com>
Diffstat (limited to 'vpp-userdemo/README.md')
-rw-r--r--vpp-userdemo/README.md27
1 files changed, 12 insertions, 15 deletions
diff --git a/vpp-userdemo/README.md b/vpp-userdemo/README.md
index 9820600..31fdc09 100644
--- a/vpp-userdemo/README.md
+++ b/vpp-userdemo/README.md
@@ -17,15 +17,7 @@
This is a Vagrant based user demo environment for beginners with VPP
-to access the GUI for the demo, simply open up your favorite browser and point it at
-` http://localhost:5000 `
-
-# RUNNING DEMOS VIA GUI
-
-- click on a tutorial from the list appearing on the side navigation bar.
-- Once the selected tutorial is loaded, click the "NEXT" button, or hit the SPACE bar to go through the steps.
-- Each step is executing the shown command against the VM, showing the response on the console that appears at the bottom of the GUI.
-
+You can run the demo either through the GUI (recommended) or through the CLI
# REQUIREMENTS
- vagrant (1.8)
@@ -38,24 +30,29 @@ to access the GUI for the demo, simply open up your favorite browser and point i
- ```vagrant up```
- ... run the demo
-# RUNNING DEMOs
-- From the Host, where you ran ```vagrant up``` run ```./run <demoname>```
+# RUNNING DEMOS VIA THE GUI
+
+- simply open up your favorite browser and point it at ` http://localhost:5000 `
+- click on a tutorial from the list appearing on the side navigation bar.
+- Once the selected tutorial is loaded, click the "Next" button, or hit the SPACE bar to go through the steps.
+- Each step is executing the shown command against the VM, showing the response on the console that appears at the bottom of the GUI.
-```./run <demoname>```
+# RUNNING DEMOs VIA THE CLI
+- From the Host, where you ran ```vagrant up``` run ```./run tutorials/<demoname>```
# DEMOs
-## routing - directly connected routing
+## Routing - directly connected routing
- Creates two network namespaces c1, c2
- A gateway interface for each on VPP
- Routes due to directly connected routes inserted into default FIB
-## bridging - directly connected interfaces into a bridge-domain
+## Bridging - directly connected interfaces into a bridge-domain
- Creates two network namespaces c1, c2
- Adds interfaces to VPP and add them to bridge-domain 1
- MAC addresses are automatically learned
-## tracing - how to show a "day in the life of a packet" in VPP
+## Tracing - how to show a "day in the life of a packet" in VPP
- Same environment as "routing" demo
- How to add a trace
- View a trace