Merge branch 'stable/1710' of https://gerrit.fd.io/r/vpp into 17101710

1 files changed, 43 insertions, 0 deletions

diff --git a/extras/vagrant/README b/extras/vagrant/README
new file mode 100644
index 00000000..4b7c7aa1
--- /dev/null
+++ b/extras/vagrant/README
@@ -0,0 +1,43 @@
+INTRO:
+
+This is a vagrant environment for VPP.
+
+VPP currently works under Linux and has support for:
+
+- Ubuntu 16.04 and Centos7.2
+
+The VM builds VPP from source which can be located at /vpp
+
+VM PARTICULARS:
+This vagrant environment creates a VM based on environment variables found in ./env.sh
+To customize the vm for your use case, edit env.sh then
+  source ./env.sh
+  vagrant up
+
+By default, the VM created is/has:
+- Ubuntu 16.04
+- 2 vCPUs
+- 4G of RAM
+- 3 NICs (1 x NAT - host access, 2 x VPP DPDK enabled)
+
+PROVIDERS:
+
+Supported vagrant providers are:
+
+- Virtualbox, VMware Fusion/Workstation, Libvirt
+
+ALTERNATE CONFIGURATIONS
+
+The following Vagrantfiles provide alternate configurations for specific testing purposes.  To use them,
+
+1. Copy the desired configuration to Vagrantfile
+2. Run "vagrant up"
+3. vagrant ssh <vm name>
+
+When testing is complete
+4. Run "vagrant destroy" to stop the VM's and delete files.
+5. Run "git checkout -- Vagrantfile" to restore the default configuration
+
+Available Vagrantfiles:
+
+Vagrantfile.vcl_test  - Create two vm's for multi-host VppCommLib testing