]>
git.proxmox.com Git - pve-storage.git/blob - PVE/Storage/RBDPlugin.pm
1 package PVE
::Storage
::RBDPlugin
;
7 use PVE
::Tools
qw(run_command trim);
8 use PVE
::Storage
::Plugin
;
9 use PVE
::JSONSchema
qw(get_standard_option);
11 use base
qw(PVE::Storage::Plugin);
13 my $rbd_unittobytes = {
16 "G" => 1024*1024*1024,
17 "T" => 1024*1024*1024*1024,
20 my $add_pool_to_disk = sub {
21 my ($scfg, $disk) = @_;
23 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
29 my ($list_text, $separator) = @_;
31 my @monhostlist = PVE
::Tools
::split_list
($list_text);
32 return join($separator, map {
33 my ($host, $port) = PVE
::Tools
::parse_host_and_port
($_);
34 $port = defined($port) ?
":$port" : '';
35 $host = "[$host]" if Net
::IP
::ip_is_ipv6
($host);
41 my ($binary, $scfg, $storeid, $op, @options) = @_;
43 my $monhost = &$hostlist($scfg->{monhost
}, ',');
45 my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
46 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
47 my $username = $scfg->{username
} ?
$scfg->{username
} : 'admin';
49 my $cmd = [$binary, '-p', $pool, '-m', $monhost];
52 push @$cmd, '-n', "client.$username";
53 push @$cmd, '--keyring', $keyring;
54 push @$cmd, '--auth_supported', 'cephx';
56 push @$cmd, '--auth_supported', 'none';
59 my $cephconfig = "/etc/pve/priv/ceph/${storeid}.conf";
62 push @$cmd, '-c', $cephconfig;
67 push @$cmd, @options if scalar(@options);
73 my ($scfg, $storeid, $op, @options) = @_;
75 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
79 my ($scfg, $storeid, $op, @options) = @_;
81 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
84 # needed for volumes created using ceph jewel (or higher)
85 my $krdb_feature_disable = sub {
86 my ($scfg, $storeid, $name) = @_;
88 return 1 if !$scfg->{krbd
};
90 my ($major, undef, undef, undef) = ceph_version
();
91 return 1 if $major < 10;
93 my $feature_cmd = &$rbd_cmd($scfg, $storeid, 'feature', 'disable', $name, 'deep-flatten,fast-diff,object-map,exclusive-lock');
94 run_rbd_command
($feature_cmd, errmsg
=> "could not disable krbd-incompatible image features of rbd volume $name");
97 my $ceph_version_parser = sub {
99 if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))/) {
100 return ($2, $3, $4, $1);
102 warn "Could not parse Ceph version: '$line'\n";
109 my $version_string = $cache;
115 if (defined($version_string)) {
116 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($version_string);
118 run_command
('ceph --version', outfunc
=> sub {
120 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($line);
123 return undef if !defined($version_string);
124 return wantarray ?
($major, $minor, $bugfix, $version_string) : $version_string;
127 sub run_rbd_command
{
128 my ($cmd, %args) = @_;
131 my $errmsg = $args{errmsg
} . ": " || "";
132 if (!exists($args{errfunc
})) {
133 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
134 # at least 1 child(ren) in pool cephstor1
135 $args{errfunc
} = sub {
137 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
142 print STDERR
$lasterr;
147 eval { run_command
($cmd, %args); };
149 die $errmsg . $lasterr if length($lasterr);
157 my ($scfg, $storeid) = @_;
159 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l');
160 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
167 if ($line =~ m/^((vm|base)-(\d+)-\S+)\s+(\d+)(k|M|G|T)\s((\S+)\/((vm
|base
)-\d
+-\S
+@\S+))?
/) {
168 my ($image, $owner, $size, $unit, $parent) = ($1, $3, $4, $5, $8);
169 return if $image =~ /@/; #skip snapshots
171 $list->{$pool}->{$image} = {
173 size
=> $size*$rbd_unittobytes->{$unit},
181 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
185 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
190 sub rbd_volume_info
{
191 my ($scfg, $storeid, $volname, $snap) = @_;
196 $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname, '--snap', $snap);
198 $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname);
204 my $protected = undef;
209 if ($line =~ m/size (\d+) (k|M|G|T)B in (\d+) objects/) {
210 $size = $1 * $rbd_unittobytes->{$2} if ($1);
211 } elsif ($line =~ m/parent:\s(\S+)\/(\S
+)/) {
213 } elsif ($line =~ m/format:\s(\d+)/) {
215 } elsif ($line =~ m/protected:\s(\S+)/) {
216 $protected = 1 if $1 eq "True";
221 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
223 return ($size, $parent, $format, $protected);
234 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
241 description
=> "IP addresses of monitors (for external clusters).",
242 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
245 description
=> "Pool.",
249 description
=> "RBD Id.",
253 description
=> "Authsupported.",
257 description
=> "Access rbd through krbd kernel module.",
265 nodes
=> { optional
=> 1 },
266 disable
=> { optional
=> 1 },
267 monhost
=> { optional
=> 1},
268 pool
=> { optional
=> 1 },
269 username
=> { optional
=> 1 },
270 content
=> { optional
=> 1 },
271 krbd
=> { optional
=> 1 },
275 # Storage implementation
278 my ($class, $volname) = @_;
280 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
281 return ('images', $4, $7, $2, $3, $5, 'raw');
284 die "unable to parse rbd volume name '$volname'\n";
288 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
290 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
291 $name .= '@'.$snapname if $snapname;
293 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
294 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
296 my $monhost = &$hostlist($scfg->{monhost
}, ';');
297 $monhost =~ s/:/\\:/g;
299 my $username = $scfg->{username
} ?
$scfg->{username
} : 'admin';
301 my $path = "rbd:$pool/$name:mon_host=$monhost";
302 my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
305 $path .= ":id=$username:auth_supported=cephx:keyring=$keyring";
307 $path .= ":auth_supported=none";
310 my $cephconfig = "/etc/pve/priv/ceph/${storeid}.conf";
312 if (-e
$cephconfig) {
313 $path .= ":conf=$cephconfig";
316 return ($path, $vmid, $vtype);
319 my $find_free_diskname = sub {
320 my ($storeid, $scfg, $vmid) = @_;
322 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
328 if ($line =~ m/^(vm|base)-\Q$vmid\E+-disk-(\d+)$/) {
334 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
338 die $err if $err && $err !~ m/doesn't contain rbd images/;
340 #fix: can we search in $rbd hash key with a regex to find (vm|base) ?
341 for (my $i = 1; $i < 100; $i++) {
342 if (!$disk_ids->{$i}) {
343 return "vm-$vmid-disk-$i";
347 die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
351 my ($class, $storeid, $scfg, $volname) = @_;
353 my $snap = '__base__';
355 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
356 $class->parse_volname($volname);
358 die "create_base not possible with base image\n" if $isBase;
360 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
361 die "rbd volume info on '$name' failed\n" if !($size);
363 die "rbd image must be at format V2" if $format ne "2";
365 die "volname '$volname' contains wrong information about parent $parent $basename\n"
366 if $basename && (!$parent || $parent ne $basename."@".$snap);
369 $newname =~ s/^vm-/base-/;
371 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
373 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
374 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
376 my $running = undef; #fixme : is create_base always offline ?
378 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
380 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
383 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
384 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
392 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
394 my $snap = '__base__';
395 $snap = $snapname if length $snapname;
397 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
398 $class->parse_volname($volname);
400 die "$volname is not a base image and snapname is not provided\n"
401 if !$isBase && !length($snapname);
403 my $name = &$find_free_diskname($storeid, $scfg, $vmid);
405 warn "clone $volname: $basename snapname $snap to $name\n";
407 if (length($snapname)) {
408 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
411 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
412 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
416 my $newvol = "$basename/$name";
417 $newvol = $name if length($snapname);
419 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
420 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
422 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
424 &$krdb_feature_disable($scfg, $storeid, $name);
430 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
433 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
434 if $name && $name !~ m/^vm-$vmid-/;
436 $name = &$find_free_diskname($storeid, $scfg, $vmid) if !$name;
438 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
439 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
441 &$krdb_feature_disable($scfg, $storeid, $name);
447 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
449 my ($vtype, $name, $vmid, undef, undef, undef) =
450 $class->parse_volname($volname);
453 my $snap = '__base__';
454 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
456 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
457 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
461 $class->deactivate_volume($storeid, $scfg, $volname);
463 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
464 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
466 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
467 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
473 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
475 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
476 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
480 if (my $dat = $cache->{rbd
}->{$pool}) {
481 foreach my $image (keys %$dat) {
483 my $info = $dat->{$image};
485 my $volname = $info->{name
};
486 my $parent = $info->{parent
};
487 my $owner = $info->{vmid
};
489 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
490 $info->{volid
} = "$storeid:$1/$volname";
492 $info->{volid
} = "$storeid:$volname";
496 my $found = grep { $_ eq $info->{volid
} } @$vollist;
499 next if defined ($vmid) && ($owner ne $vmid);
502 $info->{format
} = 'raw';
512 my ($class, $storeid, $scfg, $cache) = @_;
514 my $cmd = &$rados_cmd($scfg, $storeid, 'df');
520 if ($line =~ m/^\s*total(?:\s|_)(\S+)\s+(\d+)(k|M|G|T)?/) {
522 # luminous has units here..
524 $stats->{$1} *= $rbd_unittobytes->{$3}/1024;
530 run_rbd_command
($cmd, errmsg
=> "rados error", errfunc
=> sub {}, outfunc
=> $parser);
533 my $total = $stats->{space
} ?
$stats->{space
}*1024 : 0;
534 my $free = $stats->{avail
} ?
$stats->{avail
}*1024 : 0;
535 my $used = $stats->{used
} ?
$stats->{used
}*1024: 0;
538 return ($total, $free, $used, $active);
541 sub activate_storage
{
542 my ($class, $storeid, $scfg, $cache) = @_;
546 sub deactivate_storage
{
547 my ($class, $storeid, $scfg, $cache) = @_;
551 sub activate_volume
{
552 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
554 return 1 if !$scfg->{krbd
};
556 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
557 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
559 my $path = "/dev/rbd/$pool/$name";
560 $path .= '@'.$snapname if $snapname;
563 $name .= '@'.$snapname if $snapname;
564 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
565 run_rbd_command
($cmd, errmsg
=> "can't mount rbd volume $name");
570 sub deactivate_volume
{
571 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
573 return 1 if !$scfg->{krbd
};
575 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
576 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
578 my $path = "/dev/rbd/$pool/$name";
579 $path .= '@'.$snapname if $snapname;
580 return if ! -b
$path;
582 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $path);
583 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd volume $name");
588 sub volume_size_info
{
589 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
591 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
592 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
597 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
599 return 1 if $running && !$scfg->{krbd
};
601 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
603 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
604 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
608 sub volume_snapshot
{
609 my ($class, $scfg, $storeid, $volname, $snap) = @_;
611 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
613 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
614 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
618 sub volume_snapshot_rollback
{
619 my ($class, $scfg, $storeid, $volname, $snap) = @_;
621 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
623 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
624 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
627 sub volume_snapshot_delete
{
628 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
630 return 1 if $running && !$scfg->{krbd
};
632 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
634 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
636 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
638 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
639 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
642 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
644 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
649 sub volume_has_feature
{
650 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
653 snapshot
=> { current
=> 1, snap
=> 1},
654 clone
=> { base
=> 1, snap
=> 1},
655 template
=> { current
=> 1},
656 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
657 sparseinit
=> { base
=> 1, current
=> 1},
660 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
661 $class->parse_volname($volname);
667 $key = $isBase ?
'base' : 'current';
669 return 1 if $features->{$feature}->{$key};