use strict;
use warnings;
+use Clone;
use Fcntl ':flock';
+use File::Basename;
use File::Path;
use IO::File;
use IO::Select;
use PVE::Storage;
use PVE::VZDump::Common;
use PVE::VZDump::Plugin;
+use PVE::Tools qw(extract_param split_list);
+use PVE::API2Tools;
my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs);
my $confdesc = PVE::VZDump::Common::get_confdesc();
+my $confdesc_for_defaults = Clone::clone($confdesc);
+delete $confdesc_for_defaults->{$_}->{requires} for qw(notes-template protected);
+
# Load available plugins
my @pve_vzdump_classes = qw(PVE::VZDump::QemuServer PVE::VZDump::LXC);
foreach my $plug (@pve_vzdump_classes) {
PVE::Tools::run_command($cmdstr, %param, logfunc => $logfunc);
}
+my $verify_notes_template = sub {
+ my ($template) = @_;
+
+ die "contains a line feed\n" if $template =~ /\n/;
+
+ my @problematic = ();
+ while ($template =~ /\\(.)/g) {
+ my $char = $1;
+ push @problematic, "escape sequence '\\$char' at char " . (pos($template) - 2)
+ if $char !~ /^[n\\]$/;
+ }
+
+ while ($template =~ /\{\{([^\s{}]+)\}\}/g) {
+ my $var = $1;
+ push @problematic, "variable '$var' at char " . (pos($template) - length($var))
+ if $var !~ /^(cluster|guestname|node|vmid)$/;
+ }
+
+ die "found unknown: " . join(', ', @problematic) . "\n" if scalar(@problematic);
+};
+
+my $generate_notes = sub {
+ my ($notes_template, $task) = @_;
+
+ $verify_notes_template->($notes_template);
+
+ my $info = {
+ cluster => PVE::Cluster::get_clinfo()->{cluster}->{name} // 'standalone node',
+ guestname => $task->{hostname} // "VM $task->{vmid}", # is always set for CTs
+ node => PVE::INotify::nodename(),
+ vmid => $task->{vmid},
+ };
+
+ my $unescape = sub {
+ my ($char) = @_;
+ return '\\' if $char eq '\\';
+ return "\n" if $char eq 'n';
+ die "unexpected escape character '$char'\n";
+ };
+
+ $notes_template =~ s/\\(.)/$unescape->($1)/eg;
+
+ my $vars = join('|', keys $info->%*);
+ $notes_template =~ s/\{\{($vars)\}\}/$info->{$1}/g;
+
+ return $notes_template;
+};
+
+my sub parse_performance {
+ my ($param) = @_;
+
+ if (defined(my $perf = $param->{performance})) {
+ return if ref($perf) eq 'HASH'; # already parsed
+ $param->{performance} = PVE::JSONSchema::parse_property_string('backup-performance', $perf);
+ }
+}
+
+my $parse_prune_backups_maxfiles = sub {
+ my ($param, $kind) = @_;
+
+ my $maxfiles = delete $param->{maxfiles};
+ my $prune_backups = $param->{'prune-backups'};
+
+ debugmsg('warn', "both 'maxfiles' and 'prune-backups' defined as ${kind} - ignoring 'maxfiles'")
+ if defined($maxfiles) && defined($prune_backups);
+
+ if (defined($prune_backups)) {
+ return if ref($prune_backups) eq 'HASH'; # already parsed
+ $param->{'prune-backups'} = PVE::JSONSchema::parse_property_string(
+ 'prune-backups',
+ $prune_backups
+ );
+ } elsif (defined($maxfiles)) {
+ if ($maxfiles) {
+ $param->{'prune-backups'} = { 'keep-last' => $maxfiles };
+ } else {
+ $param->{'prune-backups'} = { 'keep-all' => 1 };
+ }
+ }
+};
+
sub storage_info {
my $storage = shift;
my $scfg = PVE::Storage::storage_config($cfg, $storage);
my $type = $scfg->{type};
- die "can't use storage type '$type' for backup\n"
- if (!($type eq 'dir' || $type eq 'nfs' || $type eq 'glusterfs'
- || $type eq 'cifs' || $type eq 'cephfs' || $type eq 'pbs'));
die "can't use storage '$storage' for backups - wrong content type\n"
if (!$scfg->{content}->{backup});
- PVE::Storage::activate_storage($cfg, $storage);
+ my $info = {
+ scfg => $scfg,
+ };
+
+ $info->{'prune-backups'} = PVE::JSONSchema::parse_property_string('prune-backups', $scfg->{'prune-backups'})
+ if defined($scfg->{'prune-backups'});
if ($type eq 'pbs') {
- return {
- scfg => $scfg,
- maxfiles => $scfg->{maxfiles},
- };
+ $info->{pbs} = 1;
} else {
- return {
- scfg => $scfg,
- dumpdir => PVE::Storage::get_backup_dir($cfg, $storage),
- maxfiles => $scfg->{maxfiles},
- };
+ $info->{dumpdir} = PVE::Storage::get_backup_dir($cfg, $storage);
}
+
+ return $info;
}
sub format_size {
}
my $mb = $size / (1024*1024);
-
if ($mb < 1024) {
return int ($mb) . "MB";
- } else {
- my $gb = $mb / 1024;
+ }
+ my $gb = $mb / 1024;
+ if ($gb < 1024) {
return sprintf ("%.2fGB", $gb);
}
+ my $tb = $gb / 1024;
+ return sprintf ("%.2fTB", $tb);
}
sub format_time {
my (@vmids) = @_;
my $res = [];
- foreach my $vmid (@vmids) {
+ for my $vmid (sort {$a <=> $b} @vmids) {
die "ERROR: strange VM ID '${vmid}'\n" if $vmid !~ m/^\d+$/;
$vmid = int ($vmid); # remove leading zeros
next if !$vmid;
map {
my $default = $confdesc->{$_}->{default};
defined($default) ? ($_ => $default) : ()
- } keys %$confdesc
+ } keys %$confdesc_for_defaults
};
+ $parse_prune_backups_maxfiles->($defaults, "defaults in VZDump schema");
+ parse_performance($defaults);
my $raw;
eval { $raw = PVE::Tools::file_get_contents($fn); };
return $defaults if $@;
- my $conf_schema = { type => 'object', properties => $confdesc, };
+ my $conf_schema = { type => 'object', properties => $confdesc_for_defaults };
my $res = PVE::JSONSchema::parse_config($conf_schema, $fn, $raw);
if (my $excludes = $res->{'exclude-path'}) {
$res->{'exclude-path'} = PVE::Tools::split_args($excludes);
}
if (defined($res->{mailto})) {
- my @mailto = PVE::Tools::split_list($res->{mailto});
+ my @mailto = split_list($res->{mailto});
$res->{mailto} = [ @mailto ];
}
+ $parse_prune_backups_maxfiles->($res, "options in '$fn'");
+ parse_performance($res);
foreach my $key (keys %$defaults) {
$res->{$key} = $defaults->{$key} if !defined($res->{$key});
}
+ if (defined($res->{storage}) && defined($res->{dumpdir})) {
+ debugmsg('warn', "both 'storage' and 'dumpdir' defined in '$fn' - ignoring 'dumpdir'");
+ delete $res->{dumpdir};
+ }
+
return $res;
}
chomp $task->{msg} if $task->{msg};
$task->{backuptime} = 0 if !$task->{backuptime};
$task->{size} = 0 if !$task->{size};
- $task->{tarfile} = 'unknown' if !$task->{tarfile};
+ $task->{target} = 'unknown' if !$task->{target};
$task->{hostname} = "VM $task->{vmid}" if !$task->{hostname};
if ($task->{state} eq 'todo') {
# text part
my $text = $err ? "$err\n\n" : '';
- $text .= sprintf ("%-10s %-6s %10s %10s %s\n", qw(VMID STATUS TIME SIZE FILENAME));
+ my $namelength = 20;
+ $text .= sprintf (
+ "%-10s %-${namelength}s %-6s %10s %10s %s\n",
+ qw(VMID NAME STATUS TIME SIZE FILENAME)
+ );
foreach my $task (@$tasklist) {
- my $vmid = $task->{vmid};
- if ($task->{state} eq 'ok') {
-
- $text .= sprintf ("%-10s %-6s %10s %10s %s\n", $vmid,
- $task->{state},
- format_time($task->{backuptime}),
- format_size ($task->{size}),
- $task->{tarfile});
- } else {
- $text .= sprintf ("%-10s %-6s %10s %8.2fMB %s\n", $vmid,
- $task->{state},
- format_time($task->{backuptime}),
- 0, '-');
- }
+ my $name = substr($task->{hostname}, 0, $namelength);
+ my $successful = $task->{state} eq 'ok';
+ my $size = $successful ? format_size ($task->{size}) : 0;
+ my $filename = $successful ? $task->{target} : '-';
+ my $size_fmt = $successful ? "%10s": "%8.2fMB";
+ $text .= sprintf(
+ "%-10s %-${namelength}s %-6s %10s $size_fmt %s\n",
+ $task->{vmid},
+ $name,
+ $task->{state},
+ format_time($task->{backuptime}),
+ $size,
+ $filename,
+ );
}
my $text_log_part;
$text_log_part .= "$vmid: no log available\n\n";
next;
}
- if (open (TMP, "$log")) {
- while (my $line = <TMP>) {
+ if (open (my $TMP, '<', "$log")) {
+ while (my $line = <$TMP>) {
next if $line =~ /^status: \d+/; # not useful in mails
$text_log_part .= encode8bit ("$vmid: $line");
}
+ close ($TMP);
} else {
$text_log_part .= "$vmid: Could not open log file\n\n";
}
- close (TMP);
$text_log_part .= "\n";
}
$text_log_part .= $detail_post if defined($detail_post);
$html .= "<tr><td>VMID<td>NAME<td>STATUS<td>TIME<td>SIZE<td>FILENAME</tr>\n";
my $ssize = 0;
-
foreach my $task (@$tasklist) {
my $vmid = $task->{vmid};
my $name = $task->{hostname};
if ($task->{state} eq 'ok') {
-
$ssize += $task->{size};
- $html .= sprintf ("<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
- $vmid, $name,
- format_time($task->{backuptime}),
- format_size ($task->{size}),
- escape_html ($task->{tarfile}));
+ $html .= sprintf (
+ "<tr><td>%s<td>%s<td>OK<td>%s<td align=right>%s<td>%s</tr>\n",
+ $vmid,
+ $name,
+ format_time($task->{backuptime}),
+ format_size ($task->{size}),
+ escape_html ($task->{target}),
+ );
} else {
- $html .= sprintf ("<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
- $vmid, $name, format_time($task->{backuptime}),
- escape_html ($task->{msg}));
+ $html .= sprintf (
+ "<tr><td>%s<td>%s<td><font color=red>FAILED<td>%s<td colspan=2>%s</tr>\n",
+ $vmid,
+ $name,
+ format_time($task->{backuptime}),
+ escape_html ($task->{msg}),
+ );
}
}
$html_log_part .= "$vmid: no log available\n\n";
next;
}
- if (open (TMP, "$log")) {
- while (my $line = <TMP>) {
+ if (open (my $TMP, '<', "$log")) {
+ while (my $line = <$TMP>) {
next if $line =~ /^status: \d+/; # not useful in mails
if ($line =~ m/^\S+\s\d+\s+\d+:\d+:\d+\s+(ERROR|WARN):/) {
$html_log_part .= encode8bit ("$vmid: <font color=red>".
$html_log_part .= encode8bit ("$vmid: " . escape_html ($line));
}
}
+ close ($TMP);
} else {
$html_log_part .= "$vmid: Could not open log file\n\n";
}
- close (TMP);
$html_log_part .= "\n";
}
$html_log_part .= escape_html($detail_post) if defined($detail_post);
$html_log_part .= "</pre>";
- my $html_end .= "\n</body></html>\n";
+ my $html_end = "\n</body></html>\n";
# end html part
if (length($text) + length($text_log_part) +
- length($html) + length($html_log_part) < MAX_MAIL_SIZE)
+ length($html) + length($html_log_part) +
+ length($html_end) < MAX_MAIL_SIZE)
{
$html .= $html_log_part;
+ $html .= $html_end;
$text .= $text_log_part;
} else {
my $msg = "Log output was too long to be sent by mail. ".
my $defaults = read_vzdump_defaults();
- my $maxfiles = $opts->{maxfiles}; # save here, because we overwrite with default
-
- $opts->{remove} = 1 if !defined($opts->{remove});
-
foreach my $k (keys %$defaults) {
- next if $k eq 'exclude-path'; # dealt with separately
+ next if $k eq 'exclude-path' || $k eq 'prune-backups'; # dealt with separately
if ($k eq 'dumpdir' || $k eq 'storage') {
$opts->{$k} = $defaults->{$k} if !defined ($opts->{dumpdir}) &&
!defined ($opts->{storage});
$opts->{tmpdir} =~ s|/+$|| if ($opts->{tmpdir});
$skiplist = [] if !$skiplist;
- my $self = bless { cmdline => $cmdline, opts => $opts, skiplist => $skiplist };
+ my $self = bless {
+ cmdline => $cmdline,
+ opts => $opts,
+ skiplist => $skiplist,
+ }, $class;
my $findexcl = $self->{findexcl} = [];
if ($defaults->{'exclude-path'}) {
}
if ($opts->{stdexcludes}) {
- push @$findexcl, '/tmp/?*',
- '/var/tmp/?*',
- '/var/run/?*.pid';
+ push @$findexcl,
+ '/tmp/?*',
+ '/var/tmp/?*',
+ '/var/run/?*.pid',
+ ;
}
foreach my $p (@plugins) {
-
- my $pd = $p->new ($self);
+ my $pd = $p->new($self);
push @{$self->{plugins}}, $pd;
}
if (defined($opts->{storage}) && $opts->{stdout}) {
- die "unable to use option 'storage' with option 'stdout'\n";
+ die "cannot use options 'storage' and 'stdout' at the same time\n";
+ } elsif (defined($opts->{storage}) && defined($opts->{dumpdir})) {
+ die "cannot use options 'storage' and 'dumpdir' at the same time\n";
}
if (!$opts->{dumpdir} && !$opts->{storage}) {
$opts->{storage} = 'local';
}
+ # Enforced by the API too, but these options might come in via defaults. Drop them if necessary.
+ if (!$opts->{storage}) {
+ delete $opts->{$_} for qw(notes-template protected);
+ }
+
my $errors = '';
+ my $add_error = sub {
+ my ($error) = @_;
+ $errors .= "\n" if $errors;
+ chomp($error);
+ $errors .= $error;
+ };
+
+ eval {
+ $self->{job_init_log} = '';
+ open my $job_init_fd, '>', \$self->{job_init_log};
+ $self->run_hook_script('job-init', undef, $job_init_fd);
+ close $job_init_fd;
+
+ PVE::Cluster::cfs_update(); # Pick up possible changes made by the hook script.
+ };
+ $add_error->($@) if $@;
if ($opts->{storage}) {
+ my $storage_cfg = PVE::Storage::config();
+ eval { PVE::Storage::activate_storage($storage_cfg, $opts->{storage}) };
+ $add_error->("could not activate storage '$opts->{storage}': $@") if $@;
+
my $info = eval { storage_info ($opts->{storage}) };
- $errors .= "could not get storage information for '$opts->{storage}': $@"
- if ($@);
- $opts->{dumpdir} = $info->{dumpdir};
- $opts->{scfg} = $info->{scfg};
- $maxfiles //= $info->{maxfiles};
+ if (my $err = $@) {
+ $add_error->("could not get storage information for '$opts->{storage}': $err");
+ } else {
+ $opts->{dumpdir} = $info->{dumpdir};
+ $opts->{scfg} = $info->{scfg};
+ $opts->{pbs} = $info->{pbs};
+ $opts->{'prune-backups'} //= $info->{'prune-backups'};
+ }
} elsif ($opts->{dumpdir}) {
- $errors .= "dumpdir '$opts->{dumpdir}' does not exist"
+ $add_error->("dumpdir '$opts->{dumpdir}' does not exist")
if ! -d $opts->{dumpdir};
} else {
die "internal error";
}
+ $opts->{'prune-backups'} //= $defaults->{'prune-backups'};
+
+ # avoid triggering any remove code path if keep-all is set
+ $opts->{remove} = 0 if $opts->{'prune-backups'}->{'keep-all'};
+
if ($opts->{tmpdir} && ! -d $opts->{tmpdir}) {
- $errors .= "\n" if $errors;
- $errors .= "tmpdir '$opts->{tmpdir}' does not exist";
+ $add_error->("tmpdir '$opts->{tmpdir}' does not exist");
}
if ($errors) {
die "$errors\n";
}
- $opts->{maxfiles} = $maxfiles if defined($maxfiles);
-
return $self;
-
}
sub get_mount_info {
my $maxwait = $self->{opts}->{lockwait} || $self->{lockwait};
- die "missimg UPID" if !$upid; # should not happen
+ die "missing UPID" if !$upid; # should not happen
- if (!open (SERVER_FLCK, ">>$lockfile")) {
+ my $SERVER_FLCK;
+ if (!open ($SERVER_FLCK, '>>', "$lockfile")) {
debugmsg ('err', "can't open lock on file '$lockfile' - $!", undef, 1);
die "can't open lock on file '$lockfile' - $!";
}
- if (!flock (SERVER_FLCK, LOCK_EX|LOCK_NB)) {
-
+ if (!flock ($SERVER_FLCK, LOCK_EX|LOCK_NB)) {
if (!$maxwait) {
debugmsg ('err', "can't acquire lock '$lockfile' (wait = 0)", undef, 1);
die "can't acquire lock '$lockfile' (wait = 0)";
}
debugmsg('info', "trying to get global lock - waiting...", undef, 1);
-
eval {
alarm ($maxwait * 60);
local $SIG{ALRM} = sub { alarm (0); die "got timeout\n"; };
- if (!flock (SERVER_FLCK, LOCK_EX)) {
+ if (!flock ($SERVER_FLCK, LOCK_EX)) {
my $err = $!;
- close (SERVER_FLCK);
+ close ($SERVER_FLCK);
alarm (0);
die "$err\n";
}
}
PVE::Tools::file_set_contents($pidfile, $upid);
+
+ return $SERVER_FLCK;
}
sub run_hook_script {
my $script = $opts->{script};
return if !$script;
- if (!-x $script) {
- die "The hook script '$script' is not executable.\n";
- }
+ die "Error: The hook script '$script' does not exist.\n" if ! -f $script;
+ die "Error: The hook script '$script' is not executable.\n" if ! -x $script;
- my $cmd = "$script $phase";
+ my $cmd = [$script, $phase];
- $cmd .= " $task->{mode} $task->{vmid}" if ($task);
+ if ($task) {
+ push @$cmd, $task->{mode};
+ push @$cmd, $task->{vmid};
+ }
local %ENV;
# set immutable opts directly (so they are available in all phases)
$ENV{STOREID} = $opts->{storage} if $opts->{storage};
$ENV{DUMPDIR} = $opts->{dumpdir} if $opts->{dumpdir};
- foreach my $ek (qw(vmtype hostname tarfile logfile)) {
+ foreach my $ek (qw(vmtype hostname target logfile)) {
$ENV{uc($ek)} = $task->{$ek} if $task->{$ek};
}
} else {
return ('gzip --rsyncable', 'gz');
}
+ } elsif ($opt_compress eq 'zstd') {
+ my $zstd_threads = $opts->{zstd} // 1;
+ if ($zstd_threads == 0) {
+ my $cpuinfo = PVE::ProcFSTools::read_cpuinfo();
+ $zstd_threads = int(($cpuinfo->{cpus} + 1)/2);
+ }
+ return ("zstd --rsyncable --threads=${zstd_threads}", 'zst');
} else {
die "internal error - unknown compression option '$opt_compress'";
}
}
sub get_backup_file_list {
- my ($dir, $bkname, $exclude_fn) = @_;
+ my ($dir, $bkname) = @_;
my $bklist = [];
foreach my $fn (<$dir/${bkname}-*>) {
- next if $exclude_fn && $fn eq $exclude_fn;
- if ($fn =~ m!/(${bkname}-(\d{4})_(\d{2})_(\d{2})-(\d{2})_(\d{2})_(\d{2})\.(tgz|((tar|vma)(\.(gz|lzo))?)))$!) {
- $fn = "$dir/$1"; # untaint
- my $t = timelocal ($7, $6, $5, $4, $3 - 1, $2);
- push @$bklist, [$fn, $t];
+ my $archive_info = eval { PVE::Storage::archive_info($fn) } // {};
+ if ($archive_info->{is_std_name}) {
+ my $path = "$dir/$archive_info->{filename}";
+ my $backup = {
+ 'path' => $path,
+ 'ctime' => $archive_info->{ctime},
+ };
+ $backup->{mark} = "protected"
+ if -e PVE::Storage::protection_file_path($path);
+ push @{$bklist}, $backup;
}
}
my $opts = $self->{opts};
+ my $cfg = PVE::Storage::config();
my $vmid = $task->{vmid};
my $plugin = $task->{plugin};
- my $vmtype = $plugin->type();
$task->{backup_time} = time();
my $pbs_group_name;
my $pbs_snapshot_name;
- if ($opts->{scfg}->{type} eq 'pbs') {
- if ($vmtype eq 'lxc') {
- $pbs_group_name = "ct/$vmid";
- } elsif ($vmtype eq 'qemu') {
- $pbs_group_name = "vm/$vmid";
- } else {
- die "pbs backup not implemented for plugin type '$vmtype'\n";
- }
- my $btime = strftime("%FT%TZ", gmtime($task->{backup_time}));
- $pbs_snapshot_name = "$pbs_group_name/$btime";
- }
-
my $vmstarttime = time ();
my $logfd;
return if !defined($task->{vmstoptime});
$task->{vmconttime} //= time();
my $delay = $task->{vmconttime} - $task->{vmstoptime};
+ $delay = '<1' if $delay < 1;
debugmsg ('info', "guest is online again after $delay seconds", $logfd);
};
eval {
die "unable to find VM '$vmid'\n" if !$plugin;
+ my $vmtype = $plugin->type();
+
+ if ($self->{opts}->{pbs}) {
+ if ($vmtype eq 'lxc') {
+ $pbs_group_name = "ct/$vmid";
+ } elsif ($vmtype eq 'qemu') {
+ $pbs_group_name = "vm/$vmid";
+ } else {
+ die "pbs backup not implemented for plugin type '$vmtype'\n";
+ }
+ my $btime = strftime("%FT%TZ", gmtime($task->{backup_time}));
+ $pbs_snapshot_name = "$pbs_group_name/$btime";
+ }
+
# for now we deny backups of a running ha managed service in *stop* mode
# as it interferes with the HA stack (started services should not stop).
if ($opts->{mode} eq 'stop' &&
my $bkname = "vzdump-$vmtype-$vmid";
my $basename = $bkname . strftime("-%Y_%m_%d-%H_%M_%S", localtime($task->{backup_time}));
- my $maxfiles = $opts->{maxfiles};
+ my $prune_options = $opts->{'prune-backups'};
- if ($maxfiles && !$opts->{remove}) {
+ my $backup_limit = 0;
+ if (!$prune_options->{'keep-all'}) {
+ foreach my $keep (values %{$prune_options}) {
+ $backup_limit += $keep;
+ }
+ }
+
+ if (($backup_limit && !$opts->{remove}) || $opts->{protected}) {
my $count;
- if ($opts->{scfg}->{type} eq 'pbs') {
- my $res = PVE::Storage::PBSPlugin::run_client_cmd($opts->{scfg}, $opts->{storage}, 'snapshots', $pbs_group_name);
- $count = scalar(@$res);
+ my $protected_count;
+ if (my $storeid = $opts->{storage}) {
+ my @backups = grep {
+ !$_->{subtype} || $_->{subtype} eq $vmtype
+ } PVE::Storage::volume_list($cfg, $storeid, $vmid, 'backup')->@*;
+
+ $count = grep { !$_->{protected} } @backups;
+ $protected_count = scalar(@backups) - $count;
} else {
- my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname);
- $count = scalar(@$bklist);
+ $count = grep { !$_->{mark} || $_->{mark} ne "protected" } get_backup_file_list($opts->{dumpdir}, $bkname)->@*;
+ }
+
+ if ($opts->{protected}) {
+ my $max_protected = PVE::Storage::get_max_protected_backups(
+ $opts->{scfg},
+ $opts->{storage},
+ );
+ if ($max_protected > -1 && $protected_count >= $max_protected) {
+ die "The number of protected backups per guest is limited to $max_protected ".
+ "on storage '$opts->{storage}'\n";
+ }
+ } elsif ($count >= $backup_limit) {
+ die "There is a max backup limit of $backup_limit enforced by the target storage ".
+ "or the vzdump parameters. Either increase the limit or delete old backups.\n";
}
- die "There is a max backup limit of ($maxfiles) enforced by the".
- " target storage or the vzdump parameters.".
- " Either increase the limit or delete old backup(s).\n"
- if $count >= $maxfiles;
}
- if ($opts->{scfg}->{type} ne 'pbs') {
+ if (!$self->{opts}->{pbs}) {
$task->{logfile} = "$opts->{dumpdir}/$basename.log";
}
$ext .= ".${comp_ext}";
}
- if ($opts->{scfg}->{type} eq 'pbs') {
+ if ($self->{opts}->{pbs}) {
die "unable to pipe backup to stdout\n" if $opts->{stdout};
+ $task->{target} = $pbs_snapshot_name;
} else {
if ($opts->{stdout}) {
- $task->{tarfile} = '-';
+ $task->{target} = '-';
} else {
- my $tarfile = $task->{tarfile} = "$opts->{dumpdir}/$basename$ext";
- $task->{tmptar} = $task->{tarfile};
+ $task->{target} = $task->{tmptar} = "$opts->{dumpdir}/$basename$ext";
$task->{tmptar} =~ s/\.[^\.]+$/\.dat/;
unlink $task->{tmptar};
}
$task->{vmtype} = $vmtype;
- if ($opts->{scfg}->{type} eq 'pbs') {
- $task->{tmpdir} = "/var/tmp/vzdumptmp$$"; #fixme
- } elsif ($opts->{tmpdir}) {
- $task->{tmpdir} = "$opts->{tmpdir}/vzdumptmp$$";
+ my $pid = $$;
+ if ($opts->{tmpdir}) {
+ $task->{tmpdir} = "$opts->{tmpdir}/vzdumptmp${pid}_$vmid/";
+ } elsif ($self->{opts}->{pbs}) {
+ $task->{tmpdir} = "/var/tmp/vzdumptmp${pid}_$vmid";
} else {
# dumpdir is posix? then use it as temporary dir
my $info = get_mount_info($opts->{dumpdir});
grep ($_ eq $info->{fstype}, @posix_filesystems)) {
$task->{tmpdir} = "$opts->{dumpdir}/$basename.tmp";
} else {
- $task->{tmpdir} = "/var/tmp/vzdumptmp$$";
+ $task->{tmpdir} = "/var/tmp/vzdumptmp${pid}_$vmid";
debugmsg ('info', "filesystem type on dumpdir is '$info->{fstype}' -" .
"using $task->{tmpdir} for temporary files", $logfd);
}
$task->{mode} = $mode;
debugmsg ('info', "backup mode: $mode", $logfd);
-
- debugmsg ('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd)
- if $opts->{bwlimit};
-
+ debugmsg ('info', "bandwidth limit: $opts->{bwlimit} KB/s", $logfd) if $opts->{bwlimit};
debugmsg ('info', "ionice priority: $opts->{ionice}", $logfd);
if ($mode eq 'stop') {
-
$plugin->prepare ($task, $vmid, $mode);
$self->run_hook_script ('backup-start', $task, $logfd);
if ($running) {
- debugmsg ('info', "stopping vm", $logfd);
+ debugmsg ('info', "stopping virtual guest", $logfd);
$task->{vmstoptime} = time();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->stop_vm ($task, $vmid);
} elsif ($mode eq 'suspend') {
-
$plugin->prepare ($task, $vmid, $mode);
$self->run_hook_script ('backup-start', $task, $logfd);
$plugin->copy_data_phase1($task, $vmid);
}
- debugmsg ('info', "suspend vm", $logfd);
+ debugmsg ('info', "suspending guest", $logfd);
$task->{vmstoptime} = time ();
$self->run_hook_script ('pre-stop', $task, $logfd);
$plugin->suspend_vm ($task, $vmid);
# post-suspend rsync
$plugin->copy_data_phase2($task, $vmid);
- debugmsg ('info', "resume vm", $logfd);
+ debugmsg ('info', "resuming guest", $logfd);
$cleanup->{resume} = 0;
$self->run_hook_script('pre-restart', $task, $logfd);
$plugin->resume_vm($task, $vmid);
}
} elsif ($mode eq 'snapshot') {
-
$self->run_hook_script ('backup-start', $task, $logfd);
my $snapshot_count = $task->{snapshot_count} || 0;
return;
}
- # fixme: ??
- if ($opts->{scfg}->{type} eq 'pbs') {
- debugmsg ('info', "creating pbs archive on storage '$opts->{storage}'", $logfd);
- } else {
- debugmsg ('info', "creating archive '$task->{tarfile}'", $logfd);
- }
+ my $archive_txt = $self->{opts}->{pbs} ? 'Proxmox Backup Server' : 'vzdump';
+ debugmsg('info', "creating $archive_txt archive '$task->{target}'", $logfd);
$plugin->archive($task, $vmid, $task->{tmptar}, $comp);
- if ($opts->{scfg}->{type} eq 'pbs') {
- # fixme: log size ?
- debugmsg ('info', "pbs upload finished", $logfd);
+ if ($self->{opts}->{pbs}) {
+ # size is added to task struct in guest vzdump plugins
} else {
- rename ($task->{tmptar}, $task->{tarfile}) ||
- die "unable to rename '$task->{tmptar}' to '$task->{tarfile}'\n";
+ rename ($task->{tmptar}, $task->{target}) ||
+ die "unable to rename '$task->{tmptar}' to '$task->{target}'\n";
# determine size
- $task->{size} = (-s $task->{tarfile}) || 0;
+ $task->{size} = (-s $task->{target}) || 0;
my $cs = format_size ($task->{size});
debugmsg ('info', "archive file size: $cs", $logfd);
}
- # purge older backup
- if ($maxfiles && $opts->{remove}) {
+ # Mark as protected before pruning.
+ if (my $storeid = $opts->{storage}) {
+ my $volname = $opts->{pbs} ? $task->{target} : basename($task->{target});
+ my $volid = "${storeid}:backup/${volname}";
- if ($opts->{scfg}->{type} eq 'pbs') {
- my $args = [$pbs_group_name, '--keep-last', $maxfiles];
- my $logfunc = sub { my $line = shift; debugmsg ('info', $line, $logfd); };
- PVE::Storage::PBSPlugin::run_raw_client_cmd(
- $opts->{scfg}, $opts->{storage}, 'prune', $args, logfunc => $logfunc);
- } else {
- my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname, $task->{tarfile});
- $bklist = [ sort { $b->[1] <=> $a->[1] } @$bklist ];
-
- while (scalar (@$bklist) >= $maxfiles) {
- my $d = pop @$bklist;
- debugmsg ('info', "delete old backup '$d->[0]'", $logfd);
- unlink $d->[0];
- my $logfn = $d->[0];
- $logfn =~ s/\.(tgz|((tar|vma)(\.(gz|lzo))?))$/\.log/;
- unlink $logfn;
+ if ($opts->{'notes-template'} && $opts->{'notes-template'} ne '') {
+ debugmsg('info', "adding notes to backup", $logfd);
+ my $notes = eval { $generate_notes->($opts->{'notes-template'}, $task); };
+ if (my $err = $@) {
+ debugmsg('warn', "unable to add notes - $err", $logfd);
+ } else {
+ eval { PVE::Storage::update_volume_attribute($cfg, $volid, 'notes', $notes) };
+ debugmsg('warn', "unable to add notes - $@", $logfd) if $@;
}
}
+
+ if ($opts->{protected}) {
+ debugmsg('info', "marking backup as protected", $logfd);
+ eval { PVE::Storage::update_volume_attribute($cfg, $volid, 'protected', 1) };
+ die "unable to set protected flag - $@\n" if $@;
+ }
+ }
+
+ if ($opts->{remove}) {
+ my $keepstr = join(', ', map { "$_=$prune_options->{$_}" } sort keys %$prune_options);
+ debugmsg ('info', "prune older backups with retention: $keepstr", $logfd);
+ my $pruned = 0;
+ if (!defined($opts->{storage})) {
+ my $bklist = get_backup_file_list($opts->{dumpdir}, $bkname);
+
+ PVE::Storage::prune_mark_backup_group($bklist, $prune_options);
+
+ foreach my $prune_entry (@{$bklist}) {
+ next if $prune_entry->{mark} ne 'remove';
+ $pruned++;
+ my $archive_path = $prune_entry->{path};
+ debugmsg ('info', "delete old backup '$archive_path'", $logfd);
+ PVE::Storage::archive_remove($archive_path);
+ }
+ } else {
+ my $pruned_list = PVE::Storage::prune_backups(
+ $cfg,
+ $opts->{storage},
+ $prune_options,
+ $vmid,
+ $vmtype,
+ 0,
+ sub { debugmsg($_[0], $_[1], $logfd) },
+ );
+ $pruned = scalar(grep { $_->{mark} eq 'remove' } $pruned_list->@*);
+ }
+ my $log_pruned_extra = $pruned > 0 ? " not covered by keep-retention policy" : "";
+ debugmsg ('info', "pruned $pruned backup(s)${log_pruned_extra}", $logfd);
}
$self->run_hook_script ('backup-end', $task, $logfd);
close ($logfd) if $logfd;
if ($task->{tmplog}) {
- if ($opts->{scfg}->{type} eq 'pbs') {
+ if ($self->{opts}->{pbs}) {
if ($task->{state} eq 'ok') {
- my $param = [$pbs_snapshot_name, $task->{tmplog}];
- PVE::Storage::PBSPlugin::run_raw_client_cmd(
- $opts->{scfg}, $opts->{storage}, 'upload-log', $param, errmsg => "upload log failed");
+ eval {
+ PVE::Storage::PBSPlugin::run_raw_client_cmd(
+ $opts->{scfg},
+ $opts->{storage},
+ 'upload-log',
+ [ $pbs_snapshot_name, $task->{tmplog} ],
+ errmsg => "uploading backup task log failed",
+ outfunc => sub {},
+ );
+ };
+ debugmsg('warn', "$@") if $@; # $@ contains already error prefix
}
} elsif ($task->{logfile}) {
system {'cp'} 'cp', $task->{tmplog}, $task->{logfile};
my $opts = $self->{opts};
debugmsg ('info', "starting new backup job: $self->{cmdline}", undef, 1);
- debugmsg ('info', "skip external VMs: " . join(', ', @{$self->{skiplist}}))
- if scalar(@{$self->{skiplist}});
+
+ if (scalar(@{$self->{skiplist}})) {
+ my $skip_string = join(', ', sort { $a <=> $b } @{$self->{skiplist}});
+ debugmsg ('info', "skip external VMs: $skip_string");
+ }
my $tasklist = [];
+ my $vzdump_plugins = {};
+ foreach my $plugin (@{$self->{plugins}}) {
+ my $type = $plugin->type();
+ next if exists $vzdump_plugins->{$type};
+ $vzdump_plugins->{$type} = $plugin;
+ }
- if ($opts->{all}) {
- foreach my $plugin (@{$self->{plugins}}) {
- my $vmlist = $plugin->vmlist();
- foreach my $vmid (sort @$vmlist) {
- next if grep { $_ eq $vmid } @{$opts->{exclude}};
- next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], 1);
- push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin, mode => $opts->{mode} };
- }
- }
- } else {
- foreach my $vmid (sort @{$opts->{vmids}}) {
- my $plugin;
- foreach my $pg (@{$self->{plugins}}) {
- my $vmlist = $pg->vmlist();
- if (grep { $_ eq $vmid } @$vmlist) {
- $plugin = $pg;
- last;
- }
- }
- $rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ]);
- push @$tasklist, { vmid => $vmid, state => 'todo', plugin => $plugin, mode => $opts->{mode} };
+ my $vmlist = PVE::Cluster::get_vmlist();
+ my $vmids = [ sort { $a <=> $b } @{$opts->{vmids}} ];
+ foreach my $vmid (@{$vmids}) {
+ my $plugin;
+ if (defined($vmlist->{ids}->{$vmid})) {
+ my $guest_type = $vmlist->{ids}->{$vmid}->{type};
+ $plugin = $vzdump_plugins->{$guest_type};
+ next if !$rpcenv->check($authuser, "/vms/$vmid", [ 'VM.Backup' ], $opts->{all});
}
+ push @$tasklist, {
+ mode => $opts->{mode},
+ plugin => $plugin,
+ state => 'todo',
+ vmid => $vmid,
+ };
}
# Use in-memory files for the outer hook logs to pass them to sendmail.
my $totaltime = time() - $starttime;
- eval { $self->sendmail ($tasklist, $totaltime, undef, $job_start_log, $job_end_log); };
+ eval {
+ $self->sendmail(
+ $tasklist,
+ $totaltime,
+ undef,
+ $self->{job_init_log} . $job_start_log,
+ $job_end_log,
+ );
+ };
debugmsg ('err', $@) if $@;
die $err if $err;
return defined($confdesc->{$key});
}
+# NOTE it might make sense to merge this and verify_vzdump_parameters(), but one
+# needs to adapt command_line() in guest-common's PVE/VZDump/Common.pm and detect
+# a second parsing attempt, because verify_vzdump_parameters() is called twice
+# during the update_job API call.
+sub parse_mailto_exclude_path {
+ my ($param) = @_;
+
+ # exclude-path list need to be 0 separated
+ if (defined($param->{'exclude-path'})) {
+ my @expaths = split(/\0/, $param->{'exclude-path'} || '');
+ $param->{'exclude-path'} = [ @expaths ];
+ }
+
+ if (defined($param->{mailto})) {
+ my @mailto = PVE::Tools::split_list(extract_param($param, 'mailto'));
+ $param->{mailto} = [ @mailto ];
+ }
+
+ return;
+}
+
sub verify_vzdump_parameters {
my ($param, $check_missing) = @_;
raise_param_exc({ pool => "option conflicts with option 'vmid'"})
if $param->{pool} && $param->{vmid};
- $param->{all} = 1 if (defined($param->{exclude}) && !$param->{pool});
+ raise_param_exc({ 'prune-backups' => "option conflicts with option 'maxfiles'"})
+ if defined($param->{'prune-backups'}) && defined($param->{maxfiles});
- warn "option 'size' is deprecated and will be removed in a future " .
- "release, please update your script/configuration!\n"
- if defined($param->{size});
+ $parse_prune_backups_maxfiles->($param, 'CLI parameters');
+ parse_performance($param);
+
+ if (my $template = $param->{'notes-template'}) {
+ eval { $verify_notes_template->($template); };
+ raise_param_exc({'notes-template' => $@}) if $@;
+ }
+
+ $param->{all} = 1 if (defined($param->{exclude}) && !$param->{pool});
return if !$check_missing;
}
}
+sub get_included_guests {
+ my ($job) = @_;
+
+ my $vmids = [];
+ my $vmids_per_node = {};
+
+ my $vmlist = PVE::Cluster::get_vmlist();
+
+ if ($job->{pool}) {
+ $vmids = PVE::API2Tools::get_resource_pool_guest_members($job->{pool});
+ } elsif ($job->{vmid}) {
+ $vmids = [ split_list($job->{vmid}) ];
+ } elsif ($job->{all}) {
+ # all or exclude
+ my $exclude = check_vmids(split_list($job->{exclude}));
+ my $excludehash = { map { $_ => 1 } @$exclude };
+
+ for my $id (keys %{$vmlist->{ids}}) {
+ next if $excludehash->{$id};
+ push @$vmids, $id;
+ }
+ } else {
+ return $vmids_per_node;
+ }
+ $vmids = check_vmids(@$vmids);
+
+ for my $vmid (@$vmids) {
+ if (defined($vmlist->{ids}->{$vmid})) {
+ my $node = $vmlist->{ids}->{$vmid}->{node};
+ next if (defined $job->{node} && $job->{node} ne $node);
+
+ push @{$vmids_per_node->{$node}}, $vmid;
+ } else {
+ push @{$vmids_per_node->{''}}, $vmid;
+ }
+ }
+
+ return $vmids_per_node;
+}
+
1;
projects / pve-manager.git / blobdiff