vagrant-hetznercloud 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 767df6134ca3dbdd8b80d875f6b6ae1bda5b0fa9
+  data.tar.gz: 34da588e386d702521dc2978a7cc71a08ee86256
+SHA512:
+  metadata.gz: bd0b7582dc180ff0e89b31cea8f1a04b261adf02c32bd637f20581fd407849031d93639514d5075db8a587f30b5de8511b052bf2454158d8beea2d28dbee2358
+  data.tar.gz: e175cf0c82ec9c77e04968b98a9b38051aed160a3bf4a9347de4a1f0be9dd70dc79b618616a792704fa72889b761b7d583c889480eb9e29670ac516fc10dcbb8

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :plugins do
+  gemspec
+end
+
+group :development do
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
+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 [2018] [Robert Heinzmann - elconas.de]
+
+   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,111 @@
+
+# Vagrant Hetznercloud Provider
+
+This is a [Vagrant](http://www.vagrantup.com/) plugin that adds a
+[Hetznercloud](https://cloud.hetzner.com/) provider to Vagrant, allowing Vagrant to
+control and provision machines in Hetznercloud.
+
+**NOTE: This is currently a MVP Prototyp (and my first vagrant plugin). Probably the interface will change. Development is tracked at [Trello](https://trello.com/b/zJx9W0OY/vagrant-hetznercloud)**
+
+
+## Features
+
+- Boot Hetznercloud servers (supports types, user_data and ssh_keys)
+- SSH into the servers.
+- Provision the servers with any built-in Vagrant provisioner.
+- Minimal synced folder support via rsync.
+
+Missing Features:
+
+- cli "command" support for listing server types, prieces, datacenters, locations ... everything
+- proper cli "command" support with multi machine vagrantfiles
+- probably a lot :)
+
+## Prerequisites
+
+Prior to using this plugin, you will first need to create an API token and
+identify your organization ID. Please see the following help pages for
+instructions.
+
+- [Hetznercloud Getting Started Guide](https://docs.hetzner.cloud/#header-getting-started-1)
+
+## Installation
+
+Install using standard Vagrant plugin installation methods.
+
+    $ vagrant plugin install vagrant-hetznercloud
+
+**Note**: As this plugin is not yet released you have to:
+
+- checkout the code
+- run $rake build
+- vagrant install pkd/plugin.gem
+- vagrant box add --name base hetznercloud.box
+
+## Usage
+
+1) Generate Token in the Web GUI of Hetznercloud
+
+Create new API token in the Hetznercloud [Console](https://console.hetzner.cloud/).
+
+2) Optional: Install the hcloud cli
+
+If you install the [Hetzner cli](https://github.com/hetznercloud/cli) and configure it with credentials,
+the vagrant-hetznercloud driver automatically picks up your default context
+from the ~/.config/hcloud/cli.toml settings file. Therefor you do not need to
+set the credentials in the environment or in the Vagrantfile.
+
+1) Create Vagrantfile
+
+See [examples/Vagrantfile](examples/Vagrantfile) for an example Vagrantfile:
+
+2) Start your machines
+
+And then run `vagrant up` and specify the `hetznercloud` provider:
+
+2.1) With hcloud cli installed and configured
+
+    $ vagrant up --provider=hetznercloud
+
+2.1) With Token via environment
+
+    $ export HETZNERCLOUD_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxx
+    $ vagrant up --provider=hetznercloud
+
+2.2) With Token in Vagrantfile
+
+See [examples/Vagrantfile](examples/Vagrantfile).
+
+**Note: This is not recommended, as this tends to leak credentials in SCM**
+
+## Configurations
+
+FIXME: Write proper documentation
+
+## Development
+
+To work on the `vagrant-hetznercloud` plugin, clone this repository out, and use
+[Bundler](http://gembundler.com) to get the dependencies:
+
+    $ bundle
+
+If those pass, you're ready to start developing the plugin. You can test
+the plugin without installing it into your Vagrant environment by just
+creating a `Vagrantfile` in the top level of this directory (it is gitignored)
+that uses it, and uses bundler to execute Vagrant:
+
+    $ bundle exec vagrant up --provider=scaleway
+
+For Debugging you can run:
+
+	$ LANG=C VAGRANT_LOG=debug VAGRANT_DEFAULT_PROVIDER=hetznercloud VAGRANT_HOME=~/.vagrant.develop.d bundle exec -- vagrant up
+
+Development is tracked at [Trello](https://trello.com/b/zJx9W0OY/vagrant-hetznercloud)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elconas/vagrant-hetznercloud.
+
+## License
+
+The plugin is available as open source under the terms of the [APACHE-2.0](https://opensource.org/licenses/APACHE-2.0).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: :rubocop

data/example_box/metadata.json

@@ -0,0 +1,3 @@
+{
+    "provider": "hetznercloud"
+}

data/examples/Vagrantfile

@@ -0,0 +1,63 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure('2') do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://vagrantcloud.com/search.
+  config.vm.box = 'elconas/base'
+  config.vm.synced_folder '.', '/vagrant', disabled: true
+  config.ssh.private_key_path = './keys/testkey2'
+  config.vm.provider 'hetznercloud' do |hcloud, override|
+
+    ## Tokens in Vagrantfiles should be avoided. You can use:
+    #  - priority1: env var "HETZNERCLCOUD_TOKEN"
+    #  - priority2: content in ~/.config/hcloud/cli.toml
+    #  - priority3: hcloud.token in this file (last resort as it tends to leak to git)
+    # hcloud.token = "YOUR_TOKEN or set via HETZNERCLCOUD_TOKEN environment variable"
+
+    ## SSH Key must exist and must match override.ssh.private_key_path
+    hcloud.ssh_keys = ['test']
+
+    ## Select an explicit context in the config file
+    ## If not speicified, the default one is used
+    # hcloud.active_context = 'non_default_context'
+
+    ## if you have a multi provider vagrantfile
+    #  you can also override config.ssh.private_key_path
+    #  provider specific.
+    #override.ssh.private_key_path = './keys/testkey2'
+
+  end
+  config.vm.provision 'shell', inline: <<-SHELL
+     yum update -y
+  SHELL
+
+  config.vm.define 'web' do |web|
+    config.vm.provider 'hetznercloud' do |hcloud|
+      hcloud.name = 'web'
+      hcloud.server_type = 'cx11'
+    end
+    web.vm.provision 'shell', inline: <<-SHELL
+     yum install -y httpd
+     systemctl start httpd
+    SHELL
+  end
+
+  config.vm.define 'db' do |db|
+    config.vm.provider 'hetznercloud' do |hcloud|
+      hcloud.name = 'db'
+      hcloud.server_type = 'cx21'
+    end
+    db.vm.provision 'shell', inline: <<-SHELL
+     yum install -y mariadb
+    SHELL
+  end
+end

data/lib/vagrant-hetznercloud.rb

@@ -0,0 +1,18 @@
+# rubocop:disable Style/FileName
+require 'pathname'
+require 'vagrant-hetznercloud/plugin'
+
+module VagrantPlugins
+  module Hetznercloud
+    lib_path = Pathname.new(File.expand_path('../vagrant-hetznercloud', __FILE__))
+    autoload :Action, lib_path.join('action')
+    autoload :Errors, lib_path.join('errors')
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    end
+  end
+end

data/lib/vagrant-hetznercloud/action.rb

@@ -0,0 +1,189 @@
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module Hetznercloud
+    module Action
+      # Include the built-in modules so we can use them as top-level things.
+      include Vagrant::Action::Builtin
+
+      # This action is called to terminate the remote machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b2.use Call, IsCreated do |env2, b3|
+                unless env2[:result]
+                  b3.use MessageNotCreated
+                  next
+                end
+
+                b3.use ConnectHetznercloud
+                b3.use ProvisionerCleanup, :before if defined?(ProvisionerCleanup)
+                b3.use DestroyServer
+              end
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called to halt the remote machine.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use ConnectHetznercloud
+            b2.use StopServer
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use Provision
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHetznercloud
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHetznercloud
+          b.use ReadState
+        end
+      end
+
+      # This action is called to restart the remote machine.
+      def self.action_reload
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectHetznercloud
+          b.use Call, IsCreated do |env1, b1|
+            unless env1[:result]
+              b1.use MessageNotCreated
+              next
+            end
+
+            b1.use action_halt
+            b1.use action_up
+          end
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SSHExec
+          end
+        end
+      end
+
+      # This action is called to execute a command on the machine via SSH.
+      def self.action_ssh_run
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            unless env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            b2.use SSHRun
+          end
+        end
+      end
+
+      # This action is called to bring the box up from nothing.
+      def self.action_up
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use BoxCheckOutdated
+          b.use ConnectHetznercloud
+          b.use Call, IsCreated do |env1, b1|
+            if env1[:result]
+              b1.use Call, IsStopped do |env2, b2|
+                if env2[:result]
+                  b2.use Provision
+                  b2.use SyncedFolders
+                  b2.use WarnNetworks
+                  b2.use StartServer
+                else
+                  b2.use MessageAlreadyCreated
+                end
+              end
+            else
+              b1.use Provision
+              b1.use SyncedFolders
+              b1.use WarnNetworks
+              b1.use CreateServer
+              b1.use StartServer
+            end
+          end
+        end
+      end
+
+      # This action is called to list available images.
+      def self.action_list_images
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConnectHetznercloud
+          b.use ListImages
+        end
+      end
+
+
+      # The autoload farm
+      action_root = Pathname.new(File.expand_path('../action', __FILE__))
+      autoload :ConnectHetznercloud, action_root.join('connect_hetznercloud')
+      autoload :CreateServer, action_root.join('create_server')
+      autoload :DestroyServer, action_root.join('destroy_server')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsStopped, action_root.join('is_stopped')
+      autoload :ListImages, action_root.join('list_images')
+      autoload :MessageAlreadyCreated, action_root.join('message_already_created')
+      autoload :MessageNotCreated, action_root.join('message_not_created')
+      autoload :MessageWillNotDestroy, action_root.join('message_will_not_destroy')
+      autoload :ReadSSHInfo, action_root.join('read_ssh_info')
+      autoload :ReadState, action_root.join('read_state')
+      autoload :StartServer, action_root.join('start_server')
+      autoload :StopServer, action_root.join('stop_server')
+      autoload :WarnNetworks, action_root.join('warn_networks')
+    end
+  end
+end