feat(commands): Add `mount` command by aawsome · Pull Request #973 · rustic-rs/rustic

aawsome · 2023-12-26T00:28:03Z

This PR adds the mount command to rustic to access snapshot contents as a read-only filesystem when the feature-flag mount is chosen.

As for the webdav command, there are following options:

Access to a concrete snapshot/path, e.g. rustic mount /mnt 37a63e5b:/my/path.
Access to all snapshots (maybe restricted by filters) by using templates to define a virtual directory structure where snapshots are located. Example: rustic mount /mnt --path-template "[{hostname}]/[{label}]/{time}" --time-template "%Y-%m-%d_%H-%M-%S" (these are also defined as default). Note that for all dirs containing only snapshots, also a latest entry is generated. latest and identical subsequent snapshots are symlinks when using mount.

This PR uses fuse_mt which is not optimal as it introduces some overhead (e.g. needs to save whole Paths in-memory).

Note: Requires rustic-rs/rustic_core#331 to properly show all data of files (without it builds and runs, but files are truncated and return error when reading).

Note: Building with the mount feature flag requires special dependencies and is only possible on supported platforms, see https://github.com/cberner/fuser

closes #971

src/commands/mount/fs.rs

src/commands/mount.rs

src/commands/mount/fs.rs

src/commands/mount.rs

aawsome · 2024-10-13T22:58:37Z

This PR is now ready but we may want to add the feature flag in our build-pipelines on selected targets (and include the dependencies) - in another PR.

src/commands/mount.rs

src/commands/mount/fusefs.rs

aawsome · 2024-10-20T12:09:06Z

rebased on top of #1329

src/commands/mount.rs

simonsan · 2024-10-20T12:57:23Z

Some things that I think we should do to prepare for this PR:

add build support in CI/CD
- add to be installed dependencies to OS build matrix
- add feature flags to OS build matrix

simonsan · 2024-11-11T20:56:18Z

config/full.toml

+[mount]
+path-template = "[{hostname}]/[{label}]/{time}" # The path template to use for snapshots. {id}, {id_long}, {time}, {username}, {hostname}, {label}, {tags}, {backup_start}, {backup_end} are replaced. [default: "[{hostname}]/[{label}]/{time}"]. Only relevant if no snapshot-path is given.
+time-template = "%Y-%m-%d_%H-%M-%S" # only relevant if no snapshot-path is given
+no-allow-other = true


Would name that exclusive = true or exclusive-mount = true

simonsan · 2024-11-11T20:58:14Z

src/commands/mount/fusefs.rs

+        fh: u64,
+        offset: u64,
+        size: u32,
+


simonsan · 2024-11-11T20:59:53Z

src/commands/mount.rs

+    /// Don't allow other users to access the mount point
+    #[clap(long)]
+    #[merge(strategy=conflate::bool::overwrite_false)]
+    no_allow_other: bool,


Same as above, exclusive_mount or exclusive is better I think.

simonsan · 2024-11-11T21:00:10Z

src/commands/mount.rs

+    /// The mount point to use
+    #[clap(value_name = "PATH")]
+    #[merge(strategy=conflate::option::overwrite_none)]
+    mountpoint: Option<PathBuf>,


mount_point

#1353) Addresses review feedback from #973 --------- Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

## 🤖 New release * `rustic-rs`: 0.9.4 -> 0.9.5 (✓ API compatible changes) <details><summary>Changelog</summary> <blockquote> ## [0.9.5](v0.9.4...v0.9.5) - 2024-12-02 ### Added - *(commands)* More dump options ([#1339](#1339)) - shut down gracefully with ctrl+c ([#1364](#1364)) - Add --filter-jq option ([#1372](#1372)) - *(async)* use `is_async_compatible()` to determine backend incompatibility and error out ([#1355](#1355)) - *(commands)* Add `mount` command ([#973](#973)) ### Fixed - *(commands)* run backup hooks before checking source dir ([#1374](#1374)) - *(commands)* Use spawn_blocking in webdav when calling rustic_core ([#1365](#1365)) - *(filesystem)* Use channels to communicate within webdav filesystem ([#1361](#1361)) ### Other - Add documentation for `minutely` keep option ([#1371](#1371)) - update snapshots to include minutely configuration options - *(deps)* update rustic_core, bytes, and libc dependencies to latest versions - simplify lifetime annotations in OpenFileReader and TreeIterItem implementations - clean up whitespace and update clippy linting allowances - *(deps)* update dependencies to latest versions - *(deps)* update lockfile to get rid of vulnerable `url` version - *(mount)* rename fields for clarity, add user options for mount ([#1353](#1353)) - *(deps)* update dependencies - *(deps)* don't use rustic_core webdav feature ([#1367](#1367)) - Revert "fix(filesystem): Use channels to communicate within webdav filesystem ([#1361](#1361))" - Revert "feat(async): use `is_async_compatible()` to determine backend incompatibility and error out ([#1355](#1355))" - move `webdavfs` from `rustic_core` to `rustic-rs` ([#1363](#1363)) - *(clippy)* comment out unused lints in lib.rs - *(clippy)* apply fixes automatically - use BTreeMap for env in global options ([#1360](#1360)) - add tiny framework for testing rustic's compat with latest restic ([#1303](#1303)) - use snapshot tests for default config, show-config and completions ([#1359](#1359)) - *(deps)* update dependencies rustic_core, rustic_backend, rustic_testing, and migrate to conflate 0.3 ([#1357](#1357)) - fix typos - *(build)* add platform-dependent settings and remove ci flag for extra features - clarify `--use-profile` command in config by using long form ([#1344](#1344)) - *(deps)* update core and testing crates ([#1340](#1340)) </blockquote> </details> --- This PR was generated with [release-plz](https://github.com/MarcoIeni/release-plz/). --------- Co-authored-by: rustic-release-plz[bot] <182542030+rustic-release-plz[bot]@users.noreply.github.com> Co-authored-by: Alexander Weiss <alex@weissfam.de>

