vagrant-cloudstack 1.3.0 → 1.4.0

data/Docker/Dockerfile

@@ -0,0 +1,51 @@
+FROM debian:8
+
+MAINTAINER Bob van den Heuvel <bvandenheuvel@schubergphilis.com>
+
+# Specific older chef-dk required due to bundler version, only available as Debian 6 package
+ENV	CHEFDK_VERSION 0.10.0
+ENV	CHEFDK_DEB_VERSION 6
+
+# Currently the latest version of the plugin has been tested with Vagrant 1.8.1
+ENV	VAGRANT_VERSION 1.8.1
+
+# The plugin currently depends on existence of the USER variable...
+ENV USER VAC
+
+# Update before all package installations
+RUN apt-get update -y && \
+   apt-get install -y build-essential liblzma-dev zlib1g-dev git openssh-client curl && \
+   ln -sf bash /bin/sh
+
+# Set the locale, seems to be required for all things gem
+RUN     apt-get install -y locales  && \
+        dpkg-reconfigure -f noninteractive tzdata && \
+        sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
+        echo 'LANG="en_US.UTF-8"'>/etc/default/locale && \
+        dpkg-reconfigure --frontend=noninteractive locales && \
+        update-locale LANG=en_US.UTF-8
+# Set environment variables AFTER configuration, else breaks
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+#
+
+# install vagrant and the vagrant-cloudstack plugin
+RUN curl -L https://releases.hashicorp.com/vagrant/${VAGRANT_VERSION}/vagrant_${VAGRANT_VERSION}_x86_64.deb > /tmp/vagrant_x86_64.deb && \
+    dpkg -i /tmp/vagrant_x86_64.deb && \
+    rm -f /tmp/vagrant_x86_64.deb && \
+    vagrant plugin install vagrant-cloudstack && \
+    vagrant plugin install vagrant-winrm
+
+RUN curl -L https://packages.chef.io/stable/debian/${CHEFDK_DEB_VERSION}/chefdk_${CHEFDK_VERSION}-1_amd64.deb > /tmp/chef_dk.deb && \
+    dpkg -i /tmp/chef_dk.deb &&  rm /tmp/chef_dk.deb && \
+    rm -f /tmp/chef_dk.deb && \
+    echo 'eval "$(chef shell-init bash)"' >> ~/.bashrc && \
+    /opt/chefdk/embedded/bin/bundler config --global path vendor/bundle && \
+    /opt/chefdk/embedded/bin/bundler config --global bin vendor/bin && \
+    /opt/chefdk/embedded/bin/gem install kitchen-vagrant
+
+
+WORKDIR "/work"
+
+VOLUME ["/work"]

data/Docker/Dockerfile.chefdk_0_17

@@ -0,0 +1,49 @@
+FROM debian:8
+
+MAINTAINER Bob van den Heuvel <bvandenheuvel@schubergphilis.com>
+
+# Specify the ChefDK version and channel
+ENV CHEFDK_VERSION 0.17
+ENV CHEFDK_CHANNEL stable
+
+# Currently the latest version of the plugin has been tested with Vagrant 1.8.1
+ENV	VAGRANT_VERSION 1.8.1
+
+# The plugin currently depends on existence of the USER variable...
+ENV USER VAC
+
+# Update before all package installations
+RUN apt-get update -y && \
+   apt-get install -y build-essential liblzma-dev zlib1g-dev git openssh-client curl && \
+   ln -sf bash /bin/sh
+
+# Set the locale, seems to be required for all things gem
+RUN     apt-get install -y locales  && \
+        dpkg-reconfigure -f noninteractive tzdata && \
+        sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
+        echo 'LANG="en_US.UTF-8"'>/etc/default/locale && \
+        dpkg-reconfigure --frontend=noninteractive locales && \
+        update-locale LANG=en_US.UTF-8
+# Set environment variables AFTER configuration, else breaks
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+#
+
+# Install vagrant and the vagrant-cloudstack plugin
+RUN curl -L https://releases.hashicorp.com/vagrant/${VAGRANT_VERSION}/vagrant_${VAGRANT_VERSION}_x86_64.deb > /tmp/vagrant_x86_64.deb && \
+    dpkg -i /tmp/vagrant_x86_64.deb && \
+    rm -f /tmp/vagrant_x86_64.deb && \
+    vagrant plugin install vagrant-cloudstack && \
+    vagrant plugin install vagrant-winrm
+
+# Install ChefDK
+RUN curl https://omnitruck.chef.io/install.sh | bash -s -- -c ${CHEFDK_CHANNEL} -P chefdk -v ${CHEFDK_VERSION} && \
+    echo 'eval "$(chef shell-init bash)"' >> ~/.bashrc && \
+    /opt/chefdk/embedded/bin/bundler config --global path vendor/bundle && \
+    /opt/chefdk/embedded/bin/bundler config --global bin vendor/bin && \
+    /opt/chefdk/embedded/bin/gem install kitchen-vagrant
+
+WORKDIR "/work"
+
+VOLUME ["/work"]

data/Docker/Dockerfile.latest_dependencies

