foreman_snapshot_management 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c83f5919e167daeb69e987e53f4ed94d675e2b597656a76615fa1b61df2ae5
-  data.tar.gz: cea57fad2f2a0695feac2f7aa61a6d610832d22851b0be29d26851c56ed2823d
+  metadata.gz: 5349e63284eef13c5d08260ac71b060ef9bcb8b6bac2e31143d511bf8de66a3b
+  data.tar.gz: 7eec5ae8a7a406c464d1d074375af37caf4c7bbff814edb5fe6c3a66497c47b2
 SHA512:
-  metadata.gz: fbe7a8c72a88ee6c92cd4fae4b43db8a389acb1ef6aa52677e4fea1191f1ac89b5124bc9000b3b080eb06ecbf10eda3d7c4d10e45277eab73b133169fbd34ab0
-  data.tar.gz: 5ba063a1df005739f04ea692cdc07b01e2878a6a478c34b7590d12f04af9ddda517736602987b27df85c52fe964a4508248f1ac7e095e761400da47aab844139
+  metadata.gz: 523ca42d75b0c24a08351a39c912fee62cc388e65ffa930830361d213eae1e50fd17539b53ad22cc894060fb83dac4382042949b670e6fba5df05cd5b18c25d9
+  data.tar.gz: 59f74f5ede323d8cbe3d8a3e625be541af7ffebc98104a5890e54d80712e0e4ececf5a8451af2fd85aaf0e98e12c8680e8192c12734afb13c8f39e341fa7dc2d

data/README.md

