1
0
Fork 0
mirror of https://github.com/restic/restic.git synced 2025-03-04 02:28:27 +00:00
restic/doc
Gilbert Gilb's 536ebefff4
feat(backends/s3): add warmup support before repacks and restores (#5173)
* feat(backends/s3): add warmup support before repacks and restores

This commit introduces basic support for transitioning pack files stored
in cold storage to hot storage on S3 and S3-compatible providers.

To prevent unexpected behavior for existing users, the feature is gated
behind new flags:

- `s3.enable-restore`: opt-in flag (defaults to false)
- `s3.restore-days`: number of days for the restored objects to remain
  in hot storage (defaults to `7`)
- `s3.restore-timeout`: maximum time to wait for a single restoration
  (default to `1 day`)
- `s3.restore-tier`: retrieval tier at which the restore will be
  processed. (default to `Standard`)

As restoration times can be lengthy, this implementation preemptively
restores selected packs to prevent incessant restore-delays during
downloads. This is slightly sub-optimal as we could process packs
out-of-order (as soon as they're transitioned), but this would really
add too much complexity for a marginal gain in speed.

To maintain simplicity and prevent resources exhautions with lots of
packs, no new concurrency mechanisms or goroutines were added. This just
hooks gracefully into the existing routines.

**Limitations:**

- Tests against the backend were not written due to the lack of cold
  storage class support in MinIO. Testing was done manually on
  Scaleway's S3-compatible object storage. If necessary, we could
  explore testing with LocalStack or mocks, though this requires further
  discussion.
- Currently, this feature only warms up before restores and repacks
  (prune/copy), as those are the two main use-cases I came across.
  Support for other commands may be added in future iterations, as long
  as affected packs can be calculated in advance.
- The feature is gated behind a new alpha `s3-restore` feature flag to
  make it explicit that the feature is still wet behind the ears.
- There is no explicit user notification for ongoing pack restorations.
  While I think it is not necessary because of the opt-in flag, showing
  some notice may improve usability (but would probably require major
  refactoring in the progress bar which I didn't want to start). Another
  possibility would be to add a flag to send restores requests and fail
  early.

See https://github.com/restic/restic/issues/3202

* ui: warn user when files are warming up from cold storage

* refactor: remove the PacksWarmer struct

It's easier to handle multiple handles in the backend directly, and it
may open the door to reducing the number of requests made to the backend
in the future.
2025-02-01 18:26:27 +00:00
..
_static docs: switch to gopher favicon 2020-02-13 00:09:37 +01:00
images/aws_s3
logo
man Update manpages and auto-completion 2024-09-05 21:25:21 +02:00
.gitignore
010_introduction.rst doc: move quickstart to docs 2023-07-23 17:32:37 +02:00
020_installation.rst bump required go version to 1.21 2024-08-10 19:16:10 +02:00
030_preparing_a_new_repo.rst azure: add support for hot, cool, or cool access tiers 2024-10-20 15:27:21 +05:30
040_backup.rst backup: allow excluding online-only cloud files 2025-01-13 21:11:23 +01:00
045_working_with_repos.rst doc: describe how to handle rewrite encoding error 2024-08-30 12:46:07 +02:00
047_tuning_backup_parameters.rst doc: fix tmpdir documentation for windows 2024-05-20 20:48:29 +02:00
050_restore.rst xattrs - restore all by default, doc/chglog update 2025-01-10 15:25:09 -05:00
060_forget.rst docs: mention that the oldest snapshot is marked oldest in the reasons of the forget comman 2024-09-07 15:07:23 +05:30
070_encryption.rst docs: explain meaning of asterisk when managing repository keys 2023-08-27 10:40:55 +02:00
075_scripting.rst tag: output the original ID and new snapshotID (#5144) 2025-01-14 18:57:47 +01:00
077_troubleshooting.rst doc: suggest to follow troubleshooting steps if check reports error 2024-07-05 20:04:25 +02:00
080_examples.rst docs(examples): Use restic binary from system path 2023-09-17 19:39:45 -07:00
090_participating.rst doc: Fix some links, focus less on implementation details 2023-03-13 00:23:15 +01:00
100_references.rst
110_talks.rst doc: Correct broken links 2023-03-22 17:37:58 +01:00
bash-completion.sh Update manpages and auto-completion 2024-10-27 16:37:19 +01:00
cache.rst Wording: change repo to repository 2022-07-08 20:05:35 +02:00
conf.py doc: add edit on github link 2025-01-31 18:53:03 +01:00
design.rst drop support for s3legacy layout 2024-08-31 17:25:24 +02:00
developer_information.rst docs: add instructions for verifying SLSA provenance of Docker images 2024-12-02 00:14:39 +05:30
faq.rst feat(backends/s3): add warmup support before repacks and restores (#5173) 2025-02-01 18:26:27 +00:00
fish-completion.fish Fix typos 2023-12-06 13:11:55 +01:00
index.rst Add troubleshooting documentation 2023-05-01 14:56:42 +02:00
Makefile
manual_rest.rst doc: fix typos 2024-08-30 12:45:20 +02:00
powershell-completion.ps1 Update manpages and auto-completion 2024-07-26 11:30:37 +02:00
requirements.txt
REST_backend.rst doc: remove blockquotes from unordered lists 2024-01-23 19:03:54 +01:00
test_irreducibility.gap
zsh-completion.zsh Update manpages and auto-completion 2023-07-31 20:23:24 +02:00