summaryrefslogtreecommitdiff
path: root/Vagrantfile
diff options
context:
space:
mode:
authorMichael Krotscheck <krotscheck@gmail.com>2015-06-15 10:40:27 -0700
committerMichael Krotscheck <krotscheck@gmail.com>2015-06-16 15:20:59 -0700
commit1ebbb7f19b0b270361caba7d39f1a1ed553f41e5 (patch)
treef48334de1a3339934286582e8c9c7d0bc38df5fc /Vagrantfile
parentf7ada6181c91391cdbae00b655f896399b5091d7 (diff)
downloadironic-1ebbb7f19b0b270361caba7d39f1a1ed553f41e5.tar.gz
Added documentation to Vagrantfile
A couple of comments during my latest CORS review indicated that there is a misunderstanding on why the Vagrantfile in ironic exists. In those comments, the assumption appeared to be that vagrant is used to provision ironic, not just the development resources necessary to work on ironic. This patch adds documentation to clarify that. Change-Id: I7d71adaba402a62343d1e0399ee53410b76c973f
Diffstat (limited to 'Vagrantfile')
-rw-r--r--Vagrantfile6
1 files changed, 6 insertions, 0 deletions
diff --git a/Vagrantfile b/Vagrantfile
index 57b93f46e..57e883fab 100644
--- a/Vagrantfile
+++ b/Vagrantfile
@@ -1,6 +1,12 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :
+# WARNING: This Vagrantfile is for development purposes only. It is intended to
+# bootstrap required services - such as mysql and rabbit - into a reliably
+# accessible VM, rather than forcing the engineer to install and manage these
+# services manually. This Vagrantfile is not intended to assist in provisioning
+# Ironic. For that, please use the bifrost project.
+
VAGRANTFILE_API_VERSION = '2'
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|