@@ -0,0 +1,49 @@
+FROM debian:8
+
+MAINTAINER Bob van den Heuvel <bvandenheuvel@schubergphilis.com>
+
+# Specify the ChefDK version and channel
+ENV CHEFDK_VERSION 0.19
+ENV CHEFDK_CHANNEL stable
+
+# Currently the latest version of the plugin has been tested with Vagrant 1.8.1
+ENV	VAGRANT_VERSION 1.8.1
+
+# The plugin currently depends on existence of the USER variable...
+ENV USER VAC
+
+# Update before all package installations
+RUN apt-get update -y && \
+   apt-get install -y build-essential liblzma-dev zlib1g-dev git openssh-client curl && \
+   ln -sf bash /bin/sh
+
+# Set the locale, seems to be required for all things gem
+RUN     apt-get install -y locales  && \
+        dpkg-reconfigure -f noninteractive tzdata && \
+        sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
+        echo 'LANG="en_US.UTF-8"'>/etc/default/locale && \
+        dpkg-reconfigure --frontend=noninteractive locales && \
+        update-locale LANG=en_US.UTF-8
+# Set environment variables AFTER configuration, else breaks
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+#
+
+# Install vagrant and the vagrant-cloudstack plugin
+RUN curl -L https://releases.hashicorp.com/vagrant/${VAGRANT_VERSION}/vagrant_${VAGRANT_VERSION}_x86_64.deb > /tmp/vagrant_x86_64.deb && \
+    dpkg -i /tmp/vagrant_x86_64.deb && \
+    rm -f /tmp/vagrant_x86_64.deb && \
+    vagrant plugin install vagrant-cloudstack && \
+    vagrant plugin install vagrant-winrm
+
+# Install ChefDK
+RUN curl https://omnitruck.chef.io/install.sh | bash -s -- -c ${CHEFDK_CHANNEL} -P chefdk -v ${CHEFDK_VERSION} && \
+    echo 'eval "$(chef shell-init bash)"' >> ~/.bashrc && \
+    /opt/chefdk/embedded/bin/bundler config --global path vendor/bundle && \
+    /opt/chefdk/embedded/bin/bundler config --global bin vendor/bin && \
+    /opt/chefdk/embedded/bin/gem install kitchen-vagrant
+
+WORKDIR "/work"
+
+VOLUME ["/work"]

data/Docker/README.md

