ovh-provisioner 0.1.0

data/bin/console

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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 'bundler/setup'
+require 'ovh/provisioner'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/ovh_provisioner

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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.
+#
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap('INT') { exit 1 }
+
+require 'bundler/setup'
+require 'ovh/provisioner'
+OVH::Provisioner.start

data/bin/setup

@@ -0,0 +1,23 @@
+#!/bin/bash
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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.
+#
+
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ovh/provisioner.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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 'logger'
+
+module OVH
+  # Main module
+  module Provisioner
+    class << self
+      attr_accessor :logger
+
+      Dir[File.join(File.dirname(__FILE__), '*', '*.rb')].each do |file|
+        require file
+      end
+
+      def start
+        OVH::Provisioner::Cli.start(ARGV)
+      rescue StandardError => error
+        puts error.message
+        puts error.backtrace
+        exit 1
+      end
+    end
+
+    # Initialize the base logger
+    OVH::Provisioner.logger = Logger.new(STDOUT)
+  end
+end

data/lib/ovh/provisioner/api_list.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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 'celluloid/current'
+require 'yaml'
+
+# rubocop:disable Metrics/ClassLength
+module OVH
+  module Provisioner
+    # Represent an API list, that is a collection of a given kind of object
+    class APIList
+      include Celluloid
+      attr_reader :list
+
+      # targets is a list of regex on object id
+      # to match nothing, do not set any target
+      # to match everything, add a '' target
+      def initialize(api_object, parent, *targets)
+        @parent = parent
+        @url = api_object.entrypoint(parent).to_s
+        @name = api_object.name.split('::').last
+        @filter = generate_filter(targets)
+        @futures = {}
+        @list = []
+      end
+
+      def init_properties
+        write = !@completed
+        unless @completed
+          # In ATOM concurrency, this is enough to avoid a race condition.
+          @completed = true
+          spawner = Actor[Spawner::NAME]
+          get.keep_if { |s| @filter.call(s) }.each do |i|
+            @futures[i] = spawner.future.get(@name, parent: @parent, id: i)
+          end
+        end
+        wait(write)
+      end
+
+      def format(*fields)
+        items = classify(list, *fields)
+        items = deep_sort(items)
+        yamlize(items)
+      end
+
+      def parallel_map(method, args = [], subject = nil)
+        futures =
+          if subject.nil?
+            list.map { |item| item.future.send(method, *args) }
+          else
+            list.map { |item| subject.future.send(method, item, *args) }
+          end
+        futures.map(&:value)
+      end
+
+      def puts_each(method, args = [], subject = nil, remove_duplicate = true)
+        results = parallel_map(method, args, subject)
+        results = results.map(&:lines).flatten.compact.uniq if remove_duplicate
+        results.each { |i| puts i unless i.nil? }
+      end
+
+      private
+
+      def get(path = '')
+        OVH::Provisioner.client.get("#{@url}/#{path}")
+      end
+
+      def wait(write = false)
+        @futures.each_pair do |key, future|
+          v = future.value
+          @list << v if write
+          @futures.delete(key)
+        end
+        @list.sort! if write
+      end
+
+      def generate_filter(targets)
+        lambda do |id|
+          targets.reduce(false) do |acc, target|
+            acc | (id.to_s =~ /#{target.to_s}/)
+          end
+        end
+      end
+
+      def classify(items, *fields)
+        items.each_with_object({}) do |item, hash|
+          item = organize(item, *fields)
+          insert!(hash, @url[1..-1].tr('/', '_') => item)
+          hash
+        end
+      end
+
+      def organize(item, *fields)
+        head, *tail = *fields
+        return [item.to_s] if head.nil?
+
+        key = item.send(head.to_sym)
+        { key => organize(item, *tail) }
+      end
+
+      def insert!(hash, item)
+        if hash.is_a?(Array)
+          hash << item.first
+        else
+          key = item.keys.first
+          if hash[key].nil?
+            hash.merge!(item)
+          else
+            insert!(hash[key], item[key])
+          end
+        end
+      end
+
+      def deep_sort(hash)
+        return hash.sort if hash.is_a?(Array)
+        return hash unless hash.is_a?(Hash)
+
+        result = {}
+        hash.each { |k, v| result[k] = deep_sort(v) }
+        result.sort.to_h
+      end
+
+      def yamlize(items)
+        token = 'TO_REMOVE_AFTER_TOYAML'
+        yaml = prep_for_yaml(items, token).to_yaml
+        yaml.lines[1..-1].grep_v(/\- \|\-/).grep_v(/#{token}/).join('')
+      end
+
+      def prep_for_yaml(obj, token)
+        if obj.is_a?(Hash)
+          obj.map { |k, v| [k, prep_for_yaml(v, token)] }.to_h
+        elsif obj.is_a?(Array)
+          obj.map { |e| prep_for_yaml(e, token) }
+        elsif obj.is_a?(String)
+          "#{obj}\n#{token}"
+        else
+          obj
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/lib/ovh/provisioner/api_object/api_object.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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 'celluloid/current'
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Base API Object
+      class APIObject
+        include Celluloid
+        include Comparable
+
+        # Define @attributes to contain all attr_readers
+        def self.attr_reader(*vars)
+          @attributes ||= superclass.attributes.dup unless superclass == Object
+          @attributes ||= []
+          @attributes.concat vars
+          super
+        end
+
+        attr_reader :id
+
+        def self.attributes # rubocop:disable Style/TrivialAccessors
+          @attributes
+        end
+
+        def attributes
+          self.class.attributes
+        end
+
+        def initialize(id, parent = nil)
+          @id = id
+          @url = "#{self.class.entrypoint(parent)}/#{normalize(id)}"
+          @futures = {}
+        end
+
+        def init_properties
+          unless @completed
+            # In ATOM concurrency, this is enough to avoid a race condition.
+            @completed = true
+            infos = private_methods(false).grep(/^set_/)
+            infos.each { |i| @futures[i] = future.send(i) }
+          end
+          @futures.each_pair do |key, future|
+            future.value
+            @futures.delete(key)
+          end
+        end
+
+        def to_s
+          "#{self.class.entrypoint}: #{id}\n" \
+          "#{attributes.map { |s| "- #{send(s)}" }.join("\n")}"
+        end
+
+        def self.entrypoint(parent = nil)
+          classpath = underscore(classname).tr('_', '/')
+          parent.nil? ? "/#{classpath}" : "#{parent}/#{classpath}"
+        end
+
+        def self.classname
+          name.split('::').last
+        end
+
+        # inspired from Rails' ActiveSupport
+        def self.underscore(string)
+          res = string.gsub(/::/, '/')
+          res.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          res.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          res.tr('-', '_').downcase
+        end
+
+        def <=>(other)
+          id <=> other.id
+        end
+
+        def config
+          OVH::Provisioner.config
+        end
+
+        def get(path = '')
+          call(:get, ["#{@url}/#{path}"])
+        end
+
+        def post(path, body = nil)
+          call(:post, ["#{@url}/#{path}", body])
+        end
+
+        def delete(path = '')
+          call(:delete, ["#{@url}/#{path}"])
+        end
+
+        private
+
+        def call(method, args)
+          OVH::Provisioner.client.send(method, *args)
+        rescue OVH::RESTError => error
+          error.to_s.split(':')[-1].strip
+        end
+
+        def normalize(id)
+          id = id.gsub('/', '%2F') if id.is_a? String
+          id
+        end
+      end
+    end
+  end
+end
+
+Dir[File.dirname(__FILE__) + '/*.rb'].each { |file| require file }

data/lib/ovh/provisioner/api_object/dedicated_server.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2015-2016 Sam4Mobile, 2017-2018 Make.org
+#
+# 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 'hashdiff'
+
+module OVH
+  module Provisioner
+    module APIObject
+      # Represent a dedicated server
+      class DedicatedServer < APIObject # rubocop:disable Metrics/ClassLength
+        # install_status const
+        IDLE = 'Server is not being installed or reinstalled at the moment'
+        NO_OS = 'none_64'
+
+        attr_reader :server_id, :reverse, :ip, :dc, :location, :os, :boot
+        attr_reader :state
+        attr_reader :flavor, :flavor_tag
+        attr_reader :vrack, :vrack_id
+        attr_reader :install_status
+
+        def install
+          raise 'Please provide a valid template' if config['template'].nil?
+
+          ok, reason = can_install
+          if ok
+            result = post('install/start', install_body)
+            if result.is_a?(String) # Meaning an error message
+              reason = result
+              ok = false
+            end
+          end
+          "#{id}: #{ok ? 'ok' : 'failed'}\n  #{reason}"
+        end
+
+        def to_s
+          "#{reverse}[#{id}/#{server_id}]" \
+          "\n  #{location} - #{flavor} - #{vrack}:#{ip} " \
+          "- #{boot}:#{os} - #{state}" \
+          "\n  #{install_status}"
+        end
+
+        def newname
+          name_scheme = Provisioner.config['name_scheme']
+          return reverse if name_scheme.nil?
+
+          subst = attributes.map { |a| { a => send(a) } }.reduce(&:merge)
+          name_scheme % subst
+        end
+
+        def rename(domain, name = newname)
+          full_name = "#{name}.#{domain.id}"
+          return "#{reverse}: no change" if reverse == full_name
+
+          # check if name is already used
+          records = domain.filter_records('subdomain' => newname)
+          return "#{reverse}: name already used" unless records.list.empty?
+
+          # remove old name (only if it belongs to the same domain)
+          remove_old_names(domain)
+
+          domain.add_record(name, 'A', ip)
+        end
+
+        def define_reverse(domain, name = newname)
+          full_name = "#{name}.#{domain.id}"
+          return "#{reverse}: no change" if reverse == full_name
+
+          add_reverse(full_name)
+        end
+
+        def ipmi
+          request_ipmi
+
+          (1..10).each do |_|
+            result = get('features/ipmi/access?type=kvmipJnlp')
+            unless result.is_a?(String)
+              launch_ipmi(result['value'])
+              break
+            end
+            sleep(1)
+          end
+        end
+
+        private
+
+        def can_install
+          if install_status != IDLE
+            [false, "Installation ongoing: #{install_status}"]
+          elsif !config['force'] && os != NO_OS
+            [false,
+             "An OS is already installed (#{os}) but option force is false"]
+          else [true, "Installation of #{config['template']} launched"]
+          end
+        end
+
+        def install_body
+          details = { 'customHostname' => reverse.chomp('.') }
+          %w[customHostname useDistribKernel sshKeyName].each do |opt|
+            value = config[APIObject.underscore(opt)]
+            details.merge!(opt => value) unless value.nil?
+          end
+          {
+            'templateName' => config['template'],
+            'details' => details
+          }
+        end
+
+        def set_general
+          general = get
+          @reverse = get_reverse(general)
+          @server_id = general['serverId']
+          @ip = general['ip']
+          @dc = general['datacenter']
+          @location = dc.gsub(/[0-9]*$/, '')
+          @os = general['os']
+          @boot = get_boot(general)
+          @state = general['state']
+        end
+
+        def get_reverse(general)
+          (general['reverse'] || id).chomp('.')
+        end
+
+        def get_boot(general)
+          get("boot/#{general['bootId']}")['bootType']
+        end
+
+        def set_flavor
+          hardware = get('specifications/hardware')
+          flavors = get_flavors_from_config(hardware)
+          raise "Too many flavor possible: #{flavors}" if flavors.size > 1
+
+          @flavor, @flavor_tag =
+            if flavors.first.nil?
+              %w[undefined undef]
+            else
+              [flavors.first, config['flavors'][flavors.first]['tag']]
+            end
+        end
+
+        def get_flavors_from_config(hardware)
+          (config['flavors'].dup || {}).map do |flavor, desc|
+            diff = HashDiff.diff(hardware, desc['hardware'])
+            signs = diff.map(&:first).uniq - ['-']
+            signs.empty? ? flavor : nil
+          end.compact
+        end
+
+        def set_vrack
+          vracks = get('vrack')
+          raise "Too many vracks for #{server}: #{vracks}" if vracks.size > 1
+
+          if vracks.first.nil?
+            @vrack_id = '-1'
+            @vrack = 'none'
+          else
+            @vrack_id = vracks.first
+            @vrack = Actor[Spawner::NAME].get('Vrack', id: @vrack_id).name
+          end
+        end
+
+        def set_install_status
+          status = get('install/status')
+          if status.is_a?(String)
+            status = {
+              'progress' => ['status' => 'doing', 'comment' => status]
+            }
+          end
+          @install_status = extract_status(status)
+        end
+
+        def extract_status(status)
+          cur = status['progress'].select { |step| step['status'] == 'doing' }
+          cur << { 'comment' => 'Preparing installation' } if cur.empty?
+          cur.first['comment']
+        end
+
+        def remove_old_names(domain)
+          old_name = reverse.match(/^(.*)\.#{domain.id}$/).to_a.last
+          return if old_name.nil?
+
+          records = domain.filter_records('subdomain' => old_name)
+          records.parallel_map(:rm_record, [], domain)
+        end
+
+        def add_reverse(full_name)
+          ip_obj = Actor[Spawner::NAME].get('IP', id: "#{ip}/32")
+          result = ip_obj.add_reverse(full_name)
+          cant = "Cannot check if #{full_name}. resolves to #{ip}"
+          if result == cant
+            result = "#{reverse}: DNS propagation is not finished, try later_"
+          end
+          result
+        end
+
+        def request_ipmi
+          body = { 'ttl' => '15', 'type' => 'kvmipJnlp' }
+          result = post('features/ipmi/access', body)
+          puts result if result.is_a?(String)
+        end
+
+        def launch_ipmi(jnlp)
+          filename = "/tmp/#{id}.jnlp"
+          File.open(filename, 'w') { |file| file.write(jnlp) }
+          system("javaws #{filename}")
+        end
+      end
+    end
+  end
+end