deprecate snapshot backups

theforeman · Oct 9, 2023 · ff8d4f2 · ff8d4f2
1 parent b02a519
commit ff8d4f2
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 1 deletion.
diff --git a/definitions/procedures/backup/snapshot/snapshot_deprecation_message.rb b/definitions/procedures/backup/snapshot/snapshot_deprecation_message.rb
@@ -0,0 +1,14 @@
+module Procedures::Backup
+  module Snapshot
+    class SnapshotDeprecationMessage < ForemanMaintain::Check
+      metadata do
+        description 'Snapshot backups are deprecated'
+        tags :backup
+      end
+
+      def run
+        set_warn('Snapshot backups are deprecated and will be removed in a future version.')
+      end
+    end
+  end
+end
diff --git a/definitions/scenarios/backup.rb b/definitions/scenarios/backup.rb
@@ -21,6 +21,7 @@ class Backup < ForemanMaintain::Scenario
 
     def compose
       check_valid_startegy
+      snapshot_deprecation_warning
       safety_confirmation
       accessibility_confirmation
       prepare_directory
@@ -110,6 +111,12 @@ def logical_volume_confirmation
       end
     end
 
+    def snapshot_deprecation_warning
+      if strategy == :snapshot
+        add_step_with_context(Procedures::Backup::Snapshot::SnapshotDeprecationMessage)
+      end
+    end
+
     def accessibility_confirmation
       if [:offline, :snapshot].include?(strategy)
         add_step_with_context(Procedures::Backup::AccessibilityConfirmation)

diff --git a/lib/foreman_maintain/cli/backup_command.rb b/lib/foreman_maintain/cli/backup_command.rb
@@ -155,7 +155,7 @@ def execute
     class BackupCommand < Base
       subcommand 'online', 'Keep services online during backup', OnlineBackupCommand
       subcommand 'offline', 'Shut down services to preserve consistent backup', OfflineBackupCommand
-      subcommand 'snapshot', 'Use snapshots of the databases to create backup', SnapshotBackupCommand
+      subcommand 'snapshot', 'Use snapshots of the databases to create backup (DEPRECATED)', SnapshotBackupCommand
     end
     # rubocop:enable Metrics/LineLength
   end