cyclid-digitalocean-plugin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eb1eb8572ab14e2bc8d035c4cae3c277ce812e0
+  data.tar.gz: c08f1446391ee32afdc64804e4dbf781da35bf26
+SHA512:
+  metadata.gz: fb1d59fe2f3b574721f95945d15517ad2cabf8e50977ed5b07901d2e4fe96016ac2b4e24cd49e65f398a87c992aec1c9c1fdbe5bbf32a3a91b880d8510a87279
+  data.tar.gz: b7a079b37b81daa21147860e2fc1cb5f7758494a6f3eff6613edc067bfd5a9111c810cda2134471edf669e3785b1c8d873d975b7f842894cc2f560f7972e6198

data/lib/cyclid/plugins/builder/digitalocean.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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.
+
+require 'droplet_kit'
+
+# Top level module for the core Cyclid code.
+module Cyclid
+  # Module for the Cyclid API
+  module API
+    # Module for Cyclid Plugins
+    module Plugins
+      # Digitalocean build host
+      class DigitaloceanHost < BuildHost
+        # SSH is the only acceptable Transport
+        def transports
+          ['ssh']
+        end
+      end
+
+      # Digitalocean builder. Uses the Digitalocean API to obtain a build host instance.
+      class Digitalocean < Builder
+        def initialize
+          @config = load_digitalocean_config(Cyclid.config.plugins)
+          @client = DropletKit::Client.new(access_token: @config[:access_token])
+        end
+
+        # Create & return a build host
+        def get(args = {})
+          args.symbolize_keys!
+
+          Cyclid.logger.debug "digitalocean: args=#{args}"
+
+          # If there is one, split the 'os' into a 'distro' and 'release'
+          if args.key? :os
+            match = args[:os].match(/\A(\w*)_(.*)\Z/)
+            distro = match[1] if match
+            release = match[2] if match
+          else
+            # No OS was specified; use the default
+            # XXX Defaults should be configurable
+            distro = 'ubuntu'
+            release = 'trusty'
+          end
+
+          # Convert Debian & Ubuntu release codenames
+          release_version = if distro == 'ubuntu' or distro == 'debian'
+                              codename_to_version(release)
+                            else
+                              release
+                            end
+
+          begin
+            # Find, or create, the SSH key Cyclid can use
+            build_key = build_ssh_key
+
+            # Create the Droplet
+            droplet = DropletKit::Droplet.new(name: create_name,
+                                              region: @config[:region],
+                                              image: "#{distro}-#{release_version}-x64",
+                                              size: @config[:size],
+                                              ssh_keys: [build_key.id])
+            created = @client.droplets.create droplet
+
+            # Wait for the droplet to become 'active'
+            created = wait_for_droplet(created)
+
+            # Create a buildhost from the active Droplet details
+            buildhost = DigitaloceanHost.new(name: created.name,
+                                             host: created.networks.v4.first.ip_address,
+                                             id: created.id,
+                                             username: 'root',
+                                             workspace: '/root',
+                                             key: @config[:ssh_private_key],
+                                             distro: distro,
+                                             release: release)
+          rescue StandardError => ex
+            Cyclid.logger.error "couldn't get a build host from Digitalocean: #{ex}"
+            raise "digitalocean failed: #{ex}"
+          end
+
+          Cyclid.logger.debug "digitalocean buildhost=#{buildhost.inspect}"
+          return buildhost
+        end
+
+        # Destroy the build host
+        def release(_transport, buildhost)
+          @client.droplets.delete(id: buildhost[:id])
+        rescue StandardError => ex
+          Cyclid.logger.error "Digitalcoean destroy timed out: #{ex}"
+        end
+
+        # Register this plugin
+        register_plugin 'digitalocean'
+
+        private
+
+        # Load the config for the Digitalocean plugin and set defaults if they're not
+        # in the config
+        def load_digitalocean_config(config)
+          config.symbolize_keys!
+
+          do_config = config[:digitalocean] || {}
+          do_config.symbolize_keys!
+          Cyclid.logger.debug "config=#{do_config}"
+
+          raise 'the Digitalocean API access token must be provided' \
+            unless do_config.key? :access_token
+
+          # Set defaults
+          do_config[:region] = 'nyc1' unless do_config.key? :region
+          do_config[:size] = '512mb' unless do_config.key? :size
+          do_config[:ssh_private_key] = File.join(%w(/ etc cyclid id_rsa_build)) \
+            unless do_config.key? :ssh_private_key
+          do_config[:ssh_public_key] = File.join(%w(/ etc cyclid id_rsa_build.pub)) \
+            unless do_config.key? :ssh_public_key
+          do_config[:ssh_key_name] = 'cyclid-build' \
+            unless do_config.key? :ssh_key_name
+          do_config[:instance_name] = 'cyclid-build' \
+            unless do_config.key? :instance_name
+
+          return do_config
+        end
+
+        # Convert Ubuntu & Debian release codenames to Digitialocean approved release versions
+        def codename_to_version(release)
+          versions = { 'precise' => '12-04',
+                       'trusty' => '14-04',
+                       'xenial' => '16-04',
+                       'yakkety' => '16-10',
+                       'wheezy' => '7',
+                       'jessie' => '8' }
+
+          # No need to convert if it isn't a codename
+          return release if release =~ /\A\d*[-\d*]/
+
+          raise "don't know what version Ubuntu/Debian #{release} is" \
+            unless versions.key? release
+
+          return versions[release]
+        end
+
+        def build_ssh_key
+          # Find the build key, if it exists
+          build_key = nil
+          all_keys = @client.ssh_keys.all
+          all_keys.each do |key|
+            build_key = key if key.name == @config[:ssh_key_name]
+          end
+          Cyclid.logger.debug "build_key=#{build_key.inspect}"
+
+          # If the key doesn't exist, create it
+          if build_key.nil?
+            pubkey = File.read(@config[:ssh_public_key])
+            key = DropletKit::SSHKey.new(name: @config[:ssh_key_name],
+                                         public_key: pubkey)
+            build_key = @client.ssh_keys.create(key)
+            Cyclid.logger.debug "build_key=#{build_key.inspect}"
+          end
+
+          return build_key
+        end
+
+        def wait_for_droplet(created)
+          # Wait for the droplet to become active; wait a maximum of 1 minute,
+          # polling every 2 seconds.
+          Cyclid.logger.debug "Waiting for instance #{created.id} to become 'active'..."
+          29.times do
+            created = @client.droplets.find(id: created.id.to_s)
+            break if created.status == 'active'
+
+            sleep 2
+          end
+          Cyclid.logger.debug "created=#{created.inspect}"
+
+          unless created.status == 'active'
+            @client.droplets.delete(id: created.id)
+
+            raise 'failed to create build host: did not become active within 1 minute. ' \
+                  "Status is #{created.status}" \
+          end
+
+          return created
+        end
+
+        def create_name
+          base = @config[:instance_name]
+          "#{base}-#{SecureRandom.hex(16)}"
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: cyclid-digitalocean-plugin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kristian Van Der Vliet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: droplet_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Creates Digitalocean Droplet build hosts
+email: contact@cyclid.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cyclid/plugins/builder/digitalocean.rb
+homepage: https://cyclid.io
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Cyclid Digitalocean plugin
+test_files: []