summaryrefslogtreecommitdiffstats
path: root/README_vagrant.md
diff options
context:
space:
mode:
Diffstat (limited to 'README_vagrant.md')
-rw-r--r--README_vagrant.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README_vagrant.md b/README_vagrant.md
new file mode 100644
index 000000000..e3b3b5551
--- /dev/null
+++ b/README_vagrant.md
@@ -0,0 +1,25 @@
+Requirements
+------------
+- vagrant (tested against version 1.7.2)
+- vagrant-hostmaster plugin (tested against version 1.5.0)
+- vagrant-libvirt (tested against version 0.0.26)
+ - Only required if using libvirt instead of virtualbox
+
+Usage
+-----
+```
+vagrant up --no-provision
+vagrant provision
+```
+
+Using libvirt:
+```
+vagrant up --provider=libvirt --no-provision
+vagrant provision
+```
+
+Environment Variables
+---------------------
+The following environment variables can be overriden:
+- OPENSHIFT_DEPLOYMENT_TYPE (defaults to origin, choices: origin, enterprise, online)
+- OPENSHIFT_NUM_NODES (the number of nodes to create, defaults to 2)