kamal-backup 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0442e12748359ee182d6fc91e5573375440c31a5a65ccf1b46079547b8e4bc21
-  data.tar.gz: 9af03ddf3ad23b99b77c717711dc66cde34bc17500e66e776aff50ca2678e653
+  metadata.gz: aa8276219db8c5d8aa820e85e0f289f87715889cb5ea18ae2c99e3e12bbfe6b9
+  data.tar.gz: 626824ed56029bf3b713676d3376ab38d571942ee3809e7cf18abbfde9c24a45
 SHA512:
-  metadata.gz: ccd324da250d8a36f623a6c65c9cf000c80e4fbcc0308944c1074c67ce9422e1e637c55e672160399078944c83c281ccec25ff17a63d1181ed28045244a2d674
-  data.tar.gz: 80f64be478843d1695cdfa34c899ba614ee7ed45a10853f521c08ee568f003f3b0045809ef1ff0c1217e5ec834d2a607888963998af64f9643886048f0e65bf1
+  metadata.gz: 75d362d35409c0447c29994a7bf4d23ac47d287fc88621eb46f32a56296537217cee76a28799983f45154361ecd61e4f553b609144969bed2b10016bf0ecc09c
+  data.tar.gz: e5f664a15123066441b940d945caed2335d8b50356acaa64d9ae6f49d87a7705894234e55db42ec6508aa188f727b01d4e4d4c71688ecd93b4dbf4c12d53ef5d

data/lib/kamal_backup/app.rb

@@ -32,6 +32,7 @@ module KamalBackup
     def backup(force: false)
       started_at = Time.now.utc
       config.validate_backup
+      return disabled_backup_result(started_at) unless config.backup_enabled? || force
       return skipped_backup_result(started_at) unless force || backup_due?(started_at)
 
       restic.ensure_repository
@@ -136,6 +137,18 @@ module KamalBackup
       due_at.nil? || now >= due_at
     end
 
+    def disabled_backup_result(now)
+      Schema.record(
+        kind: 'backup_result',
+        status: 'skipped',
+        reason: 'disabled',
+        last_backup_at: last_backup_finished_at&.iso8601,
+        next_backup_at: nil,
+        force_command: 'kamal-backup backup --force',
+        finished_at: now.iso8601
+      )
+    end
+
     def skipped_backup_result(now)
       Schema.record(
         kind: 'backup_result',

data/lib/kamal_backup/cli/helpers.rb

@@ -140,6 +140,13 @@ module KamalBackup
       end
 
       def print_backup_result(result)
+        if result[:status] == 'skipped' && result[:reason] == 'disabled'
+          puts('Backups are disabled for this app (backup.enabled is false).')
+          puts('Set backup.enabled to true and redeploy the accessory to resume scheduled backups.')
+          puts("Run `#{result.fetch(:force_command)}` to take one anyway.")
+          return
+        end
+
         if result[:status] == 'skipped'
           puts("No backup due. Last backup finished at #{result.fetch(:last_backup_at)}.")
           puts("Next backup is due at #{result.fetch(:next_backup_at)}.")

data/lib/kamal_backup/config.rb

@@ -168,6 +168,10 @@ module KamalBackup
       truthy?('KAMAL_BACKUP_ALLOW_SUSPICIOUS_PATHS')
     end
 
+    def backup_enabled?
+      !falsey?('BACKUP_ENABLED')
+    end
+
     def backup_schedule_seconds
       integer('BACKUP_SCHEDULE_SECONDS', 86_400, minimum: 1)
     end

data/lib/kamal_backup/config_file.rb

@@ -271,6 +271,7 @@ module KamalBackup
       hash = require_mapping(raw_value, "#{@path} backup")
       env = {}
       env['BACKUP_SCHEDULE_SECONDS'] = normalize_duration(hash['schedule'], "#{@path} backup.schedule") if hash.key?('schedule')
+      env['BACKUP_ENABLED'] = normalize_value(hash['enabled']) if hash.key?('enabled')
       env.compact
     end
 

data/lib/kamal_backup/scheduler.rb

@@ -15,6 +15,17 @@ module KamalBackup
       $stderr.sync = true
 
       install_signal_handlers
+
+      unless @config.backup_enabled?
+        # Stay up rather than exit: the accessory is still how restore, list, check and
+        # evidence reach the repository, and exiting would restart-loop under Kamal's
+        # `--restart unless-stopped`. Set backup.enabled to true and redeploy to resume.
+        log('scheduled backups are disabled (backup.enabled is false); no backups will be taken')
+        idle_until_stopped
+        log("scheduler stopped at #{Time.now.utc.iso8601}")
+        return
+      end
+
       sleep_interruptibly(@config.backup_start_delay_seconds)
 
       until @stop
@@ -43,6 +54,10 @@ module KamalBackup
       end
     end
 
+    def idle_until_stopped
+      sleep 1 until @stop
+    end
+
     def sleep_interruptibly(seconds)
       deadline = Time.now + seconds
       sleep([deadline - Time.now, 1].min) while !@stop && Time.now < deadline

data/lib/kamal_backup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KamalBackup
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - crmne