Skip to content

P
pve-manager
Commit 57d30b80 authored by Dietmar Maurer's avatar Dietmar Maurer
Browse files
Options

finnish and cleanup vzdump API

parent 6e36ad31
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 581 additions and 313 deletions
PVE/API2/Backup.pm 0 → 100644
View file @ 57d30b80
This diff is collapsed.
PVE/API2/Cluster.pm
View file @ 57d30b80
......@@ -7,19 +7,18 @@ use PVE::SafeSyslog;
use PVE::Tools qw(extract_param);
use PVE::Cluster qw(cfs_register_file cfs_lock_file cfs_read_file cfs_write_file);
use PVE::Storage;
use PVE::API2::Backup;
use JSON;
use PVE::API2::VZDump;
use Data::Dumper; # fixme: remove
use Apache2::Const qw(:http);
use PVE::RESTHandler;
use PVE::RPCEnvironment;
use base qw(PVE::RESTHandler);
__PACKAGE__->register_method ({
subclass => "PVE::API2::Backup",
path => 'backup',
});
my $dc_schema = PVE::Cluster::get_datacenter_schema();
my $dc_properties = {
delete => {
......@@ -58,7 +57,7 @@ __PACKAGE__->register_method ({
{ name => 'options' },
{ name => 'resources' },
{ name => 'tasks' },
{ name => 'vzdump' },
{ name => 'backup' },
];
return $result;
......@@ -328,188 +327,4 @@ __PACKAGE__->register_method({
return undef;
}});
cfs_register_file ('vzdump',
\&parse_config,
\&write_config);
my $vzdump_method_info = PVE::API2::VZDump->map_method_by_name('vzdump');
my $dowhash_to_dow = sub {
my ($d, $num) = @_;
my @da = ();
push @da, $num ? 1 : 'mon' if $d->{mon};
push @da, $num ? 2 : 'tue' if $d->{tue};
push @da, $num ? 3 : 'wed' if $d->{wed};
push @da, $num ? 4 : 'thu' if $d->{thu};
push @da, $num ? 5 : 'fri' if $d->{fri};
push @da, $num ? 6 : 'sat' if $d->{sat};
push @da, $num ? 7 : 'sun' if $d->{sun};
return join ',', @da;
};
sub parse_dow {
my ($dowstr, $noerr) = @_;
my $dowmap = {mon => 1, tue => 2, wed => 3, thu => 4,
fri => 5, sat => 6, sun => 7};
my $rdowmap = { '1' => 'mon', '2' => 'tue', '3' => 'wed', '4' => 'thu',
'5' => 'fri', '6' => 'sat', '7' => 'sun', '0' => 'sun'};
my $res = {};
$dowstr = '1,2,3,4,5,6,7' if $dowstr eq '*';
foreach my $day (split (/,/, $dowstr)) {
if ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun)-(mon|tue|wed|thu|fri|sat|sun)$/i) {
for (my $i = $dowmap->{lc($1)}; $i <= $dowmap->{lc($2)}; $i++) {
my $r = $rdowmap->{$i};
$res->{$r} = 1;
}
} elsif ($day =~ m/^(mon|tue|wed|thu|fri|sat|sun|[0-7])$/i) {
$day = $rdowmap->{$day} if $day =~ m/\d/;
$res->{lc($day)} = 1;
} else {
return undef if $noerr;
die "unable to parse day of week '$dowstr'\n";
}
}
return $res;
};
sub parse_config {
my ($filename, $raw) = @_;
my $jobs = []; # correct jobs
my $ejobs = []; # mailfomerd lines
my $jid = 1; # we start at 1
my $digest = Digest::SHA1::sha1_hex(defined($raw) ? $raw : '');
while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
my $line = $1;
next if $line =~ m/^\#/;
next if $line =~ m/^\s*$/;
next if $line =~ m/^PATH\s*=/; # we always overwrite path
if ($line =~ m|^(\d+)\s+(\d+)\s+\*\s+\*\s+(\S+)\s+root\s+(/\S+/)?vzdump(\s+(.*))?$|) {
eval {
my $minute = int($1);
my $hour = int($2);
my $dow = $3;
my $param = $6;
my $dowhash = parse_dow($dow, 1);
die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
my $args = [ split(/\s+/, $param)];
my $opts = PVE::JSONSchema::get_options($vzdump_method_info->{parameters},
$args, undef, undef, 'vmid');
$opts->{id} = "$digest:$jid";
$jid++;
$opts->{hour} = $hour;
$opts->{minute} = $minute;
$opts->{dow} = &$dowhash_to_dow($dowhash);
push @$jobs, $opts;
};
my $err = $@;
if ($err) {
syslog ('err', "parse error in '$filename': $err");
push @$ejobs, { line => $line };
}
} elsif ($line =~ m|^\S+\s+(\S+)\s+\S+\s+\S+\s+\S+\s+\S+\s+(\S.*)$|) {
syslog ('err', "warning: malformed line in '$filename'");
push @$ejobs, { line => $line };
} else {
syslog ('err', "ignoring malformed line in '$filename'");
}
}
my $res = {};
$res->{digest} = $digest;
$res->{jobs} = $jobs;
$res->{ejobs} = $ejobs;
return $res;
}
sub write_config {
my ($filename, $cfg) = @_;
my $out = "# cluster wide vzdump cron schedule\n";
$out .= "# Atomatically generated file - do not edit\n\n";
$out .= "PATH=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n\n";
my $jobs = $cfg->{jobs} || [];
foreach my $job (@$jobs) {
my $dh = parse_dow($job->{dow});
my $dow;
if ($dh->{mon} && $dh->{tue} && $dh->{wed} && $dh->{thu} &&
$dh->{fri} && $dh->{sat} && $dh->{sun}) {
$dow = '*';
} else {
$dow = &$dowhash_to_dow($dh, 1);
$dow = '*' if !$dow;
}
my $param = "";
foreach my $p (keys %$job) {
next if $p eq 'id' || $p eq 'vmid' || $p eq 'hour' ||
$p eq 'minute' || $p eq 'dow';
$param .= " --$p " . $job->{$p};
}
$param .= $job->{vmid} if $job->{vmid};
$out .= sprintf "$job->{minute} $job->{hour} * * %-11s root vzdump$param\n", $dow;
}
my $ejobs = $cfg->{ejobs} || [];
foreach my $job (@$ejobs) {
$out .= "$job->{line}\n" if $job->{line};
}
return $out;
}
__PACKAGE__->register_method({
name => 'vzdump',
path => 'vzdump',
method => 'GET',
description => "List vzdump backup schedule.",
parameters => {
additionalProperties => 0,
properties => {},
},
returns => {
type => 'array',
items => {
type => "object",
properties => {
id => { type => 'string' },
},
},
links => [ { rel => 'child', href => "{id}" } ],
},
code => sub {
my ($param) = @_;
my $rpcenv = PVE::RPCEnvironment::get();
my $user = $rpcenv->get_user();
my $data = cfs_read_file('vzdump');
my $res = $data->{jobs} || [];
return $res;
}});
1;
PVE/API2/Makefile
View file @ 57d30b80
......@@ -2,6 +2,7 @@ include ../../defines.mk
PERLSOURCE = \
VZDump.pm \
Backup.pm \
Cluster.pm \
Nodes.pm \
Tasks.pm \
......
PVE/API2/VZDump.pm
View file @ 57d30b80
......@@ -25,132 +25,13 @@ __PACKAGE__->register_method ({
protected => 1,
parameters => {
additionalProperties => 0,
properties => {
vmid => {
type => 'string', format => 'pve-vmid-list',
description => "The ID of the VM you want to backup.",
optional => 1,
},
node => get_standard_option('pve-node', {
description => "Only run if executed on this node.",
optional => 1,
}),
all => {
type => 'boolean',
description => "Backup all known VMs on this host.",
optional => 1,
default => 0,
},
stdexcludes => {
type => 'boolean',
description => "Exclude temorary files and logs.",
optional => 1,
default => 1,
},
compress => {
type => 'boolean',
description => "Compress dump file (gzip).",
optional => 1,
default => 0,
},
quiet => {
type => 'boolean',
description => "Be quiet.",
optional => 1,
default => 0,
},
stop => {
type => 'boolean',
description => "Stop/Restart VM when running.",
optional => 1,
},
snapshot => {
type => 'boolean',
description => "Try to use (LVM) snapshots when running.",
optional => 1,
},
suspend => {
type => 'boolean',
description => "Suspend/resume VM when running",
optional => 1,
},
properties => PVE::VZDump::json_config_properties({
stdout => {
type => 'boolean',
description => "Write tar to stdout, not to a file.",
optional => 1,
},
exclude => {
type => 'string', format => 'pve-vmid-list',
description => "exclude specified VMs (assumes --all)",
optional => 1,
},
'exclude-path' => {
type => 'string', format => 'string-list',
description => "exclude certain files/directories (regex).",
optional => 1,
},
mailto => {
type => 'string', format => 'string-list',
description => "",
optional => 1,
},
tmpdir => {
type => 'string',
description => "Store temporary files to specified directory.",
optional => 1,
},
dumpdir => {
type => 'string',
description => "Store resulting files to specified directory.",
optional => 1,
},
script => {
type => 'string',
description => "Use specified hook script.",
optional => 1,
},
storage => get_standard_option('pve-storage-id', {
description => "Store resulting file to this storage.",
optional => 1,
}),
size => {
type => 'integer',
description => "LVM snapshot size im MB.",
optional => 1,
minimum => 500,
},
bwlimit => {
type => 'integer',
description => "Limit I/O bandwidth (KBytes per second).",
optional => 1,
minimum => 0,
},
ionice => {
type => 'integer',
description => "Set CFQ ionice priority.",
optional => 1,
minimum => 0,
maximum => 8,
},
lockwait => {
type => 'integer',
description => "Maximal time to wait for the global lock (minutes).",
optional => 1,
minimum => 0,
},
stopwait => {
type => 'integer',
description => "Maximal time to wait until a VM is stopped (minutes).",
optional => 1,
minimum => 0,
},
maxfiles => {
type => 'integer',
description => "Maximal number of backup files per VM.",
optional => 1,
minimum => 1,
},
},
}),
},
returns => { type => 'string' },
code => sub {
......
PVE/VZDump.pm
View file @ 57d30b80
......@@ -14,6 +14,7 @@ use PVE::Cluster qw(cfs_read_file);
use PVE::VZDump::OpenVZ;
use Time::localtime;
use Time::Local;
use PVE::JSONSchema qw(get_standard_option);
my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs);
......@@ -1013,4 +1014,137 @@ sub exec_backup {
die "job errors\n" if $errcount;
}
my $confdesc = {
vmid => {
type => 'string', format => 'pve-vmid-list',
description => "The ID of the VM you want to backup.",
optional => 1,
},
node => get_standard_option('pve-node', {
description => "Only run if executed on this node.",
optional => 1,
}),
all => {
type => 'boolean',
description => "Backup all known VMs on this host.",
optional => 1,
default => 0,
},
stdexcludes => {
type => 'boolean',
description => "Exclude temorary files and logs.",
optional => 1,
default => 1,
},
compress => {
type => 'boolean',
description => "Compress dump file (gzip).",
optional => 1,
default => 0,
},
quiet => {
type => 'boolean',
description => "Be quiet.",
optional => 1,
default => 0,
},
stop => {
type => 'boolean',
description => "Stop/Restart VM when running.",
optional => 1,
},
snapshot => {
type => 'boolean',
description => "Try to use (LVM) snapshots when running.",
optional => 1,
},
suspend => {
type => 'boolean',
description => "Suspend/resume VM when running",
optional => 1,
},
exclude => {
type => 'string', format => 'pve-vmid-list',
description => "exclude specified VMs (assumes --all)",
optional => 1,
},
'exclude-path' => {
type => 'string', format => 'string-alist',
description => "exclude certain files/directories (regex).",
optional => 1,
},
mailto => {
type => 'string', format => 'string-list',
description => "",
optional => 1,
},
tmpdir => {
type => 'string',
description => "Store temporary files to specified directory.",
optional => 1,
},
dumpdir => {
type => 'string',
description => "Store resulting files to specified directory.",
optional => 1,
},
script => {
type => 'string',
description => "Use specified hook script.",
optional => 1,
},
storage => get_standard_option('pve-storage-id', {
description => "Store resulting file to this storage.",
optional => 1,
}),
size => {
type => 'integer',
description => "LVM snapshot size im MB.",
optional => 1,
minimum => 500,
},
bwlimit => {
type => 'integer',
description => "Limit I/O bandwidth (KBytes per second).",
optional => 1,
minimum => 0,
},
ionice => {
type => 'integer',
description => "Set CFQ ionice priority.",
optional => 1,
minimum => 0,
maximum => 8,
},
lockwait => {
type => 'integer',
description => "Maximal time to wait for the global lock (minutes).",
optional => 1,
minimum => 0,
},
stopwait => {
type => 'integer',
description => "Maximal time to wait until a VM is stopped (minutes).",
optional => 1,
minimum => 0,
},
maxfiles => {
type => 'integer',
description => "Maximal number of backup files per VM.",
optional => 1,
minimum => 1,
},
};
# add JSON properties for create and set function
sub json_config_properties {
my $prop = shift;
foreach my $opt (keys %$confdesc) {
$prop->{$opt} = $confdesc->{$opt};
}
return $prop;
}
1;
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023