From 1ebbb7f19b0b270361caba7d39f1a1ed553f41e5 Mon Sep 17 00:00:00 2001 From: Michael Krotscheck Date: Mon, 15 Jun 2015 10:40:27 -0700 Subject: [PATCH] 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 --- Vagrantfile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Vagrantfile b/Vagrantfile index 57b93f46e7..57e883fab2 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|