aawsome changed the title ~~Add mount command~~ WIP: Add mount command Dec 26, 2023

aawsome mentioned this pull request Dec 26, 2023

Make mount command available on more platforms #971

Open

aawsome force-pushed the mount branch from 7adcdfe to 84ccf79 Compare December 26, 2023 12:30

simonsan reviewed Dec 26, 2023

View reviewed changes

src/commands/mount/fs.rs Show resolved Hide resolved

simonsan reviewed Dec 26, 2023

View reviewed changes

src/commands/mount.rs Outdated Show resolved Hide resolved

jjedelsky reviewed Jan 3, 2024

View reviewed changes

src/commands/mount/fs.rs Outdated Show resolved Hide resolved

src/commands/mount.rs Outdated Show resolved Hide resolved

aawsome changed the title ~~WIP: Add mount command~~ WIP: Add mount&webdav command Jan 10, 2024

aawsome force-pushed the mount branch from 187c8d6 to 33c3feb Compare January 10, 2024 09:12

aawsome force-pushed the mount branch from 33c3feb to ab77d51 Compare January 20, 2024 15:44

simonsan mentioned this pull request Jan 28, 2024

mount command for oli apache/opendal#4083

Closed

aawsome changed the title ~~WIP: Add mount&webdav command~~ WIP: Add mount command Jan 28, 2024

aawsome marked this pull request as draft January 29, 2024 00:13

aawsome force-pushed the mount branch from ab77d51 to e2fb461 Compare June 16, 2024 23:07

aawsome marked this pull request as ready for review June 19, 2024 06:40

aawsome force-pushed the mount branch 2 times, most recently from e528c44 to 0b938fe Compare October 13, 2024 22:42

aawsome mentioned this pull request Oct 13, 2024

feat: add FuseFs rustic-rs/rustic_core#156

Closed

3 tasks

aawsome requested review from jjedelsky and simonsan October 13, 2024 22:59

aawsome added the S-waiting-for-review Status: PRs waiting for review label Oct 13, 2024

simonsan changed the title ~~WIP: Add mount command~~ feat: Add mount command Oct 14, 2024

simonsan reviewed Oct 14, 2024

View reviewed changes

src/commands/mount.rs Outdated Show resolved Hide resolved

src/commands/mount.rs Outdated Show resolved Hide resolved

src/commands/mount/fusefs.rs Show resolved Hide resolved

src/commands/mount/fusefs.rs Outdated Show resolved Hide resolved

simonsan changed the title ~~feat: Add mount command~~ feat(commands): Add mount command Oct 20, 2024

simonsan added C-enhancement Category: New feature or request A-commands Area: Related to commands in `rustic` labels Oct 20, 2024

aawsome added 4 commits October 20, 2024 13:51

fix: clippy lints for new Rust version

1575685

feat: Add mount command

6fdee2f

Add config file support

6c6651b

add BSD-2 to allowed licences

8b763a8

aawsome added 3 commits October 20, 2024 14:07

Allow config entries without features mount/webdav

043c257

add file-access option

339ff87

use box

9f2bfde

aawsome force-pushed the mount branch from e4f0cb4 to 9f2bfde Compare October 20, 2024 12:08

simonsan reviewed Oct 20, 2024

View reviewed changes

src/commands/mount.rs Outdated Show resolved Hide resolved

simonsan added 2 commits October 20, 2024 14:51

Update src/commands/mount.rs

6ed4e12

Merge branch 'main' into mount

2c2a7fe

simonsan added 2 commits October 30, 2024 02:12

Merge branch 'main' into mount

fa2f94b

Merge branch 'main' into mount

839ad55

simonsan removed the S-waiting-for-review Status: PRs waiting for review label Nov 10, 2024

simonsan approved these changes Nov 10, 2024

View reviewed changes

simonsan enabled auto-merge November 10, 2024 20:42

simonsan added this pull request to the merge queue Nov 10, 2024

Merged via the queue into main with commit bb107be Nov 10, 2024

simonsan deleted the mount branch November 10, 2024 21:04

rustic-release-plz bot mentioned this pull request Nov 10, 2024

chore: release v0.9.5 #1341

Merged

simonsan reviewed Nov 11, 2024

View reviewed changes

simonsan mentioned this pull request Nov 11, 2024

refactor(mount): rename fields for clarity, add user options for mount #1353

Merged

github-merge-queue bot pushed a commit that referenced this pull request Nov 25, 2024

refactor(mount): rename fields for clarity, add user options for mount (

1bdb914

#1353) Addresses review feedback from #973 --------- Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(commands): Add `mount` command#973

feat(commands): Add `mount` command#973
simonsan merged 11 commits intomainfrom
mount

aawsome commented Dec 26, 2023 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aawsome commented Oct 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aawsome commented Oct 20, 2024

Uh oh!

Uh oh!

simonsan commented Oct 20, 2024 •

edited

Loading

Uh oh!

simonsan Nov 11, 2024

Uh oh!

simonsan Nov 11, 2024

Uh oh!

simonsan Nov 11, 2024

Uh oh!

simonsan Nov 11, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

aawsome commented Dec 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aawsome commented Oct 13, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aawsome commented Oct 20, 2024

Uh oh!

Uh oh!

simonsan commented Oct 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simonsan Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

simonsan Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

simonsan Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

simonsan Nov 11, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aawsome commented Dec 26, 2023 •

edited

Loading

simonsan commented Oct 20, 2024 •

edited

Loading