fog-proxmox 0.16.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cdecf83035e83be1e7ceb19a56e551e65c0761ec0330ddfc23c834dccdf369c
-  data.tar.gz: 7469eec6715cb9210eff2da78364d8b8d67a24fc7e4bb52dd809b5202135eb79
+  metadata.gz: d571150b56652b8f22fc3172ac26caf7918bdc167c5202b9f0809f138693da0f
+  data.tar.gz: f26c7b0f98d625306b573bdc2c848974438b03260ac7814b796d055e9967c88a
 SHA512:
-  metadata.gz: 9588e62afafb53c22eac52bca2bc65d3e9c9adab8445fa2afa41c97b9933b0bcb49680f6a099df2c2f8ea8be1b5f270064e864991beb46cafdd7a949f3d5c28f
-  data.tar.gz: e96d35aa10121df4325f45908276e65af1413d900e508b7d9064cae608f74dc0033886a80e139eac313114e93e6ff7a2215f2282739b660ce4a5ebff0a6c67ef
+  metadata.gz: df89614d08202bce01cc9f9be6d0fe3bd03a763672016ef363a0666a70e08625c6babed6d5969344496334d1aa5f59ef9584bf4e10b1b8f1b39a60d648d8b3b0
+  data.tar.gz: 4fea613dea946a99e5376f6b691eaf6112c1f21d8116497a44e0cc67aba0ddb081a766941b9a1fb8922e40160e451791984a2c06176670fce9f979556fc730bd

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## [1.1.0](https://github.com/fog/fog-proxmox/compare/v1.0.0...v1.1.0) (2026-10-21)
+
+
+### Features
+
+* Add hotplug support ([#158](https://github.com/fog/fog-proxmox/issues/158)) ([0745f60](https://github.com/fog/fog-proxmox/commit/0745f6013003af9d0b1ec7304749a5c52038fa62))
+* Add VirtIO RNG device support ([#160](https://github.com/fog/fog-proxmox/issues/160)) ([a31b9d3](https://github.com/fog/fog-proxmox/commit/a31b9d39927d82b2db9da6c1889b9fd556905b5c))
+
+
+### Bug Fixes
+
+* ISO upload task polling ([3dc3c31](https://github.com/fog/fog-proxmox/commit/3dc3c31fe8cd72fc719954917dad39afa6b08ebd))
+
+## [1.0.0](https://github.com/fog/fog-proxmox/compare/v0.16.2...v1.0.0) (2026-09-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* Add support for ISO uploads via Proxmox API ([#148](https://github.com/fog/fog-proxmox/issues/148))
+
+### Features
+
+* Add support for ISO uploads via Proxmox API ([#148](https://github.com/fog/fog-proxmox/issues/148)) ([396d08c](https://github.com/fog/fog-proxmox/commit/396d08c573feceda8443072d2c76cffd3c2a4918))
+
+
+### Bug Fixes
+
+* RuboCop extra spacing offenses ([#149](https://github.com/fog/fog-proxmox/issues/149)) ([9a303bc](https://github.com/fog/fog-proxmox/commit/9a303bc03a3d5049ded43d3ad1fa6ea79febd43e))
+
+
+### Miscellaneous Chores
+
+* allow major releases before 1.0 ([#156](https://github.com/fog/fog-proxmox/issues/156)) ([0752d55](https://github.com/fog/fog-proxmox/commit/0752d55fcfa0628c452c3bc7d7a137e341c8da4a))
+
 ## [0.16.2](https://github.com/fog/fog-proxmox/compare/v0.16.1...v0.16.2) (2026-08-12)
 
 

data/README.md

@@ -2,14 +2,14 @@
 
 # Fog::Proxmox
 
-![CI](https://github.com/fog/fog-proxmox/workflows/CI/badge.svg)
+[![CI](https://github.com/fog/fog-proxmox/actions/workflows/ci.yml/badge.svg)](https://github.com/fog/fog-proxmox/actions/workflows/ci.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/maintainability)](https://codeclimate.com/github/fog/fog-proxmox/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/dfcdcc32f096abf1b2b4/test_coverage)](https://codeclimate.com/github/fog/fog-proxmox/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/fog-proxmox.svg)](https://badge.fury.io/rb/fog-proxmox)
 
-This is a [FOG](http://fog.io/) (>= 2.1) module gem to support [Proxmox VE](https://www.proxmox.com/en/proxmox-ve)
+This is a [FOG](https://fog.github.io/) (>= 2.1) module gem to support [Proxmox VE](https://www.proxmox.com/en/proxmox-ve)
 
-It is intended to satisfy this [feature](https://github.com/fog/fog/issues/3644), but Proxmox provider only, and above all this [Foreman](http://www.theforeman.org) [feature](https://projects.theforeman.org/issues/2186).
+It is intended to satisfy this [feature](https://github.com/fog/fog/issues/3644), but Proxmox provider only, and above all this [Foreman](https://www.theforeman.org) [feature](https://projects.theforeman.org/issues/2186).
 
 It is inspired by the great [fog-openstack](https://github.com/fog/fog-openstack) module.
 
@@ -102,7 +102,7 @@ bundle exec rake --tasks
 ## Contributing
 
 You can reach the [contributors](.github/CONTRIBUTORS.md).
-Bug reports and pull requests are welcome on GitHub at [Fog-Proxmox](https://github.com/fog/fog-proxmox/issues). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at [Fog-Proxmox](https://github.com/fog/fog-proxmox/issues). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org) code of conduct.
 
 Please read [how to contribute](.github/CONTRIBUTING.md).
 

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+module Fog
+  module Proxmox
+    # An IO-like multipart body that streams a file between a prefix and suffix.
+    class MultipartBody
+      attr_reader :size
+
+      def initialize(prefix, file, suffix)
+        @prefix = prefix
+        @file = file
+        @suffix = suffix
+        @size = prefix.bytesize + file_size + suffix.bytesize
+        rewind
+      end
+
+      def read(length = nil, outbuf = nil)
+        length = @size - @position if length.nil?
+        raise ArgumentError, 'negative length' if length.negative?
+
+        result = ::String.new(encoding: Encoding::BINARY)
+        read_into(result, length)
+        result = nil if result.empty? && length.positive? && @part > 2
+
+        return result unless outbuf
+
+        outbuf.replace(result || '')
+        result && outbuf
+      end
+
+      def rewind
+        @file.rewind
+        @part = 0
+        @offset = 0
+        @position = 0
+        0
+      end
+
+      def binmode
+        @file.binmode if @file.respond_to?(:binmode)
+        self
+      end
+
+      private
+
+      def file_size
+        return @file.size if @file.respond_to?(:size)
+        return @file.stat.size if @file.respond_to?(:stat)
+
+        raise ArgumentError, 'Upload file size cannot be determined'
+      end
+
+      def read_into(result, length)
+        while result.bytesize < length && @part <= 2
+          remaining = length - result.bytesize
+          chunk = @part == 1 ? @file.read(remaining) : read_string_part(remaining)
+
+          if chunk.nil? || chunk.empty?
+            @part += 1
+            @offset = 0
+          else
+            result << chunk
+            @position += chunk.bytesize
+          end
+        end
+      end
+
+      def read_string_part(length)
+        string = @part.zero? ? @prefix : @suffix
+        chunk = string.byteslice(@offset, length)
+        @offset += chunk.bytesize if chunk
+        chunk
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# 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 'securerandom'
+require 'excon'
+require 'fog/proxmox/compute/models/multipart_body'
+
+module Fog
+  module Proxmox
+    # Prepares a streamed multipart ISO upload and its content type.
+    class MultipartIsoUpload
+      attr_reader :body, :content_type
+
+      def initialize(body_params)
+        filename = body_params.fetch(:filename)
+        raise ArgumentError, "Invalid ISO filename: #{filename}" unless filename.match?(/\A[a-zA-Z0-9][a-zA-Z0-9._-]*\.iso\z/i)
+
+        file = body_params.fetch(:file)
+
+        boundary = '-' * 30 + SecureRandom.hex(15)
+        prefix = build_multipart_content(boundary, 'content', 'iso')
+        prefix << build_multipart_header(boundary, 'filename', filename: filename)
+        @body = MultipartBody.new(prefix, file, build_multipart_closing(boundary))
+
+        @content_type = "multipart/form-data; boundary=#{boundary}"
+      end
+
+      private
+
+      def build_multipart_header(boundary, name, filename: nil)
+        newline = Excon::CR_NL
+        header = ::String.new(encoding: Encoding::BINARY)
+        header << "--#{boundary}#{newline}"
+        header << %(Content-Disposition: form-data; name="#{name}")
+        header << %(; filename="#{filename}") if filename
+        header << newline
+        header << "Content-Type: application/octet-stream#{newline}" if filename
+        header << newline
+      end
+
+      def build_multipart_content(boundary, name, value)
+        build_multipart_header(boundary, name) << value << Excon::CR_NL
+      end
+
+      def build_multipart_closing(boundary)
+        "#{Excon::CR_NL}--#{boundary}--#{Excon::CR_NL}".b
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# 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/helpers/rng_helper'
+
+module Fog
+  module Proxmox
+    class Compute
+      # VirtIO RNG device; period is in milliseconds and max_bytes is in bytes.
+      class Rng < Fog::Model
+        attribute :max_bytes
+        attribute :period
+        attribute :source
+
+        def flatten
+          Fog::Proxmox::RngHelper.flatten(attributes)
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ require 'fog/proxmox/attributes'
 require 'fog/proxmox/helpers/nic_helper'
 require 'fog/proxmox/helpers/controller_helper'
 require 'fog/proxmox/helpers/efidisk_helper'
+require 'fog/proxmox/helpers/rng_helper'
 
 module Fog
   module Proxmox
@@ -41,6 +42,7 @@ module Fog
         attribute :onboot
         attribute :boot
         attribute :agent
+        attribute :hotplug
         attribute :scsihw
         attribute :sockets
         attribute :memory
@@ -80,6 +82,7 @@ module Fog
         attribute :searchdomain
         attribute :nameserver
         attribute :efidisk
+        attribute :rng
 
         def initialize(new_attributes = {})
           prepare_service_value(new_attributes)
@@ -88,6 +91,7 @@ module Fog
           initialize_interfaces(new_attributes)
           initialize_disks(new_attributes)
           initialize_efidisk(new_attributes)
+          initialize_rng(new_attributes)
           super(new_attributes)
         end
 
@@ -103,9 +107,10 @@ module Fog
         end
 
         def flatten
-          flat_hash = attributes.reject { |attribute| %i[node_id type vmid disks interfaces].include? attribute }
+          flat_hash = attributes.reject { |attribute| %i[node_id type vmid disks interfaces rng].include? attribute }
           flat_hash.merge(interfaces_flatten)
           flat_hash.merge(disks_flatten)
+          flat_hash.merge!(rng.flatten) unless rng.nil?
           flat_hash
         end
 
@@ -166,6 +171,14 @@ module Fog
           efidisk_hash = Fog::Proxmox::EfidiskHelper.extract(efidisk)
           attributes[:efidisk] = Fog::Proxmox::Compute::Efidisk.new(efidisk_hash)
         end
+
+        def initialize_rng(new_attributes)
+          rng = new_attributes[:rng0] || new_attributes['rng0']
+          return if rng.nil?
+
+          rng_hash = Fog::Proxmox::RngHelper.extract(rng)
+          attributes[:rng] = Fog::Proxmox::Compute::Rng.new(rng_hash)
+        end
       end
     end
   end

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

@@ -26,6 +26,8 @@
 
 # frozen_string_literal: true
 
+require 'fog/proxmox/storage/models/iso_upload'
+
 module Fog
   module Proxmox
     class Compute
@@ -53,6 +55,10 @@ module Fog
           super(new_attributes)
         end
 
+        def upload_iso(path)
+          Fog::Proxmox::Storage::IsoUpload.new(service: service, node_id: node_id, storage_id: identity, path: path).upload
+        end
+
         private
 
         def initialize_volumes

data/lib/fog/proxmox/compute.rb

@@ -37,6 +37,7 @@ module Fog
       model :disk
       collection :disks
       model :efidisk
+      model :rng
       model :server_config
       model :volume
       collection :volumes

data/lib/fog/proxmox/core.rb

@@ -93,8 +93,8 @@ module Fog
         begin
           authenticate! if expired?
           request_options = params.merge(path: "#{@path}/#{params[:path]}",
-                                         headers: @auth_token.headers(
-                                           params[:method], params.respond_to?(:headers) ? params[:headers] : {}, {}
+                                         headers: (params[:headers] || {}).merge(
+                                           @auth_token.headers(params[:method], {}, {})
                                          ))
           response = @connection.request(request_options)
         rescue Excon::Errors::Unauthorized => e
@@ -102,6 +102,7 @@ module Fog
           if !%w[Bad username or password, invalid token
                  value!].include?(e.response.body) && @proxmox_can_reauthenticate && !retried
             authenticate!
+            params[:body].rewind if params[:body].respond_to?(:rewind)
             retried = true
             retry
           # bad credentials or token renewal not possible

data/lib/fog/proxmox/helpers/agent_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+module Fog
+  module Proxmox
+    # Convert guest agent settings to and from Proxmox configuration strings.
+    module AgentHelper
+      DEFAULTS = {
+        'enabled' => '0',
+        'freeze-fs-on-backup' => '1',
+        'fstrim_cloned_disks' => '0',
+        'type' => 'virtio'
+      }.freeze
+
+      def self.extract(agent)
+        settings = DEFAULTS.dup
+        agent.to_s.split(',').each do |option|
+          key, value = option.split('=', 2)
+          if value.nil?
+            settings['enabled'] = key
+          else
+            settings[key] = value
+          end
+        end
+
+        settings['freeze-fs-on-backup'] = settings.fetch('freeze-fs', settings['freeze-fs-on-backup'])
+        settings
+      end
+
+      def self.flatten(settings)
+        "enabled=#{settings['enabled']},freeze-fs-on-backup=#{settings['freeze-fs-on-backup']}," \
+          "fstrim_cloned_disks=#{settings['fstrim_cloned_disks']},type=#{settings['type']}"
+      end
+    end
+  end
+end

data/lib/fog/proxmox/helpers/hotplug_helper.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# 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/>.
+
+module Fog
+  module Proxmox
+    # Convert hotplug settings to and from Proxmox configuration strings.
+    module HotplugHelper
+      DEVICES = %w[disk network usb cpu memory].freeze
+      DEFAULTS = %w[disk network usb].freeze
+
+      def self.extract(hotplug)
+        hotplug = hotplug.to_s
+        {
+          enabled: hotplug != '0',
+          devices: hotplug.empty? || hotplug == '1' ? DEFAULTS.dup : hotplug.split(',')
+        }
+      end
+
+      def self.flatten(settings)
+        return '0' unless settings[:enabled]
+
+        devices = DEVICES.select { |device| settings[:devices].include?(device) }
+        devices.empty? ? '0' : devices.join(',')
+      end
+    end
+  end
+end

data/lib/fog/proxmox/helpers/rng_helper.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# 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/hash'
+
+module Fog
+  module Proxmox
+    # Convert RNG devices to and from Proxmox configuration strings
+    module RngHelper
+      RNG_SOURCES = %w[/dev/urandom /dev/random /dev/hwrng].freeze
+
+      def self.flatten(rng)
+        return {} if rng.nil?
+
+        options = rng.select do |key, value|
+          %i[max_bytes period source].include?(key) && !value.nil? && value != ''
+        end
+
+        validate(options)
+
+        { rng0: Fog::Proxmox::Hash.stringify(options) }
+      end
+
+      def self.validate(rng)
+        raise ArgumentError, 'RNG source is required and must be /dev/urandom, /dev/random, or /dev/hwrng' unless RNG_SOURCES.include?(rng[:source].to_s)
+
+        %i[max_bytes period].each do |key|
+          next if rng[key].nil? || rng[key] == ''
+          next if rng[key].to_s.match?(/\A[0-9]+\z/)
+
+          raise ArgumentError, "RNG #{key} must be a non-negative integer"
+        end
+
+        true
+      end
+
+      def self.extract(rng)
+        options = rng.split(',').each_with_object({}) do |option, values|
+          key, value = option.split('=', 2)
+          values[key.to_sym] = value&.sub(/\A"(.*)"\z/, '\1')
+        end
+
+        options.slice(:max_bytes, :period, :source)
+      end
+    end
+  end
+end

data/lib/fog/proxmox/storage/models/iso_upload.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Fog
+  module Proxmox
+    class Storage
+      # Uploads a local ISO and waits for the Proxmox task to finish.
+      class IsoUpload < Fog::Model
+        attribute :node_id
+        attribute :storage_id
+        attribute :path
+
+        def upload
+          requires :node_id, :storage_id, :path
+
+          filename = File.basename(path)
+          size = File.size(path)
+          Fog::Logger.debug("Starting Proxmox ISO upload filename=#{filename} size=#{size} bytes node=#{node_id} storage=#{storage_id}")
+          response = File.open(path, 'rb') do |file|
+            Fog::Proxmox::Storage.new(service.config).upload_iso(
+              { node: node_id, storage: storage_id },
+              { filename: filename, file: file }
+            )
+          end
+          Fog::Logger.debug("Upload response: #{response.inspect}")
+          task_node = response.to_s[/\AUPID:([^:]+):/, 1]
+          raise Fog::Errors::Error, "Unexpected upload response: #{response.inspect}" unless task_node
+
+          service.nodes.get(task_node).tasks.wait_for(response)
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/proxmox/storage/requests/upload_iso.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# 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/compute/models/multipart_iso_upload'
+
+module Fog
+  module Proxmox
+    class Storage
+      # class Real upload_iso request
+      class Real
+        def upload_iso(path_params, body_params)
+          node = path_params[:node]
+          storage = path_params[:storage]
+          upload = MultipartIsoUpload.new(body_params)
+
+          request(
+            expects: [200],
+            method: 'POST',
+            path: "nodes/#{node}/storage/#{storage}/upload",
+            body: upload.body,
+            headers: { 'Content-Type' => upload.content_type }
+          )
+        end
+      end
+
+      # class Mock upload_iso request
+      class Mock
+        def upload_iso(_path_params, _body_params); end
+      end
+    end
+  end
+end