Skip to content

Add --container-subvolume-relpath flag for init #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
muir wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add --container-subvolume-relpath flag for init #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3351e9
Add --container-subvolume-relpath flag for init
muir Feb 21, 2021
3557dd6
Merge branch 'masc3d:master' into master
muir Mar 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,11 @@ init
argument)
-c, --compress enables compression during transmission. Requires lzop
to be installed on both source and destination
-csr container-subvolume-relpath, --container-subvolume-relpath container-subvolume-relpath
Name of the non-visible subvolume relative path on
the source side where metadata and backups are stored.
This can only be set with init. Setting this is only
required when the same source subvolume is being backed up to more than one location.

run
---
Expand Down
12 changes: 12 additions & 0 deletions btrfs_sxbackup/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
from btrfs_sxbackup.core import Location
from btrfs_sxbackup.core import Job
from btrfs_sxbackup.core import Configuration
from btrfs_sxbackup.core import DEFAULT_CONTAINER_RELPATH
from btrfs_sxbackup.retention import RetentionExpression
from btrfs_sxbackup import mail
from btrfs_sxbackup import __version__
Expand Down Expand Up @@ -74,6 +75,15 @@
'metavar': 'subvolume',
'help': 'backup job source or destination subvolume. local path or SSH url'}

container_subvolume_args = ['-csr', '--container-subvolume-relpath']
container_subvolume_kwargs = {'type': str,
'metavar': 'container-subvolume-relpath',
'default': DEFAULT_CONTAINER_RELPATH,
'help': 'Name of the non-visible subvolume relative path on the source'
' side where metadata and backups are stored. This can only be'
' set with init. Setting this is only required when the same'
' source subvolume is being backed up to more than one location.'}

# Initialize command cmdline params
p_init = subparsers.add_parser(_CMD_INIT, help='initialize backup job')
p_init.add_argument('source_subvolume', type=str, metavar='source-subvolume',
Expand All @@ -83,6 +93,7 @@
p_init.add_argument(*source_retention_args, **source_retention_kwargs)
p_init.add_argument(*destination_retention_args, **destination_retention_kwargs)
p_init.add_argument(*compress_args, **compress_kwargs)
p_init.add_argument(*container_subvolume_args, **container_subvolume_kwargs)

p_destroy = subparsers.add_parser(_CMD_DESTROY, help='destroy backup job by removing configuration files from source'
' and destination. backup snapshots will be kept on both sides'
Expand Down Expand Up @@ -227,6 +238,7 @@ def handle_exception(ex: Exception):
dest_url=urllib.parse.urlsplit(args.destination_subvolume) if args.destination_subvolume
else None,
dest_retention=destination_retention,
container_subvolume_relpath=args.container_subvolume_relpath,
compress=args.compress)

elif args.command == _CMD_UPDATE:
Expand Down
9 changes: 5 additions & 4 deletions btrfs_sxbackup/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
_logger = logging.getLogger(__name__)
_DEFAULT_RETENTION_SOURCE = RetentionExpression('3')
_DEFAULT_RETENTION_DESTINATION = RetentionExpression('2d: 1/d, 2w:3/w, 1m:1/w, 2m:none')
_DEFAULT_CONTAINER_RELPATH = '.sxbackup'
DEFAULT_CONTAINER_RELPATH = '.sxbackup'


class Error(Exception):
Expand Down Expand Up @@ -380,7 +380,7 @@ def __init__(self, url: parse.SplitResult, location_type=None,
self.location_type = location_type

if self.location_type == JobLocation.TYPE_SOURCE and container_subvolume_relpath is None:
self.container_subvolume_relpath = _DEFAULT_CONTAINER_RELPATH
self.container_subvolume_relpath = DEFAULT_CONTAINER_RELPATH
else:
self.container_subvolume_relpath = container_subvolume_relpath

Expand Down Expand Up @@ -791,6 +791,7 @@ def init(source_url: parse.SplitResult,
source_retention: RetentionExpression = None,
dest_retention: RetentionExpression = None,
compress: bool = None,
container_subvolume_relpath: str = DEFAULT_CONTAINER_RELPATH,
identical_filesystem: bool = False) -> 'Job':
"""
Initializes a new backup job
Expand All @@ -802,7 +803,7 @@ def init(source_url: parse.SplitResult,
:return: Backup job
:rtype: Job
"""
source = JobLocation(source_url, location_type=JobLocation.TYPE_SOURCE)
source = JobLocation(source_url, location_type=JobLocation.TYPE_SOURCE, container_subvolume_relpath=container_subvolume_relpath)
dest = JobLocation(dest_url, location_type=JobLocation.TYPE_DESTINATION) if dest_url else None

if source.has_configuration():
Expand Down Expand Up @@ -893,7 +894,7 @@ def handle_error(e):
corresponding_location = None
try:
if not location.has_configuration():
location.container_subvolume_relpath = _DEFAULT_CONTAINER_RELPATH
location.container_subvolume_relpath = DEFAULT_CONTAINER_RELPATH

corresponding_location = location.read_configuration()
except subprocess.CalledProcessError:
Expand Down