nixos/restic: correct location of cache directory #99579
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cole-h
requested review from
jerith666 and
Mic92
and removed request for
cole-h
|
Looks quite reasonable. I merged it locally and will report back after I see whether a couple of nightly backups work okay. |
jerith666
approved these changes
Jan 28, 2021
|
Do we have to take care of the now stale And if so, what approach could be used to handle this? |
|
Good point. We could add a release note, not sure what else to do beyond that. |
|
+1 to a release note. |
eliasp
force-pushed
the
restic-cache-directory
branch
from
0415014
to
f46cf9e
Compare
|
I added a release note and amended it into the existing commit. |
eliasp
force-pushed
the
restic-cache-directory
branch
from
f46cf9e
to
ca45de4
Compare
ofborg
bot
added
8.has: changelog
8.has: documentation
10.rebuild-linux: 1-10
10.rebuild-linux: 1
and removed
10.rebuild-linux: 0
labels
cole-h
reviewed
Jan 29, 2021
By default, restic determines the location of the cache based on the XDG base dir specification, which is `~/.cache/restic` when the environment variable `$XDG_CACHE_HOME` isn't set. As restic is executed as root by default, this resulted in the cache being written to `/root/.cache/restic`, which is not quite right for a system service and also meant, multiple backup services would use the same cache directory - potentially causing issues with locking, data corruption, etc. The goal was to ensure, restic uses the correct cache location for a system service - one cache per backup specification, using `/var/cache` as the base directory for it. systemd sets the environment variable `$CACHE_DIRECTORY` once `CacheDirectory=` is defined, but restic doesn't change its behavior based on the presence of this environment variable. Instead, the specifier [1] `%C` can be used to point restic explicitly towards the correct cache location using the `--cache-dir` argument. Furthermore, the `CacheDirectoryMode=` was set to `0700`, as the default of `0755` is far too open in this case, as the cache might contain sensitive data. [1] https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Specifiers
eliasp
force-pushed
the
restic-cache-directory
branch
from
ca45de4
to
3b1de09
Compare
|
Also, thanks for such a great commit message. We should all strive to be as detailed as you were :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation for this change
By default, restic determines the location of the cache based on the XDG
base dir specification, which is
~/.cache/resticwhen the environmentvariable
$XDG_CACHE_HOMEisn't set.As restic is executed as root by default, this resulted in the cache being
written to
/root/.cache/restic, which is not quite right for a systemservice and also meant, multiple backup services would use the same cache
directory - potentially causing issues with locking, data corruption,
etc.
The goal was to ensure, restic uses the correct cache location for a
system service - one cache per backup specification, using
/var/cacheas the base directory for it.
systemd sets the environment variable
$CACHE_DIRECTORYonceCacheDirectory=is defined, but restic doesn't change its behaviorbased on the presence of this environment variable.
Instead, the specifier [1]
%Ccan be used to point restic explicitlytowards the correct cache location using the
--cache-dirargument.Furthermore, the
CacheDirectoryMode=was set to0700, as the defaultof
0755is far too open in this case, as the cache might containsensitive data.
[1] https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Specifiers
Things done
sandboxinnix.confon non-NixOS linux)nix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)