X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=extras%2Fvagrant%2FREADME;fp=extras%2Fvagrant%2FREADME;h=238c90ce99ce77e80b99dc5fe8aa8b29370471a7;hb=48009e4c5732180ecc951ac6359b9b96d38b8dc2;hp=0000000000000000000000000000000000000000;hpb=686c1c8454803e48d45428a720f129f24dc981f7;p=vpp.git

diff --git a/extras/vagrant/README b/extras/vagrant/README
new file mode 100644
index 00000000000..238c90ce99c
--- /dev/null
+++ b/extras/vagrant/README
@@ -0,0 +1,28 @@
+INTRO:
+
+This is a vagrant environment for VPP.
+
+VPP currently works under Linux and has support for:
+
+- Ubuntu 14.04, 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 use, edit env.sh then
+  source ./env.sh
+  vagrant up
+
+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)
+
+PROVIDERS:
+
+Supported vagrant providers are:
+
+- Virtualbox, VMware Fusion/Workstation, Libvirt
+