1 package PVE
::CLI
::pvecm
;
8 use PVE
::Tools
qw(run_command);
11 use PVE
::JSONSchema
qw(get_standard_option);
12 use PVE
::RPCEnvironment
;
15 use PVE
::API2
::ClusterConfig
;
17 use PVE
::Cluster
::Setup
;
19 use base
qw(PVE::CLIHandler);
21 $ENV{HOME
} = '/root'; # for ssh-copy-id
23 my $basedir = "/etc/pve";
24 my $clusterconf = "$basedir/corosync.conf";
25 my $libdir = "/var/lib/pve-cluster";
26 my $authfile = "/etc/corosync/authkey";
29 sub setup_environment
{
30 PVE
::RPCEnvironment-
>setup_default_cli_env();
33 __PACKAGE__-
>register_method ({
37 description
=> "Generate new cryptographic key for corosync.",
39 additionalProperties
=> 0,
43 description
=> "Output file name"
47 returns
=> { type
=> 'null' },
52 my $filename = $param->{filename
};
55 $> == 0 || die "Error: Authorization key must be generated as root user.\n";
56 my $dirname = dirname
($filename);
58 die "key file '$filename' already exists\n" if -e
$filename;
60 File
::Path
::make_path
($dirname) if $dirname;
62 run_command
(['corosync-keygen', '-l', '-k', $filename]);
67 my $foreach_member = sub {
68 my ($code, $noerr) = @_;
70 my $members = PVE
::Cluster
::get_members
();
71 foreach my $node (sort keys %$members) {
72 if (my $ip = $members->{$node}->{ip
}) {
75 die "cannot get the cluster IP for node '$node'.\n" if !$noerr;
76 warn "cannot get the cluster IP for node '$node'.\n";
82 __PACKAGE__-
>register_method ({
83 name
=> 'setup_qdevice',
84 path
=> 'setup_qdevice',
86 description
=> "Setup the use of a QDevice",
88 additionalProperties
=> 0,
91 type
=> 'string', format
=> 'ip',
92 description
=> "Specifies the network address of an external corosync QDevice" ,
97 description
=> 'The network which should be used to connect to the external qdevice',
102 description
=> "Do not throw error on possible dangerous operations.",
107 returns
=> { type
=> 'null' },
112 PVE
::Corosync
::check_conf_exists
();
114 my $members = PVE
::Cluster
::get_members
();
115 foreach my $node (sort keys %$members) {
116 die "All nodes must be online! Node $node is offline, aborting.\n"
117 if !$members->{$node}->{online
};
120 my $conf = PVE
::Cluster
::cfs_read_file
("corosync.conf");
122 die "QDevice already configured!\n"
123 if defined($conf->{main
}->{quorum
}->{device
}) && !$param->{force
};
125 my $network = $param->{network
};
128 my $algorithm = 'ffsplit';
129 if (scalar($members) & 1) {
130 if ($param->{force
}) {
133 die "Clusters with an odd node count are not officially supported!\n";
137 my $qnetd_addr = $param->{address
};
138 my $base_dir = "/etc/corosync/qdevice/net";
139 my $db_dir_qnetd = "/etc/corosync/qnetd/nssdb";
140 my $db_dir_node = "$base_dir/nssdb";
141 my $ca_export_base = "qnetd-cacert.crt";
142 my $ca_export_file = "$db_dir_qnetd/$ca_export_base";
143 my $crq_file_base = "qdevice-net-node.crq";
144 my $p12_file_base = "qdevice-net-node.p12";
145 my $qdevice_certutil = "corosync-qdevice-net-certutil";
146 my $qnetd_certutil= "corosync-qnetd-certutil";
147 my $clustername = $conf->{main
}->{totem
}->{cluster_name
};
149 run_command
(['ssh-copy-id', '-i', '/root/.ssh/id_rsa', "root\@$qnetd_addr"]);
151 if (-d
$db_dir_node) {
152 # FIXME: check on all nodes?!
153 if ($param->{force
}) {
156 die "QDevice certificate store already initialised, set force to delete!\n";
160 my $ssh_cmd = ['ssh', '-o', 'BatchMode=yes', '-lroot'];
161 my $scp_cmd = ['scp', '-o', 'BatchMode=yes'];
163 print "\nINFO: initializing qnetd server\n";
165 [@$ssh_cmd, $qnetd_addr, $qnetd_certutil, "-i"],
169 print "\nINFO: copying CA cert and initializing on all nodes\n";
170 run_command
([@$scp_cmd, "root\@\[$qnetd_addr\]:$ca_export_file", "/etc/pve/$ca_export_base"]);
171 $foreach_member->(sub {
172 my ($node, $ip) = @_;
173 my $outsub = sub { print "\nnode '$node': " . shift };
175 [@$ssh_cmd, $ip, $qdevice_certutil, "-i", "-c", "/etc/pve/$ca_export_base"],
176 noerr
=> 1, outfunc
=> \
&$outsub
179 unlink "/etc/pve/$ca_export_base";
181 print "\nINFO: generating cert request\n";
182 run_command
([$qdevice_certutil, "-r", "-n", $clustername]);
184 print "\nINFO: copying exported cert request to qnetd server\n";
185 run_command
([@$scp_cmd, "$db_dir_node/$crq_file_base", "root\@\[$qnetd_addr\]:/tmp"]);
187 print "\nINFO: sign and export cluster cert\n";
189 @$ssh_cmd, $qnetd_addr, $qnetd_certutil, "-s", "-c",
190 "/tmp/$crq_file_base", "-n", "$clustername"
193 print "\nINFO: copy exported CRT\n";
195 @$scp_cmd, "root\@\[$qnetd_addr\]:$db_dir_qnetd/cluster-$clustername.crt",
199 print "\nINFO: import certificate\n";
200 run_command
(["$qdevice_certutil", "-M", "-c", "$db_dir_node/cluster-$clustername.crt"]);
202 print "\nINFO: copy and import pk12 cert to all nodes\n";
203 run_command
([@$scp_cmd, "$db_dir_node/$p12_file_base", "/etc/pve/"]);
204 $foreach_member->(sub {
205 my ($node, $ip) = @_;
206 my $outsub = sub { print "\nnode '$node': " . shift };
208 @$ssh_cmd, $ip, "$qdevice_certutil", "-m", "-c",
209 "/etc/pve/$p12_file_base"], outfunc
=> \
&$outsub
212 unlink "/etc/pve/$p12_file_base";
216 my $conf = PVE
::Cluster
::cfs_read_file
("corosync.conf");
217 my $quorum_section = $conf->{main
}->{quorum
};
219 die "Qdevice already configured, must be removed before setting up new one!\n"
220 if defined($quorum_section->{device
}); # must not be forced!
227 algorithm
=> $algorithm,
230 $qdev_section->{votes
} = 1 if $algorithm eq 'ffsplit';
232 $quorum_section->{device
} = $qdev_section;
234 PVE
::Corosync
::atomic_write_conf
($conf);
237 print "\nINFO: add QDevice to cluster configuration\n";
238 PVE
::Cluster
::cfs_lock_file
('corosync.conf', 10, $code);
241 $foreach_member->(sub {
242 my ($node, $ip) = @_;
243 my $outsub = sub { print "\nnode '$node': " . shift };
244 print "\nINFO: start and enable corosync qdevice daemon on node '$node'...\n";
245 run_command
([@$ssh_cmd, $ip, 'systemctl', 'start', 'corosync-qdevice'], outfunc
=> \
&$outsub);
246 run_command
([@$ssh_cmd, $ip, 'systemctl', 'enable', 'corosync-qdevice'], outfunc
=> \
&$outsub);
249 run_command
(['corosync-cfgtool', '-R']); # do cluster wide config reload
254 __PACKAGE__-
>register_method ({
255 name
=> 'remove_qdevice',
256 path
=> 'remove_qdevice',
258 description
=> "Remove a configured QDevice",
260 additionalProperties
=> 0,
263 returns
=> { type
=> 'null' },
268 PVE
::Corosync
::check_conf_exists
();
270 my $members = PVE
::Cluster
::get_members
();
271 foreach my $node (sort keys %$members) {
272 die "All nodes must be online! Node $node is offline, aborting.\n"
273 if !$members->{$node}->{online
};
276 my $ssh_cmd = ['ssh', '-o', 'BatchMode=yes', '-lroot'];
279 my $conf = PVE
::Cluster
::cfs_read_file
("corosync.conf");
280 my $quorum_section = $conf->{main
}->{quorum
};
282 die "No QDevice configured!\n" if !defined($quorum_section->{device
});
284 delete $quorum_section->{device
};
286 PVE
::Corosync
::atomic_write_conf
($conf);
288 # cleanup qdev state (cert storage)
289 my $qdev_state_dir = "/etc/corosync/qdevice";
290 $foreach_member->(sub {
291 my (undef, $ip) = @_;
292 run_command
([@$ssh_cmd, $ip, '--', 'rm', '-rf', $qdev_state_dir]);
296 PVE
::Cluster
::cfs_lock_file
('corosync.conf', 10, $code);
299 $foreach_member->(sub {
300 my (undef, $ip) = @_;
301 run_command
([@$ssh_cmd, $ip, 'systemctl', 'stop', 'corosync-qdevice']);
302 run_command
([@$ssh_cmd, $ip, 'systemctl', 'disable', 'corosync-qdevice']);
305 run_command
(['corosync-cfgtool', '-R']);
307 print "\nRemoved Qdevice.\n";
312 __PACKAGE__-
>register_method ({
316 description
=> "Adds the current node to an existing cluster.",
318 additionalProperties
=> 0,
319 properties
=> PVE
::Corosync
::add_corosync_link_properties
({
322 description
=> "Hostname (or IP) of an existing cluster member."
324 nodeid
=> get_standard_option
('corosync-nodeid'),
327 description
=> "Number of votes for this node",
333 description
=> "Do not throw error if node already exists.",
336 fingerprint
=> get_standard_option
('fingerprint-sha256', {
341 description
=> "Always use SSH to join, even if peer may do it over API.",
346 returns
=> { type
=> 'null' },
351 my $nodename = PVE
::INotify
::nodename
();
352 my $host = $param->{hostname
};
356 if (!$param->{use_ssh
}) {
357 my $password = PVE
::PTY
::read_password
("Please enter superuser (root) password for '$host': ");
359 delete $param->{use_ssh
};
360 $param->{password
} = $password;
362 my $local_cluster_lock = "/var/lock/pvecm.lock";
363 PVE
::Tools
::lock_file
($local_cluster_lock, 10, \
&PVE
::Cluster
::Setup
::join, $param);
366 if (ref($err) eq 'PVE::APIClient::Exception' && defined($err->{code
}) && $err->{code
} == 501) {
367 $err = "Remote side is not able to use API for Cluster join!\n" .
368 "Pass the 'use_ssh' switch or update the remote side.\n";
372 return; # all OK, the API join endpoint successfully set us up
375 # allow fallback to old ssh only join if wished or needed
377 my $local_ip_address = PVE
::Cluster
::remote_node_ip
($nodename);
378 my $links = PVE
::Corosync
::extract_corosync_link_args
($param);
380 PVE
::Cluster
::Setup
::assert_joinable
($local_ip_address, $links, $param->{force
});
382 PVE
::Cluster
::Setup
::setup_sshd_config
();
383 PVE
::Cluster
::Setup
::setup_rootsshconfig
();
384 PVE
::Cluster
::Setup
::setup_ssh_keys
();
386 # make sure known_hosts is on local filesystem
387 PVE
::Cluster
::Setup
::ssh_unmerge_known_hosts
();
389 my $cmd = ['ssh-copy-id', '-i', '/root/.ssh/id_rsa', "root\@$host"];
390 run_command
($cmd, 'outfunc' => sub {}, 'errfunc' => sub {},
391 'errmsg' => "unable to copy ssh ID");
393 $cmd = ['ssh', $host, '-o', 'BatchMode=yes',
394 'pvecm', 'addnode', $nodename, '--force', 1];
396 push @$cmd, '--nodeid', $param->{nodeid
} if $param->{nodeid
};
397 push @$cmd, '--votes', $param->{votes
} if defined($param->{votes
});
399 foreach my $link (keys %$links) {
400 push @$cmd, "--link$link", PVE
::JSONSchema
::print_property_string
(
401 $links->{$link}, get_standard_option
('corosync-link'));
404 if (system (@$cmd) != 0) {
405 my $cmdtxt = join (' ', @$cmd);
406 die "unable to add node: command failed ($cmdtxt)\n";
409 my $tmpdir = "$libdir/.pvecm_add.tmp.$$";
413 print "copy corosync auth key\n";
414 $cmd = ['rsync', '--rsh=ssh -l root -o BatchMode=yes', '-lpgoq',
415 "[$host]:$authfile $clusterconf", $tmpdir];
417 system(@$cmd) == 0 || die "can't rsync data from host '$host'\n";
419 my $corosync_conf = PVE
::Tools
::file_get_contents
("$tmpdir/corosync.conf");
420 my $corosync_authkey = PVE
::Tools
::file_get_contents
("$tmpdir/authkey");
422 PVE
::Cluster
::Setup
::finish_join
($host, $corosync_conf, $corosync_authkey);
431 # use a synced worker so we get a nice task log when joining through CLI
432 my $rpcenv = PVE
::RPCEnvironment
::get
();
433 my $authuser = $rpcenv->get_user();
435 $rpcenv->fork_worker('clusterjoin', '', $authuser, $worker);
440 __PACKAGE__-
>register_method ({
444 description
=> "Displays the local view of the cluster status.",
446 additionalProperties
=> 0,
449 returns
=> { type
=> 'null' },
454 PVE
::Corosync
::check_conf_exists
();
455 my $conf = eval { PVE
::Cluster
::cfs_read_file
("corosync.conf") } // {};
457 my $totem = PVE
::Corosync
::totem_config
($conf);
459 if (scalar(%$totem)) {
460 my $print_info = sub {
461 my ($label, $key, $default) = @_;
462 my $val = $totem->{$key} // $default;
463 printf "%-17s %s\n", "$label:", "$val";
466 printf "Cluster information\n";
467 printf "-------------------\n";
468 $print_info->('Name', 'cluster_name', 'UNKOWN?');
469 $print_info->('Config Version', 'config_version', -1);
470 $print_info->('Transport', 'transport', 'knet');
471 $print_info->('Secure auth', 'secauth', 'off');
475 my $cmd = ['corosync-quorumtool', '-siH'];
479 exit (-1); # should not be reached
482 __PACKAGE__-
>register_method ({
486 description
=> "Displays the local view of the cluster nodes.",
488 additionalProperties
=> 0,
491 returns
=> { type
=> 'null' },
496 PVE
::Corosync
::check_conf_exists
();
498 my $cmd = ['corosync-quorumtool', '-l'];
502 exit (-1); # should not be reached
505 __PACKAGE__-
>register_method ({
509 description
=> "Tells corosync a new value of expected votes.",
511 additionalProperties
=> 0,
515 description
=> "Expected votes",
520 returns
=> { type
=> 'null' },
525 PVE
::Corosync
::check_conf_exists
();
527 my $cmd = ['corosync-quorumtool', '-e', $param->{expected
}];
531 exit (-1); # should not be reached
535 __PACKAGE__-
>register_method ({
536 name
=> 'updatecerts',
537 path
=> 'updatecerts',
539 description
=> "Update node certificates (and generate all needed files/directories).",
541 additionalProperties
=> 0,
544 description
=> "Force generation of new SSL certifate.",
549 description
=> "Ignore errors (i.e. when cluster has no quorum).",
555 returns
=> { type
=> 'null' },
559 # we get called by the pve-cluster.service ExecStartPost and as we do
560 # IO (on /etc/pve) which can hang (uninterruptedly D state). That'd be
561 # no-good for ExecStartPost as it fails the whole service in this case
562 PVE
::Tools
::run_fork_with_timeout
(30, sub {
563 PVE
::Cluster
::Setup
::updatecerts_and_ssh
($param->@{qw(force silent)});
569 __PACKAGE__-
>register_method ({
573 description
=> "Used by VM/CT migration - do not use manually.",
575 additionalProperties
=> 0,
577 get_migration_ip
=> {
580 description
=> 'return the migration IP, if configured',
583 migration_network
=> {
586 description
=> 'the migration network used to detect the local migration IP',
591 description
=> 'Run a command with a tcp socket as standard input.'
592 .' The IP address and port are printed via this'
593 ." command's stdandard output first, each on a separate line.",
596 'extra-args' => PVE
::JSONSchema
::get_standard_option
('extra-args'),
599 returns
=> { type
=> 'null'},
603 if (!PVE
::Cluster
::check_cfs_quorum
(1)) {
608 my $get_local_migration_ip = sub {
611 if (!defined($cidr)) {
612 my $dc_conf = cfs_read_file
('datacenter.cfg');
613 $cidr = $dc_conf->{migration
}->{network
}
614 if defined($dc_conf->{migration
}->{network
});
617 if (defined($cidr)) {
618 my $ips = PVE
::Network
::get_local_ip_from_cidr
($cidr);
620 die "could not get migration ip: no IP address configured on local " .
621 "node for network '$cidr'\n" if scalar(@$ips) == 0;
623 die "could not get migration ip: multiple, different, IP address configured for " .
624 "network '$cidr'\n" if scalar(@$ips) > 1 && grep { @$ips[0] ne $_ } @$ips;
632 my $network = $param->{migration_network
};
633 if ($param->{get_migration_ip
}) {
634 die "cannot use --run-command with --get_migration_ip\n"
635 if $param->{'run-command'};
637 if (my $ip = $get_local_migration_ip->($network)) {
642 # do not keep tunnel open when asked for migration ip
646 if ($param->{'run-command'}) {
647 my $cmd = $param->{'extra-args'};
648 die "missing command\n"
649 if !$cmd || !scalar(@$cmd);
651 # Get an ip address to listen on, and find a free migration port
653 if (defined($network)) {
654 $ip = $get_local_migration_ip->($network)
655 or die "failed to get migration IP address to listen on\n";
656 $family = PVE
::Tools
::get_host_address_family
($ip);
658 my $nodename = PVE
::INotify
::nodename
();
659 ($ip, $family) = PVE
::Network
::get_ip_from_hostname
($nodename, 0);
661 my $port = PVE
::Tools
::next_migrate_port
($family, $ip);
663 PVE
::Tools
::pipe_socket_to_command
($cmd, $ip, $port);
667 print "tunnel online\n";
670 while (my $line = <STDIN
>) {
672 last if $line =~ m/^quit$/;
680 keygen
=> [ __PACKAGE__
, 'keygen', ['filename']],
681 create
=> [ 'PVE::API2::ClusterConfig', 'create', ['clustername']],
682 add
=> [ __PACKAGE__
, 'add', ['hostname']],
683 addnode
=> [ 'PVE::API2::ClusterConfig', 'addnode', ['node']],
684 delnode
=> [ 'PVE::API2::ClusterConfig', 'delnode', ['node']],
685 status
=> [ __PACKAGE__
, 'status' ],
686 nodes
=> [ __PACKAGE__
, 'nodes' ],
687 expected
=> [ __PACKAGE__
, 'expected', ['expected']],
688 updatecerts
=> [ __PACKAGE__
, 'updatecerts', []],
689 mtunnel
=> [ __PACKAGE__
, 'mtunnel', ['extra-args']],
691 setup
=> [ __PACKAGE__
, 'setup_qdevice', ['address']],
692 remove
=> [ __PACKAGE__
, 'remove_qdevice', []],