kamal-backup 0.1.0.pre.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b0a9aca508a2247ae1f44ae5cb3eab3366dcb2f47c80681c67890e0ad60a2fd
-  data.tar.gz: 16208b98365aeccabd346cd5ba150797ecff0c98e86a8592b71c8c882af67c42
+  metadata.gz: 7135af9b16454829f69ed19ca84d58045232e5db583cc54cbc1fe623bf80c4f6
+  data.tar.gz: 8f70a9143faec5b730e3e9d70a33b4bed4f1f650815f81c97c303766151fd2af
 SHA512:
-  metadata.gz: dd46bd886c0f59413ad0762aa4a252d9e3a6ed721bc54c53e2a81ba88b80a9da40272b52c19792817ffabd2a92903db00eab0aa2bdd0d63917745955e5c7ffc2
-  data.tar.gz: '057386894dadb84c3afbd73b6949ab749873df06c8470f32e32a02036b8facf195067cd8652d13dd920110aa95e14462c275586a1de7c92e8b32823dedb1cf77'
+  metadata.gz: a919c1e57b6061ce588bd73d00b87eeff13e7b312b3da1bf05d8263116eadc119facc2fedadcba62d21a4d0983835bb52b89486eb13beeeffb3673588ec39845
+  data.tar.gz: 64739bbaac082b4266d37b2dfbd70d4ad53c7010a825a037126ff4b9cfb828c0968d2dd1045c25cd82fab5371864a2405c10c0edee99152948131f8d8112bf38

data/README.md

@@ -59,6 +59,8 @@ For most Rails apps, that is enough. `restore local` and `drill local` can infer
 
 Only create `config/kamal-backup.local.yml` if you need to override those local defaults.
 
+Local restore and drill also require the `restic` binary on your machine. The backup accessory image already includes `restic` for production-side commands.
+
 Then add the backup accessory to `config/deploy.yml`:
 
 ```yaml
@@ -193,6 +195,8 @@ You still provide the local secrets yourself in env:
 - `POSTGRES_PASSWORD` or `MYSQL_PWD` when needed
 - `RESTIC_REPOSITORY` when it is not visible through `kamal config`
 
+And you need `restic` installed locally and available on `PATH`.
+
 Example:
 
 ```sh
@@ -217,6 +221,8 @@ It prompts locally, then shells out through Kamal to the backup accessory.
 bundle exec kamal-backup -d production drill local latest --check "bin/rails runner 'puts User.count'"
 ```
 
+Like `restore local`, this runs on your machine and requires a local `restic` install.
+
 `drill production` restores into scratch targets on production infrastructure. It does not touch the live production database:
 
 ```sh

data/lib/kamal_backup/app.rb

@@ -29,6 +29,7 @@ module KamalBackup
 
     def backup
       config.validate_backup
+      require_restic!
 
       timestamp = current_timestamp
       restic.ensure_repository
@@ -48,6 +49,7 @@ module KamalBackup
 
     def restore_to_local_machine(snapshot = "latest")
       validate_local_machine_restore
+      require_restic!
 
       build_restore_result("local", snapshot) do |result|
         adapter = database
@@ -63,6 +65,7 @@ module KamalBackup
 
     def restore_to_production(snapshot = "latest")
       validate_production_restore
+      require_restic!
 
       build_restore_result("production", snapshot) do |result|
         adapter = database
@@ -77,6 +80,7 @@ module KamalBackup
 
     def drill_on_local_machine(snapshot = "latest", check_command: nil)
       validate_local_machine_restore
+      require_restic!
 
       run_drill("local", snapshot, check_command: check_command) do |result|
         adapter = database
@@ -92,6 +96,7 @@ module KamalBackup
 
     def drill_on_production(snapshot = "latest", database_name: nil, sqlite_path: nil, file_target: "/restore/files", check_command: nil)
       validate_production_drill(file_target, database_name, sqlite_path)
+      require_restic!
 
       run_drill("production", snapshot, check_command: check_command) do |result|
         adapter = database
@@ -113,16 +118,19 @@ module KamalBackup
 
     def snapshots
       config.validate_restic
+      require_restic!
       restic.snapshots.stdout
     end
 
     def check
       config.validate_restic
+      require_restic!
       restic.check.stdout
     end
 
     def evidence
       config.validate_restic
+      require_restic!
       @evidence_class.new(config, restic: restic, redactor: redactor).to_json
     end
 
@@ -312,6 +320,14 @@ module KamalBackup
         config.validate_local_database_restore_target(adapter.current_target_identifier)
       end
 
+      def require_restic!
+        return unless using_builtin_restic?
+        return if Command.available?("restic")
+
+        raise ConfigurationError,
+          "restic is required on PATH for commands that run on this machine. Install restic locally and try again."
+      end
+
       def run_drill_check(command)
         result = Command.capture(
           CommandSpec.new(argv: ["sh", "-lc", command]),
@@ -347,6 +363,10 @@ module KamalBackup
         @restic ||= Restic.new(config, redactor: redactor)
       end
 
+      def using_builtin_restic?
+        @restic.nil? || @restic.is_a?(Restic)
+      end
+
       def database
         @database ||= Databases::Base.build(config, redactor: redactor)
       end

data/lib/kamal_backup/cli.rb

@@ -329,6 +329,7 @@ module KamalBackup
       puts deploy_snippet
       puts
       puts "For most Rails apps, restore local and drill local can infer the development database, storage path, and tmp state directory."
+      puts "Local restore and drill also require the restic binary on your machine."
       puts "Create config/kamal-backup.local.yml only if you need to override those local defaults."
     end
 

data/lib/kamal_backup/command.rb

@@ -26,6 +26,13 @@ module KamalBackup
 
   class Command
     class << self
+      def available?(name)
+        ENV.fetch("PATH", "").split(File::PATH_SEPARATOR).any? do |dir|
+          path = File.join(dir, name)
+          File.executable?(path) && !File.directory?(path)
+        end
+      end
+
       def capture(spec, input: nil, redactor:)
         stdout, stderr, status = Open3.capture3(spec.env, *spec.argv, stdin_data: input)
         result = CommandResult.new(stdout: stdout, stderr: stderr, status: status.exitstatus)

data/lib/kamal_backup/databases/base.rb

@@ -88,10 +88,7 @@ module KamalBackup
         end
 
         def executable_available?(name)
-          ENV.fetch("PATH", "").split(File::PATH_SEPARATOR).any? do |dir|
-            path = File.join(dir, name)
-            File.executable?(path) && !File.directory?(path)
-          end
+          Command.available?(name)
         end
     end
   end

data/lib/kamal_backup/version.rb

@@ -1,3 +1,3 @@
 module KamalBackup
-  VERSION = "0.1.0.pre.10"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kamal-backup
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.10
+  version: 0.1.0
 platform: ruby
 authors:
 - crmne