vagrant-profitbricks 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3f000a1380a564fccefc12c251179b1095a4e16
+  data.tar.gz: e71772e76b43e0ff3438f51bb47067808e94d467
+SHA512:
+  metadata.gz: b05fd364f07481880b0fabb81e7ba654460de4077579e2b2d531746b3d207e8843b7752e13dee5a791d4815a703870937f6d7cb601aa160513ab7e97119b7f81
+  data.tar.gz: 3d6e241542522813a2f2213959804e381dd178c61d30d06c6585d8de7dcec9deac942f2e0aa3742e05e726b8ba70e8b925bf6b36d741c383d344176813a2273c

data/.gitignore

@@ -0,0 +1,25 @@
+.idea/
+.vagrant
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.dat*
+.repl_history
+build/
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+Gemfile.lock
+gemfiles/*.lock
+.rvmrc

data/Appraisals

@@ -0,0 +1,35 @@
+# Note: You may need to use bundler 1.5.2 to run `appraisal install`
+appraise "vagrant-1.7" do
+  group :plugins do
+    gem 'bundler', '>= 1.5.2', '< 1.8.0'
+    gem "vagrant", :git => 'https://github.com/mitchellh/vagrant', :tag => 'v1.7.1'
+  end
+end
+
+appraise "vagrant-1.6" do
+  gem 'bundler', '>= 1.5.2', '< 1.7.0'
+  group :plugins do
+    gem "vagrant", :git => 'https://github.com/mitchellh/vagrant', :tag => 'v1.6.5'
+  end
+end
+
+appraise "vagrant-1.5" do
+  gem 'bundler', '= 1.5.2'
+  group :plugins do
+    gem "vagrant", :git => 'https://github.com/mitchellh/vagrant', :tag => 'v1.5.4'
+  end
+end
+
+# Oldest supported
+appraise "vagrant-1.5.0" do
+  gem 'bundler', '= 1.5.2'
+  group :plugins do
+    gem "vagrant", :git => 'https://github.com/mitchellh/vagrant', :tag => 'v1.5.4'
+  end
+end
+
+appraise "windows-wip" do
+  group :plugins do
+    gem "vagrant", :git => 'https://github.com/maxlinc/vagrant', :branch => 'winrm-1.3'
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (Month Day, Year)
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+# This group will not be installed on Travis
+group :development do
+  gem 'pry'
+  # My branch contains a fix for https://github.com/thoughtbot/appraisal/issues/76
+  gem 'appraisal', '~> 1.0', git: 'http://github.com/malibeg/appraisal', branch: 'gemspec_in_group'
+end
+
+group :test do
+  gem 'coveralls', require: false
+end
+
+group :plugins do
+  gem "vagrant", git: "http://github.com/mitchellh/vagrant.git", :branch => 'master'
+  gemspec
+end
+

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2015 ProfitBricks GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,268 @@
+# WIP: Vagrant ProfitBricks Cloud Provider
+
+This is a [Vagrant](http://www.vagrantup.com) 1.5+ plugin that adds a
+[ProfitBricks](https://devops.profitbricks.com) provider to Vagrant,
+allowing Vagrant to control and provision machines within the ProfitBricks
+cloud.
+
+**Note:** This plugin requires Vagrant 1.5+.
+
+## Features
+
+* Boot ProfitBricks instances.
+* SSH into the instances.
+* COMING SOON: Provision the instances with any built-in Vagrant provisioner.
+* Sync folders with any built-in Vagrant synchronized folder plugin (e.g. `rsync`)
+* Create ProfitBricks images from a running Vagrant box
+
+## Installation
+
+Install using the standard Vagrant plugin installation methods.
+
+```
+$ vagrant plugin install vagrant-profitbricks
+```
+
+## Usage
+
+Once the plugin is installed, you use it with `vagrant up` by specifying
+the `profitbricks` provider:
+```
+$ vagrant up --provider=profitbricks
+```
+
+You'll need a Vagrantfile in order to properly create/configure remote servers. You can generate a sample
+Vagrantfile with `vagrant init`. Here's an example with ProfitBricks configuration:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # The box is optional in newer versions of Vagrant
+  # config.vm.box = "dummy"
+
+  config.vm.provider :profitbricks do |rs|
+    rs.username = "YOUR PB USERNAME"
+    rs.password  = "YOUR PB PASSWORD"
+    rs.flavor   = /Small/
+    rs.image    = /Ubuntu/
+    rs.datacenter_id = /DC_Ge/
+    rs.profitbricks_volume_size = 20
+  end
+end
+```
+
+You may be required to use a box, depending on your version of Vagrant. If necessary you can
+add the "dummy" box with the command:
+```
+$ vagrant box add dummy https://github.com/profitbricks/vagrant-profitbricks/raw/master/dummy.box
+```
+Then uncomment the line containing `config.vm.box = "dummy"`.
+
+
+Once the server is created a confirmation email is received with your credentials. Also, the password can be set inside the config section with the option admin_password. In both cases it is required that you change
+the password upon first logon. After server creation the user can login with:
+
+```
+$ vagrant ssh
+```
+
+Once the password is changed it is posible to provision synced_folders with
+```
+$ vagrant provision
+```
+
+
+
+### CentOS / RHEL / Fedora
+
+The default configuration of the RHEL family of Linux distributions requires a tty in order to run sudo. Vagrant does not connect with a tty by default, so you may experience the error:
+> sudo: sorry, you must have a tty to run sudo
+
+You can tell Vagrant it should use a pseudo-terminal (pty) to get around this issue with the option:
+```ruby
+  config.ssh.pty = true
+```
+
+However, Vagrant does not always work well with the pty. In particular, rsync may not work. So we recommend
+using this configuration for a workaround which will reconfigure the server so a tty is not required to run sudo:
+
+The following settings show an example of how you can workaround the issue:
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.ssh.pty = true
+
+  config.vm.provider :profitbricks do |rs|
+    rs.username = "YOUR USERNAME"
+    rs.password = "YOUR PASSWORD"
+    rs.profitbricks_ram = 1024
+    rs.profitbricks_cores = 1
+    rs.image    = /^CentOS-7/
+    rs.datacenter_id = /DC_US/
+  end
+end
+```
+
+### Windows
+
+Windows servers can be created with this provider; however, Profitbricks images do not have the WinRM service started or an SSH server pre-installed. To take full advantage of Vagrant, you need to enable WinRM to use the `vagrant rdp` command to launch Remote Desktop. You can consult the vagrant documentation on how to enable WinRM on created server
+[WINRM CONFIGURATION](http://docs.vagrantup.com/v2/boxes/base.html)
+
+
+The following settings show how to setup box to enable RDP:
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "dummy"
+  config.vm.communicator = "winrm"
+  config.vm.provider :profitbricks do |rs|
+    rs.username = "YOUR USERNAME"
+    rs.password = "YOUR PASSWORD"
+    rs.flavor   = /Meduim/
+    rs.image    = /^windows-2012-r2/
+    rs.profitbricks_volume_size = 30
+    rs.datacenter_id = /DC_US/
+  end
+end
+```
+
+### Parallel, multi-machine setup
+
+You can define multiple machines in a single Vagrant file, for example:
+
+```ruby
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  # All Vagrant configuration is done here. The most common configuration
+  # options are documented and commented below. For a complete reference,
+  # please see the online documentation at vagrantup.com.
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "dummy"
+
+  config.vm.define :ubuntu do |ubuntu|
+    ubuntu.vm.provider :profitbricks do |rs|
+      rs.username = ENV['PB_USERNAME']
+      rs.admin_password = ENV['VAGRANT_ADMIN_PASSWORD']
+      rs.password  = ENV['PB_PASSWORD']
+      rs.flavor   = /Micro/
+      rs.image    = /Ubuntu/
+      rs.datacenter_id = /DC_US/
+    end
+  end
+
+  config.vm.define :centos do |centos|
+    centos.ssh.pty = true
+    centos.vm.provider :profitbricks do |rs|
+      rs.username = ENV['PB_USERNAME']
+      rs.admin_password = ENV['VAGRANT_ADMIN_PASSWORD']
+      rs.password  = ENV['PB_PASSWORD']
+      rs.flavor   = /Micro/
+      rs.image    = /^CentOS/ # Don't match OnMetal - CentOS
+      rs.datacenter_id = /DC_US/
+    end
+  end
+end
+```
+
+You than can then launch them all with `vagrant up --provider profitbricks`, or a specific server
+with `vagrant up --provider profitbricks <name>`.
+
+Vagrant will create all machines simultaneously when you have a multi-machine setup. If you want to
+create them one at a time or have any trouble, you can use the `--no-parallel` option.
+
+## Custom Commands
+
+The plugin includes several ProfitBricks-specific vagrant commands. You can get the
+list of available commands with `vagrant profitbricks -h`.
+
+### Flavors / Images
+
+You can list all available images with the command:
+
+```
+$ vagrant profitbricks images
+```
+
+```
+$ vagrant profitbricks flavors
+```
+
+If you have a multi-machine setup than this will show the images/flavors for each machine. This seems
+a bit repetitive, but since machines can be configured for different locations or even accounts they may
+have a different set of available images or flavors. You can also get the list for a specific machine by specifying its name as an argument:
+
+```
+$ vagrant profitbricks images <name>
+$ vagrant profitbricks flavors <name>
+```
+
+These commands will connect to ProfitBricks using the settings associated with the machine and query the location to get the list of available flavors, images, networks and servers.
+
+## Configuration
+
+This provider exposes quite a few provider-specific configuration options:
+
+| NAME| DESCRIPTION |
+|---|---|
+| datacenter_id | Datacenter Id or name or regular expression that matches the datacenter name. |
+| username | The username with which to access ProfitBricks. |
+| password | The API password for accessing ProfitBricks. |
+| admin_password | Root user password that will be used for first login. |
+| 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. Flavors are listed [here](#flavors). As an alternative to using flavor names, one can specify the amount of ram in MB and number of cores with `profitbricks_ram` and `profitbricks_cores`. |
+| profitbricks_volume_size | The size of the volume in GB. |
+| volume_type | Disk volume type (SSD or HDD). Will default to SSD if not specified |
+| volume_licence_type | The licence type of the volume. Options: LINUX, WINDOWS, UNKNOWN, OTHER. You will need to provide either the `image` or the `volume_licence_type` parameters. `volume_licence_type` is required, but if `image` is supplied, it is already set and cannot be changed. |
+| volume_availability_zone | The storage availability zone assigned to the volume. Valid values: AUTO, ZONE_1, ZONE_2, or ZONE_3. This only applies to HDD volumes. Leave blank or set to AUTO when provisioning SSD volumes. Will default to AUTO if not specified. |
+| 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. |
+| image_password | One-time password is set on the Image for the appropriate account. This field may only be set in creation requests. When reading, it always returns null. Password has to contain 8-50 characters. Only these characters are allowed: [abcdefghjkmnpqrstuvxABCDEFGHJKLMNPQRSTUVX23456789] |
+| volume_ssh_keys | SSH keys to allow access to the volume via SSH |
+| profitbricks_url | The compute_url to hit. This is good for custom endpoints. |
+| server_name | The name of the server within ProfitBricks Cloud. This defaults to the name of the Vagrant machine (via `config.vm.define`), but can be overridden with this. |
+| location | Specify location for datacenter if one needs to be created, default value is 'us/las' |
+| cpu_family | Sets the CPU type. "AMD_OPTERON" or "INTEL_XEON". Defaults to "AMD_OPTERON". |
+| lan_id | The LAN ID the network interface (NIC) will sit on. If the LAN ID does not exist it will be created. |
+| nat | Indicates the private IP address has outbound access to the public internet. Defaults to 'false'. |
+
+These can be set like typical provider-specific configurations:
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider :profitbricks do |rs|
+    rs.username = "profitbricks_user"
+    rs.api_key  = "profitbricks_password"
+  end
+end
+```
+
+You can find a more complete list the documentation for the [Config class](http://www.rubydoc.info/gems/vagrant-profitbricks/VagrantPlugins/ProfitBricks/Config).
+
+### Networks
+
+Networking features in the form of `config.vm.network` are not
+supported with `vagrant-profitbricks`, currently. If any of these are
+specified, Vagrant will emit a warning, but will otherwise boot
+the ProfitBricks server.
+
+## Development
+
+To work on the `vagrant-profitbricks` 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 use bundler to execute Vagrant:
+
+```
+$ bundle exec vagrant up --provider=profitbricks
+```