summaryrefslogtreecommitdiffstats
path: root/docs/reference/vppvagrant/vagrantOverview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/vppvagrant/vagrantOverview.rst')
-rw-r--r--docs/reference/vppvagrant/vagrantOverview.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/reference/vppvagrant/vagrantOverview.rst b/docs/reference/vppvagrant/vagrantOverview.rst
new file mode 100644
index 00000000000..882b8a68cfd
--- /dev/null
+++ b/docs/reference/vppvagrant/vagrantOverview.rst
@@ -0,0 +1,25 @@
+.. _vagrantOverview:
+
+.. toctree::
+
+Overview
+^^^^^^^^
+
+This guide shows how the VPP :ref:`vppVagrantfile` interacts with shell scripts to configure a `Vagrant box <https://www.vagrantup.com/docs/boxes.html>`_ that boots a VM with VPP.
+
+.. _prereqlabel:
+
+Prerequisites
+_____________
+
+You have the `FD.io VPP repo <https://github.com/FDio/vpp>`_ cloned locally on your machine.
+
+
+This guide will refer to the following files from that repo: *Vagrantfile, build.sh, env.sh, and update.sh*.
+
+
+
+
+
+
+