@@ -0,0 +1,67 @@
+# Vagrant Cloudstack Container
+
+This container contains some tools commonly used with the vagrant-cloudstack plugin
+## latest
+The versions have been specifically tuned to provide a working set for development of the plugin. To this end also developer tools (e.g. make, g++) are installed to enable bundler to pull in and compile required gems.
+So this one is _required_ for developing and testing the plugin from (latest, master) source.
+* [Vagrant](http://www.vagrantup.com) 1.8.1
+* [Vagrant-cloudstack](https://github.com/missioncriticalcloud/vagrant-cloudstack) plugin latest
+* [Vagrant-winrm](https://github.com/criteo/vagrant-winrm) latest
+* [Chef-DK](https://downloads.chef.io/chef-dk/) 0.10.0
+* [Kitchen-Vagrant](https://github.com/test-kitchen/kitchen-vagrant) latest
+_As the container is build automatically on triggers, latest versions are latest at time of (re)build_
+ 
+
+## latest_dependencies
+This may not work for everyone as we try to use latest, but also stable combination of versions.
+* [Vagrant](http://www.vagrantup.com) 1.8.1
+* [Vagrant-cloudstack](https://github.com/missioncriticalcloud/vagrant-cloudstack) plugin latest
+* [Vagrant-winrm](https://github.com/criteo/vagrant-winrm) latest
+* [Chef-DK](https://downloads.chef.io/chef-dk/) 0.19
+* [Kitchen-Vagrant](https://github.com/test-kitchen/kitchen-vagrant) latest
+_As the container is build automatically on triggers, latest versions are latest at time of (re)build_
+
+
+## chefdk_0_17
+This will install chef-client 12.13.37 which is needed for some compatibilty reasons.
+* [Vagrant](http://www.vagrantup.com) 1.8.1
+* [Vagrant-cloudstack](https://github.com/missioncriticalcloud/vagrant-cloudstack) plugin latest
+* [Vagrant-winrm](https://github.com/criteo/vagrant-winrm) latest
+* [Chef-DK](https://downloads.chef.io/chef-dk/) 0.17
+* [Kitchen-Vagrant](https://github.com/test-kitchen/kitchen-vagrant) latest
+_As the container is build automatically on triggers, latest versions are latest at time of (re)build_
+
+
+Links to the respective Dockerfiles:
+* [latest](https://raw.githubusercontent.com/MissionCriticalCloud/vagrant-cloudstack/master/Docker/Dockerfile)
+* [latest_dependencies](https://raw.githubusercontent.com/MissionCriticalCloud/vagrant-cloudstack/master/Docker/Dockerfile.latest_dependencies)
+* [chefdk_0_17](https://raw.githubusercontent.com/MissionCriticalCloud/vagrant-cloudstack/master/Docker/Dockerfile.chefdk_0_17)
+
+## Features
+* Run Vagrant with the plugin
+* Run Test-Kitchen with the plugin
+* Using Bundler, run Vagrant/Test-Kitchen with vagrant-cloudstack from source
+
+## Usage
+Retrieve the docker container:
+```
+docker pull missioncriticalcloud/vagrant-cloudstack
+```
+Change into the directory containing your project (Vagrantfile, .kitchen.yml), and execute:
+```
+docker run -ti --rm  -v $(pwd):/work missioncriticalcloud/vagrant-cloudstack /bin/bash
+```
+This provides a bash shell (in the container) where you can execute e.g. Vagrant, Test-Kitchen, Bundler.
+
+For use of Vagrantfile or .kitchen.yml files containing environment variables, environment variables need to be specified in the docker run, e.g.:
+```
+docker run \
+-e USER=${USER} \
+-e CLOUDSTACK_API_KEY=${CLOUDSTACK_API_KEY} \
+-e CLOUDSTACK_SECRET_KEY=${CLOUDSTACK_SECRET_KEY} \
+-ti --rm  -v $(pwd):/work missioncriticalcloud/vagrant-cloudstack /bin/bash
+```
+
+For actual development of the plugin, a lot more variables are required. To this end you can use the [bash script `vac.sh`](https://raw.githubusercontent.com/MissionCriticalCloud/vagrant-cloudstack/master/Docker/vac.sh) or [PowerShell script `vac.ps1`](https://raw.githubusercontent.com/MissionCriticalCloud/vagrant-cloudstack/master/Docker/vac.ps1) in the git repo.
+
+_Note on usage of SSH keyfile_: As the container is mounted on a specific folder (`$(pwd)`), the keyfile must be specified (by `SSH_KEY`) relative to, __and within__, the specified folder!

data/Docker/vac.ps1

@@ -0,0 +1,29 @@
+docker run `
+-e USER=$env:USERNAME `
+-e CLOUDSTACK_API_KEY=$env:CLOUDSTACK_API_KEY `
+-e CLOUDSTACK_SECRET_KEY=$env:CLOUDSTACK_SECRET_KEY `
+-e CLOUDSTACK_HOST=$env:CLOUDSTACK_HOST `
+-e ZONE_NAME=$env:ZONE_NAME `
+-e SERVICE_OFFERING_NAME=$env:SERVICE_OFFERING_NAME `
+-e VPC_PUBLIC_IP=$env:VPC_PUBLIC_IP `
+-e VPC_TIER_NAME=$env:VPC_TIER_NAME `
+-e VR_PUBLIC_IP=$env:VR_PUBLIC_IP `
+-e VR_NETWORK_NAME=$env:VR_NETWORK_NAME `
+-e NETWORK_NAME=$env:NETWORK_NAME `
+-e PUBLIC_SOURCE_NAT_IP=$env:PUBLIC_SOURCE_NAT_IP `
+-e OPEN_FIREWALL=$env:OPEN_FIREWALL `
+-e PUBLIC_SSH_PORT=$env:PUBLIC_SSH_PORT `
+-e PRIVATE_SSH_PORT=$env:PRIVATE_SSH_PORT `
+-e PUBLIC_WINRM_PORT=$env:PUBLIC_WINRM_PORT `
+-e PRIVATE_WINRM_PORT=$env:PRIVATE_WINRM_PORT `
+-e SSH_USER=$env:SSH_USER `
+-e SSH_KEY=/work/$env:SSH_KEY `
+-e WINDOWS_USER=$env:WINDOWS_USER `
+-e LINUX_TEMPLATE_NAME=$env:LINUX_TEMPLATE_NAME `
+-e WINDOWS_TEMPLATE_NAME=$env:WINDOWS_TEMPLATE_NAME `
+-e SOURCE_CIDR=$env:SOURCE_CIDR `
+-e TRUSTED_NETWORKS=$env:TRUSTED_NETWORKS `
+-e KITCHEN_LOCAL_YAML=$env:KITCHEN_LOCAL_YAML `
+-e DISK_OFFERING_NAME=$env:DISK_OFFERING_NAME `
+-e EXPUNGE_ON_DESTROY=$env:EXPUNGE_ON_DESTROY `
+-ti --rm  -v "$( $(pwd) -replace '\\', '/'):/work" missioncriticalcloud/vagrant-cloudstack /bin/bash

data/Docker/vac.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+docker run \
+-e USER=${USER} \
+-e CLOUDSTACK_API_KEY=${CLOUDSTACK_API_KEY} \
+-e CLOUDSTACK_SECRET_KEY=${CLOUDSTACK_SECRET_KEY} \
+-e CLOUDSTACK_HOST=${CLOUDSTACK_HOST} \
+-e ZONE_NAME=${ZONE_NAME} \
+-e SERVICE_OFFERING_NAME=${SERVICE_OFFERING_NAME} \
+-e VPC_PUBLIC_IP=${VPC_PUBLIC_IP} \
+-e VPC_TIER_NAME=${VPC_TIER_NAME} \
+-e VR_PUBLIC_IP=${VR_PUBLIC_IP} \
+-e VR_NETWORK_NAME=${VR_NETWORK_NAME} \
+-e NETWORK_NAME=${NETWORK_NAME} \
+-e PUBLIC_SOURCE_NAT_IP=${PUBLIC_SOURCE_NAT_IP} \
+-e OPEN_FIREWALL=${OPEN_FIREWALL} \
+-e PUBLIC_SSH_PORT=${PUBLIC_SSH_PORT} \
+-e PRIVATE_SSH_PORT=${PRIVATE_SSH_PORT} \
+-e PUBLIC_WINRM_PORT=${PUBLIC_WINRM_PORT} \
+-e PRIVATE_WINRM_PORT=${PRIVATE_WINRM_PORT} \
+-e SSH_USER=${SSH_USER} \
+-e SSH_KEY=/work/${SSH_KEY} \
+-e WINDOWS_USER=${WINDOWS_USER} \
+-e LINUX_TEMPLATE_NAME=${LINUX_TEMPLATE_NAME} \
+-e WINDOWS_TEMPLATE_NAME=${WINDOWS_TEMPLATE_NAME} \
+-e SOURCE_CIDR=${SOURCE_CIDR} \
+-e TRUSTED_NETWORKS=${TRUSTED_NETWORKS} \
+-e KITCHEN_LOCAL_YAML=${KITCHEN_LOCAL_YAML} \
+-e DISK_OFFERING_NAME=${DISK_OFFERING_NAME} \
+-e EXPUNGE_ON_DESTROY=${EXPUNGE_ON_DESTROY} \
+-ti --rm  -v $(pwd):/work missioncriticalcloud/vagrant-cloudstack /bin/bash

data/Gemfile

@@ -1,20 +1,20 @@
-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: 'git://github.com/mitchellh/vagrant.git', tag: 'v1.8.1'
-  gem 'coveralls', require: false
-  gem 'simplecov', require: false
-  gem 'rspec-core'
-  gem 'rspec-expectations'
-  gem 'rspec-its'
-  gem 'rspec-mocks'
-end
-
-group :plugins do
-  gem 'vagrant-cloudstack', path: '.'
-end
+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: 'git://github.com/mitchellh/vagrant.git', tag: 'v1.8.1'
+  gem 'coveralls', require: false
+  gem 'simplecov', require: false
+  gem 'rspec-core'
+  gem 'rspec-expectations'
+  gem 'rspec-its'
+  gem 'rspec-mocks'
+end
+
+group :plugins do
+  gem 'vagrant-cloudstack', path: '.'
+end

data/LICENSE

@@ -1,8 +1,8 @@
-The MIT License (MIT)
-Copyright (c) 2013 Mitchell Hashimoto
-
-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.
+The MIT License (MIT)
+Copyright (c) 2013 Mitchell Hashimoto
+
+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

@@ -1,416 +1,416 @@
-# Vagrant Cloudstack Provider
-
-[![Build Status](https://travis-ci.org/schubergphilis/vagrant-cloudstack.png?branch=master)](https://travis-ci.org/schubergphilis/vagrant-cloudstack)
-[![Gem Version](https://badge.fury.io/rb/vagrant-cloudstack.png)](http://badge.fury.io/rb/vagrant-cloudstack)
-[![Code climate](https://codeclimate.com/github/schubergphilis/vagrant-cloudstack.png)](https://codeclimate.com/github/schubergphilis/vagrant-cloudstack)
-[![Coverage Status](https://coveralls.io/repos/schubergphilis/vagrant-cloudstack/badge.svg?branch=master)](https://coveralls.io/r/schubergphilis/vagrant-cloudstack?branch=master)
-[![Gem Version](https://badge.fury.io/rb/vagrant-cloudstack.svg)](http://badge.fury.io/rb/vagrant-cloudstack)
-
-This is a fork of [mitchellh AWS Provider](https://github.com/mitchellh/vagrant-aws/).
-
-This is a [Vagrant](http://www.vagrantup.com) 1.5+ plugin that adds a [Cloudstack](http://cloudstack.apache.org)
-provider to Vagrant.
-
-## Features
-
-* SSH into the instances.
-* Provision the instances with any built-in Vagrant provisioner.
-* Minimal synced folder support via `rsync`/`winrm`.
-
-## Usage
-
-Install using standard Vagrant 1.1+ plugin installation methods. After
-installing, `vagrant up` and specify the `cloudstack` provider. An example is
-shown below.
-
-```
-$ vagrant plugin install vagrant-cloudstack
-...
-$ vagrant up --provider=cloudstack
-...
-```
-
-Of course prior to doing this, you'll need to obtain an Cloudstack-compatible
-box file for Vagrant.
-
-## Quick Start
-
-After installing the plugin (instructions above), the quickest way to get
-started is to actually make a Vagrantfile that looks like the following, filling in
-your information where necessary.
-
-```
-Vagrant.configure("2") do |config|
-  config.vm.box = "${cloudstack.template_name}"
-
-  config.vm.provider :cloudstack do |cloudstack, override|
-    cloudstack.host = "cloudstack.local"
-    cloudstack.path = "/client/api"
-    cloudstack.port = "8080"
-    cloudstack.scheme = "http"
-    cloudstack.api_key = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.secret_key = "AAAAAAAAAAAAAAAAAAA"
-
-    cloudstack.service_offering_id = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.disk_offering_id = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.network_id = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.zone_id = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.project_id = "AAAAAAAAAAAAAAAAAAA"
-  end
-end
-```
-
-Or with names instead of ids:
-
-```
-Vagrant.configure("2") do |config|
-  config.vm.box = "${cloudstack.template_name}"
-
-  config.vm.provider :cloudstack do |cloudstack, override|
-    cloudstack.host = "cloudstack.local"
-    cloudstack.path = "/client/api"
-    cloudstack.port = "8080"
-    cloudstack.scheme = "http"
-    cloudstack.api_key = "AAAAAAAAAAAAAAAAAAA"
-    cloudstack.secret_key = "AAAAAAAAAAAAAAAAAAA"
-
-    cloudstack.service_offering_name = "THE-BESTEST"
-    cloudstack.disk_offering_name = "THE-LARGEST-OFFER-AVAILABLE"
-    cloudstack.network_name = "WOW-SUCH-FAST-OFFERING"
-    cloudstack.zone_name = "District-9"
-    cloudstack.name = "doge-is-a-hostname-now"
-    # Sadly there is currently no support for the project api in fog.
-    cloudstack.project_id = "AAAAAAAAAAAAAAAAAAA"
-  end
-end
-```
-
-
-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.
-
-And then run `vagrant up --provider=cloudstack`.
-
-This will start an instance in Cloudstack. And assuming your template
-on Cloudstack is Vagrant compatible _(vagrant user with official
-vagrant pub key in authorized_keys)_ SSH and provisioning will work as
-well.
-
-## Box Format
-
-Every provider in Vagrant must introduce a custom box format. This
-provider introduces `cloudstack` boxes. You can view an example box in
-the [example_box/ directory](https://github.com/schubergphilis/vagrant-cloudstack/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. Most of the settings
-have both an id and a name setting and you can chose to use either (i.e network_id or network_name).
-This gives the possibility to use the easier to remember name instead of the UUID,
-this will also enable you to upgrade the different settings in your cloud without having
-to update UUIDs in your Vagrantfile. If both are specified, the id parameter takes precedence.
-
-* `name` - Hostname of the created machine
-* `host` - Cloudstack api host
-* `path` - Cloudstack api path
-* `port` - Cloudstack api port
-* `scheme` - Cloudstack api scheme _(defaults: https (thanks to the resolution order in fog))_
-* `api_key` - The api key for accessing Cloudstack
-* `secret_key` - The secret key for accessing Cloudstack
-* `instance_ready_timeout` - The number of seconds to wait for the instance
-  to become "ready" in Cloudstack. Defaults to 120 seconds.
-* `domain_id` - Domain id to launch the instance into
-* `network_id` - Network uuid that the instance should use
-* `network_name` - Network name that the instance should use
-* `project_id` - Project uuid that the instance should belong to
-* `service_offering_id`- Service offering uuid to use for the instance
-* `service_offering_name`- Service offering name to use for the instance
-* `template_id` - Template uuid to use for the instance
-* `template_name` - Template name to use for the instance, defaults to Vagrants config.vm.box
-* `zone_id` - Zone uuid to launch the instance into
-* `zone_name` - Zone uuid to launch the instance into
-* `keypair` - SSH keypair name, if neither'keypair' nor 'ssh_key' have been specified, a temporary keypair will be created
-* `static_nat` - static nat for the virtual machine
-* `pf_ip_address_id` - IP address ID for port forwarding rule
-* `pf_ip_address` - IP address for port forwarding rule
-* `pf_public_port` - Public Communicator port for port forwarding rule
-* `pf_public_rdp_port` - Public RDP port for port forwarding rule
-* `pf_public_port_randomrange` - If public port is omited, a port from this range wll be used (default `{:start=>49152, :end=>65535}`)
-* `pf_private_port` - Private port for port forwarding rule (defaults to respective Communicator protocol)
-* `pf_open_firewall` - Flag to enable/disable automatic open firewall rule (by CloudStack)
-* `pf_trusted_networks` - Array of CIDRs or (array of) comma-separated string of CIDRs to network(s) to 
-  - automatically (by plugin) generate firewall rules for, ignored if `pf_open_firewall` set `true`
-  - use as default for firewall rules where source CIDR is missing
-* `port_forwarding_rules` - Port forwarding rules for the virtual machine
-* `firewall_rules` - Firewall rules
-* `display_name` - Display name for the instance
-* `group` - Group for the instance
-* `ssh_key` - Path to a private key to be used with ssh _(defaults to Vagrant's `config.ssh.private_key_path`)_
-* `ssh_user` - User name to be used with ssh _(defaults to Vagrant's `config.ssh.username`)_
-* `vm_user` - User name to be used with winrm _(defaults to Vagrant's `config.winrm.username`)_
-* `vm_password` - Password to be used with winrm. _(If the CloudStack template is "Password Enabled", leaving this unset will trigger the plugin to retrieve and use it.)_
-* `private_ip_address` - private (static)ip address to be used by the virtual machine
-* `expunge_on_destroy` - Flag to enable/disable expunge vm on destroy
-
-These can be set like typical provider-specific configuration:
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.api_key = "foo"
-    cloudstack.secret_key = "bar"
-  end
-end
-```
-
-In addition to the above top-level configs, you can use the `region_config`
-method to specify region-specific overrides within your Vagrantfile. Note
-that the top-level `region` config must always be specified to choose which
-region you want to actually use, however. This looks like this:
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.api_key = "foo"
-    cloudstack.secret_key = "bar"
-    cloudstack.domain = "internal"
-
-    # Simple domain config
-    cloudstack.domain_config "internal", :network_id => "AAAAAAAAAAAAAAAAAAA"
-
-    # More comprehensive region config
-    cloudstack.domain_config "internal" do |domain|
-      domain.network_id = "AAAAAAAAAAAAAAAAAAA"
-      domain.service_offering_id = "AAAAAAAAAAAAAAAAAAA"
-    end
-  end
-end
-```
-
-The domain-specific configurations will override the top-level
-configurations when that domain is used. They otherwise inherit
-the top-level configurations, as you would probably expect.
-
-## Networks
-
-Networking features in the form of `config.vm.network` are not
-supported with `vagrant-cloudstack`, currently. If any of these are
-specified, Vagrant will emit a warning, but will otherwise boot
-the Cloudstack machine.
-
-### Basic networking versus Advanced networking
-
-The plugin will determine this network type dynamically from the zone.
-The setting `network_type` in the Vagrant file has been deprecated,
-and is silently ignored.
-
-### Basic Networking
-
-If the network type of your zone is `basic`, you can use Security
-Groups and associate rules in your Vagrantfile.
-
-If you already have Security Groups, you can associate them to your
-instance, with their IDs:
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.api_key = "foo"
-    cloudstack.secret_key = "bar"
-    cloudstack.security_group_ids = ['aaaa-bbbb-cccc-dddd', '1111-2222-3333-4444']
-  end
-end
-```
-
-or their names:
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.api_key = "foo"
-    cloudstack.secret_key = "bar"
-    cloudstack.security_group_names = ['
-min_fantastiska_security_group', 'another_security_grupp']
-  end
-end
-```
-
-But you can also create your Security Groups in the Vagrantfile:
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.api_key = "foo"
-    cloudstack.secret_key = "bar"
-    cloudstack.security_groups = [
-      {
-        :name         => "Awesome_security_group",
-        :description  => "Created from the Vagrantfile",
-          :rules => [
-        {:type => "ingress", :protocol => "TCP", :startport => 22, :endport => 22, :cidrlist => "0.0.0.0/0"},
-        {:type => "ingress", :protocol => "TCP", :startport => 80, :endport => 80, :cidrlist => "0.0.0.0/0"},
-        {:type => "egress",  :protocol => "TCP", :startport => 81, :endport => 82, :cidrlist => "1.2.3.4/24"},
-    ]
-      }
-    ]
-  end
-end
-```
-
-### Static NAT, Firewall, Port forwarding
-
-You can create your static nat, firewall and port forwarding rules in the Vagrantfile.
-You can use this rule to access virtual machine from an external machine.
-
-The rules created in Vagrantfile are removed when the virtual machine is destroyed.
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-
-    override.ssh.host = "X.X.X.X"
-
-    cloudstack.static_nat = [
-      { :ipaddress => "A.A.A.A"}
-    ]
-
-    cloudstack.port_forwarding_rules = [
-      { :ipaddress => "X.X.X.X", :protocol => "tcp", :publicport => 22, :privateport  => 22, :openfirewall => false },
-      { :ipaddress => "X.X.X.X", :protocol => "tcp", :publicport => 80, :privateport  => 80, :openfirewall => false }
-    ]
-
-    cloudstack.firewall_rules = [
-      { :ipaddress => "A.A.A.A", :cidrlist  => "1.2.3.4/24", :protocol => "icmp", :icmptype => 8, :icmpcode => 0 },
-      { :ipaddress => "X.X.X.X", :cidrlist  => "1.2.3.4/24", :protocol => "tcp", :startport => 22, :endport => 22 },
-      { :ipaddress => "X.X.X.X", :cidrlist  => "1.2.3.4/24", :protocol => "tcp", :startport => 80, :endport => 80 }
-    ]
-
-  end
-end
-```
-Most values in the firewall and portforwarding rules are not mandatory, except either startport/endport or privateport/publicport
-* `:ipaddress` - defaults to `pf_ip_address`
-* `:protocol` - defaults to `'tcp'`
-* `:publicport` - defaults to `:privateport`
-* `:privateport` - defaults to `:publicport`
-* `:openfirewall` - defaults to `pf_open_firewall`
-* `:cidrlist` - defaults to `pf_trusted_networks`
-* `:startport` - defaults to `:endport`
-* `:endport` - not required by CloudStack
-
-
-For only allowing Vagrant to access the box for further provisioning (SSH/WinRM), and opening the Firewall for some subnets, the following config is sufficient:
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    cloudstack.pf_open_firewall      = "false"
-    cloudstack.pf_ip_address         = X.X.X.X
-    cloudstack.pf_trusted_networks   = [ "1.2.3.4/24" , "11.22.33.44/32" ]
-  end
-end
-```
-Where X.X.X.X is the ip of the respective CloudStack network, this will automatically map the port of the used Communicator (SSH/Winrm) via a random public port, open the Firewall and set Vagrant to use it.
-
-The plugin can also automatically generate firewall rules off of the portforwarding  rules:
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-
-    cloudstack.pf_trusted_networks   = "1.2.3.4/24,11.22.33.44/32"
-    cloudstack.port_forwarding_rules = [
-      { :privateport  => 22, :generate_firewall => true },
-      { :privateport  => 80, :generate_firewall => true }
-    ]
-
-  end
-end
-```
-
-## Synced Folders
-
-There is minimal support for synced folders. Upon `vagrant up`, `vagrant reload`, and `vagrant provision`, the Cloudstack provider will use `rsync` (if available) to uni-directionally sync the folder to the remote machine over SSH, and use Vagrant plugin `vagrant-winrm-syncedfolders` (if available) to uni-directionally sync the folder to the remote machine over WinRM.
-
-This is good enough for all built-in Vagrant provisioners (shell,
-chef, and puppet) to work!
-
-### User data
-
-You can specify user data for the instance being booted.
-
-```ruby
-Vagrant.configure("2") do |config|
-  # ... other stuff
-
-  config.vm.provider :cloudstack do |cloudstack|
-    # Option 1: a single string
-    cloudstack.user_data = "#!/bin/bash\necho 'got user data' > /tmp/user_data.log\necho"
-
-    # Option 2: use a file
-    cloudstack.user_data = File.read("user_data.txt")
-  end
-end
-```
-
-The maximum length of user_data is around 1500 bytes with Cloudstack API < 4.2 ( base64 encoded user_data must be < 2048 bytes)
-
-## Development
-
-To work on the `vagrant-cloudstack` 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 the unit-tests pass, verify the plugin is functionaly good by running the functional tests with bats.
-Before running the tests you need to export a set of variables that are used in the tests. Look at the
-Rake file for the required variables, or run the following Rake command to check:
-```
-bundle exec rake functional_tests:check_environment
-```
-
-Run all functional tests by executing:
-```
-bundle exec rake functional_tests:all
-```
-
-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)
-and add the following line to your `Vagrantfile`
-```ruby
-Vagrant.require_plugin "vagrant-cloudstack"
-```
-Use bundler to execute Vagrant:
-
-```
-$ bundle exec vagrant up --provider=cloudstack
-```
+# Vagrant Cloudstack Provider
+
+[![Build Status](https://travis-ci.org/MissionCriticalCloud/vagrant-cloudstack.png?branch=master)](https://travis-ci.org/missioncriticalcloud/vagrant-cloudstack)
+[![Gem Version](https://badge.fury.io/rb/vagrant-cloudstack.png)](http://badge.fury.io/rb/vagrant-cloudstack)
+[![Code climate](https://codeclimate.com/github/MissionCriticalCloud/vagrant-cloudstack.png)](https://codeclimate.com/github/missioncriticalcloud/vagrant-cloudstack)
+[![Coverage Status](https://coveralls.io/repos/github/MissionCriticalCloud/vagrant-cloudstack/badge.svg?branch=master)](https://coveralls.io/github/MissionCriticalCloud/vagrant-cloudstack?branch=master)
+[![Gem Version](https://badge.fury.io/rb/vagrant-cloudstack.svg)](http://badge.fury.io/rb/vagrant-cloudstack)
+
+This is a fork of [mitchellh AWS Provider](https://github.com/mitchellh/vagrant-aws/).
+
+This is a [Vagrant](http://www.vagrantup.com) 1.5+ plugin that adds a [Cloudstack](http://cloudstack.apache.org)
+provider to Vagrant for use with either [Cosmic](https://github.com/MissionCriticalCloud/cosmic) or [Cloudstack](http://cloudstack.apache.org).
+
+## Features
+
+* SSH into the instances.
+* Provision the instances with any built-in Vagrant provisioner.
+* Minimal synced folder support via `rsync`/`winrm`.
+
+## Usage
+
+Install using standard Vagrant 1.1+ plugin installation methods. After
+installing, `vagrant up` and specify the `cloudstack` provider. An example is
+shown below.
+
+```
+$ vagrant plugin install vagrant-cloudstack
+...
+$ vagrant up --provider=cloudstack
+...
+```
+
+## Quick Start
+
+After installing the plugin (instructions above), the quickest way to get
+started is to actually make a Vagrantfile that looks like the following, filling in
+your information where necessary.
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "${cloudstack.template_name}"
+
+  config.vm.provider :cloudstack do |cloudstack, override|
+    cloudstack.host = "cloudstack.local"
+    cloudstack.path = "/client/api"
+    cloudstack.port = "8080"
+    cloudstack.scheme = "http"
+    cloudstack.api_key = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.secret_key = "AAAAAAAAAAAAAAAAAAA"
+
+    cloudstack.service_offering_id = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.disk_offering_id = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.network_id = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.zone_id = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.project_id = "AAAAAAAAAAAAAAAAAAA"
+  end
+end
+```
+
+Or with names instead of ids:
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "${cloudstack.template_name}"
+
+  config.vm.provider :cloudstack do |cloudstack, override|
+    cloudstack.host = "cloudstack.local"
+    cloudstack.path = "/client/api"
+    cloudstack.port = "8080"
+    cloudstack.scheme = "http"
+    cloudstack.api_key = "AAAAAAAAAAAAAAAAAAA"
+    cloudstack.secret_key = "AAAAAAAAAAAAAAAAAAA"
+
+    cloudstack.service_offering_name = "THE-BESTEST"
+    cloudstack.disk_offering_name = "THE-LARGEST-OFFER-AVAILABLE"
+    cloudstack.network_name = "WOW-SUCH-FAST-OFFERING"
+    cloudstack.zone_name = "District-9"
+    cloudstack.name = "doge-is-a-hostname-now"
+    # Sadly there is currently no support for the project api in fog.
+    cloudstack.project_id = "AAAAAAAAAAAAAAAAAAA"
+  end
+end
+```
+
+And then run `vagrant up --provider=cloudstack`.
+
+This will start an instance in Cloudstack. And assuming your template
+on Cloudstack is Vagrant compatible _(vagrant user with official
+vagrant pub key in authorized_keys)_ SSH and provisioning will work as
+well.
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options. Most of the settings
+have both an id and a name setting and you can chose to use either (i.e network_id or network_name).
+This gives the possibility to use the easier to remember name instead of the UUID,
+this will also enable you to upgrade the different settings in your cloud without having
+to update UUIDs in your Vagrantfile. If both are specified, the id parameter takes precedence.
+
+* `name` - Hostname of the created machine
+* `host` - Cloudstack api host
+* `path` - Cloudstack api path
+* `port` - Cloudstack api port
+* `scheme` - Cloudstack api scheme _(defaults: https (thanks to the resolution order in fog))_
+* `api_key` - The api key for accessing Cloudstack
+* `secret_key` - The secret key for accessing Cloudstack
+* `instance_ready_timeout` - The number of seconds to wait for the instance
+  to become "ready" in Cloudstack. Defaults to 120 seconds.
+* `domain_id` - Domain id to launch the instance into
+* `network_id` - Network uuid(s) that the instance should use
+  - `network_id` is single value (e.g. `"AAAA"`) or multiple values (e.g. `["AAAA", "BBBB"]`)
+* `network_name` - Network name(s) that the instance should use
+  - `network_name` is single value (e.g. `"AAAA"`) or multiple values (e.g. `["AAAA", "BBBB"]`)
+* `project_id` - Project uuid that the instance should belong to
+* `service_offering_id`- Service offering uuid to use for the instance
+* `service_offering_name`- Service offering name to use for the instance
+* `template_id` - Template uuid to use for the instance
+* `template_name` - Template name to use for the instance, defaults to Vagrants config.vm.box
+* `zone_id` - Zone uuid to launch the instance into
+* `zone_name` - Zone uuid to launch the instance into
+* `keypair` - SSH keypair name, if neither'keypair' nor 'ssh_key' have been specified, a temporary keypair will be created
+* `static_nat` - static nat for the virtual machine
+* `pf_ip_address_id` - IP address ID for port forwarding rule
+* `pf_ip_address` - IP address for port forwarding rule
+* `pf_public_port` - Public Communicator port for port forwarding rule
+* `pf_public_rdp_port` - Public RDP port for port forwarding rule
+* `pf_public_port_randomrange` - If public port is omited, a port from this range wll be used (default `{:start=>49152, :end=>65535}`)
+* `pf_private_port` - Private port for port forwarding rule (defaults to respective Communicator protocol)
+* `pf_open_firewall` - Flag to enable/disable automatic open firewall rule (by CloudStack)
+* `pf_trusted_networks` - Array of CIDRs or (array of) comma-separated string of CIDRs to network(s) to 
+  - automatically (by plugin) generate firewall rules for, ignored if `pf_open_firewall` set `true`
+  - use as default for firewall rules where source CIDR is missing
+* `port_forwarding_rules` - Port forwarding rules for the virtual machine
+* `firewall_rules` - Firewall rules
+* `display_name` - Display name for the instance
+* `group` - Group for the instance
+* `ssh_key` - Path to a private key to be used with ssh _(defaults to Vagrant's `config.ssh.private_key_path`)_
+* `ssh_user` - User name to be used with ssh _(defaults to Vagrant's `config.ssh.username`)_
+* `ssh_network_id` - The network_id to be used when loging in to the vm via ssh _(defaults to first nic)_
+* `ssh_network_name` - The network_name to be used when loging in to the vm via ssh _(defaults to first nic)_
+  - Use either `ssh_network_id` or `ssh_network_name`. If specified both , use `ssh_network_id`
+* `vm_user` - User name to be used with winrm _(defaults to Vagrant's `config.winrm.username`)_
+* `vm_password` - Password to be used with winrm. _(If the CloudStack template is "Password Enabled", leaving this unset will trigger the plugin to retrieve and use it.)_
+* `private_ip_address` - private (static)ip address to be used by the virtual machine
+* `expunge_on_destroy` - Flag to enable/disable expunge vm on destroy
+
+These can be set like typical provider-specific configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.api_key = "foo"
+    cloudstack.secret_key = "bar"
+  end
+end
+```
+
+In addition to the above top-level configs, you can use the `region_config`
+method to specify region-specific overrides within your Vagrantfile. Note
+that the top-level `region` config must always be specified to choose which
+region you want to actually use, however. This looks like this:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.api_key = "foo"
+    cloudstack.secret_key = "bar"
+    cloudstack.domain = "internal"
+
+    # Simple domain config
+    cloudstack.domain_config "internal", :network_id => "AAAAAAAAAAAAAAAAAAA"
+
+    # More comprehensive region config
+    cloudstack.domain_config "internal" do |domain|
+      domain.network_id = "AAAAAAAAAAAAAAAAAAA"
+      domain.service_offering_id = "AAAAAAAAAAAAAAAAAAA"
+    end
+  end
+end
+```
+
+The domain-specific configurations will override the top-level
+configurations when that domain is used. They otherwise inherit
+the top-level configurations, as you would probably expect.
+
+## Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-cloudstack`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the Cloudstack machine.
+
+### Basic networking versus Advanced networking
+
+The plugin will determine this network type dynamically from the zone.
+The setting `network_type` in the Vagrant file has been deprecated,
+and is silently ignored.
+
+### Basic Networking
+
+If the network type of your zone is `basic`, you can use Security
+Groups and associate rules in your Vagrantfile.
+
+If you already have Security Groups, you can associate them to your
+instance, with their IDs:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.api_key = "foo"
+    cloudstack.secret_key = "bar"
+    cloudstack.security_group_ids = ['aaaa-bbbb-cccc-dddd', '1111-2222-3333-4444']
+  end
+end
+```
+
+or their names:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.api_key = "foo"
+    cloudstack.secret_key = "bar"
+    cloudstack.security_group_names = ['
+min_fantastiska_security_group', 'another_security_grupp']
+  end
+end
+```
+
+But you can also create your Security Groups in the Vagrantfile:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.api_key = "foo"
+    cloudstack.secret_key = "bar"
+    cloudstack.security_groups = [
+      {
+        :name         => "Awesome_security_group",
+        :description  => "Created from the Vagrantfile",
+          :rules => [
+        {:type => "ingress", :protocol => "TCP", :startport => 22, :endport => 22, :cidrlist => "0.0.0.0/0"},
+        {:type => "ingress", :protocol => "TCP", :startport => 80, :endport => 80, :cidrlist => "0.0.0.0/0"},
+        {:type => "egress",  :protocol => "TCP", :startport => 81, :endport => 82, :cidrlist => "1.2.3.4/24"},
+    ]
+      }
+    ]
+  end
+end
+```
+
+### Static NAT, Firewall, Port forwarding
+
+You can create your static nat, firewall and port forwarding rules in the Vagrantfile.
+You can use this rule to access virtual machine from an external machine.
+
+The rules created in Vagrantfile are removed when the virtual machine is destroyed.
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+
+    override.ssh.host = "X.X.X.X"
+
+    cloudstack.static_nat = [
+      { :ipaddress => "A.A.A.A"}
+    ]
+
+    cloudstack.port_forwarding_rules = [
+      { :ipaddress => "X.X.X.X", :protocol => "tcp", :publicport => 22, :privateport  => 22, :openfirewall => false },
+      { :ipaddress => "X.X.X.X", :protocol => "tcp", :publicport => 80, :privateport  => 80, :openfirewall => false }
+    ]
+
+    cloudstack.firewall_rules = [
+      { :ipaddress => "A.A.A.A", :cidrlist  => "1.2.3.4/24", :protocol => "icmp", :icmptype => 8, :icmpcode => 0 },
+      { :ipaddress => "X.X.X.X", :cidrlist  => "1.2.3.4/24", :protocol => "tcp", :startport => 22, :endport => 22 },
+      { :ipaddress => "X.X.X.X", :cidrlist  => "1.2.3.4/24", :protocol => "tcp", :startport => 80, :endport => 80 }
+    ]
+
+  end
+end
+```
+Most values in the firewall and portforwarding rules are not mandatory, except either startport/endport or privateport/publicport
+* `:ipaddress` - defaults to `pf_ip_address`
+* `:protocol` - defaults to `'tcp'`
+* `:publicport` - defaults to `:privateport`
+* `:privateport` - defaults to `:publicport`
+* `:openfirewall` - defaults to `pf_open_firewall`
+* `:cidrlist` - defaults to `pf_trusted_networks`
+* `:startport` - defaults to `:endport`
+* `:endport` - not required by CloudStack
+
+
+For only allowing Vagrant to access the box for further provisioning (SSH/WinRM), and opening the Firewall for some subnets, the following config is sufficient:
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    cloudstack.pf_open_firewall      = "false"
+    cloudstack.pf_ip_address         = X.X.X.X
+    cloudstack.pf_trusted_networks   = [ "1.2.3.4/24" , "11.22.33.44/32" ]
+  end
+end
+```
+Where X.X.X.X is the ip of the respective CloudStack network, this will automatically map the port of the used Communicator (SSH/Winrm) via a random public port, open the Firewall and set Vagrant to use it.
+
+The plugin can also automatically generate firewall rules off of the portforwarding rules:
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+
+    cloudstack.pf_trusted_networks   = "1.2.3.4/24,11.22.33.44/32"
+    cloudstack.port_forwarding_rules = [
+      { :privateport  => 22, :generate_firewall => true },
+      { :privateport  => 80, :generate_firewall => true }
+    ]
+
+  end
+end
+```
+
+### Virtual Router versus VPC
+Both Virtual Routers and VPCs are supported when using port-forwarding and firewall. This is automatically determined by the specific `pf_ip_address`.
+
+Note that there are architectural differences in CloudStack which the configuration must adhere to.
+
+For VPC:
+* `pf_open_firewall` will be ignored as global setting and (specifically) in `port_forwarding_rules`
+* for `firewall_rules` to open access for `port_forwarding_rules`, the firewall rule should allow traffic for the `:privateport` port.
+
+For Virtual Router:
+* for `firewall_rules` to open access for `port_forwarding_rules`, the firewall rule should allow traffic for the `:publicport` port.
+
+Usage of other attributes and features work with both network types. Such as `:generate_firewall` for portforwarding rules, or `pf_trusted_networks` to automatically generate rules for the Communicator.
+
+## Synced Folders
+
+There is minimal support for synced folders. Upon `vagrant up`, `vagrant reload`, and `vagrant provision`, the Cloudstack provider will use `rsync` (if available) to uni-directionally sync the folder to the remote machine over SSH, and use Vagrant plugin `vagrant-winrm-syncedfolders` (if available) to uni-directionally sync the folder to the remote machine over WinRM.
+
+This is good enough for all built-in Vagrant provisioners (shell,
+chef, and puppet) to work!
+
+### User data
+
+You can specify user data for the instance being booted.
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :cloudstack do |cloudstack|
+    # Option 1: a single string
+    cloudstack.user_data = "#!/bin/bash\necho 'got user data' > /tmp/user_data.log\necho"
+
+    # Option 2: use a file
+    cloudstack.user_data = File.read("user_data.txt")
+  end
+end
+```
+
+The maximum length of user_data is around 1500 bytes with Cloudstack API < 4.2 (base64 encoded user_data must be < 2048 bytes)
+
+## Development
+
+To work on the `vagrant-cloudstack` 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 the unit-tests pass, verify the plugin is functionaly good by running the functional tests with bats.
+Before running the tests you need to export a set of variables that are used in the tests. Look at the
+Rake file for the required variables, or run the following Rake command to check:
+```
+bundle exec rake functional_tests:check_environment
+```
+
+Run all functional tests by executing:
+```
+bundle exec rake functional_tests:all
+```
+
+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)
+and add the following line to your `Vagrantfile`
+```ruby
+Vagrant.require_plugin "vagrant-cloudstack"
+```
+Use bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up --provider=cloudstack
+```