vagrant-oneandone 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0f816f92435f56df953f1b43412d451e0c0f2db
+  data.tar.gz: a9494b78b7a70c8893ff1582171079184aa95641
+SHA512:
+  metadata.gz: 62615f02cb118ba4bf9c0e362b9d1da1c2af3a5e1d50e2fa8ce632a26a5a91ffa7bb8842294dfc1fc55e4c791e404a269c8c1259cbede38f6790a355606f2e1e
+  data.tar.gz: e4b5275e321edcc79a234387d6572d633d0e11bedc2625ff53637410d2a0c9a788150738dde7c8b8ebb1effa6e74f820f6727bda1ac1a24716d58cc9e1d342b4

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+Gemfile.lock
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.dat*
+.repl_history
+build/
+
+# Vagrant
+.vagrant
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# RVM gemset/ruby setting
+.ruby-*
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,29 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+   Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FileName:
+  Exclude:
+    - 'lib/vagrant-oneandone.rb'
+    - 'vagrant-spec.config.rb'
+

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+cache: bundler
+
+branches:
+  only:
+    - master
+rvm:
+  - 2.2.5
+
+before_install:
+  - rvm @global do gem uninstall bundler --all --force --executables
+  - gem uninstall bundler --all --force --executables
+  - gem install bundler -v 1.12.5
+
+script: rake spec:unit

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :development do
+  # tag: 'v1.8.5'
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+  # ref: 9bba7e1228379c0a249a06ce76ba8ea7d276afbe
+  gem 'vagrant-spec', git: 'https://github.com/mitchellh/vagrant-spec.git'
+end
+
+group :plugins do
+  gem 'vagrant-oneandone', path: '.'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 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 (c) 2016 1&1 Internet SE
+
+   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,275 @@
+# Vagrant OneAndOne Cloud Provider
+
+[![Build Status](https://travis-ci.org/1and1/oneandone-cloudserver-vagrant.svg?branch=master)](https://travis-ci.org/1and1/oneandone-cloudserver-vagrant)
+
+## Table of Contents
+
+* [Introduction](#introduction)
+* [Features](#features)
+* [Requirements](#requirements)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Supported Commands](#supported-commands)
+* [Examples](#examples)
+* [Development](#development)
+
+
+## Introduction
+
+This is a [Vagrant](http://www.vagrantup.com) plugin that adds a
+1&1 provider to Vagrant, which allows Vagrant to control and provision 
+machines in the [1&1 Server Cloud](https://www.1and1.com/dynamic-cloud-server).
+
+## Features
+
+* Create and destroy servers.
+* Start, stop and restart servers.
+* Provision the servers with built-in Vagrant provisioners.
+* SSH into the instances.
+* Custom sub-commands within the Vagrant CLI to query 1&1 Server entities.
+
+## Requirements
+
+* Ruby 2.0 or higher
+* [Vagrant 1.4+](http://www.vagrantup.com/downloads.html)
+* [1&1](https://www.1and1.com/dynamic-cloud-server) API access key
+* SSH (RSA) public/private key pair
+
+**Note:** Public and private keys need to be stored on the same location.
+
+## Usage
+
+Install the plugin using the standard installation method, the Vagrant command-line interface:
+
+```
+vagrant plugin install vagrant-oneandone
+```
+
+Before we start using the plugin we must provider a custom [box](https://www.vagrantup.com/docs/boxes.html) for the 1&1
+provider. Vagrant requires any provider to introduce its own [package format](https://www.vagrantup.com/docs/boxes/format.html)
+for Vagrant environment.
+
+You can find an example box and instructions how to create it in the [box directory](box/).
+To use the `dummy.box`, add it to Vagrant:
+
+```
+vagrant box add dummy https://github.com/StackPointCloud/oneandone-cloudserver-vagrant/raw/master/box/dummy.box
+```
+
+Assuming you have a valid [Vagrantfile](https://www.vagrantup.com/docs/vagrantfile/) 
+in the same directory, initiate a machine creation, i.e., server deployment:
+
+```
+vagrant up --provider=oneandone
+```
+
+The following example shows a minimal Vagrantfile configuration for the 1&1 provider.
+
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = 'path/to/private/key'
+
+  config.vm.provider :oneandone do |server|
+    server.api_key = 'your api key'
+    server.name    = 'my-server-name'
+  end
+end
+```
+
+## Configuration
+
+The 1&1 Vagrant provider exposes a few provider-specific configuration options:
+
+* `api_key`: The API key for accessing 1&1 Cloud Server (required). Defaults to `ENV['ONEANDONE_API_KEY']`, if not provided.
+* `name`: The server host name. Required, if Vagrant `config.vm.hostname` option is not specified. It has precedence over `hostname`, if both options are set.
+* `fixed_size`: A fixed-instance size for the server (required). ID or name is supported. Defaults to `M`, if not provided.
+* `appliance`: A server appliance for the server (required). ID or name (without spaces) is supported. Defaults to `ubuntu1404-64std`, if not provided.
+* `datacenter`: A data center for the server (required). ID or country code is supported. Defaults to `US`, if not provided.
+* `description`: The server description.
+* `password`: The server's `root` user password.
+* `ip`: An unassigned public IP address for the server. ID or IP address can be used.
+* `firewall_id`: The ID of a firewall policy that is to be assigned to the server.
+* `load_balancer_id`: The ID of a load balancer that is to be assigned to the server.
+* `monitoring_policy_id`: The ID of a monitoring policy that is to be assigned to the server.
+* `timeout`: The server deployment timeout in seconds. Defaults to `1800`, if not provided.
+
+**Note:** Only Linux-based server appliances are supported in this version of the plugin.
+
+## Supported Commands
+
+The following Vagrant actions are currently supported with the provider:
+
+- `vagrant up`: Creates or starts an existing server instance.
+- `vagrant status`: Displays the server status (active, off, not created).
+- `vagrant halt`: Stops the server instance. If `--force` option is specified, performs hardware-based shutdown.
+- `vagrant ssh`: Connects to the server instance using the configured public/private keys. No insecure Vagrant key is supported.
+- `vagrant ssh-config`: Displays the SSH configuration for the server instance.
+- `vagrant provision`: Provisions the server with one or more.
+- `vagrant reload`: Reboots the server instance. If `--force` option is specified, performs hardware-based reset.
+- `vagrant destroy`: Destroys the server instance. If `--force` option is specified, deletes the server without asking for confirmation.
+
+In addition to these, several custom commands are available to list 1&1 Cloud entities.
+
+```
+vagrant oneandone
+Usage: vagrant oneandone <subcommand> [<api_key>]
+
+Available subcommands:
+     appliances
+     datacenters
+     firewalls
+     ips
+     loadbalancers
+     monitors
+     servers
+     sizes
+
+For help on any subcommand run `vagrant oneandone <subcommand> -h`
+```
+
+An example of a custom command output:
+
+```
+vagrant oneandone datacenters
++----------------------------------+------------------------------------------------------+--------------+
+| ID                               | Location                                             | Country Code |
++----------------------------------+------------------------------------------------------+--------------+
+| 81DEF28500FBC2A973FC0C620DF5B721 | Spain                                                | ES           |
+| 908DC2072407C94C8054610AD5A53B8C | United States of America                             | US           |
+| 4EFAD5836CE43ACA502FD5B99BEE44EF | Germany                                              | DE           |
+| 5091F6D8CBFEF9C26ACE957C652D5D49 | United Kingdom of Great Britain and Northern Ireland | GB           |
++----------------------------------+------------------------------------------------------+--------------+
+```
+
+## Examples
+
+The Vagrantfile examples in this section can be found in the `examples` directory of this repository.
+
+It is assumed that a valid API key is set in `$ONEANDONE_API_KEY` environment variable.
+
+* A simple CoreOS server configuration:
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+  config.vm.provider :oneandone do |server|
+    server.name       = 'vagrant-coreos'
+    server.appliance  = 'CoreOS_Stable_64std'
+  end
+end
+```
+
+* Deploy a Django DB application server:
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+  config.vm.provider :oneandone do |server|
+    server.name       = 'django-db-server'
+    server.appliance  = 'django'
+    server.datacenter = 'DE'
+    server.fixed_size = 'L'
+  end
+end
+```
+
+* Run shell provisioning on an Ubuntu 12.04 instance:
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.hostname = 'ubuntu1204-server-example'
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+  config.ssh.pty = true
+
+  config.vm.provider :oneandone do |oneandone|
+    oneandone.appliance  = 'ubuntu1204-64std'
+    oneandone.datacenter = 'ES'
+    oneandone.fixed_size = 'S'
+  end
+
+  config.vm.provision "shell" do |s|
+    s.inline = 'apt-get update && apt-get install -y'
+  end
+end
+```
+
+* Create multiple servers in parallel:
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+  config.vm.define :centos do |centos|
+   centos.ssh.pty = true
+   centos.vm.provider :oneandone do |vm|
+     vm.name        = 'worker1'
+     vm.description = 'worker node 1'
+     vm.appliance   = 'centos7-64std'
+     vm.datacenter  = 'US'
+   end
+  end
+
+  config.vm.define :ubuntu do |ubuntu|
+   ubuntu.vm.provider :oneandone do |vm|
+     vm.name        = 'worker2'
+     vm.description = 'worker node 2'
+     vm.appliance   = 'ubuntu1604-64std'
+     vm.datacenter  = 'US'
+   end
+  end
+end
+```
+
+* Provision a Debian 8 server with Docker:
+```ruby
+Vagrant.configure('2') do |config|
+  config.vm.box = 'dummy'
+  config.ssh.private_key_path = '~/.ssh/id_rsa'
+
+  config.vm.provider :oneandone do |oneandone|
+    oneandone.name       = 'debian8-docker'
+    oneandone.appliance  = 'debian8-64std'
+    oneandone.datacenter = 'GB'
+    oneandone.fixed_size = 'XL'
+  end
+
+  config.vm.provision "docker" do |d|
+  end
+end
+```
+
+## Development
+
+While Ruby 2.0 might be sufficient to run the plugin within Vagrant, some of the
+plugin dependencies may require a higher version of Ruby to install. Therefore, 
+Ruby 2.2.3 or higher is recommended for the plugin development.
+
+Check out the repository and use [Bundler](http://bundler.io/) to install dependencies.
+
+The current version of Vagrant (1.8.6 and 1.8.7.dev) requires Bundler version 1.12.5.
+
+    $ gem install bundler -v 1.12.5
+
+Install the plugin dependency gems:
+
+    $ bundle install
+
+Execute the unit test task:
+
+    $ rake spec:unit
+
+`bundle exec vagrant <command>` enables you to test the plugin during the development.
+
+Build the plugin gem for local installation and deployment to https://rubygems.org/:
+
+    $ rake build
+
+Before you send a pull request, make sure you have successfully run the functional 
+tests as well.
+
+    $ rake spec:acceptance
+
+Refer to [the test documentation](spec/doc/) for more information on the plugin testing.