easy_manager 0.9.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a183ff2d7a5d75f1f6f75bb9aecae632bd834cf85e42f5eb54ccca4a5b1fc05c
+  data.tar.gz: 7329205dad75e774fdffe1c09d83969a953540062888ac392824e36add60e7fc
+SHA512:
+  metadata.gz: 9875faf48edbdeac8d47bfdcd7f2d46980cfb78b6493b513fce019135ad100748551662c4a8b13b376639bd5bb25585db3d21e74d73a8c2dc08e1549f7cd085a
+  data.tar.gz: e47ef66b3b3bab4a3e4f76b09397c163483678d958fc2089333b7239607dcbde83c0b27307126089cf36aa14ed4dc5a277d5206e30cf4ccdd74536a2c89f350d

data/lib/easy_manager.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'typhoeus'
+
+require_relative 'easymanager/scaleway/main'
+require_relative 'easymanager/ssh'
+require_relative 'easymanager/utilities'

data/lib/easymanager/scaleway/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class EasyManager
+  class Scaleway
+    # Methods to retrieve information specific to Scaleway
+    class Config
+      def self.srv_infos(srv_type)
+        srv_infos = {
+          'DEV1-S' => { volume: 20_000_000_000, volume_type: 'l_ssd' },
+          'DEV1-M' => { volume: 40_000_000_000, volume_type: 'l_ssd' },
+          'DEV1-L' => { volume: 80_000_000_000, volume_type: 'l_ssd' },
+          'DEV1-XL' => { volume: 120_000_000_000, volume_type: 'l_ssd' }
+        }
+        srv_infos[srv_type]
+      end
+
+      def self.image_id(image)
+        image_id = {
+          'ubuntu-jammy' => '2289fad9-2694-48ab-bb41-f19e4a9a8584',
+          'debian-buster' => '6d124a42-de28-493f-933b-85a0df5552eb'
+        }
+        image_id[image]
+      end
+    end
+  end
+end

data/lib/easymanager/scaleway/ips.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class EasyManager
+  class Scaleway
+    # Specific method for ips management
+    # https://developers.scaleway.com/en/products/instance/api/#ips-268151
+    class Ips
+      def self.reserve(scw)
+        data = { project: scw.project }
+
+        response = Typhoeus.post(
+          File.join(scw.api_url, "instance/v1/zones/#{scw.zone}/ips"),
+          headers: scw.headers,
+          body: data.to_json
+        )
+        return unless response&.code == 201
+
+        Utilities.parse_json(response.body)
+      end
+
+      def self.delete(scw, ip_id)
+        Typhoeus.delete(
+          File.join(scw.api_url, "/instance/v1/zones/#{scw.zone}/ips/#{ip_id}"),
+          headers: scw.headers
+        )
+      end
+    end
+  end
+end

data/lib/easymanager/scaleway/main.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'servers'
+require_relative '../ssh'
+
+class EasyManager
+  # Scaleway Class with global methods
+  class Scaleway
+    attr_reader :provider, :zone, :project, :api_url, :headers, :secret_token
+
+    def initialize(options)
+      @secret_token = options[:secret_token]
+      @zone = options[:zone]
+      @project = options[:project]
+      @api_url = 'https://api.scaleway.com/'
+      @headers = { 'X-Auth-Token' => @secret_token, 'Content-Type' => 'application/json' }
+    end
+
+    def list
+      Servers.list(self)
+    end
+
+    def create(options)
+      srv_type = options[:srv_type] || 'DEV1-S'
+      image = options[:image] || 'ubuntu-jammy'
+      name_pattern = options[:name_pattern] || 'scw-easymanager-__RANDOM__'
+      cloud_init = options[:cloud_init] || false
+
+      Servers.create(self, srv_type, image, name_pattern, cloud_init)
+    end
+
+    def delete(srv)
+      Servers.delete(self, srv['id'], srv['public_ip']['id'])
+    end
+
+    def delete_by_id(id)
+      servers = list
+
+      servers.each { |server| delete(server) if server['id'] == id }
+    end
+
+    def status(srv)
+      Servers.status(self, srv['id'])
+    end
+
+    def srv_ready?(srv, ssh)
+      Servers.ready?(self, srv, ssh, srv_ready_cmds)
+    end
+
+    def wait_until_ready!(srv, ssh, timeout = 300)
+      ready = false
+      start = Time.now
+      loop do
+        ready = srv_ready?(srv, ssh)
+        break if ready || Utilities.elapsed_times(Time.now.to_s, start.to_s) >= timeout
+
+        sleep(30)
+      end
+
+      ready
+    end
+
+    private
+
+    def srv_ready_cmds
+      check_cloud_init_cmd = "test -f '/var/log/cloud-init.log' && echo true"
+      cloud_init_ready_cmd = 'tail -1 /var/log/cloud-init-output.log'
+
+      [check_cloud_init_cmd, cloud_init_ready_cmd, 'hostname']
+    end
+  end
+end

