vagrant-openstack-plugin-tom 0.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ece582d0db46a5cd3a339b2d23fc7b2c9a210050
+  data.tar.gz: ab82202f9a37dbc1ebf2a5a019696c1e5f628f2d
+SHA512:
+  metadata.gz: 0b45aebe1c68ef02501647e90342b33258ae12929b7ebc1cb6596698d90fd53cc37e1963a981ea624ef9d830d03cc30ca9c691a14eb3a9d9842fd648eaffb137
+  data.tar.gz: b77a9e2f2a182f1c1f02c07a4b926c7534a7630d98c8f4d0542790ffe06a5bd260a8205ee468e4477d92faa9636240e2736acbd587b57e41c01df8e38bf7176d

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.idea
+.bundle
+.config
+.vagrant
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Vagrantfile

data/.travis.yml

@@ -0,0 +1,11 @@
+langauge: ruby
+script: rake test
+branches:
+  only:
+    - master
+rvm:
+  - 1.9.3
+  - 2.0.0
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Authors.txt

@@ -0,0 +1,11 @@
+Brian Miller
+Corey Stubbs
+Hendrik Volkmer
+Jasper Capel
+Joe Topjian
+Jon Burgess
+Mathieu Mitchell
+Mitchell Hashimoto
+Stephan Renatus
+Thomas Kadauke
+Xavier Antoviaque

data/CHANGELOG.md

