4 # Copyright (C) 2006, 2007, 2008 Google Inc.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 """Functions to bootstrap a new cluster.
32 from ganeti import rpc
33 from ganeti import ssh
34 from ganeti import utils
35 from ganeti import errors
36 from ganeti import config
37 from ganeti import constants
38 from ganeti import objects
39 from ganeti import ssconf
40 from ganeti import serializer
41 from ganeti import hypervisor
45 """Setup the SSH configuration for the cluster.
47 This generates a dsa keypair for root, adds the pub key to the
48 permitted hosts and adds the hostkey to its own known hosts.
51 priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
53 for name in priv_key, pub_key:
54 if os.path.exists(name):
55 utils.CreateBackup(name)
56 utils.RemoveFile(name)
58 result = utils.RunCmd(["ssh-keygen", "-t", "dsa",
62 raise errors.OpExecError("Could not generate ssh keypair, error %s" %
65 utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
68 def GenerateHmacKey(file_name):
69 """Writes a new HMAC key.
72 @param file_name: Path to output file
75 utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400,
79 def GenerateClusterCrypto(new_cluster_cert, new_rapi_cert, new_confd_hmac_key,
80 new_cds, rapi_cert_pem=None, cds=None):
81 """Updates the cluster certificates, keys and secrets.
83 @type new_cluster_cert: bool
84 @param new_cluster_cert: Whether to generate a new cluster certificate
85 @type new_rapi_cert: bool
86 @param new_rapi_cert: Whether to generate a new RAPI certificate
87 @type new_confd_hmac_key: bool
88 @param new_confd_hmac_key: Whether to generate a new HMAC key
90 @param new_cds: Whether to generate a new cluster domain secret
91 @type rapi_cert_pem: string
92 @param rapi_cert_pem: New RAPI certificate in PEM format
94 @param cds: New cluster domain secret
97 # noded SSL certificate
98 cluster_cert_exists = os.path.exists(constants.NODED_CERT_FILE)
99 if new_cluster_cert or not cluster_cert_exists:
100 if cluster_cert_exists:
101 utils.CreateBackup(constants.NODED_CERT_FILE)
103 logging.debug("Generating new cluster certificate at %s",
104 constants.NODED_CERT_FILE)
105 utils.GenerateSelfSignedSslCert(constants.NODED_CERT_FILE)
108 if new_confd_hmac_key or not os.path.exists(constants.CONFD_HMAC_KEY):
109 logging.debug("Writing new confd HMAC key to %s", constants.CONFD_HMAC_KEY)
110 GenerateHmacKey(constants.CONFD_HMAC_KEY)
113 rapi_cert_exists = os.path.exists(constants.RAPI_CERT_FILE)
116 # Assume rapi_pem contains a valid PEM-formatted certificate and key
117 logging.debug("Writing RAPI certificate at %s",
118 constants.RAPI_CERT_FILE)
119 utils.WriteFile(constants.RAPI_CERT_FILE, data=rapi_cert_pem, backup=True)
121 elif new_rapi_cert or not rapi_cert_exists:
123 utils.CreateBackup(constants.RAPI_CERT_FILE)
125 logging.debug("Generating new RAPI certificate at %s",
126 constants.RAPI_CERT_FILE)
127 utils.GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)
129 # Cluster domain secret
131 logging.debug("Writing cluster domain secret to %s",
132 constants.CLUSTER_DOMAIN_SECRET_FILE)
133 utils.WriteFile(constants.CLUSTER_DOMAIN_SECRET_FILE,
134 data=cds, backup=True)
136 elif new_cds or not os.path.exists(constants.CLUSTER_DOMAIN_SECRET_FILE):
137 logging.debug("Generating new cluster domain secret at %s",
138 constants.CLUSTER_DOMAIN_SECRET_FILE)
139 GenerateHmacKey(constants.CLUSTER_DOMAIN_SECRET_FILE)
142 def _InitGanetiServerSetup(master_name):
143 """Setup the necessary configuration for the initial node daemon.
145 This creates the nodepass file containing the shared password for
146 the cluster and also generates the SSL certificate.
149 # Generate cluster secrets
150 GenerateClusterCrypto(True, False, False, False)
152 result = utils.RunCmd([constants.DAEMON_UTIL, "start", constants.NODED])
154 raise errors.OpExecError("Could not start the node daemon, command %s"
155 " had exitcode %s and error %s" %
156 (result.cmd, result.exit_code, result.output))
158 _WaitForNodeDaemon(master_name)
161 def _WaitForNodeDaemon(node_name):
162 """Wait for node daemon to become responsive.
165 def _CheckNodeDaemon():
166 result = rpc.RpcRunner.call_version([node_name])[node_name]
168 raise utils.RetryAgain()
171 utils.Retry(_CheckNodeDaemon, 1.0, 10.0)
172 except utils.RetryTimeout:
173 raise errors.OpExecError("Node daemon on %s didn't answer queries within"
174 " 10 seconds" % node_name)
177 def InitCluster(cluster_name, mac_prefix,
178 master_netdev, file_storage_dir, candidate_pool_size,
179 secondary_ip=None, vg_name=None, beparams=None,
180 nicparams=None, hvparams=None, enabled_hypervisors=None,
181 modify_etc_hosts=True, modify_ssh_setup=True,
182 maintain_node_health=False):
183 """Initialise the cluster.
185 @type candidate_pool_size: int
186 @param candidate_pool_size: master candidate pool size
189 # TODO: complete the docstring
190 if config.ConfigWriter.IsCluster():
191 raise errors.OpPrereqError("Cluster is already initialised",
194 if not enabled_hypervisors:
195 raise errors.OpPrereqError("Enabled hypervisors list must contain at"
196 " least one member", errors.ECODE_INVAL)
197 invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
199 raise errors.OpPrereqError("Enabled hypervisors contains invalid"
200 " entries: %s" % invalid_hvs,
203 hostname = utils.GetHostInfo()
205 if hostname.ip.startswith("127."):
206 raise errors.OpPrereqError("This host's IP resolves to the private"
207 " range (%s). Please fix DNS or %s." %
208 (hostname.ip, constants.ETC_HOSTS),
209 errors.ECODE_ENVIRON)
211 if not utils.OwnIpAddress(hostname.ip):
212 raise errors.OpPrereqError("Inconsistency: this host's name resolves"
213 " to %s,\nbut this ip address does not"
214 " belong to this host. Aborting." %
215 hostname.ip, errors.ECODE_ENVIRON)
217 clustername = utils.GetHostInfo(utils.HostInfo.NormalizeName(cluster_name))
219 if utils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT,
221 raise errors.OpPrereqError("Cluster IP already active. Aborting.",
222 errors.ECODE_NOTUNIQUE)
225 if not utils.IsValidIP(secondary_ip):
226 raise errors.OpPrereqError("Invalid secondary ip given",
228 if (secondary_ip != hostname.ip and
229 not utils.OwnIpAddress(secondary_ip)):
230 raise errors.OpPrereqError("You gave %s as secondary IP,"
231 " but it does not belong to this host." %
232 secondary_ip, errors.ECODE_ENVIRON)
234 secondary_ip = hostname.ip
236 if vg_name is not None:
237 # Check if volume group is valid
238 vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
239 constants.MIN_VG_SIZE)
241 raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
242 " you are not using lvm" % vgstatus,
245 file_storage_dir = os.path.normpath(file_storage_dir)
247 if not os.path.isabs(file_storage_dir):
248 raise errors.OpPrereqError("The file storage directory you passed is"
249 " not an absolute path.", errors.ECODE_INVAL)
251 if not os.path.exists(file_storage_dir):
253 os.makedirs(file_storage_dir, 0750)
255 raise errors.OpPrereqError("Cannot create file storage directory"
256 " '%s': %s" % (file_storage_dir, err),
257 errors.ECODE_ENVIRON)
259 if not os.path.isdir(file_storage_dir):
260 raise errors.OpPrereqError("The file storage directory '%s' is not"
261 " a directory." % file_storage_dir,
262 errors.ECODE_ENVIRON)
264 if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
265 raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix,
268 result = utils.RunCmd(["ip", "link", "show", "dev", master_netdev])
270 raise errors.OpPrereqError("Invalid master netdev given (%s): '%s'" %
272 result.output.strip()), errors.ECODE_INVAL)
274 dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
275 utils.EnsureDirs(dirs)
277 utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
278 utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
279 objects.NIC.CheckParameterSyntax(nicparams)
281 # hvparams is a mapping of hypervisor->hvparams dict
282 for hv_name, hv_params in hvparams.iteritems():
283 utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
284 hv_class = hypervisor.GetHypervisor(hv_name)
285 hv_class.CheckParameterSyntax(hv_params)
287 # set up the inter-node password and certificate
288 _InitGanetiServerSetup(hostname.name)
290 # set up ssh config and /etc/hosts
291 sshline = utils.ReadFile(constants.SSH_HOST_RSA_PUB)
292 sshkey = sshline.split(" ")[1]
295 utils.AddHostToEtcHosts(hostname.name)
302 # init of cluster config file
303 cluster_config = objects.Cluster(
305 rsahostkeypub=sshkey,
306 highest_used_port=(constants.FIRST_DRBD_PORT - 1),
307 mac_prefix=mac_prefix,
308 volume_group_name=vg_name,
309 tcpudp_port_pool=set(),
310 master_node=hostname.name,
311 master_ip=clustername.ip,
312 master_netdev=master_netdev,
313 cluster_name=clustername.name,
314 file_storage_dir=file_storage_dir,
315 enabled_hypervisors=enabled_hypervisors,
316 beparams={constants.PP_DEFAULT: beparams},
317 nicparams={constants.PP_DEFAULT: nicparams},
319 candidate_pool_size=candidate_pool_size,
320 modify_etc_hosts=modify_etc_hosts,
321 modify_ssh_setup=modify_ssh_setup,
324 uuid=utils.NewUUID(),
325 maintain_node_health=maintain_node_health,
327 master_node_config = objects.Node(name=hostname.name,
328 primary_ip=hostname.ip,
329 secondary_ip=secondary_ip,
331 master_candidate=True,
332 offline=False, drained=False,
334 InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
335 cfg = config.ConfigWriter()
336 ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
337 cfg.Update(cfg.GetClusterInfo(), logging.error)
339 # start the master ip
340 # TODO: Review rpc call from bootstrap
341 # TODO: Warn on failed start master
342 rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
345 def InitConfig(version, cluster_config, master_node_config,
346 cfg_file=constants.CLUSTER_CONF_FILE):
347 """Create the initial cluster configuration.
349 It will contain the current node, which will also be the master
350 node, and no instances.
353 @param version: configuration version
354 @type cluster_config: L{objects.Cluster}
355 @param cluster_config: cluster configuration
356 @type master_node_config: L{objects.Node}
357 @param master_node_config: master node configuration
358 @type cfg_file: string
359 @param cfg_file: configuration file path
363 master_node_config.name: master_node_config,
367 config_data = objects.ConfigData(version=version,
368 cluster=cluster_config,
372 ctime=now, mtime=now)
373 utils.WriteFile(cfg_file,
374 data=serializer.Dump(config_data.ToDict()),
378 def FinalizeClusterDestroy(master):
379 """Execute the last steps of cluster destroy
381 This function shuts down all the daemons, completing the destroy
382 begun in cmdlib.LUDestroyOpcode.
385 cfg = config.ConfigWriter()
386 modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
387 result = rpc.RpcRunner.call_node_stop_master(master, True)
388 msg = result.fail_msg
390 logging.warning("Could not disable the master role: %s", msg)
391 result = rpc.RpcRunner.call_node_leave_cluster(master, modify_ssh_setup)
392 msg = result.fail_msg
394 logging.warning("Could not shutdown the node daemon and cleanup"
395 " the node: %s", msg)
398 def SetupNodeDaemon(cluster_name, node, ssh_key_check):
399 """Add a node to the cluster.
401 This function must be called before the actual opcode, and will ssh
402 to the remote node, copy the needed files, and start ganeti-noded,
403 allowing the master to do the rest via normal rpc calls.
405 @param cluster_name: the cluster name
406 @param node: the name of the new node
407 @param ssh_key_check: whether to do a strict key check
410 sshrunner = ssh.SshRunner(cluster_name)
412 noded_cert = utils.ReadFile(constants.NODED_CERT_FILE)
413 rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
414 confd_hmac_key = utils.ReadFile(constants.CONFD_HMAC_KEY)
416 # in the base64 pem encoding, neither '!' nor '.' are valid chars,
417 # so we use this to detect an invalid certificate; as long as the
418 # cert doesn't contain this, the here-document will be correctly
419 # parsed by the shell sequence below. HMAC keys are hexadecimal strings,
420 # so the same restrictions apply.
421 for content in (noded_cert, rapi_cert, confd_hmac_key):
422 if re.search('^!EOF\.', content, re.MULTILINE):
423 raise errors.OpExecError("invalid SSL certificate or HMAC key")
425 if not noded_cert.endswith("\n"):
427 if not rapi_cert.endswith("\n"):
429 if not confd_hmac_key.endswith("\n"):
430 confd_hmac_key += "\n"
432 # set up inter-node password and certificate and restarts the node daemon
433 # and then connect with ssh to set password and start ganeti-noded
434 # note that all the below variables are sanitized at this point,
435 # either by being constants or by the checks above
436 # TODO: Could this command exceed a shell's maximum command length?
437 mycommand = ("umask 077 && "
438 "cat > '%s' << '!EOF.' && \n"
440 "cat > '%s' << '!EOF.' && \n"
442 "cat > '%s' << '!EOF.' && \n"
444 "chmod 0400 %s %s %s && "
446 (constants.NODED_CERT_FILE, noded_cert,
447 constants.RAPI_CERT_FILE, rapi_cert,
448 constants.CONFD_HMAC_KEY, confd_hmac_key,
449 constants.NODED_CERT_FILE, constants.RAPI_CERT_FILE,
450 constants.CONFD_HMAC_KEY,
451 constants.DAEMON_UTIL, constants.NODED))
453 result = sshrunner.Run(node, 'root', mycommand, batch=False,
454 ask_key=ssh_key_check,
455 use_cluster_key=False,
456 strict_host_check=ssh_key_check)
458 raise errors.OpExecError("Remote command on node %s, error: %s,"
460 (node, result.fail_reason, result.output))
462 _WaitForNodeDaemon(node)
465 def MasterFailover(no_voting=False):
466 """Failover the master node.
468 This checks that we are not already the master, and will cause the
469 current master to cease being master, and the non-master to become
472 @type no_voting: boolean
473 @param no_voting: force the operation without remote nodes agreement
477 sstore = ssconf.SimpleStore()
479 old_master, new_master = ssconf.GetMasterAndMyself(sstore)
480 node_list = sstore.GetNodeList()
481 mc_list = sstore.GetMasterCandidates()
483 if old_master == new_master:
484 raise errors.OpPrereqError("This commands must be run on the node"
485 " where you want the new master to be."
486 " %s is already the master" %
487 old_master, errors.ECODE_INVAL)
489 if new_master not in mc_list:
490 mc_no_master = [name for name in mc_list if name != old_master]
491 raise errors.OpPrereqError("This node is not among the nodes marked"
492 " as master candidates. Only these nodes"
493 " can become masters. Current list of"
494 " master candidates is:\n"
495 "%s" % ('\n'.join(mc_no_master)),
499 vote_list = GatherMasterVotes(node_list)
502 voted_master = vote_list[0][0]
503 if voted_master is None:
504 raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
505 " not respond.", errors.ECODE_ENVIRON)
506 elif voted_master != old_master:
507 raise errors.OpPrereqError("I have a wrong configuration, I believe"
508 " the master is %s but the other nodes"
509 " voted %s. Please resync the configuration"
511 (old_master, voted_master),
517 logging.info("Setting master to %s, old master: %s", new_master, old_master)
519 result = rpc.RpcRunner.call_node_stop_master(old_master, True)
520 msg = result.fail_msg
522 logging.error("Could not disable the master role on the old master"
523 " %s, please disable manually: %s", old_master, msg)
525 # Here we have a phase where no master should be running
527 # instantiate a real config writer, as we now know we have the
529 cfg = config.ConfigWriter()
531 cluster_info = cfg.GetClusterInfo()
532 cluster_info.master_node = new_master
533 # this will also regenerate the ssconf files, since we updated the
535 cfg.Update(cluster_info, logging.error)
537 result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
538 msg = result.fail_msg
540 logging.error("Could not start the master role on the new master"
541 " %s, please check: %s", new_master, msg)
548 """Returns the current master node.
550 This is a separate function in bootstrap since it's needed by
551 gnt-cluster, and instead of importing directly ssconf, it's better
552 to abstract it in bootstrap, where we do use ssconf in other
556 sstore = ssconf.SimpleStore()
558 old_master, _ = ssconf.GetMasterAndMyself(sstore)
563 def GatherMasterVotes(node_list):
564 """Check the agreement on who is the master.
566 This function will return a list of (node, number of votes), ordered
567 by the number of votes. Errors will be denoted by the key 'None'.
569 Note that the sum of votes is the number of nodes this machine
570 knows, whereas the number of entries in the list could be different
571 (if some nodes vote for another master).
573 We remove ourselves from the list since we know that (bugs aside)
574 since we use the same source for configuration information for both
575 backend and boostrap, we'll always vote for ourselves.
577 @type node_list: list
578 @param node_list: the list of nodes to query for master info; the current
579 node will be removed if it is in the list
581 @return: list of (node, votes)
584 myself = utils.HostInfo().name
586 node_list.remove(myself)
590 # no nodes left (eventually after removing myself)
592 results = rpc.RpcRunner.call_master_info(node_list)
593 if not isinstance(results, dict):
594 # this should not happen (unless internal error in rpc)
595 logging.critical("Can't complete rpc call, aborting master startup")
596 return [(None, len(node_list))]
604 logging.warning("Error contacting node %s: %s", node, msg)
606 elif not isinstance(data, (tuple, list)) or len(data) < 3:
607 logging.warning("Invalid data received from node %s: %s", node, data)
610 if None not in votes:
614 master_node = data[2]
615 if master_node not in votes:
616 votes[master_node] = 0
617 votes[master_node] += 1
619 vote_list = [v for v in votes.items()]
620 # sort first on number of votes then on name, since we want None
621 # sorted later if we have the half of the nodes not responding, and
622 # half voting all for the same master
623 vote_list.sort(key=lambda x: (x[1], x[0]), reverse=True)