fog-proxmox 0.4.0

data/fog-proxmox.gemspec

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fog/proxmox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fog-proxmox'
+  spec.version       = Fog::Proxmox::VERSION
+  spec.authors       = ['Tristan Robert']
+  spec.email         = ['tristan.robert.44@gmail.com']
+
+  spec.summary       = "Module for the 'Fog' gem to support Proxmox VE"
+  spec.description   = 'This library can be used as a module for `fog`.'
+  spec.homepage      = 'http://github.com/fog/fog-proxmox'
+  spec.license       = 'GPL-3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3'
+  spec.rubygems_version = '~> 2.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'debase', '~> 0.2.2'
+  spec.add_development_dependency 'debride', '~> 1.8'
+  spec.add_development_dependency 'fasterer', '~> 0.3'
+  spec.add_development_dependency 'fastri', '~> 0.3'
+  spec.add_development_dependency 'minitest', '~> 5.11'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rcodetools', '~> 0.3'
+  spec.add_development_dependency 'reek', '~> 4.7'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.55'
+  spec.add_development_dependency 'ruby-debug-ide', '~> 0.6'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+
+  spec.add_dependency 'fog-core',  '~> 1.45'
+  spec.add_dependency 'fog-json',  '~> 1.0'
+  spec.add_dependency 'ipaddress', '~> 0.8'
+end

data/lib/fog/compute/proxmox.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/proxmox/core'
+
+module Fog
+  module Compute
+    # Proxmox compute service
+    class Proxmox < Fog::Service
+      requires :pve_url
+      recognizes :pve_ticket, :pve_path, :pve_ticket_expires,
+                 :pve_csrftoken, :persistent, :current_user, :pve_username,
+                 :pve_password, :pve_deadline
+
+      # Models
+      model_path 'fog/compute/proxmox/models'
+      model :node
+      collection :nodes
+      model :server
+      collection :servers
+      model :interface
+      collection :interfaces
+      model :disk
+      collection :disks
+      model :server_config
+      model :volume
+      collection :volumes
+      model :storage
+      collection :storages
+      model :task
+      collection :tasks
+      model :snapshot
+      collection :snapshots
+      model :container
+      collection :containers
+      model :container_config
+
+      # Requests
+      request_path 'fog/compute/proxmox/requests'
+
+      # Manage nodes cluster
+      request :list_nodes
+      request :get_node
+      # Manage servers
+      request :next_vmid
+      request :check_vmid
+      request :list_servers
+      request :create_server
+      request :get_server_status
+      request :get_server_config
+      request :update_server
+      request :delete_server
+      request :action_server
+      request :template_server
+      request :clone_server
+      request :migrate_server
+      request :move_disk
+      request :move_volume
+      request :resize_server
+      request :resize_container
+      # Manage volumes
+      request :list_volumes
+      request :get_volume
+      request :delete_volume
+      # Manage backups
+      request :create_backup
+      # Manage storages
+      request :list_storages
+      request :get_storage
+      # Tasks
+      request :list_tasks
+      request :get_task
+      request :stop_task
+      request :status_task
+      request :log_task
+      # CRUD snapshots
+      request :list_snapshots
+      request :get_snapshot
+      request :create_snapshot
+      request :update_snapshot
+      request :delete_snapshot
+      request :rollback_snapshot
+      # Consoles
+      request :create_term
+      request :create_spice
+      request :create_vnc
+      request :get_vnc
+
+      # Mock class
+      class Mock
+        attr_reader :config
+
+        def initialize(options = {})
+          @pve_uri = URI.parse(options[:pve_url])
+          @pve_path = @pve_uri.path
+          @config = options
+        end
+      end
+
+      # Real class
+      class Real
+        include Fog::Proxmox::Core
+        def initialize(options = {})
+          initialize_identity(options)
+          @connection_options = options[:connection_options] || {}
+          @path_prefix = URI.parse(options[:pve_url]).path
+          authenticate
+          @persistent = options[:persistent] || false
+          url = "#{@scheme}://#{@host}:#{@port}"
+          @connection = Fog::Core::Connection.new(url, @persistent, @connection_options.merge(path_prefix: @path_prefix))
+        end
+      end
+    end
+  end
+end

data/lib/fog/compute/proxmox/models/container.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/compute/proxmox/models/server'
+require 'fog/compute/proxmox/models/container_config'
+
+module Fog
+  module Compute
+    class Proxmox
+      # Container model
+      class Container < Fog::Compute::Proxmox::Server
+        identity  :vmid
+        attribute :lock
+        attribute :maxswap
+        attribute :swap
+        attribute :config
+
+        def initialize(attributes = {})
+          prepare_service_value(attributes)
+          set_config(attributes)
+          super
+        end
+
+        def type(attributes = {})
+          @type ||= 'lxc' unless attributes[:type] || attributes['type']
+          @type
+        end
+
+        def restore(backup, options = {})
+          requires :node, :vmid
+          path_params = { node: node, type: type }
+          body_params = options.merge(vmid: vmid, ostemplate: backup.volid, force: 1, restore: 1)
+          task_upid = service.create_server(path_params, body_params)
+          tasks.wait_for(task_upid)
+        end
+
+        def move(volume, storage, options = {})
+          requires :vmid, :node
+          path_params = { node: node, vmid: vmid }
+          body_params = options.merge(volume: volume, storage: storage)
+          task_upid = service.move_volume(path_params, body_params)
+          tasks.wait_for(task_upid)
+        end
+
+        def update(config = {})
+          requires :node, :vmid
+          path_params = { node: node, type: type, vmid: vmid }
+          body_params = config
+          service.update_server(path_params, body_params)
+        end
+
+        def set_config(attributes = {})
+          @config = Fog::Compute::Proxmox::ContainerConfig.new({ service: service }.merge(attributes))
+        end
+
+        def config
+          path_params = { node: node, type: type, vmid: vmid }
+          set_config(service.get_server_config(path_params)) if uptime
+          @config
+        end
+
+        def detach(mpid)
+          update(delete: mpid)
+        end
+
+        def extend(disk, size, options = {})
+          requires :vmid, :node
+          path_params = { node: node, vmid: vmid }
+          body_params = options.merge(disk: disk, size: size)
+          task_upid = service.resize_container(path_params, body_params)
+          tasks.wait_for(task_upid)
+        end
+
+        def action(action, options = {})
+          raise Fog::Errors::Error, "Action #{action} not implemented" unless %w[start stop shutdown].include? action
+          super
+        end
+      end
+    end
+  end
+end