data/lib/easymanager/scaleway/servers.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'ips'
+
+class EasyManager
+  class Scaleway
+    # Specific method for server management
+    # https://developers.scaleway.com/en/products/instance/api/#servers-8bf7d7
+    class Servers
+      def self.list(scw)
+        response = Typhoeus.get(
+          File.join(scw.api_url, "instance/v1/zones/#{scw.zone}/servers"),
+          headers: scw.headers
+        )
+        return unless response&.code == 200
+
+        json_body = Utilities.parse_json(response.body)
+        return unless json_body
+
+        json_body['servers']
+      end
+
+      def self.srv_up?(scw, srv)
+        status(scw, srv['id']) == 'running' && Utilities.elapsed_times(Time.now.to_s, srv['creation_date']) > 90
+      end
+
+      def self.ready?(scw, srv, ssh, cmds)
+        return unless srv_up?(scw, srv)
+
+        cmd_values = SSH.cmd_exec(ssh, srv, cmds)
+        if cmd_values[cmds[0]].empty?
+          cmd_values['hostname'] == srv['hostname']
+        else
+          cmd_values[cmds[1]].include?('The system is finally up')
+        end
+      end
+
+      def self.status(scw, srv_id)
+        response = Typhoeus.get(
+          File.join(scw.api_url, "/instance/v1/zones/#{scw.zone}/servers/#{srv_id}"),
+          headers: scw.headers
+        )
+        return unless response&.code == 200
+
+        json_body = Utilities.parse_json(response.body)
+        return unless json_body
+
+        json_body['server']['state']
+      end
+
+      def self.create(scw, srv_type, image, name_pattern, cloud_init)
+        data = srv_data(scw, srv_type, image, name_pattern)
+        return if data.nil?
+
+        response = Typhoeus.post(File.join(scw.api_url, "/instance/v1/zones/#{scw.zone}/servers/"),
+                                 headers: scw.headers, body: data.to_json)
+        return unless response&.code == 201
+
+        body_json = Utilities.parse_json(response.body)
+        return unless body_json
+
+        srv_id = body_json['server']['id']
+        launch(scw, srv_id, cloud_init)
+
+        body_json['server']
+      end
+
+      def self.delete(scw, srv_id, srv_ip_id)
+        Ips.delete(scw, srv_ip_id)
+        action(scw, srv_id, 'terminate')
+      end
+
+      def self.launch(scw, srv_id, cloud_init)
+        add_cloud_init(scw, srv_id, cloud_init) if cloud_init
+        action(scw, srv_id, 'poweron')
+      end
+
+      def self.add_cloud_init(scw, srv_id, cloud_init)
+        data = Utilities.file_read(cloud_init)
+        return if data.nil?
+
+        Typhoeus.patch(
+          File.join(scw.api_url, "/instance/v1/zones/#{scw.zone}/servers/#{srv_id}/user_data/cloud-init"),
+          headers: { 'X-Auth-Token' => scw.secret_token, 'Content-Type' => 'text/plain' },
+          body: data
+        )
+      end
+
+      def self.action(scw, srv_id, action)
+        data = { action: action }
+        Typhoeus.post(
+          File.join(scw.api_url, "/instance/v1/zones/#{scw.zone}/servers/#{srv_id}/action"),
+          headers: scw.headers,
+          body: data.to_json
+        )
+      end
+
+      def self.srv_data(scw, srv_type, image, name_pattern)
+        srv_infos = Config.srv_infos(srv_type)
+        image_id = Config.image_id(image)
+        new_ip = Ips.reserve(scw)
+        return if image_id.nil? || srv_infos.nil? || new_ip.nil?
+
+        {
+          name: name_pattern.gsub('__RANDOM__', Utilities.random_string), commercial_type: srv_type,
+          public_ip: new_ip['ip']['id'], project: scw.project,
+          image: image_id,
+          volumes: { '0' => { size: srv_infos[:volume], volume_type: srv_infos[:volume_type] } }
+        }
+      end
+    end
+  end
+end

data/lib/easymanager/ssh.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'net/ssh'
+require 'net/scp'
+
+class EasyManager
+  # SSH Class
+  class SSH
+    attr_reader :username, :ssh_key
+
+    def initialize(options = {})
+      @username = options[:username] || 'root'
+      @ssh_key = options[:ssh_key] || '~/.ssh/id_rsa'
+    end
+
+    def self.cmd_exec(ssh, srv, cmds)
+      cmd_values = {}
+
+      Net::SSH.start(srv['public_ip']['address'], ssh.username, keys: ssh.ssh_key) do |shell|
+        cmds.each do |cmd|
+          cmd_values[cmd] = shell.exec!(cmd).chomp
+        end
+      end
+
+      cmd_values
+    rescue Net::SSH::AuthenticationFailed
+      nil
+    end
+
+    def self.scp(ssh, srv, files)
+      Net::SCP.start(srv['public_ip']['address'], ssh.username, keys: ssh.ssh_key) do |shell|
+        files.each do |name, infos|
+          shell.upload! name, infos[:remote], recursive: infos[:recursive] || false
+        end
+      end
+    rescue Net::SSH::AuthenticationFailed
+      nil
+    end
+  end
+end

data/lib/easymanager/utilities.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# Utility method that can be reused in the code
+class Utilities
+  def self.parse_json(content)
+    JSON.parse(content)
+  rescue JSON::ParseError
+    nil
+  end
+
+  def self.random_string
+    (0...8).map { rand(97..122).chr }.join
+  end
+
+  def self.file_read(file)
+    File.read(file)
+  rescue (Errno::ENOENT)
+    nil
+  end
+
+  def self.elapsed_times(first, second)
+    ((DateTime.parse(first) - DateTime.parse(second)) * 24 * 60 * 60).to_i
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: easy_manager
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+platform: ruby
+authors:
+- Joshua MARTINELLE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0beta1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: x25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+description:
+email:
+- contact@jomar.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/easy_manager.rb
+- lib/easymanager/scaleway/config.rb
+- lib/easymanager/scaleway/ips.rb
+- lib/easymanager/scaleway/main.rb
+- lib/easymanager/scaleway/servers.rb
+- lib/easymanager/ssh.rb
+- lib/easymanager/utilities.rb
+homepage: https://rubygems.org/gems/easymanager
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Cloud Server Manager Library
+test_files: []