drbd: comment that the builtin plugin is depreacated

[pve-storage.git] / PVE / Storage / Plugin.pm

diff --git a/PVE/Storage/Plugin.pm b/PVE/Storage/Plugin.pm
index 8a58ff4050ae516af4ffe708a196e8bf274a704a..57c58a9de470c371eb87cc65be78323201e2654f 100644 (file)
--- a/PVE/Storage/Plugin.pm
+++ b/PVE/Storage/Plugin.pm
@@ -19,6 +19,8 @@ use base qw(PVE::SectionConfig);
 
 use constant COMPRESSOR_RE => 'gz|lzo|zst';
 
+use constant NOTES_EXT => ".notes";
+
 our @COMMON_TAR_FLAGS = qw(
     --one-file-system
     -p --sparse --numeric-owner --acls
@@ -49,45 +51,55 @@ my %prune_option = (
     format_description => 'N',
 );
 
-my $prune_backups_format = {
-       'keep-last' => {
-           %prune_option,
-           description => 'Keep the last <N> backups.',
-       },
-       'keep-hourly' => {
-           %prune_option,
-           description => 'Keep backups for the last <N> different hours. If there is more' .
-                          'than one backup for a single hour, only the latest one is kept.'
-       },
-       'keep-daily' => {
-           %prune_option,
-           description => 'Keep backups for the last <N> different days. If there is more' .
-                          'than one backup for a single day, only the latest one is kept.'
-       },
-       'keep-weekly' => {
-           %prune_option,
-           description => 'Keep backups for the last <N> different weeks. If there is more' .
-                          'than one backup for a single week, only the latest one is kept.'
-       },
-       'keep-monthly' => {
-           %prune_option,
-           description => 'Keep backups for the last <N> different months. If there is more' .
-                          'than one backup for a single month, only the latest one is kept.'
-       },
-       'keep-yearly' => {
-           %prune_option,
-           description => 'Keep backups for the last <N> different years. If there is more' .
-                          'than one backup for a single year, only the latest one is kept.'
-       },
+our $prune_backups_format = {
+    'keep-all' => {
+       type => 'boolean',
+       description => 'Keep all backups. Conflicts with the other options when true.',
+       optional => 1,
+    },
+    'keep-last' => {
+       %prune_option,
+       description => 'Keep the last <N> backups.',
+    },
+    'keep-hourly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different hours. If there is more' .
+                      'than one backup for a single hour, only the latest one is kept.'
+    },
+    'keep-daily' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different days. If there is more' .
+                      'than one backup for a single day, only the latest one is kept.'
+    },
+    'keep-weekly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different weeks. If there is more' .
+                      'than one backup for a single week, only the latest one is kept.'
+    },
+    'keep-monthly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different months. If there is more' .
+                      'than one backup for a single month, only the latest one is kept.'
+    },
+    'keep-yearly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different years. If there is more' .
+                      'than one backup for a single year, only the latest one is kept.'
+    },
 };
 PVE::JSONSchema::register_format('prune-backups', $prune_backups_format, \&validate_prune_backups);
 sub validate_prune_backups {
-    my ($keep) = @_;
+    my ($prune_backups) = @_;
+
+    my $keep_all = delete $prune_backups->{'keep-all'};
 
-    die "at least one keep-option must be set and positive\n"
-       if !grep { $_ } values %{$keep};
+    if (!scalar(grep {$_ > 0} values %{$prune_backups})) {
+       $prune_backups = { 'keep-all' => 1 };
+    } elsif ($keep_all) {
+       die "keep-all cannot be set together with other options.\n";
+    }
 
-    return $keep;
+    return $prune_backups;
 }
 register_standard_option('prune-backups', {
     description => "The retention options with shorter intervals are processed first " .
@@ -425,6 +437,7 @@ sub on_add_hook {
     my ($class, $storeid, $scfg, %param) = @_;
 
     # do nothing by default
+    return undef;
 }
 
 # called during storage configuration update (before the updated storage config got written)
@@ -434,6 +447,7 @@ sub on_update_hook {
     my ($class, $storeid, $scfg, %param) = @_;
 
     # do nothing by default
+    return undef;
 }
 
 # called during deletion of storage (before the new storage config got written)
@@ -445,6 +459,7 @@ sub on_delete_hook {
     my ($class, $storeid, $scfg) = @_;
 
     # do nothing by default
+    return undef;
 }
 
 sub cluster_lock_storage {
@@ -783,6 +798,12 @@ sub file_size_info {
 
     my $st = File::stat::stat($filename);
 
+    if (!defined($st)) {
+       my $extramsg = -l $filename ? ' - dangling symlink?' : '';
+       warn "failed to stat '$filename'$extramsg\n";
+       return undef;
+    }
+
     if (S_ISDIR($st->mode)) {
        return wantarray ? (0, 'subvol', 0, undef, $st->ctime) : 1;
     }
@@ -805,6 +826,18 @@ sub file_size_info {
     return wantarray ? ($size, $format, $used, $parent, $st->ctime) : $size;
 }
 
+sub get_volume_notes {
+    my ($class, $scfg, $storeid, $volname, $timeout) = @_;
+
+    die "volume notes are not supported for $class";
+}
+
+sub update_volume_notes {
+    my ($class, $scfg, $storeid, $volname, $notes, $timeout) = @_;
+
+    die "volume notes are not supported for $class";
+}
+
 sub volume_size_info {
     my ($class, $scfg, $storeid, $volname, $timeout) = @_;
     my $path = $class->filesystem_path($scfg, $volname);
@@ -882,6 +915,10 @@ sub volume_snapshot_delete {
     return undef;
 }
 
+sub volume_snapshot_needs_fsfreeze {
+
+    return 0;
+}
 sub storage_can_replicate {
     my ($class, $scfg, $storeid, $format) = @_;
 
@@ -978,7 +1015,6 @@ my $get_subdir_files = sub {
     my $res = [];
 
     foreach my $fn (<$path/*>) {
-
        my $st = File::stat::stat($fn);
 
        next if (!$st || S_ISDIR($st->mode));
@@ -998,6 +1034,7 @@ my $get_subdir_files = sub {
        } elsif ($tt eq 'backup') {
            next if defined($vmid) && $fn !~  m/\S+-$vmid-\S+/;
            next if $fn !~ m!/([^/]+\.(tgz|(?:(?:tar|vma)(?:\.(${\COMPRESSOR_RE}))?)))$!;
+           my $original = $fn;
            my $format = $2;
            $fn = $1;
            $info = { volid => "$sid:backup/$fn", format => $format };
@@ -1010,6 +1047,12 @@ my $get_subdir_files = sub {
                $info->{vmid} = $vmid // $1;
            }
 
+           my $notes_fn = $original.NOTES_EXT;
+           if (-f $notes_fn) {
+               my $notes = PVE::Tools::file_read_firstline($notes_fn);
+               $info->{notes} = $notes if defined($notes);
+           }
+
        } elsif ($tt eq 'snippets') {
 
            $info = {