Prep work for Coverity upload processing via Jenkins

[vpp.git] / build-root / vagrant / README

diff --git a/build-root/vagrant/README b/build-root/vagrant/README
index 0498615..238c90c 100644 (file)
--- a/build-root/vagrant/README
+++ b/build-root/vagrant/README
@@ -1,54 +1,28 @@
-To run vpp with the debug shell:
+INTRO:
 
-sudo ~vagrant/git/vpp/build-root/install-vpp_debug-native/vpp/bin/vpe unix interactive
+This is a vagrant environment for VPP.
 
-which will result in a prompt that looks like:
+VPP currently works under Linux and has support for:
 
-DBGvpd#
+- Ubuntu 14.04, Ubuntu 16.04 and Centos7.2
 
-To give it a spin, we can create a tap interface and try a simple ping
-(with trace).
+The VM builds VPP from source which can be located at /vpp
 
-To create the tap:
+VM PARTICULARS:
+This vagrant environment creates a VM based on environment variables found in ./env.sh
+To use, edit env.sh then
+  source ./env.sh
+  vagrant up
 
-DBGvpd# tap connect foobar
-Created tap-0 for Linux tap 'foobar'
-DBGvpd# show int
+By default, the VM created is/has:
+- Ubuntu 14.04
+- 2 vCPUs
+- 4G of RAM
+- 2 NICs (1 x NAT - host access, 1 x VPP DPDK enabled)
 
-To assign it an ip address (and 'up' the interface):
+PROVIDERS:
 
-DBGvpd# set int ip address tap-0 192.168.1.1/24
-DBGvpd# set int state tap-0 up
+Supported vagrant providers are:
 
-To turn on packet tracing for the tap interface:
-DBGvpd# trace add tapcli-rx 10
+- Virtualbox, VMware Fusion/Workstation, Libvirt
 
-Now, to set up and try the other end from the unix prompt:
-vagrant@vagrant-ubuntu-trusty-64:~$ sudo ip addr add 192.168.1.2/24 dev foobar
-vagrant@vagrant-ubuntu-trusty-64:~$ ping -c 3 192.168.1.1
-
-To look at the trace, back in the vpp CLI:
-DBGvpd#  show trace
-
-And to stop tracing:
-
-DBGvpd# clear trace
-
-Other fun things to look at:
-
-The vlib packet processing graph:
-DBGvpd# show vlib graph
-
-which will produce output like:
-
-           Name                      Next                    Previous
-ip4-icmp-input                  error-punt [0]               ip4-local
-                                ip4-icmp-echo-request [1]
-                                vpe-icmp4-oam [2]
-
-To read this, the first column (Name) is the name of the node.
-The second column (Next) is the name of the children of that node.
-The third column (Previous) is the name of the parents of this node.
-
-To see this README again:
-cat /vagrant/README
\ No newline at end of file