@@ -27,14 +27,6 @@ For more information, see [Installing the Snapshot Management Plug-in](https://d
 | >= 3.13         | >= 4.0.0       |
 | >= 3.7          | >= 3.0.0       |
 | >= 2.3          | >= 2.0.0       |
-| 1.24            | >= 1.7.0       |
-| 1.23            | >= 1.7.0       |
-| 1.22            | >= 1.6.0       |
-| 1.21            | >= 1.5.0       |
-| 1.20            | >= 1.5.0       |
-| 1.19            | >= 1.5.0       |
-| 1.18            | >= 1.5.0       |
-| 1.17            | >= 1.5.0       |
 
 ## Usage
 
@@ -230,7 +222,7 @@ curl -s -u "$AUTH" \
 Fork and send a Pull Request. Thanks!
 
 ## Copyright
-Copyright (c) 2024 ATIX AG - http://www.atix.de
+Copyright (c) 2025 ATIX AG - http://www.atix.de
 
 This program 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.
 

data/app/assets/javascripts/foreman_snapshot_management/locale/cs_CZ/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Pavel Borecki <pavel.borecki@gmail.com>, 2022",

data/app/assets/javascripts/foreman_snapshot_management/locale/de/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Wiederoder <stefanwiederoder@googlemail.com>, 2022",

data/app/assets/javascripts/foreman_snapshot_management/locale/el/foreman_snapshot_management.js

@@ -3,10 +3,10 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
-        "Last-Translator": "Efstathios Iosifidis <iefstathios@gmail.com>, 2022",
+        "Last-Translator": "Efstathios Iosifidis <eiosifidis@gmail.com>, 2022",
         "Language-Team": "Greek (https://app.transifex.com/foreman/teams/114/el/)",
         "MIME-Version": "1.0",
         "Content-Type": "text/plain; charset=UTF-8",

data/app/assets/javascripts/foreman_snapshot_management/locale/en/foreman_snapshot_management.js

@@ -3,10 +3,289 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
+        "Report-Msgid-Bugs-To": "",
+        "PO-Revision-Date": "2026-02-11 19:31+0000",
+        "Last-Translator": "FULL NAME <EMAIL@ADDRESS>",
+        "Language-Team": "LANGUAGE <LL@li.org>",
+        "Language": "",
+        "MIME-Version": "1.0",
+        "Content-Type": "text/plain; charset=UTF-8",
+        "Content-Transfer-Encoding": "8bit",
+        "Plural-Forms": "nplurals=INTEGER; plural=EXPRESSION;",
         "lang": "en",
         "domain": "foreman_snapshot_management",
-        "plural_forms": null
-      }
+        "plural_forms": "nplurals=INTEGER; plural=EXPRESSION;"
+      },
+      "%d snapshot succeeded, %d failed.": [
+        ""
+      ],
+      "%d snapshots succeeded, %d failed.": [
+        ""
+      ],
+      "%s host is selected for snapshot creation": [
+        ""
+      ],
+      "%s hosts are selected for snapshot creation": [
+        ""
+      ],
+      "Action": [
+        ""
+      ],
+      "Cancel": [
+        ""
+      ],
+      "Create": [
+        ""
+      ],
+      "Create Snapshot": [
+        ""
+      ],
+      "Create a snapshot": [
+        ""
+      ],
+      "Create snapshot": [
+        ""
+      ],
+      "Create snapshots for multiple hosts": [
+        ""
+      ],
+      "Created %{snapshots} for %{num} %{hosts}": [
+        ""
+      ],
+      "Creating...": [
+        ""
+      ],
+      "Delete": [
+        ""
+      ],
+      "Delete Snapshot \\\"%s\\\"?": [
+        ""
+      ],
+      "Delete a snapshot": [
+        ""
+      ],
+      "Description": [
+        ""
+      ],
+      "Description of the snapshot": [
+        ""
+      ],
+      "Description of this snapshot": [
+        ""
+      ],
+      "Error occurred while creating Snapshot for:%s": [
+        ""
+      ],
+      "Error occurred while creating Snapshot: %s": [
+        ""
+      ],
+      "Error occurred while removing Snapshot: %s": [
+        ""
+      ],
+      "Error occurred while rolling back VM: %s": [
+        ""
+      ],
+      "Error occurred while updating Snapshot: %s": [
+        ""
+      ],
+      "Failed hosts": [
+        ""
+      ],
+      "Failed to load snapshot list": [
+        ""
+      ],
+      "Failed to update Snapshot: %s": [
+        ""
+      ],
+      "Foreman-plugin to manage snapshots in a virtual-hardware environments.": [
+        ""
+      ],
+      "Host has no UUID, cannot create snapshot.": [
+        ""
+      ],
+      "Host has no compute resource, cannot create snapshot.": [
+        ""
+      ],
+      "ID of the organization": [
+        ""
+      ],
+      "Include RAM": [
+        ""
+      ],
+      "Invalid mode": [
+        ""
+      ],
+      "List all snapshots": [
+        ""
+      ],
+      "List of host ids to exclude and not run an action on": [
+        ""
+      ],
+      "List of host ids to perform an action on": [
+        ""
+      ],
+      "Loading Snapshots information ...": [
+        ""
+      ],
+      "N/A": [
+        ""
+      ],
+      "Name": [
+        ""
+      ],
+      "Name must contain at least 2 characters starting with alphabet. Valid characters are A-Z a-z 0-9 _": [
+        ""
+      ],
+      "Name of the snapshot": [
+        ""
+      ],
+      "Name of this snapshot": [
+        ""
+      ],
+      "No capable hosts found.": [
+        ""
+      ],
+      "No capable hosts selected": [
+        ""
+      ],
+      "No hosts were found with that id, name or query filter": [
+        ""
+      ],
+      "None": [
+        ""
+      ],
+      "Note: Not all selected hosts support quiesce. The quiesce option is disabled.": [
+        ""
+      ],
+      "Quiesce": [
+        ""
+      ],
+      "Revert Host to a snapshot": [
+        ""
+      ],
+      "Rollback": [
+        ""
+      ],
+      "Rollback to \\\"%s\\\"?": [
+        ""
+      ],
+      "Search string for hosts to perform an action on": [
+        ""
+      ],
+      "Select Snapshot Mode between mutually exclusive options, 'Memory' (includes RAM) and 'Quiesce'.": [
+        ""
+      ],
+      "Select Snapshot Mode between mutually exclusive options.": [
+        ""
+      ],
+      "Select snapshot mode": [
+        ""
+      ],
+      "Snapshot": [
+        "",
+        ""
+      ],
+      "Snapshot Mode": [
+        ""
+      ],
+      "Snapshot creation failed.": [
+        ""
+      ],
+      "Snapshot creation failed: %s": [
+        ""
+      ],
+      "Snapshot mode": [
+        ""
+      ],
+      "Snapshot mode: full (default), include_ram, or quiesce": [
+        ""
+      ],
+      "Snapshot name cannot be changed": [
+        ""
+      ],
+      "Snapshot parameters": [
+        ""
+      ],
+      "Snapshots": [
+        ""
+      ],
+      "Something went wrong while selecting hosts - %s": [
+        ""
+      ],
+      "Successfully removed Snapshot \\\"%s\\\" from host %s": [
+        ""
+      ],
+      "Successfully rolled back Snapshot \\\"%s\\\" on host %s": [
+        ""
+      ],
+      "Successfully triggered bulk snapshot creation": [
+        ""
+      ],
+      "Successfully triggered snapshot creation": [
+        ""
+      ],
+      "Successfully updated Snapshot \\\"%s\\\"": [
+        ""
+      ],
+      "Unable to create Proxmox Snapshot": [
+        ""
+      ],
+      "Unable to create VMWare Snapshot": [
+        ""
+      ],
+      "Unable to create VMWare Snapshot with Quiesce. Check Power and VMWare Tools status.": [
+        ""
+      ],
+      "Unable to create VMWare Snapshot. Cannot set both Memory and Quiesce options.": [
+        ""
+      ],
+      "Unable to remove Proxmox Snapshot": [
+        ""
+      ],
+      "Unable to remove VMWare Snapshot": [
+        ""
+      ],
+      "Unable to revert Proxmox Snapshot": [
+        ""
+      ],
+      "Unable to revert VMWare Snapshot": [
+        ""
+      ],
+      "Unable to update Proxmox Snapshot": [
+        ""
+      ],
+      "Unable to update VMWare Snapshot": [
+        ""
+      ],
+      "Update a snapshot": [
+        ""
+      ],
+      "VM details could not be retrieved from compute resource %s. The VM may be missing/deleted or inaccessible.": [
+        ""
+      ],
+      "VM successfully rolled back.": [
+        ""
+      ],
+      "Warning: In Select All mode, we cannot guarantee that all hosts support the quiesce option as the data is not available. If a host does not support quiesce, the snapshot creation may fail for that host.": [
+        ""
+      ],
+      "Whether to include the Quiesce state in the snapshot": [
+        ""
+      ],
+      "Whether to include the RAM state in the snapshot": [
+        ""
+      ],
+      "edit entry": [
+        ""
+      ],
+      "host": [
+        "",
+        ""
+      ],
+      "snapshot.name is required": [
+        ""
+      ]
     }
   }
