kamal-backup 0.4.1 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -0
- data/lib/kamal_backup/cli.rb +9 -8
- data/lib/kamal_backup/config.rb +4 -1
- data/lib/kamal_backup/rails_app.rb +0 -7
- data/lib/kamal_backup/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0442e12748359ee182d6fc91e5573375440c31a5a65ccf1b46079547b8e4bc21
|
|
4
|
+
data.tar.gz: 9af03ddf3ad23b99b77c717711dc66cde34bc17500e66e776aff50ca2678e653
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ccd324da250d8a36f623a6c65c9cf000c80e4fbcc0308944c1074c67ce9422e1e637c55e672160399078944c83c281ccec25ff17a63d1181ed28045244a2d674
|
|
7
|
+
data.tar.gz: 80f64be478843d1695cdfa34c899ba614ee7ed45a10853f521c08ee568f003f3b0045809ef1ff0c1217e5ec834d2a607888963998af64f9643886048f0e65bf1
|
data/README.md
CHANGED
|
@@ -99,6 +99,8 @@ backup:
|
|
|
99
99
|
schedule: 1d
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
+
Only paths explicitly listed under `paths` are included in file snapshots. Omit `paths` for a database-only backup; `kamal-backup` never infers `storage` from Rails.
|
|
103
|
+
|
|
102
104
|
Boot it. The container runs `kamal-backup schedule` by default:
|
|
103
105
|
|
|
104
106
|
```sh
|
data/lib/kamal_backup/cli.rb
CHANGED
|
@@ -26,15 +26,15 @@ module KamalBackup
|
|
|
26
26
|
CLI.basename
|
|
27
27
|
end
|
|
28
28
|
|
|
29
|
-
desc 'local [SNAPSHOT]', 'Restore the backup into the local database and
|
|
29
|
+
desc 'local [SNAPSHOT]', 'Restore the backup into the local database and configured file paths'
|
|
30
30
|
def local(snapshot = 'latest')
|
|
31
|
-
confirm!("Restore #{snapshot} into the local database and
|
|
31
|
+
confirm!("Restore #{snapshot} into the local database and configured file paths? This will overwrite local data.")
|
|
32
32
|
puts(JSON.pretty_generate(local_restore_app.restore_to_local_machine(snapshot)))
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
method_option :"confirm-production-restore", type: :boolean, default: false,
|
|
36
36
|
desc: 'Confirm production restore without interactive prompts'
|
|
37
|
-
desc 'production [SNAPSHOT]', 'Restore the backup into the production database and
|
|
37
|
+
desc 'production [SNAPSHOT]', 'Restore the backup into the production database and configured file paths'
|
|
38
38
|
def production(snapshot = 'latest')
|
|
39
39
|
confirm_production_restore!(snapshot)
|
|
40
40
|
|
|
@@ -133,7 +133,7 @@ module KamalBackup
|
|
|
133
133
|
class_option :config_file, aliases: '-c', type: :string, desc: 'Path to Kamal deploy config file'
|
|
134
134
|
class_option :destination, aliases: '-d', type: :string, desc: 'Kamal destination to use'
|
|
135
135
|
remove_command :tree
|
|
136
|
-
desc 'restore SUBCOMMAND ...ARGS', 'Restore
|
|
136
|
+
desc 'restore SUBCOMMAND ...ARGS', 'Restore database and configured file backups locally or into production'
|
|
137
137
|
subcommand 'restore', RestoreCLI
|
|
138
138
|
desc 'drill SUBCOMMAND ...ARGS', 'Run a restore drill on the local machine or on production infrastructure'
|
|
139
139
|
subcommand 'drill', DrillCLI
|
|
@@ -162,7 +162,7 @@ module KamalBackup
|
|
|
162
162
|
|
|
163
163
|
method_option :force, type: :boolean, default: false,
|
|
164
164
|
desc: 'Run a backup even if the configured schedule is not due'
|
|
165
|
-
desc 'backup', 'Run a due database and
|
|
165
|
+
desc 'backup', 'Run a due database and configured file backup'
|
|
166
166
|
def backup
|
|
167
167
|
if remote_command_mode?
|
|
168
168
|
argv = %w[kamal-backup backup]
|
|
@@ -238,10 +238,11 @@ module KamalBackup
|
|
|
238
238
|
puts
|
|
239
239
|
puts deploy_snippet
|
|
240
240
|
puts
|
|
241
|
-
puts 'The accessory runs scheduled database and file backups with backup.schedule.'
|
|
242
|
-
puts '
|
|
241
|
+
puts 'The accessory runs scheduled database and configured file backups with backup.schedule.'
|
|
242
|
+
puts 'File backups run only for paths explicitly configured in config/kamal-backup.yml.'
|
|
243
|
+
puts 'Rails local restores infer the development database and tmp state directory, but never file paths.'
|
|
243
244
|
puts 'Local restore and drill also require the restic binary on your machine.'
|
|
244
|
-
puts '
|
|
245
|
+
puts 'When production paths are configured, set their local targets in config/kamal-backup.local.yml.'
|
|
245
246
|
end
|
|
246
247
|
|
|
247
248
|
desc 'schedule', 'Run the foreground scheduler loop'
|
data/lib/kamal_backup/config.rb
CHANGED
|
@@ -214,7 +214,10 @@ module KamalBackup
|
|
|
214
214
|
source_paths = local_restore_source_paths
|
|
215
215
|
target_paths = backup_paths
|
|
216
216
|
|
|
217
|
-
|
|
217
|
+
unless source_paths.size == target_paths.size
|
|
218
|
+
raise ConfigurationError,
|
|
219
|
+
'local file paths must be explicitly configured and match the number of production restore source paths'
|
|
220
|
+
end
|
|
218
221
|
|
|
219
222
|
source_paths.zip(target_paths)
|
|
220
223
|
end
|
|
@@ -22,9 +22,6 @@ module KamalBackup
|
|
|
22
22
|
{}.tap do |defaults|
|
|
23
23
|
defaults.merge!(deploy_defaults)
|
|
24
24
|
defaults.merge!(database_defaults)
|
|
25
|
-
|
|
26
|
-
defaults['BACKUP_PATHS'] = local_storage_path if local_storage_path
|
|
27
|
-
|
|
28
25
|
defaults['KAMAL_BACKUP_STATE_DIR'] = File.join(@cwd, 'tmp', 'kamal-backup')
|
|
29
26
|
end
|
|
30
27
|
end
|
|
@@ -90,10 +87,6 @@ module KamalBackup
|
|
|
90
87
|
end
|
|
91
88
|
end
|
|
92
89
|
|
|
93
|
-
def local_storage_path
|
|
94
|
-
File.join(@cwd, 'storage')
|
|
95
|
-
end
|
|
96
|
-
|
|
97
90
|
def local_database_config
|
|
98
91
|
environment = fetch(parsed_yaml(database_config_path), DEVELOPMENT_ENV)
|
|
99
92
|
return nil unless environment.is_a?(Hash)
|
data/lib/kamal_backup/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: kamal-backup
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.4.
|
|
4
|
+
version: 0.4.2
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- crmne
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-
|
|
11
|
+
date: 2026-08-10 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: thor
|