]>
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);
12 use base
qw(PVE::Storage::Plugin);
14 my $rbd_unittobytes = {
17 "G" => 1024*1024*1024,
18 "T" => 1024*1024*1024*1024,
21 my $add_pool_to_disk = sub {
22 my ($scfg, $disk) = @_;
24 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
30 my ($list_text, $separator) = @_;
32 my @monhostlist = PVE
::Tools
::split_list
($list_text);
33 return join($separator, map {
34 my ($host, $port) = PVE
::Tools
::parse_host_and_port
($_);
35 $port = defined($port) ?
":$port" : '';
36 $host = "[$host]" if Net
::IP
::ip_is_ipv6
($host);
41 my $ceph_connect_option = sub {
42 my ($scfg, $storeid, %options) = @_;
45 my $ceph_storeid_conf = "/etc/pve/priv/ceph/${storeid}.conf";
46 my $pveceph_config = '/etc/pve/ceph.conf';
47 my $keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
48 my $pveceph_managed = !defined($scfg->{monhost
});
50 $cmd_option->{ceph_conf
} = $pveceph_config if $pveceph_managed;
52 if (-e
$ceph_storeid_conf) {
53 if ($pveceph_managed) {
54 warn "ignoring custom ceph config for storage '$storeid', 'monhost' is not set (assuming pveceph managed cluster)!\n";
56 $cmd_option->{ceph_conf
} = $ceph_storeid_conf;
60 $cmd_option->{keyring
} = $keyring if (-e
$keyring);
61 $cmd_option->{auth_supported
} = (defined $cmd_option->{keyring
}) ?
'cephx' : 'none';
62 $cmd_option->{userid
} = $scfg->{username
} ?
$scfg->{username
} : 'admin';
63 $cmd_option->{mon_host
} = $hostlist->($scfg->{monhost
}, ',') if (defined($scfg->{monhost
}));
66 foreach my $k (keys %options) {
67 $cmd_option->{$k} = $options{$k};
76 my ($binary, $scfg, $storeid, $op, @options) = @_;
78 my $cmd_option = $ceph_connect_option->($scfg, $storeid);
79 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
81 my $cmd = [$binary, '-p', $pool];
83 push @$cmd, '-c', $cmd_option->{ceph_conf
} if ($cmd_option->{ceph_conf
});
84 push @$cmd, '-m', $cmd_option->{mon_host
} if ($cmd_option->{mon_host
});
85 push @$cmd, '--auth_supported', $cmd_option->{auth_supported
} if ($cmd_option->{auth_supported
});
86 push @$cmd, '-n', "client.$cmd_option->{userid}" if ($cmd_option->{userid
});
87 push @$cmd, '--keyring', $cmd_option->{keyring
} if ($cmd_option->{keyring
});
91 push @$cmd, @options if scalar(@options);
97 my ($scfg, $storeid, $op, @options) = @_;
99 return $build_cmd->('/usr/bin/rbd', $scfg, $storeid, $op, @options);
102 my $rados_cmd = sub {
103 my ($scfg, $storeid, $op, @options) = @_;
105 return $build_cmd->('/usr/bin/rados', $scfg, $storeid, $op, @options);
108 my $librados_connect = sub {
109 my ($scfg, $storeid, $options) = @_;
111 my $librados_config = $ceph_connect_option->($scfg, $storeid);
113 my $rados = PVE
::RADOS-
>new(%$librados_config);
118 # needed for volumes created using ceph jewel (or higher)
119 my $krbd_feature_disable = sub {
120 my ($scfg, $storeid, $name) = @_;
122 return 1 if !$scfg->{krbd
};
124 my ($major, undef, undef, undef) = ceph_version
();
125 return 1 if $major < 10;
127 my $krbd_feature_blacklist = ['deep-flatten', 'fast-diff', 'object-map', 'exclusive-lock'];
128 my (undef, undef, undef, undef, $features) = rbd_volume_info
($scfg, $storeid, $name);
130 my $active_features = { map { $_ => 1 } PVE
::Tools
::split_list
($features)};
131 my $incompatible_features = join(',', grep { %$active_features{$_} } @$krbd_feature_blacklist);
133 if ($incompatible_features) {
134 my $feature_cmd = &$rbd_cmd($scfg, $storeid, 'feature', 'disable', $name, $incompatible_features);
135 run_rbd_command
($feature_cmd, errmsg
=> "could not disable krbd-incompatible image features of rbd volume $name");
139 my $ceph_version_parser = sub {
141 if ($line =~ m/^ceph version ((\d+)\.(\d+)\.(\d+))(?: \([a-fA-F0-9]+\))/) {
142 return ($2, $3, $4, $1);
144 warn "Could not parse Ceph version: '$line'\n";
151 my $version_string = $cache;
157 if (defined($version_string)) {
158 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($version_string);
160 run_command
('ceph --version', outfunc
=> sub {
162 ($major, $minor, $bugfix, $version_string) = &$ceph_version_parser($line);
165 return undef if !defined($version_string);
166 return wantarray ?
($major, $minor, $bugfix, $version_string) : $version_string;
169 sub run_rbd_command
{
170 my ($cmd, %args) = @_;
173 my $errmsg = $args{errmsg
} . ": " || "";
174 if (!exists($args{errfunc
})) {
175 # ' error: 2014-02-06 11:51:59.839135 7f09f94d0760 -1 librbd: snap_unprotect: can't unprotect;
176 # at least 1 child(ren) in pool cephstor1
177 $args{errfunc
} = sub {
179 if ($line =~ m/^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}\.\d+ [0-9a-f]+ [\-\d]+ librbd: (.*)$/) {
184 print STDERR
$lasterr;
189 eval { run_command
($cmd, %args); };
191 die $errmsg . $lasterr if length($lasterr);
199 my ($scfg, $storeid) = @_;
201 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls', '-l');
202 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
209 if ($line =~ m/^((vm|base)-(\d+)-\S+)\s+(\d+)(k|M|G|T)\s((\S+)\/((vm
|base
)-\d
+-\S
+@\S+))?
/) {
210 my ($image, $owner, $size, $unit, $parent) = ($1, $3, $4, $5, $8);
211 return if $image =~ /@/; #skip snapshots
213 $list->{$pool}->{$image} = {
215 size
=> $size*$rbd_unittobytes->{$unit},
223 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
227 die $err if $err && $err !~ m/doesn't contain rbd images/ ;
232 sub rbd_volume_info
{
233 my ($scfg, $storeid, $volname, $snap) = @_;
238 $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname, '--snap', $snap);
240 $cmd = &$rbd_cmd($scfg, $storeid, 'info', $volname);
246 my $protected = undef;
247 my $features = undef;
252 if ($line =~ m/size (\d+) (k|M|G|T)B in (\d+) objects/) {
253 $size = $1 * $rbd_unittobytes->{$2} if ($1);
254 } elsif ($line =~ m/parent:\s(\S+)\/(\S
+)/) {
256 } elsif ($line =~ m/format:\s(\d+)/) {
258 } elsif ($line =~ m/protected:\s(\S+)/) {
259 $protected = 1 if $1 eq "True";
260 } elsif ($line =~ m/features:\s(.+)/) {
266 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
268 return ($size, $parent, $format, $protected, $features);
279 content
=> [ {images
=> 1, rootdir
=> 1}, { images
=> 1 }],
286 description
=> "IP addresses of monitors (for external clusters).",
287 type
=> 'string', format
=> 'pve-storage-portal-dns-list',
290 description
=> "Pool.",
294 description
=> "RBD Id.",
298 description
=> "Authsupported.",
302 description
=> "Access rbd through krbd kernel module.",
310 nodes
=> { optional
=> 1 },
311 disable
=> { optional
=> 1 },
312 monhost
=> { optional
=> 1},
313 pool
=> { optional
=> 1 },
314 username
=> { optional
=> 1 },
315 content
=> { optional
=> 1 },
316 krbd
=> { optional
=> 1 },
317 bwlimit
=> { optional
=> 1 },
321 # Storage implementation
324 my ($class, $storeid, $scfg, %param) = @_;
326 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
328 my $ceph_admin_keyring = '/etc/pve/priv/ceph.client.admin.keyring';
329 my $ceph_storage_keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
331 die "ceph authx keyring file for storage '$storeid' already exists!\n"
332 if -e
$ceph_storage_keyring;
335 mkdir '/etc/pve/priv/ceph';
336 PVE
::Tools
::file_copy
($ceph_admin_keyring, $ceph_storage_keyring);
339 unlink $ceph_storage_keyring;
340 die "failed to copy ceph authx keyring for storage '$storeid': $err\n";
346 my ($class, $storeid, $scfg) = @_;
348 return if defined($scfg->{monhost
}); # nothing to do if not pve managed ceph
350 my $ceph_storage_keyring = "/etc/pve/priv/ceph/${storeid}.keyring";
351 if (-f
$ceph_storage_keyring) {
352 unlink($ceph_storage_keyring) or warn "removing keyring of storage failed: $!\n";
358 my ($class, $volname) = @_;
360 if ($volname =~ m/^((base-(\d+)-\S+)\/)?
((base
)?
(vm
)?
-(\d
+)-\S
+)$/) {
361 return ('images', $4, $7, $2, $3, $5, 'raw');
364 die "unable to parse rbd volume name '$volname'\n";
368 my ($class, $scfg, $volname, $storeid, $snapname) = @_;
370 my $cmd_option = $ceph_connect_option->($scfg, $storeid);
371 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
372 $name .= '@'.$snapname if $snapname;
374 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
375 return ("/dev/rbd/$pool/$name", $vmid, $vtype) if $scfg->{krbd
};
377 my $path = "rbd:$pool/$name";
379 $path .= ":conf=$cmd_option->{ceph_conf}" if $cmd_option->{ceph_conf
};
380 if (defined($scfg->{monhost
})) {
381 my $monhost = $hostlist->($scfg->{monhost
}, ';');
382 $monhost =~ s/:/\\:/g;
383 $path .= ":mon_host=$monhost";
384 $path .= ":auth_supported=$cmd_option->{auth_supported}";
387 $path .= ":id=$cmd_option->{userid}:keyring=$cmd_option->{keyring}" if ($cmd_option->{keyring
});
389 return ($path, $vmid, $vtype);
392 my $find_free_diskname = sub {
393 my ($storeid, $scfg, $vmid) = @_;
395 my $cmd = &$rbd_cmd($scfg, $storeid, 'ls');
401 if ($line =~ m/^(vm|base)-\Q$vmid\E+-disk-(\d+)$/) {
407 run_rbd_command
($cmd, errmsg
=> "rbd error", errfunc
=> sub {}, outfunc
=> $parser);
411 die $err if $err && $err !~ m/doesn't contain rbd images/;
413 #fix: can we search in $rbd hash key with a regex to find (vm|base) ?
414 for (my $i = 1; $i < 100; $i++) {
415 if (!$disk_ids->{$i}) {
416 return "vm-$vmid-disk-$i";
420 die "unable to allocate an image name for VM $vmid in storage '$storeid'\n";
424 my ($class, $storeid, $scfg, $volname) = @_;
426 my $snap = '__base__';
428 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
429 $class->parse_volname($volname);
431 die "create_base not possible with base image\n" if $isBase;
433 my ($size, $parent, $format, undef) = rbd_volume_info
($scfg, $storeid, $name);
434 die "rbd volume info on '$name' failed\n" if !($size);
436 die "rbd image must be at format V2" if $format ne "2";
438 die "volname '$volname' contains wrong information about parent $parent $basename\n"
439 if $basename && (!$parent || $parent ne $basename."@".$snap);
442 $newname =~ s/^vm-/base-/;
444 my $newvolname = $basename ?
"$basename/$newname" : "$newname";
446 my $cmd = &$rbd_cmd($scfg, $storeid, 'rename', &$add_pool_to_disk($scfg, $name), &$add_pool_to_disk($scfg, $newname));
447 run_rbd_command
($cmd, errmsg
=> "rbd rename '$name' error");
449 my $running = undef; #fixme : is create_base always offline ?
451 $class->volume_snapshot($scfg, $storeid, $newname, $snap, $running);
453 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $newname, $snap);
456 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $newname, '--snap', $snap);
457 run_rbd_command
($cmd, errmsg
=> "rbd protect $newname snap '$snap' error");
465 my ($class, $scfg, $storeid, $volname, $vmid, $snapname) = @_;
467 my $snap = '__base__';
468 $snap = $snapname if length $snapname;
470 my ($vtype, $basename, $basevmid, undef, undef, $isBase) =
471 $class->parse_volname($volname);
473 die "$volname is not a base image and snapname is not provided\n"
474 if !$isBase && !length($snapname);
476 my $name = &$find_free_diskname($storeid, $scfg, $vmid);
478 warn "clone $volname: $basename snapname $snap to $name\n";
480 if (length($snapname)) {
481 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $volname, $snapname);
484 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'protect', $volname, '--snap', $snapname);
485 run_rbd_command
($cmd, errmsg
=> "rbd protect $volname snap $snapname error");
489 my $newvol = "$basename/$name";
490 $newvol = $name if length($snapname);
492 my $cmd = &$rbd_cmd($scfg, $storeid, 'clone', &$add_pool_to_disk($scfg, $basename),
493 '--snap', $snap, &$add_pool_to_disk($scfg, $name));
495 run_rbd_command
($cmd, errmsg
=> "rbd clone '$basename' error");
497 &$krbd_feature_disable($scfg, $storeid, $name);
503 my ($class, $storeid, $scfg, $vmid, $fmt, $name, $size) = @_;
506 die "illegal name '$name' - should be 'vm-$vmid-*'\n"
507 if $name && $name !~ m/^vm-$vmid-/;
509 $name = &$find_free_diskname($storeid, $scfg, $vmid) if !$name;
511 my $cmd = &$rbd_cmd($scfg, $storeid, 'create', '--image-format' , 2, '--size', int(($size+1023)/1024), $name);
512 run_rbd_command
($cmd, errmsg
=> "rbd create $name' error");
514 &$krbd_feature_disable($scfg, $storeid, $name);
520 my ($class, $storeid, $scfg, $volname, $isBase) = @_;
522 my ($vtype, $name, $vmid, undef, undef, undef) =
523 $class->parse_volname($volname);
526 my $snap = '__base__';
527 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
529 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
530 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
534 $class->deactivate_volume($storeid, $scfg, $volname);
536 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'purge', $name);
537 run_rbd_command
($cmd, errmsg
=> "rbd snap purge '$volname' error");
539 $cmd = &$rbd_cmd($scfg, $storeid, 'rm', $name);
540 run_rbd_command
($cmd, errmsg
=> "rbd rm '$volname' error");
546 my ($class, $storeid, $scfg, $vmid, $vollist, $cache) = @_;
548 $cache->{rbd
} = rbd_ls
($scfg, $storeid) if !$cache->{rbd
};
549 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
553 if (my $dat = $cache->{rbd
}->{$pool}) {
554 foreach my $image (keys %$dat) {
556 my $info = $dat->{$image};
558 my $volname = $info->{name
};
559 my $parent = $info->{parent
};
560 my $owner = $info->{vmid
};
562 if ($parent && $parent =~ m/^(base-\d+-\S+)\@__base__$/) {
563 $info->{volid
} = "$storeid:$1/$volname";
565 $info->{volid
} = "$storeid:$volname";
569 my $found = grep { $_ eq $info->{volid
} } @$vollist;
572 next if defined ($vmid) && ($owner ne $vmid);
575 $info->{format
} = 'raw';
585 my ($class, $storeid, $scfg, $cache) = @_;
588 my $rados = &$librados_connect($scfg, $storeid);
589 my $df = $rados->mon_command({ prefix
=> 'df', format
=> 'json' });
591 my ($d) = grep { $_->{name
} eq $scfg->{pool
} } @{$df->{pools
}};
593 # max_avail -> max available space for data w/o replication in the pool
594 # bytes_used -> data w/o replication in the pool
595 my $free = $d->{stats
}->{max_avail
};
596 my $used = $d->{stats
}->{bytes_used
};
597 my $total = $used + $free;
600 return ($total, $free, $used, $active);
603 sub activate_storage
{
604 my ($class, $storeid, $scfg, $cache) = @_;
608 sub deactivate_storage
{
609 my ($class, $storeid, $scfg, $cache) = @_;
613 sub activate_volume
{
614 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
616 return 1 if !$scfg->{krbd
};
618 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
619 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
621 my $path = "/dev/rbd/$pool/$name";
622 $path .= '@'.$snapname if $snapname;
625 $name .= '@'.$snapname if $snapname;
626 my $cmd = &$rbd_cmd($scfg, $storeid, 'map', $name);
627 run_rbd_command
($cmd, errmsg
=> "can't mount rbd volume $name");
632 sub deactivate_volume
{
633 my ($class, $storeid, $scfg, $volname, $snapname, $cache) = @_;
635 return 1 if !$scfg->{krbd
};
637 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
638 my $pool = $scfg->{pool
} ?
$scfg->{pool
} : 'rbd';
640 my $path = "/dev/rbd/$pool/$name";
641 $path .= '@'.$snapname if $snapname;
642 return if ! -b
$path;
644 my $cmd = &$rbd_cmd($scfg, $storeid, 'unmap', $path);
645 run_rbd_command
($cmd, errmsg
=> "can't unmap rbd volume $name");
650 sub volume_size_info
{
651 my ($class, $scfg, $storeid, $volname, $timeout) = @_;
653 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
654 my ($size, undef) = rbd_volume_info
($scfg, $storeid, $name);
659 my ($class, $scfg, $storeid, $volname, $size, $running) = @_;
661 return 1 if $running && !$scfg->{krbd
};
663 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
665 my $cmd = &$rbd_cmd($scfg, $storeid, 'resize', '--allow-shrink', '--size', ($size/1024/1024), $name);
666 run_rbd_command
($cmd, errmsg
=> "rbd resize '$volname' error");
670 sub volume_snapshot
{
671 my ($class, $scfg, $storeid, $volname, $snap) = @_;
673 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
675 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'create', '--snap', $snap, $name);
676 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
680 sub volume_snapshot_rollback
{
681 my ($class, $scfg, $storeid, $volname, $snap) = @_;
683 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
685 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rollback', '--snap', $snap, $name);
686 run_rbd_command
($cmd, errmsg
=> "rbd snapshot $volname to '$snap' error");
689 sub volume_snapshot_delete
{
690 my ($class, $scfg, $storeid, $volname, $snap, $running) = @_;
692 return 1 if $running && !$scfg->{krbd
};
694 $class->deactivate_volume($storeid, $scfg, $volname, $snap, {});
696 my ($vtype, $name, $vmid) = $class->parse_volname($volname);
698 my (undef, undef, undef, $protected) = rbd_volume_info
($scfg, $storeid, $name, $snap);
700 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'unprotect', $name, '--snap', $snap);
701 run_rbd_command
($cmd, errmsg
=> "rbd unprotect $name snap '$snap' error");
704 my $cmd = &$rbd_cmd($scfg, $storeid, 'snap', 'rm', '--snap', $snap, $name);
706 run_rbd_command
($cmd, errmsg
=> "rbd snapshot '$volname' error");
711 sub volume_has_feature
{
712 my ($class, $scfg, $feature, $storeid, $volname, $snapname, $running) = @_;
715 snapshot
=> { current
=> 1, snap
=> 1},
716 clone
=> { base
=> 1, snap
=> 1},
717 template
=> { current
=> 1},
718 copy
=> { base
=> 1, current
=> 1, snap
=> 1},
719 sparseinit
=> { base
=> 1, current
=> 1},
722 my ($vtype, $name, $vmid, $basename, $basevmid, $isBase) =
723 $class->parse_volname($volname);
729 $key = $isBase ?
'base' : 'current';
731 return 1 if $features->{$feature}->{$key};