-};
+};

data/app/assets/javascripts/foreman_snapshot_management/locale/fr/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Amit Upadhye <aupadhye@redhat.com>, 2023",

data/app/assets/javascripts/foreman_snapshot_management/locale/ja/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Amit Upadhye <aupadhye@redhat.com>, 2022",

data/app/assets/javascripts/foreman_snapshot_management/locale/ka/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Temuri Doghonadze <temuri.doghonadze@gmail.com>, 2022",

data/app/assets/javascripts/foreman_snapshot_management/locale/zh_CN/foreman_snapshot_management.js

@@ -3,7 +3,7 @@
   "locale_data": {
     "foreman_snapshot_management": {
       "": {
-        "Project-Id-Version": "foreman_snapshot_management 3.0.1",
+        "Project-Id-Version": "foreman_snapshot_management 4.1.1",
         "Report-Msgid-Bugs-To": "",
         "PO-Revision-Date": "2019-10-22 11:54+0000",
         "Last-Translator": "Amit Upadhye <aupadhye@redhat.com>, 2022",

data/app/controllers/api/v2/bulk_snapshots_controller.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Api
+  module V2
+    class BulkSnapshotsController < V2::BaseController
+      include ::Api::V2::BulkHostsExtension
+
+      SNAPSHOT_MODES = ForemanSnapshotManagement::Extensions::BulkHostsManager::SNAPSHOT_MODES
+
+      before_action :validate_snapshot, :validate_mode, :find_snapshotable_hosts, only: :create
+
+      api :POST, '/snapshots/bulk/create_snapshot', N_('Create snapshots for multiple hosts')
+
+      param :organization_id, :number, required: true, desc: N_('ID of the organization')
+
+      param :included, Hash, required: true, action_aware: true do
+        param :search, String, required: false,
+          desc: N_('Search string for hosts to perform an action on')
+        param :ids, Array, required: false,
+          desc: N_('List of host ids to perform an action on')
+      end
+
+      param :excluded, Hash, required: true, action_aware: true do
+        param :ids, Array, required: false,
+          desc: N_('List of host ids to exclude and not run an action on')
+      end
+
+      param :snapshot, Hash, desc: N_('Snapshot parameters'), required: true do
+        param :name, String, desc: N_('Name of the snapshot'), required: true
+        param :description, String, desc: N_('Description of the snapshot'), required: false
+      end
+
+      param :mode,
+        SNAPSHOT_MODES,
+        desc: N_('Snapshot mode: full (default), include_ram, or quiesce'),
+        required: false
+
+      def create
+        results = ::BulkHostsManager.new(hosts: @hosts).create_snapshots(
+          name: @snapshot_name,
+          description: @snapshot_description,
+          mode: params[:mode]
+        )
+
+        render_results(results)
+      end
+
+      private
+
+      def find_snapshotable_hosts
+        find_bulk_hosts(:create_snapshots, params)
+      end
+
+      def validate_mode
+        mode = params[:mode]
+        return true if mode.blank? || SNAPSHOT_MODES.include?(mode)
+
+        render(
+          json: {
+            error: _('Invalid mode'),
+            valid_modes: SNAPSHOT_MODES,
+          },
+          status: :unprocessable_entity
+        )
+        false
+      end
+
+      def validate_snapshot
+        snap = params[:snapshot] || {}
+        @snapshot_name = snap[:name].to_s.strip
+        @snapshot_description = snap[:description].to_s
+
+        return true if @snapshot_name.present?
+
+        render(
+          json: { error: _('snapshot.name is required') },
+          status: :unprocessable_entity
+        )
+        false
+      end
+
+      def render_results(results)
+        failed_hosts = results.select { |r| r[:status] == 'failed' }
+        failed_count = failed_hosts.length
+        status = failed_count.zero? ? :ok : :unprocessable_entity
+
+        render(
+          json: {
+            results: results.map { |r| r.except(:errors) },
+            total: results.length,
+            success_count: results.length - failed_count,
+            failed_count: failed_count,
+            failed_hosts: failed_hosts,
+          },
+          status: status
+        )
+      end
+
+      def resource_class
+        ::ForemanSnapshotManagement::Snapshot
+      end
+
+      def resource_name
+        'snapshot'
+      end
+    end
+  end
+end

data/app/controllers/foreman_snapshot_management/snapshots_controller.rb

@@ -14,6 +14,7 @@ module ForemanSnapshotManagement
     before_action :enumerate_snapshots, only: [:index]
     before_action :find_snapshot, only: %i[destroy revert update]
     helper_method :xeditable?
+    helper_method :available_snapshot_modes
 
     def xeditable?(_object = nil)
       true
@@ -186,6 +187,15 @@ module ForemanSnapshotManagement
       end
     end
 
+    def available_snapshot_modes
+      capable_hosts = @hosts.select { |h| h.compute_resource.capable?(:snapshot_include_quiesce) }
+      if capable_hosts.length < @hosts.length
+        { 'Include RAM' => 'memory' }
+      else
+        { 'Include RAM' => 'memory', 'Quiesce' => 'quiesce' }
+      end
+    end
+
     def check_snapshot_capability
       not_found unless @host.compute_resource&.capabilities&.include?(:snapshots)
     end

data/app/models/foreman_snapshot_management/extensions/bulk_hosts_manager.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module ForemanSnapshotManagement
+  module Extensions
+    module BulkHostsManager
+      extend ActiveSupport::Concern
+
+      SNAPSHOT_MODES = %w[full include_ram quiesce].freeze
+      QUIESCE_ERROR_MESSAGE =
+        _('Unable to create VMWare Snapshot with Quiesce. Check Power and VMWare Tools status.').freeze
+
+      def create_snapshots(name:, description:, mode:)
+        include_ram, quiesce = resolve_mode(mode)
+
+        @hosts.map do |host|
+          process_snapshot_for_host(
+            host: host,
+            name: name,
+            description: description,
+            include_ram: include_ram,
+            quiesce: quiesce
+          )
+        end
+      end
+
+      private
+
+      def resolve_mode(mode)
+        case mode
+        when 'include_ram'
+          [true, false]
+        when 'quiesce'
+          [false, true]
+        else
+          [false, false]
+        end
+      end
+
+      def process_snapshot_for_host(host:, name:, description:, include_ram:, quiesce:)
+        validation_error = validate_host(host)
+        return validation_error if validation_error
+
+        create_snapshot_for_host(host, name, description, include_ram, quiesce)
+      rescue ActiveRecord::RecordNotFound => e
+        handle_record_not_found(host, e)
+      rescue StandardError => e
+        handle_snapshot_error(host, e)
+      end
+
+      def validate_host(host)
+        if host.compute_resource.nil?
+          return {
+            host_id: host.id,
+            host_name: host.name,
+            status: 'failed',
+            errors: [_('Host has no compute resource, cannot create snapshot.')],
+          }
+        end
+
+        return if host.uuid.present?
+
+        {
+          host_id: host.id,
+          host_name: host.name,
+          status: 'failed',
+          errors: [_('Host has no UUID, cannot create snapshot.')],
+        }
+      end
+
+      def create_snapshot_for_host(host, name, description, include_ram, quiesce)
+        snapshot = ::ForemanSnapshotManagement::Snapshot.new(
+          name: name,
+          description: description,
+          include_ram: include_ram,
+          quiesce: quiesce,
+          host: host
+        )
+
+        if snapshot.create
+          { host_id: host.id, host_name: host.name, status: 'success' }
+        else
+          errors = snapshot.errors.full_messages
+          errors << QUIESCE_ERROR_MESSAGE if quiesce
+          { host_id: host.id, host_name: host.name, status: 'failed', errors: errors }
+        end
+      end
+
+      def handle_record_not_found(host, exception)
+        ::Foreman::Logging.exception(
+          "Failed to create snapshot for host #{host.name} (ID: #{host.id})",
+          exception
+        )
+
+        cr_name = host.compute_resource&.name
+        cr_name = "#{cr_name} " if cr_name.present?
+
+        msg =
+          _('VM details could not be retrieved from compute resource %s. The VM may be missing/deleted or inaccessible.') % cr_name
+
+        {
+          host_id: host.id,
+          host_name: host.name,
+          status: 'failed',
+          errors: [msg],
+        }
+      end
+
+      def handle_snapshot_error(host, exception)
+        ::Foreman::Logging.exception(
+          "Failed to create snapshot for host #{host.name} (ID: #{host.id})",
+          exception
+        )
+
+        {
+          host_id: host.id,
+          host_name: host.name,
+          status: 'failed',
+          errors: [_('Snapshot creation failed: %s') % exception.message],
+        }
+      end
+    end
+  end
+end

data/app/views/foreman_snapshot_management/snapshots/_index.html.erb

@@ -1,3 +1,4 @@
+<% if @host.compute_resource && @host.compute_resource.capabilities.include?(:snapshots) && authorized_for(:auth_object => @host, :permission => :view_snapshots) %>
 <%= react_component('SnapshotManagement', {
   host: @host,
   canCreate: authorized_for(:auth_object => @host, :permission => :create_snapshots),
@@ -11,3 +12,4 @@
     quiesceOption: @host.compute_resource.capable?(:snapshot_include_quiesce)
   }
 }) %> 
+<% end %>

data/app/views/foreman_snapshot_management/snapshots/select_multiple_host.html.erb

@@ -3,6 +3,7 @@
 <% if @hosts.empty? %>
   <%= _('No capable hosts selected') %>
 <% else %>
+  <% snapshot_modes = available_snapshot_modes %>
   <%= form_for :snapshot, :url => create_multiple_host_snapshots_path(:host_ids => @hosts.map{ | h| h.id}) do |f| %>
     <%= text_f f, :name,
       { :label => _("Snapshot")}
@@ -10,10 +11,10 @@
     <%= textarea_f f, :description,
       { :label => _("Description")}
     %>
-    <%= selectable_f f, :snapshot_mode, {'Quiesce' => 'quiesce', 'Include RAM' => 'memory'},
+    <%= selectable_f f, :snapshot_mode, snapshot_modes,
         {:include_blank => true}, {
         :label => _("Snapshot Mode"),
-        :label_help => _("Select Snapshot Mode between mutually exclusive options, 'Memory' (includes RAM) and 'Quiesce'."),
+        :label_help => _("Select Snapshot Mode between mutually exclusive options."),
         :onchange => "tfm.hosts.table.toggleMultipleOkButton(this)"} %>
   <% end %>
 <% end %>