Cleanups for README.vagrant

Assorted cleanups for this readme, including:
- Move file to .rst extension
- Fix bulleted lists
- Mark up literals
- Fix typos

Change-Id: I66f8454c671b3d8d8f126304875285e2599f7dde
This commit is contained in:
stephane 2015-09-10 16:07:15 -07:00 committed by Julia Kreger
parent 6c5c81bb66
commit 226ebe9642
5 changed files with 50 additions and 38 deletions

View File

@ -1,36 +0,0 @@
Vagrant support for developers
==============================
Bifrost vagrant file for developers can be found in the tools/vagrant_dev_env
directory. Running 'vagrant up' from with in this folder will bring up an Ubuntu
Trusty box with bifrost installed.
By default the vm will have three interfaces:
eth0 - connected to a NAT network
eth1 - connected to Host-only network named: vboxnet1
eth2 - bridged - adapter must be set in Vagrantfile
Walkthrough done on OS X:
-------------------------
Setup vagrant by:
Installing git
Installing virtualbox
Installing vagrant
Installing ansible
Configure Vagrant with the correct box:
vagrant box add ubuntu/trusty64
Clone bifrost repo:
git clone https://github.com/openstack/bifrost.git
change in to the bifrost directory
cd bifrost/tools/vagrant_dev_env
edit Vagrantfile:
change public_key to correct key name
change network_interface to match your needs
change bridged adaptor
Boot the vm with:
vagrant up

48
README.vagrant.rst Normal file
View File

@ -0,0 +1,48 @@
==============================
Vagrant support for developers
==============================
Bifrost vagrant file for developers can be found in the
``tools/vagrant_dev_env`` directory. Running ``vagrant up`` from
within this folder will bring up an Ubuntu Trusty box with Bifrost
installed.
By default, the VM will have three interfaces:
- **eth0** - connected to a NAT network
- **eth1** - connected to Host-only network named: vboxnet1
- **eth2** - bridged - adapter must be set in Vagrantfile
-------------------------
Walkthrough done on OS X
-------------------------
Setup vagrant by:
- Installing git
- Installing virtualbox
- Installing vagrant
- Installing ansible
Configure Vagrant with the correct box::
vagrant box add ubuntu/trusty64
Clone bifrost repo::
git clone https://github.com/openstack/bifrost.git
Change into the bifrost directory::
cd bifrost/tools/vagrant_dev_env
Edit the Vagrantfile:
- Change the ``bifrost.vm.network`` ``public_network`` value to a
valid network interface to allow Bare Metal connectivity
- Change ``public_key`` to correct key name
- Change ``network_interface`` to match your needs
Boot the VM with::
vagrant up

View File

@ -1 +0,0 @@
.. include:: ../../README.vagrant

View File

@ -9,7 +9,7 @@ Contents:
readme
contributing
troubleshooting
Vagrant
vagrant
deploy/dhcp
offline-install

1
doc/source/vagrant.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../README.vagrant.rst