@@ -0,0 +1,185 @@
+# Changelog for vagrant-openstack-plugin
+
+## 0.12.0 (2015/08/27)
+
+- be more specific on using symbols in the config. fixes cloudbau/vagrant-openstack-plugin#106 [view commit](http://github.com///commit/0ef0865c6e38debd77982310073fe09cd99c6054)
+- Merge pull request #103 from corpix/ssh_ip_family [view commit](http://github.com///commit/6ca314cc0cdbbe62bd4b80e65e518103ce73b027)
+- Merge pull request #109 from joelanford/floating-ip-fix [view commit](http://github.com///commit/2bf8a08494a8aa4a5a5eae677691c56b9748208b)
+- Merge pull request #118 from maxx/master [view commit](http://github.com///commit/eadeaa992ad7f2b1e43d35843fdfdc2fda661e3d)
+- allows an alternative to os.floating_ip :auto, called os.floating_ip :associate_unassigned. This pulls an unassigned IP address from an existing pool with pre-allocated IP's, and will not try to allocate a new IP. If an IP is not available, no floating IP is assigned. Relevant errors and documentation added as well [view commit](http://github.com///commit/adc708405c47c44ef60ccdc5df4d9f6f04cd5a1f)
+- Fixes issue #100, where config.rb incorrectly handled floating_ip and floating_ip_pool configurations [view commit](http://github.com///commit/21f8532e726d21d75788dcd3d6cdd0ec84acc633)
+- Merge pull request #107 from Chealion/handleEphemeralDisks [view commit](http://github.com///commit/338e0525397bd710e351cb7a6eadcb801b2255f6)
+- Merge pull request #104 from cshaffer/upgrade_rsepc [view commit](http://github.com///commit/533c0ac004be755e973098c6589b4cf6b1fdc696)
+- Add ability to handle swap and ephemeral disks to disks feature [view commit](http://github.com///commit/c4f7acea6e2d97d040184534403fee2262671176)
+- Convert specs to RSpec 3.1.7 syntax with Transpec [view commit](http://github.com///commit/6115ccb73c8e28704bbe8efb5d079d35b1d0d844)
+- Upgrade rspec to 3.1.0 [view commit](http://github.com///commit/c0dfe22fdd7c9d2e72c02187491acea7b9e1b013)
+- Convert specs to RSpec 2.14.8 syntax with Transpec [view commit](http://github.com///commit/dd34a0eed957e190fec369f43514c8a5d4549833)
+- Upgrade rspec to 2.14 first [view commit](http://github.com///commit/332c537e4f028bc8ab4ffd630c75a32ca93a681f)
+- Removed debug printing [view commit](http://github.com///commit/59a8f024d090fff5ae28d30ef72a24d2f58044c3)
+- Updated readme [view commit](http://github.com///commit/815f05d770f9991fa5e333ae24e15fde801643d7)
+- IP address family match support [view commit](http://github.com///commit/5aa125c0e741496c60927cff9a413e942d9f2720)
+
+## 0.11.1
+
+- Merge pull request #99 from jtopjian/master [view commit](http://github.com///commit/1c2667532e408f239761882a367c11d948610f37)
+- Update README.md to add Static IP instructions [view commit](http://github.com///commit/9246d8b9389dd4e1108e0f3ab7c2652459d6d192)
+- Merge pull request #98 from Chealion/fixFloatingIP [view commit](http://github.com///commit/1d6635791286bf396ec1a852730116ec1c0bbba0)
+- Don't release a floating IP unless it was automatically assigned. [view commit](http://github.com///commit/c5f51082323b9defa5d101b0f5decbe68e15cfa3)
+
+## 0.11.0
+
+- Merge pull request #97 from cbaenziger/issue_96_fix [view commit](http://github.com///commit/36295904ffb65d7461870a97e561c470fdedbbe5)
+- Merge pull request #95 from cbaenziger/volume_support [view commit](http://github.com///commit/3d3fb8d6ae3b3115abea725820ac4a205c814070)
+- Retry server deletes until we are sure the VM is dead -- only then remove IP's and volumes [view commit](http://github.com///commit/8799e70521a4ad4c4d1a5aa2a3ea42b83c042c38)
+- Update README for more volume related material [view commit](http://github.com///commit/c0e6e0afae67a1e63095f917d50b7c3aa3655547)
+- Fix to prevent stack trace failing to find VM, if destroying a non-existant VM [view commit](http://github.com///commit/7632b70a9f2c5af3a6d46a31b2ce4beb1bc9217b)
+- Use same check as connect.rb for Vagrantfile disks section [view commit](http://github.com///commit/bd440fbacd7abc7914629431edd74e73cad71f95)
+- Fix issue finding volumes if running vagrant destroy after server is destroyed [view commit](http://github.com///commit/8629390d724cdaa611504121bca64690e191cdba)
+
+## 0.10.0
+
+- Merge pull request #84 from cbaenziger/volume_support [view commit](http://github.com///commit/fc613a49cb5b2fecf2255d3050d1bff68956735d)
+- Add support for creating OpenStack Volumes [view commit](http://github.com///commit/60ed3924957bb7eefa95e113336165d76da3a985)
+
+## 0.9.1
+
+- Merge pull request #91 from Chealion/master [view commit](http://github.com///commit/6285cae325afa378e90f06635a2cc39b1428a6dd)
+- Fixes #90 that hostname is set to key path [view commit](http://github.com///commit/5feb04c7bf46cee1ef4d38e25d74710ea9d0981b)
+- Merge pull request #89 from reachlocal/fix_handleurl_deprecation_for_older_versions [view commit](http://github.com///commit/6ba9ee7d18d63a3d6f254c80e106bc440003fae6)
+- Added a check for the vagrant version to keep HandleUrl for older versions of vagrant [view commit](http://github.com///commit/07871ed10ea9cca9c51e97fb8bb3e11c33d41a33)
+
+## 0.9.0
+
+- Merge pull request #80 from hawknewton/network_fix [view commit](http://github.com///commit/542e7a2e077d624df9cb56a53c24cf3450e11c71)
+- Merge pull request #86 from ipoddar-ibm/master [view commit](http://github.com///commit/11fccb73264aa852df88825936026a9da4771580)
+- Merge pull request #88 from chino/fix-rsync-identify-file-options [view commit](http://github.com///commit/9319af5216c8c65ba144154ddfba2c1d767c567d)
+- Merge pull request #87 from arbrandes/master [view commit](http://github.com///commit/49839de94e1865eb88a25d5876f1698e2069a0be)
+- sync_folders: should have space between ssh-i options [view commit](http://github.com///commit/07325bfe4c782043d7ecec32a64fa516344cebf8)
+- Allocate IPs automatically [view commit](http://github.com///commit/84c311544d00286fc2c910f9147892e5ae6c0a5b)
+- Adds support for static IPs and interface config [view commit](http://github.com///commit/a5fdb22e23687c9bcd540b37b65b8d478d3a5d94)
+- remove extra line [view commit](http://github.com///commit/010e347acf403d6426fffac5ec01cb999dd9545f)
+- fix typo [view commit](http://github.com///commit/08dda991121f7e2e2f5bb8f32e03432f69aec226)
+- support cygwin [view commit](http://github.com///commit/62c2184906e444c22933d34b8b9054fca56df54f)
+- Connect to openstack network resource when needed [view commit](http://github.com///commit/8515a9305f354963d8687077e203a35c902035ce)
+
+## 0.8.0
+
+- Merge pull request #67 from pradels/master [view commit](http://github.com///commit/15f5b5531622376df952bccc0512a6de50d7a92f)
+- Merge pull request #66 from matope/use-execute-to-make-synced_folder [view commit](http://github.com///commit/96f64a846d40e5c7f0355def17189e38895e29f3)
+- Merge pull request #72 from mathuin/fix-handlebox [view commit](http://github.com///commit/3396e33e54d2527d28a70f1487da6221cd2316e2)
+- Merge pull request #64 from bewiwi/reboot [view commit](http://github.com///commit/24bec035508853be871ed8ed73b1d33f15beff76)
+- Merge pull request #63 from bewiwi/status [view commit](http://github.com///commit/79a8c341501461a0d5ef1ce4f11cc0a1810d38f3)
+- Merge pull request #71 from bewiwi/add_openstack_snapshot_commmand [view commit](http://github.com///commit/bf4eedd6eb5e29aefe4c0e156b932b4f4a81e1f5)
+- Merge pull request #73 from detiber/configNetworks [view commit](http://github.com///commit/5e17c5aaeee7bebc4991e440565f2ee4c1b6f191)
+- Set config.networks to [] if unset [view commit](http://github.com///commit/5aad087358792bee0bd1a6a026820b04bb8ca68f)
+- Changed HandleBoxUrl to HandleBox. [view commit](http://github.com///commit/ad7b2acdea81fe6f4b50e4658ecd36762a849f74)
+- Add command snapshot [view commit](http://github.com///commit/2d207ced7e70fe206fa309ed43a8ace3eb86b327)
+- Orchestration support added. [view commit](http://github.com///commit/d4e098db8517d491adfeb826500ac3ec5384d237)
+- Avoid using sudo to make synced_folder if possible [view commit](http://github.com///commit/b5b6205fbc34e95b4dbd9c13f974b728cb27c76e)
+- Add some status messages [view commit](http://github.com///commit/0c9287bc765e074eac104e02d7a64b36bd122034)
+- Modify reload action to be a real reboot [view commit](http://github.com///commit/91f5dc65a781d062d156b912bfd9d4b84db82e44)
+
+## 0.7.0
+
+- Merge pull request #35 from johnbellone/master [view commit](http://github.com///commit/5969261f11585e19348e903eec15617634c3c899)
+- Fix issues with SSH private keys in Vagrant 1.4. [view commit](http://github.com///commit/a8bf7574de48dc1c62928f5ad73fb6d1e7dd4347)
+- Refactor OpenStack actions to match AWS. [view commit](http://github.com///commit/c7177dc98ba43e3434075186a76df57d27ce7b26)
+
+## 0.6.1
+
+- Merge pull request #60 from matope/fix-floating_ip-NoMethodError [view commit](http://github.com///commit/a058256c27573c7545afbc09cce60214731e6e4e)
+- Fix NoMethodError on vagrant up w/o floating_ip [view commit](http://github.com///commit/be6fb0d46f69a3b9925c11648e5bc71af4491a7d)
+
+## 0.6.0
+
+- Merge pull request #59 from virtuald/fixed_automatic_ip [view commit](http://github.com///commit/7e7867ee7340515a8d0171fe5ea88aa340646e0f)
+- Update README with additional information about automatic allocation [view commit](http://github.com///commit/ea4ee9f409f61a2583588d3782701fe66239bd24)
+- Allow address_id to use the automatically assigned floating ip [view commit](http://github.com///commit/cb0e29c20e7105dae2a6534ccaebbe656c0d8419)
+- Update README [view commit](http://github.com///commit/b26f70653fb7cfbfe9604031d82aa42d4a324421)
+- Add support for automatically allocating a floating IP [view commit](http://github.com///commit/aee3129fc6020d3e3a6cc8db28b9b1c812225fbc)
+- update changelog [view commit](http://github.com///commit/936a2eef3d802d65a9f0753b5652ef4a8dbdb345)
+
+## 0.5.0
+
+
+- Merge pull request #45 from detiber/fixNetworksPR [view commit](http://github.com///commit/56b28eff5a1079c6805ec944b1a0c1dde458b10e)
+- Merge pull request #53 from tjheeta/remote_machine_id [view commit](http://github.com///commit/5873d1b5282fe2d24a0e725ec6289d1ba5e20e9b)
+- Merge pull request #54 from last-g/patch-1 [view commit](http://github.com///commit/7941573ef8f547a915e31c51ab4d1b85b878eebe)
+- Merge pull request #56 from nicobrevin/feature-no-verify-peer [view commit](http://github.com///commit/844835811808d256f67ad43e0124ace3f552a18c)
+- Merge pull request #58 from ohnoimdead/no-network-fix [view commit](http://github.com///commit/4b44a7c80d4a381531266844a5c99de0eea850b5)
+- Fix for exception when OS endpoint doesn't have neutron installed [view commit](http://github.com///commit/7558bbed3b5ecae8bb3e3ca9c64ffc9512a4c170)
+- add ssl_verify_peer config option [view commit](http://github.com///commit/cb94f002d790afb5fbec225d17385c8f5b0ebb35)
+- Missing semicolon [view commit](http://github.com///commit/8f609ee474b548b096e42b08c27fc5f874037204)
+- Missing region while configuring networks [view commit](http://github.com///commit/ea10bff5cdabea0b9c543a5231500fb7f9fd50ac)
+- Fix for delete_server [view commit](http://github.com///commit/d4f812eb99d135f7b7c5d210778e92cd8e5a4561)
+- If the .vagrant directory does not contain the machine id, try to connect remotely to try to find it [view commit](http://github.com///commit/71447bf49afe1fed29fa7ce561305dcc756a2e16)
+- Fix test for config.network and config.networks. [view commit](http://github.com///commit/5c9161aaf3ac715bc52819ee99c2d02d8434ea7b)
+
+## 0.4.1
+
+- update release info [view commit](http://github.com///commit/9866c83713ec0f1db8aed02a9aa9cbaafe8e85a4)
+
+## 0.4.0
+
+- Merge pull request #49 from RackerJohnMadrid/fix-rsync-vagrant-1-4 [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/5664ead3fda8f889dad72de1de2fbb
+- fixes the issue of ssh keys now being represented as an Array in vagrant >= 1.4 [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/0741d802a13c4a858
+- fix regression wrt multiple nics [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/9c5441db359b34f2bbf66d30853c97b0896a494b)
+- update README [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/725e66ab7970e5698aa7347dae93f791e926097a)
+- implement multiple networks [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/0bbbda10bc3b6a09e3165936a2cd17d56b9d3159)
+- two minor rsync bugfixes [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/5bf54e8ab99baa850631803137d991a4756f34ab)
+- Merge pull request #33 from johnbellone/master [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/f863781405a1070fe991f55f93d2b37763f6c1da)
+- Add actions for pausing/suspending (and inverse). [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/a5ec0edd25af250599e0e248a25d8a34af0e1c40)
+- Merge pull request #31 from johnbellone/master [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/83031f79e5834693e2c45656c0ae17b6f13afe83)
+- Add a little debugging output. [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/c00310ed8855d3b2b0472ab9304debefbb0918e3)
+- Add travis.yml file to the project. [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/bc53baaa43c2bf652294d374e071c96bf00bcf12)
+- Add proxy option to configuration. [view commit](http://github.com/cloudbau/vagrant-openstack-plugin/commit/3d33bdc9a3bf28af7403bd1a0245a9869799eadc)
+
+
+## 0.3.0 (September 25, 2013)
+
+- Adds support to determine IP address to use
+- Region Support
+- Enabled controlling multiple VMs in parallel
+- Honor disabling of synced folders
+- Adds `availability_zone` option to specify instance zone
+- Added --delete to rsync command
+- Call SetHostname action from Vagrant core in up phase
+- Handled not having the box and providing it via a box_url.
+- Allowed vagrant ssh -c 'command'
+- Adds tenant to network request
+- Improved documentation
+
+## 0.2.2  (May 30, 2013)
+
+- Also ignore HOSTUNREACH errors when first trying to connect to newly created VM
+
+## 0.2.1 (May 29, 2013)
+
+- Fix passing user data to server on create
+- Floating IP Capability
+- Added ability to configure scheduler hints
+- Update doc (network config in fact has higher precedence than address_id)
+- 'address_id' now defaults to 'public', to reduce number of cases in read_ssh_info
+- Introduced 'address_id' config, which has a higher order of precedence than 'network'
+
+## 0.2.0 (May 2, 2013)
+
+- Added docs
+- Removed metadata validation and bumped version
+- Tenant and security groups are now configurable
+
+## 0.1.3 (April 26, 2013)
+
+- Added the ability to pass metadata keypairs to instances
+- Added support for nics configurations to allow for selection of a specific network on creation
+
+## 0.1.2 (April 26, 2013)
+
+- Added the option of passing user data to VMs
+- Enabled `vagrant provision` in this provider
+- Made finding IP address more stable
+- Doc improvements and minor fixes
+
+## 0.1.0 (March 14, 2013)
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  # We depend on Vagrant for development, but we don't add it as a
+  # gem dependency because we expect to be installed within the
+  # Vagrant environment itself using `vagrant plugin`.
+  gem "vagrant", :git => "https://github.com/mitchellh/vagrant.git", :tag => "v1.4.3"
+end

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Mitchell Hashimoto
+Copyright (c) 2013 cloudbau GmbH
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,278 @@
+# Vagrant OpenStack Cloud Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.1+ plugin that adds a
+[OpenStack Cloud](http://www.openstack.org) provider to Vagrant,
+allowing Vagrant to control and provision machines within an OpenStack
+cloud.
+
+This plugin started as a fork of the Vagrant RackSpace provider.
+
+**Note:** This plugin requires Vagrant 1.1+.
+
+## Features
+
+* Boot OpenStack Cloud instances.
+* SSH into the instances.
+* Provision the instances with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`.
+* Creation and destruction of volumes with VM
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+installing, `vagrant up` and specify the `openstack` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-openstack-plugin
+...
+$ vagrant up --provider=openstack
+...
+```
+
+Of course prior to doing this, you'll need to obtain an OpenStack-compatible
+box file for Vagrant.
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually use a dummy OpenStack box and specify all the details
+manually within a `config.vm.provider` block. So first, add the dummy
+box using any name you want:
+
+```
+$ vagrant box add dummy https://github.com/cloudbau/vagrant-openstack-plugin/raw/master/dummy.box
+...
+```
+
+And then make a Vagrantfile that looks like the following, filling in
+your information where necessary.
+
+```
+require 'vagrant-openstack-plugin'
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+
+  # Make sure the private key from the key pair is provided
+  config.ssh.private_key_path = "~/.ssh/id_rsa"
+
+  config.vm.provider :openstack do |os|
+    os.username     = "YOUR USERNAME"          # e.g. "#{ENV['OS_USERNAME']}"
+    os.api_key      = "YOUR API KEY"           # e.g. "#{ENV['OS_PASSWORD']}"
+    os.flavor       = /m1.tiny/                # Regex or String
+    os.image        = /Ubuntu/                 # Regex or String
+    os.endpoint     = "KEYSTONE AUTH URL"      # e.g. "#{ENV['OS_AUTH_URL']}/tokens"
+    os.keypair_name = "YOUR KEYPAIR NAME"      # as stored in Nova
+    os.ssh_username = "SSH USERNAME"           # login for the VM
+
+    os.ssh_ip_family = "ipv6"                  # IP address family
+
+    os.metadata  = {"key" => "value"}                      # optional
+    os.user_data = "#cloud-config\nmanage_etc_hosts: True" # optional
+    os.network            = "YOUR NETWORK_NAME"            # optional
+    os.networks           = [ "internal", "external" ]     # optional, overrides os.network
+    os.address_id         = "YOUR ADDRESS ID"              # optional (`network` above has higher precedence)
+    os.scheduler_hints    = {
+        :cell => 'australia'
+    }                                          # optional
+    os.availability_zone  = "az0001"           # optional
+    os.security_groups    = ['ssh', 'http']    # optional
+    os.tenant             = "YOUR TENANT_NAME" # optional
+    os.floating_ip        = "33.33.33.33"      # optional (The floating IP to assign for this instance, or set to :auto or :associate_unassigned (ruby symbol, no quotes!))
+    os.floating_ip_pool   = "public"           # optional (The floating IP pool to allocate addresses to, if floating_ip = :auto, or the pool to pull the next available IP from if floating_ip = :associate_unassigned (ruby symbol, no quotes!))
+
+    os.disks              = [                  # optional
+                             {"name" => "volume_name_here", "description" => "A 10GB Volume", "size" => 10},
+                             {"name" => "volume_name_here", "description" => "A 20GB Volume", "size" => 20}
+                            ]
+
+    os.orchestration_stack_name = 'stack01'				# optional
+    os.orchestration_cfn_template_file = '/tmp/cfn_heat_template.json'	# optional
+    os.orchestration_cfn_template_parameters = {			# optional
+      'NetworkName' => 'net_01'
+    }
+  end
+end
+```
+
+And then run `vagrant up --provider=openstack`.
+
+This will start a tiny Ubuntu instance in your OpenStack installation within
+your tenant. And assuming your SSH information was filled in properly
+within your Vagrantfile, SSH and provisioning will work as well.
+
+Note that normally a lot of this boilerplate is encoded within the box
+file, but the box file used for the quick start, the "dummy" box, has
+no preconfigured defaults.
+
+## Box Format
+
+Every provider in Vagrant must introduce a custom box format. This
+provider introduces `openstack` boxes. You can view an example box in
+the [example_box/ directory](https://github.com/cloudbau/vagrant-openstack-plugin/tree/master/example_box).
+That directory also contains instructions on how to build a box.
+
+The box format is basically just the required `metadata.json` file
+along with a `Vagrantfile` that does default settings for the
+provider-specific configuration for this provider.
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options:
+
+* `api_key` - The API key for accessing OpenStack.
+* `flavor` - The server flavor to boot. This can be a string matching
+  the exact ID or name of the server, or this can be a regular expression
+  to partially match some server flavor.
+* `image` - The server image to boot. This can be a string matching the
+  exact ID or name of the image, or this can be a regular expression to
+  partially match some image.
+* `endpoint` - The keystone authentication URL of your OpenStack installation.
+* `server_name` - The name of the server within the OpenStack Cloud. This
+  defaults to the name of the Vagrant machine (via `config.vm.define`), but
+  can be overridden with this.
+* `username` - The username with which to access OpenStack.
+* `keypair_name` - The name of the keypair to access the machine.
+* `ssh_username` - The username to access the machine. This can also be
+configured using the standard config.ssh.username configuration value.
+* `ssh_ip_family` - The IP address family to use for SSH connection. It could be `ipv6` or `ipv4`.
+This option takes effect only if virtual machine have multiple addresses.
+* `metadata` - A set of key pair values that will be passed to the instance
+  for configuration.
+* `network` - A name or id that will be used to fetch network configuration
+  data when configuring the instance. NOTE: This is not compliant with the
+  vagrant network configurations.
+* `networks` - An array of names or ids to create a server with multiple network interfaces. This overrides the `network` setting.
+* `address_id` - A specific address identifier to use when connecting to the
+  instance. `network` has higher precedence. If set to :floating_ip, then
+  the floating IP address will be used.
+* `scheduler_hints` - Pass hints to the open stack scheduler, see `--hint` flag in [OpenStack filters doc](http://docs.openstack.org/trunk/openstack-compute/admin/content/scheduler-filters.html)
+* `availability_zone` - Specify the availability zone in which the instance
+  must be created.
+* `security_groups` - List of security groups to be applied to the machine.
+* `tenant` - Tenant name.  You only need to specify this if your OpenStack user has access to multiple tenants.
+* `region` - Region Name. Specify the region you want the instance to be launched in for multi-region environments.
+* `proxy` - HTTP proxy. When behind a firewall override this value for API access.
+* `ssl_verify_peer` - sets the ssl_verify_peer on the underlying excon connection - useful for self signed certs etc.
+* `floating_ip` - Floating ip. The floating IP to assign for this instance. If
+  set to :auto, then this assigns any available floating IP to the instance. If set to :associate_unassigned, then it will use the next IP address which is unasssigned in the pool specified in floating_ip_pool.
+* `floating_ip_pool` - Floating ip pool to allocate IP addresses from, if
+  floating_ip is set to :auto.  Previously allocated addresses will not be
+  used, and addresses allocated here will be released when the VM is destroyed.
+* `orchestration_stack_name` - Name for orchestration stack. Mandatory
+  parameter when creating new stack. One of parameters for template should be
+  set with this parameter.
+* `orchestration_stack_destroy` - If stack created by vagrant should be deleted
+  when destroy action is invoked. Default value is `false`.
+* `orchestration_cfn_template` - AWS CloudFormation Template specified as a string.
+* `orchestration_cfn_template_file` - AWS CloudFormation Template file path
+  accessible for vagrant.
+* `orchestration_cfn_template_url` - AWS CloudFormation Template URL.
+* `orchestration_cfn_template_parameters` - AWS CloudFormation Template
+  parameters specified in ruby hash (take a look at example Vagrantfile).
+  This parameter is optional.
+* `disks` - Array of disk specifications to create or attach
+
+These can be set like typical provider-specific configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :openstack do |rs|
+    rs.username = "mitchellh"
+    rs.api_key  = "foobarbaz"
+  end
+end
+```
+
+## Networks
+
+Static IP assignment is supported by doing the following:
+
+First, define one or more networks with `os.networks`:
+
+```ruby
+os.networks = ['network1', 'network2']
+```
+
+Next, configure those networks using `config.vm.network`:
+
+```ruby
+config.vm.network 'private_network', ip: '192.168.1.100'
+config.vm.network 'private_network', ip: '192.168.2.100'
+```
+
+Note that the order must be the same as the order in `os.networks`.
+If you only want to configure the second NIC with a static IP, do
+the following:
+
+```ruby
+config.vm.network 'private_network', type: 'dhcp'
+config.vm.network 'private_network', ip: '192.168.2.100'
+```
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`,
+`vagrant reload`, and `vagrant provision`, the OpenStack provider will use
+`rsync` (if available) to uni-directionally sync the folder to
+the remote machine over SSH.
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+## Command
+
+### Snapshot
+`vagrant openstack snapshot <vmname> -n <snapshotname>`
+
+Take snapshot of ***vmname*** with name ***snapshotname***
+
+## Contributors
+
+- [mitchellh](https://github.com/mitchellh)
+- [tkadauke](https://github.com/tkadauke)
+- [srenatus](https://github.com/srenatus)
+- [hvolkmer](https://github.com/hvolkmer)
+- [ehaselwanter](https://github.com/ehaselwanter)
+- [BRIMIL01](https://github.com/BRIMIL01)
+- [jkburges](https://github.com/jkburges)
+- [johnbellone](https://github.com/johnbellone)
+- [mat128](https://github.com/mat128)
+- [jtopjian](https://github.com/jtopjian)
+- [antoviaque](https://github.com/antoviaque)
+- [last-g](https://github.com/last-g)
+- [spil-jasper](https://github.com/spil-jasper)
+- [detiber](https://github.com/detiber)
+- [RackerJohnMadrid](https://github.com/RackerJohnMadrid)
+- [Lull3rSkat3r](https://github.com/Lull3rSkat3r)
+- [nicobrevin](https://github.com/nicobrevin)
+- [ohnoimdead](https://github.com/ohnoimdead)
+- [cbaenziger](https://github.com/cbaenziger)
+- [chealion](https://github.com/chealion)
+
+## Development
+
+To work on the `vagrant-openstack-plugin` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+```
+$ bundle
+```
+
+Once you have the dependencies, verify the unit tests pass with `rake`:
+
+```
+$ bundle exec rake
+```
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+that uses it, and uses bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up --provider=openstack
+```