code.grnet.gr Git - ganeti-local/blob - lib/bootstrap.py

   1 #
   2 #
   3
   4 # Copyright (C) 2006, 2007, 2008 Google Inc.
   5 #
   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.
  10 #
  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.
  15 #
  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
  19 # 02110-1301, USA.
  20
  21
  22 """Functions to bootstrap a new cluster.
  23
  24 """
  25
  26 import os
  27 import os.path
  28 import re
  29 import logging
  30 import tempfile
  31
  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 hypervisor
  41
  42
  43 def _InitSSHSetup():
  44   """Setup the SSH configuration for the cluster.
  45
  46   This generates a dsa keypair for root, adds the pub key to the
  47   permitted hosts and adds the hostkey to its own known hosts.
  48
  49   """
  50   priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
  51
  52   for name in priv_key, pub_key:
  53     if os.path.exists(name):
  54       utils.CreateBackup(name)
  55     utils.RemoveFile(name)
  56
  57   result = utils.RunCmd(["ssh-keygen", "-t", "dsa",
  58                          "-f", priv_key,
  59                          "-q", "-N", ""])
  60   if result.failed:
  61     raise errors.OpExecError("Could not generate ssh keypair, error %s" %
  62                              result.output)
  63
  64   f = open(pub_key, 'r')
  65   try:
  66     utils.AddAuthorizedKey(auth_keys, f.read(8192))
  67   finally:
  68     f.close()
  69
  70
  71 def _GenerateSelfSignedSslCert(file_name, validity=(365 * 5)):
  72   """Generates a self-signed SSL certificate.
  73
  74   @type file_name: str
  75   @param file_name: Path to output file
  76   @type validity: int
  77   @param validity: Validity for certificate in days
  78
  79   """
  80   (fd, tmp_file_name) = tempfile.mkstemp(dir=os.path.dirname(file_name))
  81   try:
  82     # Set permissions before writing key
  83     os.chmod(tmp_file_name, 0600)
  84
  85     result = utils.RunCmd(["openssl", "req", "-new", "-newkey", "rsa:1024",
  86                            "-days", str(validity), "-nodes", "-x509",
  87                            "-keyout", tmp_file_name, "-out", tmp_file_name,
  88                            "-batch"])
  89     if result.failed:
  90       raise errors.OpExecError("Could not generate SSL certificate, command"
  91                                " %s had exitcode %s and error message %s" %
  92                                (result.cmd, result.exit_code, result.output))
  93
  94     # Make read-only
  95     os.chmod(tmp_file_name, 0400)
  96
  97     os.rename(tmp_file_name, file_name)
  98   finally:
  99     utils.RemoveFile(tmp_file_name)
 100
 101
 102 def _InitGanetiServerSetup():
 103   """Setup the necessary configuration for the initial node daemon.
 104
 105   This creates the nodepass file containing the shared password for
 106   the cluster and also generates the SSL certificate.
 107
 108   """
 109   _GenerateSelfSignedSslCert(constants.SSL_CERT_FILE)
 110
 111   # Don't overwrite existing file
 112   if not os.path.exists(constants.RAPI_CERT_FILE):
 113     _GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)
 114
 115   result = utils.RunCmd([constants.NODE_INITD_SCRIPT, "restart"])
 116
 117   if result.failed:
 118     raise errors.OpExecError("Could not start the node daemon, command %s"
 119                              " had exitcode %s and error %s" %
 120                              (result.cmd, result.exit_code, result.output))
 121
 122
 123 def InitCluster(cluster_name, mac_prefix,
 124                 master_netdev, file_storage_dir, candidate_pool_size,
 125                 secondary_ip=None, vg_name=None, beparams=None,
 126                 nicparams=None, hvparams=None, enabled_hypervisors=None,
 127                 default_hypervisor=None, modify_etc_hosts=True):
 128   """Initialise the cluster.
 129
 130   @type candidate_pool_size: int
 131   @param candidate_pool_size: master candidate pool size
 132
 133   """
 134   # TODO: complete the docstring
 135   if config.ConfigWriter.IsCluster():
 136     raise errors.OpPrereqError("Cluster is already initialised")
 137
 138   hostname = utils.HostInfo()
 139
 140   if hostname.ip.startswith("127."):
 141     raise errors.OpPrereqError("This host's IP resolves to the private"
 142                                " range (%s). Please fix DNS or %s." %
 143                                (hostname.ip, constants.ETC_HOSTS))
 144
 145   if not utils.OwnIpAddress(hostname.ip):
 146     raise errors.OpPrereqError("Inconsistency: this host's name resolves"
 147                                " to %s,\nbut this ip address does not"
 148                                " belong to this host."
 149                                " Aborting." % hostname.ip)
 150
 151   clustername = utils.HostInfo(cluster_name)
 152
 153   if utils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT,
 154                    timeout=5):
 155     raise errors.OpPrereqError("Cluster IP already active. Aborting.")
 156
 157   if secondary_ip:
 158     if not utils.IsValidIP(secondary_ip):
 159       raise errors.OpPrereqError("Invalid secondary ip given")
 160     if (secondary_ip != hostname.ip and
 161         not utils.OwnIpAddress(secondary_ip)):
 162       raise errors.OpPrereqError("You gave %s as secondary IP,"
 163                                  " but it does not belong to this host." %
 164                                  secondary_ip)
 165   else:
 166     secondary_ip = hostname.ip
 167
 168   if vg_name is not None:
 169     # Check if volume group is valid
 170     vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
 171                                           constants.MIN_VG_SIZE)
 172     if vgstatus:
 173       raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
 174                                  " you are not using lvm" % vgstatus)
 175
 176   file_storage_dir = os.path.normpath(file_storage_dir)
 177
 178   if not os.path.isabs(file_storage_dir):
 179     raise errors.OpPrereqError("The file storage directory you passed is"
 180                                " not an absolute path.")
 181
 182   if not os.path.exists(file_storage_dir):
 183     try:
 184       os.makedirs(file_storage_dir, 0750)
 185     except OSError, err:
 186       raise errors.OpPrereqError("Cannot create file storage directory"
 187                                  " '%s': %s" %
 188                                  (file_storage_dir, err))
 189
 190   if not os.path.isdir(file_storage_dir):
 191     raise errors.OpPrereqError("The file storage directory '%s' is not"
 192                                " a directory." % file_storage_dir)
 193
 194   if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
 195     raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix)
 196
 197   result = utils.RunCmd(["ip", "link", "show", "dev", master_netdev])
 198   if result.failed:
 199     raise errors.OpPrereqError("Invalid master netdev given (%s): '%s'" %
 200                                (master_netdev,
 201                                 result.output.strip()))
 202
 203   if not (os.path.isfile(constants.NODE_INITD_SCRIPT) and
 204           os.access(constants.NODE_INITD_SCRIPT, os.X_OK)):
 205     raise errors.OpPrereqError("Init.d script '%s' missing or not"
 206                                " executable." % constants.NODE_INITD_SCRIPT)
 207
 208   dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
 209   utils.EnsureDirs(dirs)
 210
 211   utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
 212   utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
 213   objects.NIC.CheckParameterSyntax(nicparams)
 214
 215   # hvparams is a mapping of hypervisor->hvparams dict
 216   for hv_name, hv_params in hvparams.iteritems():
 217     utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
 218     hv_class = hypervisor.GetHypervisor(hv_name)
 219     hv_class.CheckParameterSyntax(hv_params)
 220
 221   # set up the inter-node password and certificate
 222   _InitGanetiServerSetup()
 223
 224   # set up ssh config and /etc/hosts
 225   f = open(constants.SSH_HOST_RSA_PUB, 'r')
 226   try:
 227     sshline = f.read()
 228   finally:
 229     f.close()
 230   sshkey = sshline.split(" ")[1]
 231
 232   if modify_etc_hosts:
 233     utils.AddHostToEtcHosts(hostname.name)
 234
 235   _InitSSHSetup()
 236
 237   # init of cluster config file
 238   cluster_config = objects.Cluster(
 239     serial_no=1,
 240     rsahostkeypub=sshkey,
 241     highest_used_port=(constants.FIRST_DRBD_PORT - 1),
 242     mac_prefix=mac_prefix,
 243     volume_group_name=vg_name,
 244     tcpudp_port_pool=set(),
 245     master_node=hostname.name,
 246     master_ip=clustername.ip,
 247     master_netdev=master_netdev,
 248     cluster_name=clustername.name,
 249     file_storage_dir=file_storage_dir,
 250     enabled_hypervisors=enabled_hypervisors,
 251     default_hypervisor=default_hypervisor,
 252     beparams={constants.PP_DEFAULT: beparams},
 253     nicparams={constants.PP_DEFAULT: nicparams},
 254     hvparams=hvparams,
 255     candidate_pool_size=candidate_pool_size,
 256     modify_etc_hosts=modify_etc_hosts,
 257     )
 258   master_node_config = objects.Node(name=hostname.name,
 259                                     primary_ip=hostname.ip,
 260                                     secondary_ip=secondary_ip,
 261                                     serial_no=1,
 262                                     master_candidate=True,
 263                                     offline=False, drained=False,
 264                                     )
 265
 266   sscfg = InitConfig(constants.CONFIG_VERSION,
 267                      cluster_config, master_node_config)
 268   ssh.WriteKnownHostsFile(sscfg, constants.SSH_KNOWN_HOSTS_FILE)
 269   cfg = config.ConfigWriter()
 270   cfg.Update(cfg.GetClusterInfo())
 271
 272   # start the master ip
 273   # TODO: Review rpc call from bootstrap
 274   # TODO: Warn on failed start master
 275   rpc.RpcRunner.call_node_start_master(hostname.name, True)
 276
 277
 278 def InitConfig(version, cluster_config, master_node_config,
 279                cfg_file=constants.CLUSTER_CONF_FILE):
 280   """Create the initial cluster configuration.
 281
 282   It will contain the current node, which will also be the master
 283   node, and no instances.
 284
 285   @type version: int
 286   @param version: configuration version
 287   @type cluster_config: L{objects.Cluster}
 288   @param cluster_config: cluster configuration
 289   @type master_node_config: L{objects.Node}
 290   @param master_node_config: master node configuration
 291   @type cfg_file: string
 292   @param cfg_file: configuration file path
 293
 294   @rtype: L{ssconf.SimpleConfigWriter}
 295   @return: initialized config instance
 296
 297   """
 298   nodes = {
 299     master_node_config.name: master_node_config,
 300     }
 301
 302   config_data = objects.ConfigData(version=version,
 303                                    cluster=cluster_config,
 304                                    nodes=nodes,
 305                                    instances={},
 306                                    serial_no=1)
 307   cfg = ssconf.SimpleConfigWriter.FromDict(config_data.ToDict(), cfg_file)
 308   cfg.Save()
 309
 310   return cfg
 311
 312
 313 def FinalizeClusterDestroy(master):
 314   """Execute the last steps of cluster destroy
 315
 316   This function shuts down all the daemons, completing the destroy
 317   begun in cmdlib.LUDestroyOpcode.
 318
 319   """
 320   result = rpc.RpcRunner.call_node_stop_master(master, True)
 321   msg = result.RemoteFailMsg()
 322   if msg:
 323     logging.warning("Could not disable the master role: %s" % msg)
 324   result = rpc.RpcRunner.call_node_leave_cluster(master)
 325   if result.failed or not result.data:
 326     logging.warning("Could not shutdown the node daemon and cleanup the node")
 327
 328
 329 def SetupNodeDaemon(cluster_name, node, ssh_key_check):
 330   """Add a node to the cluster.
 331
 332   This function must be called before the actual opcode, and will ssh
 333   to the remote node, copy the needed files, and start ganeti-noded,
 334   allowing the master to do the rest via normal rpc calls.
 335
 336   @param cluster_name: the cluster name
 337   @param node: the name of the new node
 338   @param ssh_key_check: whether to do a strict key check
 339
 340   """
 341   sshrunner = ssh.SshRunner(cluster_name)
 342
 343   noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
 344   rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
 345
 346   # in the base64 pem encoding, neither '!' nor '.' are valid chars,
 347   # so we use this to detect an invalid certificate; as long as the
 348   # cert doesn't contain this, the here-document will be correctly
 349   # parsed by the shell sequence below
 350   if (re.search('^!EOF\.', noded_cert, re.MULTILINE) or
 351       re.search('^!EOF\.', rapi_cert, re.MULTILINE)):
 352     raise errors.OpExecError("invalid PEM encoding in the SSL certificate")
 353
 354   if not noded_cert.endswith("\n"):
 355     noded_cert += "\n"
 356   if not rapi_cert.endswith("\n"):
 357     rapi_cert += "\n"
 358
 359   # set up inter-node password and certificate and restarts the node daemon
 360   # and then connect with ssh to set password and start ganeti-noded
 361   # note that all the below variables are sanitized at this point,
 362   # either by being constants or by the checks above
 363   mycommand = ("umask 077 && "
 364                "cat > '%s' << '!EOF.' && \n"
 365                "%s!EOF.\n"
 366                "cat > '%s' << '!EOF.' && \n"
 367                "%s!EOF.\n"
 368                "chmod 0400 %s %s && "
 369                "%s restart" %
 370                (constants.SSL_CERT_FILE, noded_cert,
 371                 constants.RAPI_CERT_FILE, rapi_cert,
 372                 constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
 373                 constants.NODE_INITD_SCRIPT))
 374
 375   result = sshrunner.Run(node, 'root', mycommand, batch=False,
 376                          ask_key=ssh_key_check,
 377                          use_cluster_key=False,
 378                          strict_host_check=ssh_key_check)
 379   if result.failed:
 380     raise errors.OpExecError("Remote command on node %s, error: %s,"
 381                              " output: %s" %
 382                              (node, result.fail_reason, result.output))
 383
 384
 385 def MasterFailover():
 386   """Failover the master node.
 387
 388   This checks that we are not already the master, and will cause the
 389   current master to cease being master, and the non-master to become
 390   new master.
 391
 392   """
 393   sstore = ssconf.SimpleStore()
 394
 395   old_master, new_master = ssconf.GetMasterAndMyself(sstore)
 396   node_list = sstore.GetNodeList()
 397   mc_list = sstore.GetMasterCandidates()
 398
 399   if old_master == new_master:
 400     raise errors.OpPrereqError("This commands must be run on the node"
 401                                " where you want the new master to be."
 402                                " %s is already the master" %
 403                                old_master)
 404
 405   if new_master not in mc_list:
 406     mc_no_master = [name for name in mc_list if name != old_master]
 407     raise errors.OpPrereqError("This node is not among the nodes marked"
 408                                " as master candidates. Only these nodes"
 409                                " can become masters. Current list of"
 410                                " master candidates is:\n"
 411                                "%s" % ('\n'.join(mc_no_master)))
 412
 413   vote_list = GatherMasterVotes(node_list)
 414
 415   if vote_list:
 416     voted_master = vote_list[0][0]
 417     if voted_master is None:
 418       raise errors.OpPrereqError("Cluster is inconsistent, most nodes did not"
 419                                  " respond.")
 420     elif voted_master != old_master:
 421       raise errors.OpPrereqError("I have wrong configuration, I believe the"
 422                                  " master is %s but the other nodes voted for"
 423                                  " %s. Please resync the configuration of"
 424                                  " this node." % (old_master, voted_master))
 425   # end checks
 426
 427   rcode = 0
 428
 429   logging.info("Setting master to %s, old master: %s", new_master, old_master)
 430
 431   result = rpc.RpcRunner.call_node_stop_master(old_master, True)
 432   msg = result.RemoteFailMsg()
 433   if msg:
 434     logging.error("Could not disable the master role on the old master"
 435                  " %s, please disable manually: %s", old_master, msg)
 436
 437   # Here we have a phase where no master should be running
 438
 439   # instantiate a real config writer, as we now know we have the
 440   # configuration data
 441   cfg = config.ConfigWriter()
 442
 443   cluster_info = cfg.GetClusterInfo()
 444   cluster_info.master_node = new_master
 445   # this will also regenerate the ssconf files, since we updated the
 446   # cluster info
 447   cfg.Update(cluster_info)
 448
 449   result = rpc.RpcRunner.call_node_start_master(new_master, True)
 450   msg = result.RemoteFailMsg()
 451   if msg:
 452     logging.error("Could not start the master role on the new master"
 453                   " %s, please check: %s", new_master, msg)
 454     rcode = 1
 455
 456   return rcode
 457
 458
 459 def GetMaster():
 460   """Returns the current master node.
 461
 462   This is a separate function in bootstrap since it's needed by
 463   gnt-cluster, and instead of importing directly ssconf, it's better
 464   to abstract it in bootstrap, where we do use ssconf in other
 465   functions too.
 466
 467   """
 468   sstore = ssconf.SimpleStore()
 469
 470   old_master, _ = ssconf.GetMasterAndMyself(sstore)
 471
 472   return old_master
 473
 474
 475 def GatherMasterVotes(node_list):
 476   """Check the agreement on who is the master.
 477
 478   This function will return a list of (node, number of votes), ordered
 479   by the number of votes. Errors will be denoted by the key 'None'.
 480
 481   Note that the sum of votes is the number of nodes this machine
 482   knows, whereas the number of entries in the list could be different
 483   (if some nodes vote for another master).
 484
 485   We remove ourselves from the list since we know that (bugs aside)
 486   since we use the same source for configuration information for both
 487   backend and boostrap, we'll always vote for ourselves.
 488
 489   @type node_list: list
 490   @param node_list: the list of nodes to query for master info; the current
 491       node wil be removed if it is in the list
 492   @rtype: list
 493   @return: list of (node, votes)
 494
 495   """
 496   myself = utils.HostInfo().name
 497   try:
 498     node_list.remove(myself)
 499   except ValueError:
 500     pass
 501   if not node_list:
 502     # no nodes left (eventually after removing myself)
 503     return []
 504   results = rpc.RpcRunner.call_master_info(node_list)
 505   if not isinstance(results, dict):
 506     # this should not happen (unless internal error in rpc)
 507     logging.critical("Can't complete rpc call, aborting master startup")
 508     return [(None, len(node_list))]
 509   votes = {}
 510   for node in results:
 511     nres = results[node]
 512     data = nres.data
 513     if nres.failed or not isinstance(data, (tuple, list)) or len(data) < 3:
 514       # here the rpc layer should have already logged errors
 515       if None not in votes:
 516         votes[None] = 0
 517       votes[None] += 1
 518       continue
 519     master_node = data[2]
 520     if master_node not in votes:
 521       votes[master_node] = 0
 522     votes[master_node] += 1
 523
 524   vote_list = [v for v in votes.items()]
 525   # sort first on number of votes then on name, since we want None
 526   # sorted later if we have the half of the nodes not responding, and
 527   # half voting all for the same master
 528   vote_list.sort(key=lambda x: (x[1], x[0]), reverse=True)
 529
 530   return vote_list