data/lib/fog/compute/proxmox/models/container_config.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/proxmox/variables'
+require 'fog/proxmox/helpers/nic_helper'
+
+module Fog
+  module Compute
+    class Proxmox
+      # ContainerConfig model
+      class ContainerConfig < Fog::Proxmox::Model
+        identity  :digest
+        attribute :ostype
+        attribute :arch
+        attribute :memory
+        attribute :swap
+        attribute :hostname
+        attribute :onboot
+        attribute :rootfs
+        attribute :interfaces
+        attribute :mount_points
+
+        def initialize(attributes = {})
+          prepare_service_value(attributes)
+          compute_nets(attributes)
+          compute_mps(attributes)
+          super(attributes)
+        end
+
+        attr_reader :interfaces
+
+        attr_reader :mount_points
+
+        def mac_addresses
+          Fog::Proxmox::NicHelper.to_mac_adresses_array(interfaces)
+        end
+
+        private
+
+        def compute_nets(attributes)
+          nets = Fog::Proxmox::ControllerHelper.to_hash(attributes, Fog::Compute::Proxmox::Interface::NAME)
+          @interfaces ||= Fog::Compute::Proxmox::Interfaces.new
+          nets.each do |key, value|
+            nic_hash = {
+              id: key.to_s,
+              name: Fog::Proxmox::NicHelper.extract_name(value),
+              mac: Fog::Proxmox::NicHelper.extract_mac_address(value)
+            }
+            names = Fog::Compute::Proxmox::Interface.attributes.reject { |key, _value| %i[id mac name].include? key }
+            names.each { |name| nic_hash.store(name.to_sym, Fog::Proxmox::ControllerHelper.extract(name, value)) }
+            @interfaces << Fog::Compute::Proxmox::Interface.new(nic_hash)
+          end
+        end
+
+        def compute_mps(attributes)
+          mps = Fog::Proxmox::ControllerHelper.to_hash(attributes, 'mp')
+          @mount_points ||= Fog::Compute::Proxmox::Disks.new
+          mps.each do |key, value|
+            storage, volid, size = Fog::Proxmox::DiskHelper.extract_storage_volid_size(value)
+            disk_hash = {
+              id: key.to_s,
+              storage: storage,
+              volid: volid,
+              size: size
+            }
+            names = Fog::Compute::Proxmox::Disk.attributes.reject { |key, _value| %i[id size storage].include? key }
+            names.each { |name| disk_hash.store(name.to_sym, Fog::Proxmox::ControllerHelper.extract(name, value)) }
+            @mount_points << Fog::Compute::Proxmox::Disk.new(disk_hash)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/compute/proxmox/models/containers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+require 'fog/compute/proxmox/models/server'
+
+module Fog
+  module Compute
+    class Proxmox
+      # Containers Collection
+      class Containers < Fog::Compute::Proxmox::Servers
+        model Fog::Compute::Proxmox::Container
+
+        def new(attributes = {})
+          super({ node: node, type: type }.merge(attributes))
+        end
+
+        def type(attributes = {})
+          @type ||= 'lxc' unless attributes[:type] || attributes['type']
+          @type
+        end
+      end
+    end
+  end
+end

data/lib/fog/compute/proxmox/models/disk.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# Copyright 2018 Tristan Robert
+
+# This file is part of Fog::Proxmox.
+
+# Fog::Proxmox is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Fog::Proxmox is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Fog::Proxmox. If not, see <http://www.gnu.org/licenses/>.
+
+# frozen_string_literal: true
+
+require 'fog/proxmox/models/model'
+require 'fog/proxmox/helpers/disk_helper'
+
+module Fog
+  module Compute
+    class Proxmox
+      # class Disk model
+      class Disk < Fog::Proxmox::Model
+        identity  :id
+        attribute :volid
+        attribute :size
+        attribute :storage
+        attribute :cache
+        attribute :replicate
+        attribute :media
+        attribute :format
+        attribute :model
+        attribute :shared
+        attribute :snapshot
+        attribute :backup
+        attribute :aio
+
+        CONTROLLERS = %w[ide sata scsi virtio].freeze
+
+        def controller
+          Fog::Proxmox::DiskHelper.extract_controller(id)
+        end
+
+        def device
+          Fog::Proxmox::DiskHelper.extract_device(id)
+        end
+
+        def cdrom?
+          id == 'ide2' && media == 'cdrom'
+        end
+      end
+    end
+  end
+end