[pve-devel] [PATCH v4 manager 1/2] vzdump: move code needed for cfs register of vzdump.cron to guest-common
Christian Ebner
c.ebner at proxmox.com
Tue Oct 15 13:00:22 CEST 2019
This removes the cfs register code for vzdump.cron, now located in pve-guest-common.
It therefore relies on the corresponding patches in pve-guest-common
be6bd58a51f2bba931136595b93cb1ad41b0abdd
and pve-docs
82af9e5b9a7f620356e46c76f324c1a425964243
as build dependencies.
Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
version 4:
* not present in v3
PVE/API2/Backup.pm | 169 +----------------------------------
PVE/API2/VZDump.pm | 5 +-
PVE/VZDump.pm | 213 +--------------------------------------------
3 files changed, 9 insertions(+), 378 deletions(-)
diff --git a/PVE/API2/Backup.pm b/PVE/API2/Backup.pm
index 0b69cc62..86377c0a 100644
--- a/PVE/API2/Backup.pm
+++ b/PVE/API2/Backup.pm
@@ -6,20 +6,17 @@ use Digest::SHA;
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::Cluster qw(cfs_lock_file cfs_read_file cfs_write_file);
use PVE::RESTHandler;
use PVE::RPCEnvironment;
use PVE::JSONSchema;
use PVE::Storage;
use PVE::Exception qw(raise_param_exc);
use PVE::VZDump;
+use PVE::VZDump::Common;
use base qw(PVE::RESTHandler);
-cfs_register_file ('vzdump.cron',
- \&parse_vzdump_cron_config,
- \&write_vzdump_cron_config);
-
PVE::JSONSchema::register_format('pve-day-of-week', \&verify_day_of_week);
sub verify_day_of_week {
my ($value, $noerr) = @_;
@@ -37,164 +34,6 @@ my $vzdump_job_id_prop = {
maxLength => 50
};
-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;
-};
-
-# parse crontab style day of week
-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 (PVE::Tools::split_list($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;
-};
-
-my $vzdump_properties = {
- additionalProperties => 0,
- properties => PVE::VZDump::json_config_properties({}),
-};
-
-sub parse_vzdump_cron_config {
- my ($filename, $raw) = @_;
-
- my $jobs = []; # correct jobs
-
- my $ejobs = []; # mailfomerd lines
-
- my $jid = 1; # we start at 1
-
- my $digest = Digest::SHA::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 = $7;
- my $enabled = $5;
-
- my $dowhash = parse_dow($dow, 1);
- die "unable to parse day of week '$dow' in '$filename'\n" if !$dowhash;
-
- my $args = PVE::Tools::split_args($param);
- my $opts = PVE::JSONSchema::get_options($vzdump_properties, $args, 'vmid');
-
- $opts->{enabled} = !defined($enabled);
- $opts->{id} = "$digest:$jid";
- $jid++;
- $opts->{starttime} = sprintf "%02d:%02d", $hour, $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_vzdump_cron_config {
- my ($filename, $cfg) = @_;
-
- my $out = "# cluster wide vzdump cron schedule\n";
- $out .= "# Automatically 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 $enabled = ($job->{enabled}) ? '' : '#';
- 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 ($hour, $minute);
-
- die "no job start time specified\n" if !$job->{starttime};
- if ($job->{starttime} =~ m/^(\d{1,2}):(\d{1,2})$/) {
- ($hour, $minute) = (int($1), int($2));
- die "hour '$hour' out of range\n" if $hour < 0 || $hour > 23;
- die "minute '$minute' out of range\n" if $minute < 0 || $minute > 59;
- } else {
- die "unable to parse job start time\n";
- }
-
- $job->{quiet} = 1; # we do not want messages from cron
-
- my $cmd = PVE::VZDump::command_line($job);
-
- $out .= sprintf "$minute $hour * * %-11s root $enabled$cmd\n", $dow;
- }
-
- my $ejobs = $cfg->{ejobs} || [];
- foreach my $job (@$ejobs) {
- $out .= "$job->{line}\n" if $job->{line};
- }
-
- return $out;
-}
-
__PACKAGE__->register_method({
name => 'index',
path => '',
@@ -242,7 +81,7 @@ __PACKAGE__->register_method({
},
parameters => {
additionalProperties => 0,
- properties => PVE::VZDump::json_config_properties({
+ properties => PVE::VZDump::Common::json_config_properties({
starttime => {
type => 'string',
description => "Job Start time.",
@@ -393,7 +232,7 @@ __PACKAGE__->register_method({
},
parameters => {
additionalProperties => 0,
- properties => PVE::VZDump::json_config_properties({
+ properties => PVE::VZDump::Common::json_config_properties({
id => $vzdump_job_id_prop,
starttime => {
type => 'string',
diff --git a/PVE/API2/VZDump.pm b/PVE/API2/VZDump.pm
index d370467c..f01e4de0 100644
--- a/PVE/API2/VZDump.pm
+++ b/PVE/API2/VZDump.pm
@@ -11,6 +11,7 @@ use PVE::AccessControl;
use PVE::JSONSchema qw(get_standard_option);
use PVE::Storage;
use PVE::VZDump;
+use PVE::VZDump::Common;
use PVE::API2Tools;
use Data::Dumper; # fixme: remove
@@ -31,7 +32,7 @@ __PACKAGE__->register_method ({
proxyto => 'node',
parameters => {
additionalProperties => 0,
- properties => PVE::VZDump::json_config_properties({
+ properties => PVE::VZDump::Common::json_config_properties({
stdout => {
type => 'boolean',
description => "Write tar to stdout, not to a file.",
@@ -67,7 +68,7 @@ __PACKAGE__->register_method ({
# silent exit if we run on wrong node
return 'OK' if $param->{node} && $param->{node} ne $nodename;
- my $cmdline = PVE::VZDump::command_line($param);
+ my $cmdline = PVE::VZDump::Common::command_line($param);
my @vmids;
# convert string lists to arrays
if ($param->{pool}) {
diff --git a/PVE/VZDump.pm b/PVE/VZDump.pm
index 39669f49..a829a52e 100644
--- a/PVE/VZDump.pm
+++ b/PVE/VZDump.pm
@@ -17,6 +17,7 @@ use PVE::JSONSchema qw(get_standard_option);
use PVE::HA::Env::PVE2;
use PVE::HA::Config;
use PVE::VZDump::Plugin;
+use PVE::VZDump::Common;
my @posix_filesystems = qw(ext3 ext4 nfs nfs4 reiserfs xfs);
@@ -26,161 +27,7 @@ my $logdir = '/var/log/vzdump';
my @plugins = qw();
-my $confdesc = {
- vmid => {
- type => 'string', format => 'pve-vmid-list',
- description => "The ID of the guest system you want to backup.",
- completion => \&PVE::Cluster::complete_local_vmid,
- optional => 1,
- },
- node => get_standard_option('pve-node', {
- description => "Only run if executed on this node.",
- completion => \&PVE::Cluster::get_nodelist,
- optional => 1,
- }),
- all => {
- type => 'boolean',
- description => "Backup all known guest systems on this host.",
- optional => 1,
- default => 0,
- },
- stdexcludes => {
- type => 'boolean',
- description => "Exclude temporary files and logs.",
- optional => 1,
- default => 1,
- },
- compress => {
- type => 'string',
- description => "Compress dump file.",
- optional => 1,
- enum => ['0', '1', 'gzip', 'lzo'],
- default => '0',
- },
- pigz=> {
- type => "integer",
- description => "Use pigz instead of gzip when N>0.".
- " N=1 uses half of cores, N>1 uses N as thread count.",
- optional => 1,
- default => 0,
- },
- quiet => {
- type => 'boolean',
- description => "Be quiet.",
- optional => 1,
- default => 0,
- },
- mode => {
- type => 'string',
- description => "Backup mode.",
- optional => 1,
- default => 'snapshot',
- enum => [ 'snapshot', 'suspend', 'stop' ],
- },
- exclude => {
- type => 'string', format => 'pve-vmid-list',
- description => "Exclude specified guest systems (assumes --all)",
- optional => 1,
- },
- 'exclude-path' => {
- type => 'string', format => 'string-alist',
- description => "Exclude certain files/directories (shell globs).",
- optional => 1,
- },
- mailto => {
- type => 'string', format => 'string-list',
- description => "Comma-separated list of email addresses that should" .
- " receive email notifications.",
- optional => 1,
- },
- mailnotification => {
- type => 'string',
- description => "Specify when to send an email",
- optional => 1,
- enum => [ 'always', 'failure' ],
- default => 'always',
- },
- 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.",
- completion => \&complete_backup_storage,
- optional => 1,
- }),
- stop => {
- type => 'boolean',
- description => "Stop running backup jobs on this host.",
- optional => 1,
- default => 0,
- },
- size => {
- type => 'integer',
- description => "Unused, will be removed in a future release.",
- optional => 1,
- minimum => 500,
- default => 1024,
- },
- bwlimit => {
- type => 'integer',
- description => "Limit I/O bandwidth (KBytes per second).",
- optional => 1,
- minimum => 0,
- default => 0,
- },
- ionice => {
- type => 'integer',
- description => "Set CFQ ionice priority.",
- optional => 1,
- minimum => 0,
- maximum => 8,
- default => 7,
- },
- lockwait => {
- type => 'integer',
- description => "Maximal time to wait for the global lock (minutes).",
- optional => 1,
- minimum => 0,
- default => 3*60, # 3 hours
- },
- stopwait => {
- type => 'integer',
- description => "Maximal time to wait until a guest system is stopped (minutes).",
- optional => 1,
- minimum => 0,
- default => 10, # 10 minutes
- },
- maxfiles => {
- type => 'integer',
- description => "Maximal number of backup files per guest system.",
- optional => 1,
- minimum => 1,
- default => 1,
- },
- remove => {
- type => 'boolean',
- description => "Remove old backup files if there are more than 'maxfiles' backup files.",
- optional => 1,
- default => 1,
- },
- pool => {
- type => 'string',
- description => 'Backup all known guest systems included in the specified pool.',
- optional => 1,
- }
-};
+my $confdesc = PVE::VZDump::Common::get_confdesc();
# Load available plugins
my @pve_vzdump_classes = qw(PVE::VZDump::QemuServer PVE::VZDump::LXC);
@@ -1161,17 +1008,6 @@ sub option_exists {
return defined($confdesc->{$key});
}
-# 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;
-}
-
sub verify_vzdump_parameters {
my ($param, $check_missing) = @_;
@@ -1218,49 +1054,4 @@ sub stop_running_backups {
}
}
-sub command_line {
- my ($param) = @_;
-
- my $cmd = "vzdump";
-
- if ($param->{vmid}) {
- $cmd .= " " . join(' ', PVE::Tools::split_list($param->{vmid}));
- }
-
- foreach my $p (keys %$param) {
- next if $p eq 'id' || $p eq 'vmid' || $p eq 'starttime' ||
- $p eq 'dow' || $p eq 'stdout' || $p eq 'enabled';
- my $v = $param->{$p};
- my $pd = $confdesc->{$p} || die "no such vzdump option '$p'\n";
- if ($p eq 'exclude-path') {
- foreach my $path (split(/\0/, $v || '')) {
- $cmd .= " --$p " . PVE::Tools::shellquote($path);
- }
- } else {
- $cmd .= " --$p " . PVE::Tools::shellquote($v) if defined($v) && $v ne '';
- }
- }
-
- return $cmd;
-}
-
-# bash completion helpers
-sub complete_backup_storage {
-
- my $cfg = PVE::Storage::config();
- my $ids = $cfg->{ids};
-
- my $nodename = PVE::INotify::nodename();
-
- my $res = [];
- foreach my $sid (keys %$ids) {
- my $scfg = $ids->{$sid};
- next if !PVE::Storage::storage_check_enabled($cfg, $sid, $nodename, 1);
- next if !$scfg->{content}->{backup};
- push @$res, $sid;
- }
-
- return $res;
-}
-
1;
--
2.20.1
More information about the pve-devel
mailing list