X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=pve-zsync;h=6ca2da16ef2ffe97b0ed3e2e4c3deed9ef31c393;hb=56ce1be3c7334a5bb76dde98074685da5d7480f4;hp=881b9c85cbfb98c6cd8a0e0341a4482ba4ad07c5;hpb=f06c336b2a3fd5f97a95cc48e9fe6b62d46e7e8f;p=pve-zsync.git diff --git a/pve-zsync b/pve-zsync index 881b9c8..6ca2da1 100755 --- a/pve-zsync +++ b/pve-zsync @@ -55,6 +55,8 @@ my $TARGETRE = qr!^(?:($HOSTRE):)?(\d+|(?:[\w\-_]+)(/.+)?)$!; my $DISK_KEY_RE = qr/^(?:(?:(?:virtio|ide|scsi|sata|efidisk|mp)\d+)|rootfs): /; +my $INSTANCE_ID = get_instance_id($$); + my $command = $ARGV[0]; if (defined($command) && $command ne 'help' && $command ne 'printpod') { @@ -81,6 +83,19 @@ sub check_bin { die "unable to find command '$bin'\n"; } +sub read_file { + my ($filename, $one_line_only) = @_; + + my $fh = IO::File->new($filename, "r") + or die "Could not open file ${filename}: $!\n"; + + my $text = $one_line_only ? <$fh> : [ <$fh> ]; + + close($fh); + + return $text; +} + sub cut_target_width { my ($path, $maxlen) = @_; $path =~ s@/+@/@g; @@ -137,15 +152,15 @@ sub get_status { return undef; } -sub check_pool_exists { - my ($target, $user) = @_; +sub check_dataset_exists { + my ($dataset, $ip, $user) = @_; my $cmd = []; - if ($target->{ip}) { - push @$cmd, 'ssh', "$user\@$target->{ip}", '--'; + if ($ip) { + push @$cmd, 'ssh', "$user\@$ip", '--'; } - push @$cmd, 'zfs', 'list', '-H', '--', $target->{all}; + push @$cmd, 'zfs', 'list', '-H', '--', $dataset; eval { run_cmd($cmd); }; @@ -156,6 +171,19 @@ sub check_pool_exists { return 1; } +sub create_file_system { + my ($file_system, $ip, $user) = @_; + + my $cmd = []; + + if ($ip) { + push @$cmd, 'ssh', "$user\@$ip", '--'; + } + push @$cmd, 'zfs', 'create', $file_system; + + run_cmd($cmd); +} + sub parse_target { my ($text) = @_; @@ -202,14 +230,9 @@ sub read_cron { return undef; } - my $fh = IO::File->new("< $CRONJOBS"); - die "Could not open file $CRONJOBS: $!\n" if !$fh; - - my @text = <$fh>; + my $text = read_file($CRONJOBS, 0); - close($fh); - - return encode_cron(@text); + return encode_cron(@{$text}); } sub parse_argv { @@ -226,6 +249,7 @@ sub parse_argv { method => undef, source_user => undef, dest_user => undef, + prepend_storage_id => undef, properties => undef, dest_config_path => undef, }; @@ -242,6 +266,7 @@ sub parse_argv { 'method=s' => \$param->{method}, 'source-user=s' => \$param->{source_user}, 'dest-user=s' => \$param->{dest_user}, + 'prepend-storage-id' => \$param->{prepend_storage_id}, 'properties' => \$param->{properties}, 'dest-config-path=s' => \$param->{dest_config_path}, ); @@ -266,6 +291,7 @@ sub add_state_to_job { $job->{state} = $state->{state}; $job->{lsync} = $state->{lsync}; $job->{vm_type} = $state->{vm_type}; + $job->{instance_id} = $state->{instance_id}; for (my $i = 0; $state->{"snap$i"}; $i++) { $job->{"snap$i"} = $state->{"snap$i"}; @@ -301,17 +327,19 @@ sub param_to_job { my $job = {}; my $source = parse_target($param->{source}); - my $dest = parse_target($param->{dest}) if $param->{dest}; + my $dest; + $dest = parse_target($param->{dest}) if $param->{dest}; $job->{name} = !$param->{name} ? "default" : $param->{name}; $job->{dest} = $param->{dest} if $param->{dest}; $job->{method} = "local" if !$dest->{ip} && !$source->{ip}; $job->{method} = "ssh" if !$job->{method}; $job->{limit} = $param->{limit}; - $job->{maxsnap} = $param->{maxsnap} if $param->{maxsnap}; + $job->{maxsnap} = $param->{maxsnap}; $job->{source} = $param->{source}; $job->{source_user} = $param->{source_user}; $job->{dest_user} = $param->{dest_user}; + $job->{prepend_storage_id} = !!$param->{prepend_storage_id}; $job->{properties} = !!$param->{properties}; $job->{dest_config_path} = $param->{dest_config_path} if $param->{dest_config_path}; @@ -329,28 +357,14 @@ sub read_state { return undef; } - my $fh = IO::File->new("< $STATE"); - die "Could not open file $STATE: $!\n" if !$fh; - - my $text = <$fh>; - my $states = decode_json($text); - - close($fh); - - return $states; + my $text = read_file($STATE, 1); + return decode_json($text); } sub update_state { my ($job) = @_; - my $text; - my $in_fh; - - eval { - $in_fh = IO::File->new("< $STATE"); - die "Could not open file $STATE: $!\n" if !$in_fh; - $text = <$in_fh>; - }; + my $text = eval { read_file($STATE, 1); }; my $out_fh = IO::File->new("> $STATE.new"); die "Could not open file ${STATE}.new: $!\n" if !$out_fh; @@ -365,6 +379,7 @@ sub update_state { if ($job->{state} ne "del") { $state->{state} = $job->{state}; $state->{lsync} = $job->{lsync}; + $state->{instance_id} = $job->{instance_id}; $state->{vm_type} = $job->{vm_type}; for (my $i = 0; $job->{"snap$i"} ; $i++) { @@ -382,9 +397,6 @@ sub update_state { close($out_fh); rename "$STATE.new", $STATE; - eval { - close($in_fh); - }; return $states; } @@ -399,12 +411,9 @@ sub update_cron { my $header = "SHELL=/bin/sh\n"; $header .= "PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin\n\n"; - my $fh = IO::File->new("< $CRONJOBS"); - die "Could not open file $CRONJOBS: $!\n" if !$fh; - - my @test = <$fh>; + my $current = read_file($CRONJOBS, 0); - while (my $line = shift(@test)) { + foreach my $line (@{$current}) { chomp($line); if ($line =~ m/source $job->{source} .*name $job->{name} /) { $updated = 1; @@ -429,11 +438,10 @@ sub update_cron { my $new_fh = IO::File->new("> ${CRONJOBS}.new"); die "Could not open file ${CRONJOBS}.new: $!\n" if !$new_fh; - die "can't write to $CRONJOBS.new\n" if !print($new_fh $text); + print $new_fh $text or die "can't write to $CRONJOBS.new: $!\n"; close ($new_fh); - die "can't move $CRONJOBS.new: $!\n" if !rename "${CRONJOBS}.new", $CRONJOBS; - close ($fh); + rename "${CRONJOBS}.new", $CRONJOBS or die "can't move $CRONJOBS.new: $!\n"; } sub format_job { @@ -457,6 +465,7 @@ sub format_job { $text .= " --verbose" if $job->{verbose}; $text .= " --source-user $job->{source_user}"; $text .= " --dest-user $job->{dest_user}"; + $text .= " --prepend-storage-id" if $job->{prepend_storage_id}; $text .= " --properties" if $job->{properties}; $text .= " --dest-config-path $job->{dest_config_path}" if $job->{dest_config_path}; $text .= "\n"; @@ -526,10 +535,12 @@ sub init { run_cmd(['ssh-copy-id', '-i', '/root/.ssh/id_rsa.pub', "$param->{source_user}\@$ip"]); } - die "Pool $dest->{all} does not exists\n" if !check_pool_exists($dest, $param->{dest_user}); + die "Pool $dest->{all} does not exist\n" + if !check_dataset_exists($dest->{all}, $dest->{ip}, $param->{dest_user}); if (!defined($source->{vmid})) { - die "Pool $source->{all} does not exists\n" if !check_pool_exists($source, $param->{source_user}); + die "Pool $source->{all} does not exist\n" + if !check_dataset_exists($source->{all}, $source->{ip}, $param->{source_user}); } my $vm_type = vm_exists($source, $param->{source_user}); @@ -584,6 +595,33 @@ sub destroy_job { }); } +sub get_instance_id { + my ($pid) = @_; + + my $stat = read_file("/proc/$pid/stat", 1) + or die "unable to read process stats\n"; + my $boot_id = read_file("/proc/sys/kernel/random/boot_id", 1) + or die "unable to read boot ID\n"; + + my $stats = [ split(/\s+/, $stat) ]; + my $starttime = $stats->[21]; + chomp($boot_id); + + return "${pid}:${starttime}:${boot_id}"; +} + +sub instance_exists { + my ($instance_id) = @_; + + if (defined($instance_id) && $instance_id =~ m/^([1-9][0-9]*):/) { + my $pid = $1; + my $actual_id = eval { get_instance_id($pid); }; + return defined($actual_id) && $actual_id eq $instance_id; + } + + return 0; +} + sub sync { my ($param) = @_; @@ -593,11 +631,16 @@ sub sync { eval { $job = get_job($param) }; if ($job) { - if (defined($job->{state}) && ($job->{state} eq "syncing" || $job->{state} eq "waiting")) { + my $state = $job->{state} // 'ok'; + $state = 'ok' if !instance_exists($job->{instance_id}); + + if ($state eq "syncing" || $state eq "waiting") { die "Job --source $param->{source} --name $param->{name} is already scheduled to sync\n"; } $job->{state} = "waiting"; + $job->{instance_id} = $INSTANCE_ID; + update_state($job); } }); @@ -636,6 +679,8 @@ sub sync { ($dest->{old_snap}, $dest->{last_snap}) = snapshot_get($source, $dest, $param->{maxsnap}, $param->{name}, $param->{dest_user}); + prepare_prepended_target($source, $dest, $param->{dest_user}) if defined($dest->{prepend}); + snapshot_add($source, $dest, $param->{name}, $date, $param->{source_user}, $param->{dest_user}); send_image($source, $dest, $param); @@ -655,6 +700,10 @@ sub sync { $source->{pool} = $disks->{$disk}->{pool}; $source->{path} = $disks->{$disk}->{path} if $disks->{$disk}->{path}; $source->{last_part} = $disks->{$disk}->{last_part}; + + $dest->{prepend} = $disks->{$disk}->{storage_id} + if $param->{prepend_storage_id}; + &$sync_path($source, $dest, $job, $param, $date); } if ($param->{method} eq "ssh" && ($source->{ip} || $dest->{ip})) { @@ -671,6 +720,7 @@ sub sync { eval { $job = get_job($param); }; if ($job) { $job->{state} = "error"; + delete $job->{instance_id}; update_state($job); } }); @@ -687,6 +737,7 @@ sub sync { $job->{state} = "ok"; } $job->{lsync} = $date; + delete $job->{instance_id}; update_state($job); } }); @@ -700,8 +751,7 @@ sub snapshot_get{ push @$cmd, 'ssh', "$dest_user\@$dest->{ip}", '--', if $dest->{ip}; push @$cmd, 'zfs', 'list', '-r', '-t', 'snapshot', '-Ho', 'name', '-S', 'creation'; - my $path = $dest->{all}; - $path .= "/$source->{last_part}" if $source->{last_part}; + my $path = target_dataset($source, $dest); push @$cmd, $path; my $raw; @@ -819,7 +869,7 @@ sub parse_disks { my @parameter = split(/,/,$1); foreach my $opt (@parameter) { - if ($opt =~ m/^(?:file=|volume=)?([^:]+:)([A-Za-z0-9\-]+)$/){ + if ($opt =~ m/^(?:file=|volume=)?([^:]+):([A-Za-z0-9\-]+)$/){ $disk = $2; $stor = $1; last; @@ -833,11 +883,13 @@ sub parse_disks { my $cmd = []; push @$cmd, 'ssh', "$user\@$ip", '--' if $ip; - push @$cmd, 'pvesm', 'path', "$stor$disk"; + push @$cmd, 'pvesm', 'path', "$stor:$disk"; my $path = run_cmd($cmd); - die "Get no path from pvesm path $stor$disk\n" if !$path; - + die "Get no path from pvesm path $stor:$disk\n" if !$path; + + $disks->{$num}->{storage_id} = $stor; + if ($vm_type eq 'qemu' && $path =~ m/^\/dev\/zvol\/(\w+.*)(\/$disk)$/) { my @array = split('/', $1); @@ -875,6 +927,35 @@ sub parse_disks { return $disks; } +# how the corresponding dataset is named on the target +sub target_dataset { + my ($source, $dest) = @_; + + my $target = "$dest->{all}"; + $target .= "/$dest->{prepend}" if defined($dest->{prepend}); + $target .= "/$source->{last_part}" if $source->{last_part}; + $target =~ s!/+!/!g; + + return $target; +} + +# create the parent dataset for the actual target +sub prepare_prepended_target { + my ($source, $dest, $dest_user) = @_; + + die "internal error - not a prepended target\n" if !defined($dest->{prepend}); + + # The parent dataset shouldn't be the actual target. + die "internal error - no last_part for source\n" if !$source->{last_part}; + + my $target = "$dest->{all}/$dest->{prepend}"; + $target =~ s!/+!/!g; + + return if check_dataset_exists($target, $dest->{ip}, $dest_user); + + create_file_system($target, $dest->{ip}, $dest_user); +} + sub snapshot_destroy { my ($source, $dest, $method, $snap, $source_user, $dest_user) = @_; @@ -894,8 +975,7 @@ sub snapshot_destroy { if ($dest) { my @ssh = $dest->{ip} ? ('ssh', "$dest_user\@$dest->{ip}", '--') : (); - my $path = "$dest->{all}"; - $path .= "/$source->{last_part}" if $source->{last_part}; + my $path = target_dataset($source, $dest); eval { run_cmd([@ssh, @zfscmd, "$path\@$snap"]); @@ -946,9 +1026,7 @@ sub send_image { my $bwl = $param->{limit}*1024; push @$cmd, \'|', 'cstream', '-t', $bwl; } - my $target = "$dest->{all}"; - $target .= "/$source->{last_part}" if $source->{last_part}; - $target =~ s!/+!/!g; + my $target = target_dataset($source, $dest); push @$cmd, \'|'; push @$cmd, 'ssh', '-o', 'BatchMode=yes', "$param->{dest_user}\@$dest->{ip}", '--' if $dest->{ip}; @@ -1052,108 +1130,96 @@ sub disable_job { my $cmd_help = { destroy => qq{ -$PROGNAME destroy -source [OPTIONS] - - remove a sync Job from the scheduler +$PROGNAME destroy --source [OPTIONS] - -name string + Remove a sync Job from the scheduler - name of the sync job, if not set it is default - - -source string + --name string + The name of the sync job, if not set 'default' is used. - the source can be an or [IP:][/Path] + --source string + The source can be an or [IP:][/Path] }, create => qq{ -$PROGNAME create -dest -source [OPTIONS] - - Create a sync Job - - -dest string - - the destination target is like [IP]:[/Path] - - -dest-user string +$PROGNAME create --dest --source [OPTIONS] - name of the user on the destination target, root by default + Create a new sync-job - -limit integer + --dest string + The destination target is like [IP]:[/Path] - max sync speed in kBytes/s, default unlimited + --dest-user string + The name of the user on the destination target, root by default - -maxsnap string + --limit integer + Maximal sync speed in kBytes/s, default is unlimited - how much snapshots will be kept before get erased, default 1 + --maxsnap integer + The number of snapshots to keep until older ones are erased. + The default is 1, use 0 for unlimited. - -name string + --name string + The name of the sync job, if not set it is default - name of the sync job, if not set it is default - - -skip boolean - - if this flag is set it will skip the first sync - - -source string + --prepend-storage-id + If specified, prepend the storage ID to the destination's path(s). - the source can be an or [IP:][/Path] + --skip + If specified, skip the first sync. - -source-user string + --source string + The source can be an or [IP:][/Path] - name of the user on the source target, root by default + --source-user string + The (ssh) user-name on the source target, root by default - -properties boolean + --properties + If specified, include the dataset's properties in the stream. - Include the dataset's properties in the stream. - - -dest-config-path string - - specify a custom config path on the destination target. default is /var/lib/pve-zsync + --dest-config-path string + Specifies a custom config path on the destination target. + The default is /var/lib/pve-zsync }, sync => qq{ -$PROGNAME sync -dest -source [OPTIONS]\n - - will sync one time +$PROGNAME sync --dest --source [OPTIONS]\n - -dest string + Trigger one sync. - the destination target is like [IP:][/Path] + --dest string + The destination target is like [IP:][/Path] - -dest-user string + --dest-user string + The (ssh) user-name on the destination target, root by default - name of the user on the destination target, root by default + --limit integer + The maximal sync speed in kBytes/s, default is unlimited - -limit integer + --maxsnap integer + The number of snapshots to keep until older ones are erased. + The default is 1, use 0 for unlimited. - max sync speed in kBytes/s, default unlimited - - -maxsnap integer - - how much snapshots will be kept before get erased, default 1 - - -name string - - name of the sync job, if not set it is default. + --name string + The name of the sync job, if not set it is 'default'. It is only necessary if scheduler allready contains this source. - -source string - - the source can be an or [IP:][/Path] - - -source-user string + --prepend-storage-id + If specified, prepend the storage ID to the destination's path(s). - name of the user on the source target, root by default + --source string + The source can either be an or [IP:][/Path] - -verbose boolean + --source-user string + The name of the user on the source target, root by default - print out the sync progress. + --verbose + If specified, print out the sync progress. - -properties boolean + --properties + If specified, include the dataset's properties in the stream. - Include the dataset's properties in the stream. - - -dest-config-path string - - specify a custom config path on the destination target. default is /var/lib/pve-zsync + --dest-config-path string + Specifies a custom config path on the destination target. + The default is /var/lib/pve-zsync }, list => qq{ $PROGNAME list @@ -1168,43 +1234,37 @@ $PROGNAME status help => qq{ $PROGNAME help [OPTIONS] - Get help about specified command. - - string + Get help about specified command. - Command name - - -verbose boolean + string + Command name to get help about. + --verbose Verbose output format. }, enable => qq{ -$PROGNAME enable -source [OPTIONS] - - enable a syncjob and reset error +$PROGNAME enable --source [OPTIONS] - -name string + Enable a sync-job and reset all job-errors, if any. + --name string name of the sync job, if not set it is default - -source string - - the source can be an or [IP:][/Path] + --source string + the source can be an or [IP:][/Path] }, disable => qq{ -$PROGNAME disable -source [OPTIONS] +$PROGNAME disable --source [OPTIONS] - pause a sync job + Disables (pauses) a sync-job - -name string + --name string + name of the sync-job, if not set it is default - name of the sync job, if not set it is default - - -source string - - the source can be an or [IP:][/Path] + --source string + the source can be an or [IP:][/Path] }, - printpod => 'internal command', + printpod => "$PROGNAME printpod\n\n\tinternal command", }; @@ -1287,13 +1347,13 @@ sub usage { print("ERROR:\tno command specified\n") if !$help; print("USAGE:\t$PROGNAME [ARGS] [OPTIONS]\n"); print("\t$PROGNAME help [] [OPTIONS]\n\n"); - print("\t$PROGNAME create -dest -source [OPTIONS]\n"); - print("\t$PROGNAME destroy -source [OPTIONS]\n"); - print("\t$PROGNAME disable -source [OPTIONS]\n"); - print("\t$PROGNAME enable -source [OPTIONS]\n"); + print("\t$PROGNAME create --dest --source [OPTIONS]\n"); + print("\t$PROGNAME destroy --source [OPTIONS]\n"); + print("\t$PROGNAME disable --source [OPTIONS]\n"); + print("\t$PROGNAME enable --source [OPTIONS]\n"); print("\t$PROGNAME list\n"); print("\t$PROGNAME status\n"); - print("\t$PROGNAME sync -dest -source [OPTIONS]\n"); + print("\t$PROGNAME sync --dest --source [OPTIONS]\n"); } sub check_target { @@ -1304,57 +1364,62 @@ sub check_target { sub print_pod { my $synopsis = join("\n", sort values %$cmd_help); + my $commands = join(", ", sort keys %$cmd_help); print < [ARGS] [OPTIONS] -$synopsis +Where can be one of: $commands =head1 DESCRIPTION -This Tool helps you to sync your VM or directory which stored on ZFS between 2 servers. -This tool also has the capability to add jobs to cron so the sync will be automatically done. -The default syncing interval is set to 15 min, if you want to change this value you can do this in /etc/cron.d/pve-zsync. -To config cron see man crontab. +The pve-zsync tool can help you to sync your VMs or directories stored on ZFS +between multiple servers. + +pve-zsync is able to automatically configure CRON jobs, so that a periodic sync +will be automatically triggered. +The default sync interval is 15 min, if you want to change this value you can +do this in F. If you need help to configure CRON tabs, see +man crontab. -=head2 PVE ZFS Storage sync Tool +=head1 COMMANDS AND OPTIONS -This Tool can get remote pool on other PVE or send Pool to others ZFS machines +$synopsis =head1 EXAMPLES -add sync job from local VM to remote ZFS Server -pve-zsync create -source=100 -dest=192.168.1.2:zfspool +Adds a job for syncing the local VM 100 to a remote server's ZFS pool named "tank": + pve-zsync create --source=100 -dest=192.168.1.2:tank =head1 IMPORTANT FILES -Cron jobs and config are stored at /etc/cron.d/pve-zsync +Cron jobs and config are stored in F -The VM config get copied on the destination machine to /var/lib/pve-zsync/ +The VM configuration itself gets copied to the destination machines +F path. =head1 COPYRIGHT AND DISCLAIMER -Copyright (C) 2007-2015 Proxmox Server Solutions GmbH +Copyright (C) 2007-2021 Proxmox Server Solutions GmbH -This program is free software: you can redistribute it and/or modify it -under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +This program is free software: you can redistribute it and/or modify it under +the terms of the GNU Affero General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) any +later version. -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Affero General Public License for more details. +This program is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. See the GNU Affero General Public License for more +details. -You should have received a copy of the GNU Affero General Public -License along with this program. If not, see -. +You should have received a copy of the GNU Affero General Public License along +with this program. If not, see . EOF }