bootstrap.py 20.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
#
#

# Copyright (C) 2006, 2007, 2008 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Functions to bootstrap a new cluster.

"""

import os
import os.path
import re
29
import logging
30
import tempfile
31
import time
32 33 34 35 36 37 38

from ganeti import rpc
from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import config
from ganeti import constants
39
from ganeti import objects
40
from ganeti import ssconf
41
from ganeti import serializer
42
from ganeti import hypervisor
43

44

45
def _InitSSHSetup():
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
  """Setup the SSH configuration for the cluster.

  This generates a dsa keypair for root, adds the pub key to the
  permitted hosts and adds the hostkey to its own known hosts.

  """
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)

  for name in priv_key, pub_key:
    if os.path.exists(name):
      utils.CreateBackup(name)
    utils.RemoveFile(name)

  result = utils.RunCmd(["ssh-keygen", "-t", "dsa",
                         "-f", priv_key,
                         "-q", "-N", ""])
  if result.failed:
    raise errors.OpExecError("Could not generate ssh keypair, error %s" %
                             result.output)

66
  utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
67 68


69
def GenerateSelfSignedSslCert(file_name, validity=(365 * 5)):
70
  """Generates a self-signed SSL certificate.
71

72 73 74 75
  @type file_name: str
  @param file_name: Path to output file
  @type validity: int
  @param validity: Validity for certificate in days
76 77

  """
78 79
  (fd, tmp_file_name) = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
    try:
      # Set permissions before writing key
      os.chmod(tmp_file_name, 0600)

      result = utils.RunCmd(["openssl", "req", "-new", "-newkey", "rsa:1024",
                             "-days", str(validity), "-nodes", "-x509",
                             "-keyout", tmp_file_name, "-out", tmp_file_name,
                             "-batch"])
      if result.failed:
        raise errors.OpExecError("Could not generate SSL certificate, command"
                                 " %s had exitcode %s and error message %s" %
                                 (result.cmd, result.exit_code, result.output))

      # Make read-only
      os.chmod(tmp_file_name, 0400)

      os.rename(tmp_file_name, file_name)
    finally:
      utils.RemoveFile(tmp_file_name)
99
  finally:
100
    os.close(fd)
101 102


103 104 105 106 107 108 109 110 111 112
def GenerateHmacKey(file_name):
  """Writes a new HMAC key.

  @type file_name: str
  @param file_name: Path to output file

  """
  utils.WriteFile(file_name, data=utils.GenerateSecret(), mode=0400)


113
def _InitGanetiServerSetup(master_name):
114 115 116 117 118 119
  """Setup the necessary configuration for the initial node daemon.

  This creates the nodepass file containing the shared password for
  the cluster and also generates the SSL certificate.

  """
120
  GenerateSelfSignedSslCert(constants.SSL_CERT_FILE)
121

122 123
  # Don't overwrite existing file
  if not os.path.exists(constants.RAPI_CERT_FILE):
124
    GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)
125

126
  if not os.path.exists(constants.HMAC_CLUSTER_KEY):
127
    GenerateHmacKey(constants.HMAC_CLUSTER_KEY)
128

129 130 131 132 133 134 135
  result = utils.RunCmd([constants.NODE_INITD_SCRIPT, "restart"])

  if result.failed:
    raise errors.OpExecError("Could not start the node daemon, command %s"
                             " had exitcode %s and error %s" %
                             (result.cmd, result.exit_code, result.output))

136 137 138 139 140 141 142 143 144 145 146 147 148
  # Wait for node daemon to become responsive
  end_time = time.time() + 10.0
  while True:
    result = rpc.RpcRunner.call_version([master_name])[master_name]
    if not result.fail_msg:
      break

    if time.time() > end_time:
      raise errors.OpExecError("Node daemon didn't answer queries within"
                               " 10 seconds")

    time.sleep(1)

149

150
def InitCluster(cluster_name, mac_prefix,
151
                master_netdev, file_storage_dir, candidate_pool_size,
152 153
                secondary_ip=None, vg_name=None, beparams=None,
                nicparams=None, hvparams=None, enabled_hypervisors=None,
154
                modify_etc_hosts=True, modify_ssh_setup=True):
155 156
  """Initialise the cluster.

157 158 159
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size

160
  """
161
  # TODO: complete the docstring
162
  if config.ConfigWriter.IsCluster():
163 164
    raise errors.OpPrereqError("Cluster is already initialised",
                               errors.ECODE_STATE)
165

166 167
  if not enabled_hypervisors:
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
168
                               " least one member", errors.ECODE_INVAL)
169 170 171
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
  if invalid_hvs:
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
172 173
                               " entries: %s" % invalid_hvs,
                               errors.ECODE_INVAL)
174

175 176 177 178 179
  hostname = utils.HostInfo()

  if hostname.ip.startswith("127."):
    raise errors.OpPrereqError("This host's IP resolves to the private"
                               " range (%s). Please fix DNS or %s." %
180 181
                               (hostname.ip, constants.ETC_HOSTS),
                               errors.ECODE_ENVIRON)
182

183
  if not utils.OwnIpAddress(hostname.ip):
184 185
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
186 187
                               " belong to this host. Aborting." %
                               hostname.ip, errors.ECODE_ENVIRON)
188 189 190 191 192

  clustername = utils.HostInfo(cluster_name)

  if utils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT,
                   timeout=5):
193 194
    raise errors.OpPrereqError("Cluster IP already active. Aborting.",
                               errors.ECODE_NOTUNIQUE)
195 196 197

  if secondary_ip:
    if not utils.IsValidIP(secondary_ip):
198 199
      raise errors.OpPrereqError("Invalid secondary ip given",
                                 errors.ECODE_INVAL)
200
    if (secondary_ip != hostname.ip and
201
        not utils.OwnIpAddress(secondary_ip)):
202 203
      raise errors.OpPrereqError("You gave %s as secondary IP,"
                                 " but it does not belong to this host." %
204
                                 secondary_ip, errors.ECODE_ENVIRON)
205 206
  else:
    secondary_ip = hostname.ip
207 208 209 210 211 212 213

  if vg_name is not None:
    # Check if volume group is valid
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
                                          constants.MIN_VG_SIZE)
    if vgstatus:
      raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
214 215
                                 " you are not using lvm" % vgstatus,
                                 errors.ECODE_INVAL)
216 217 218 219 220

  file_storage_dir = os.path.normpath(file_storage_dir)

  if not os.path.isabs(file_storage_dir):
    raise errors.OpPrereqError("The file storage directory you passed is"
221
                               " not an absolute path.", errors.ECODE_INVAL)
222 223 224 225 226 227

  if not os.path.exists(file_storage_dir):
    try:
      os.makedirs(file_storage_dir, 0750)
    except OSError, err:
      raise errors.OpPrereqError("Cannot create file storage directory"
228 229
                                 " '%s': %s" % (file_storage_dir, err),
                                 errors.ECODE_ENVIRON)
230 231 232

  if not os.path.isdir(file_storage_dir):
    raise errors.OpPrereqError("The file storage directory '%s' is not"
233 234
                               " a directory." % file_storage_dir,
                               errors.ECODE_ENVIRON)
235 236

  if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
237 238
    raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix,
                               errors.ECODE_INVAL)
239 240 241 242 243

  result = utils.RunCmd(["ip", "link", "show", "dev", master_netdev])
  if result.failed:
    raise errors.OpPrereqError("Invalid master netdev given (%s): '%s'" %
                               (master_netdev,
244
                                result.output.strip()), errors.ECODE_INVAL)
245 246 247 248

  if not (os.path.isfile(constants.NODE_INITD_SCRIPT) and
          os.access(constants.NODE_INITD_SCRIPT, os.X_OK)):
    raise errors.OpPrereqError("Init.d script '%s' missing or not"
249 250
                               " executable." % constants.NODE_INITD_SCRIPT,
                               errors.ECODE_ENVIRON)
251

252 253 254
  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
  utils.EnsureDirs(dirs)

255
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
256 257 258
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
  objects.NIC.CheckParameterSyntax(nicparams)

259 260 261 262 263
  # hvparams is a mapping of hypervisor->hvparams dict
  for hv_name, hv_params in hvparams.iteritems():
    utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
    hv_class = hypervisor.GetHypervisor(hv_name)
    hv_class.CheckParameterSyntax(hv_params)
264

265
  # set up the inter-node password and certificate
266
  _InitGanetiServerSetup(hostname.name)
267 268

  # set up ssh config and /etc/hosts
269
  sshline = utils.ReadFile(constants.SSH_HOST_RSA_PUB)
270 271
  sshkey = sshline.split(" ")[1]

272 273 274
  if modify_etc_hosts:
    utils.AddHostToEtcHosts(hostname.name)

275 276
  if modify_ssh_setup:
    _InitSSHSetup()
277

278 279
  now = time.time()

280
  # init of cluster config file
281 282 283 284 285 286 287
  cluster_config = objects.Cluster(
    serial_no=1,
    rsahostkeypub=sshkey,
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
    mac_prefix=mac_prefix,
    volume_group_name=vg_name,
    tcpudp_port_pool=set(),
288 289 290 291 292
    master_node=hostname.name,
    master_ip=clustername.ip,
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
293
    enabled_hypervisors=enabled_hypervisors,
294
    beparams={constants.PP_DEFAULT: beparams},
295
    nicparams={constants.PP_DEFAULT: nicparams},
296
    hvparams=hvparams,
297
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
298
    modify_etc_hosts=modify_etc_hosts,
299
    modify_ssh_setup=modify_ssh_setup,
300 301 302
    ctime=now,
    mtime=now,
    uuid=utils.NewUUID(),
303 304 305
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
306
                                    secondary_ip=secondary_ip,
307 308
                                    serial_no=1,
                                    master_candidate=True,
309
                                    offline=False, drained=False,
310
                                    )
311
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
312
  cfg = config.ConfigWriter()
313
  ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
314
  cfg.Update(cfg.GetClusterInfo(), logging.error)
315

Iustin Pop's avatar
Iustin Pop committed
316 317
  # start the master ip
  # TODO: Review rpc call from bootstrap
318
  # TODO: Warn on failed start master
319
  rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
Iustin Pop's avatar
Iustin Pop committed
320

321

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
322 323
def InitConfig(version, cluster_config, master_node_config,
               cfg_file=constants.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
324 325 326 327 328 329
  """Create the initial cluster configuration.

  It will contain the current node, which will also be the master
  node, and no instances.

  @type version: int
Iustin Pop's avatar
Iustin Pop committed
330 331 332 333 334 335 336 337
  @param version: configuration version
  @type cluster_config: L{objects.Cluster}
  @param cluster_config: cluster configuration
  @type master_node_config: L{objects.Node}
  @param master_node_config: master node configuration
  @type cfg_file: string
  @param cfg_file: configuration file path

Iustin Pop's avatar
Iustin Pop committed
338 339 340 341 342
  """
  nodes = {
    master_node_config.name: master_node_config,
    }

343
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
344 345 346 347
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
                                   nodes=nodes,
                                   instances={},
348 349
                                   serial_no=1,
                                   ctime=now, mtime=now)
350 351 352
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
353 354


Iustin Pop's avatar
Iustin Pop committed
355 356 357 358 359 360 361
def FinalizeClusterDestroy(master):
  """Execute the last steps of cluster destroy

  This function shuts down all the daemons, completing the destroy
  begun in cmdlib.LUDestroyOpcode.

  """
362 363
  cfg = config.ConfigWriter()
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
364
  result = rpc.RpcRunner.call_node_stop_master(master, True)
365
  msg = result.fail_msg
366 367
  if msg:
    logging.warning("Could not disable the master role: %s" % msg)
368
  result = rpc.RpcRunner.call_node_leave_cluster(master, modify_ssh_setup)
369
  msg = result.fail_msg
370 371 372
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
373 374


Iustin Pop's avatar
Iustin Pop committed
375
def SetupNodeDaemon(cluster_name, node, ssh_key_check):
376 377
  """Add a node to the cluster.

378 379 380
  This function must be called before the actual opcode, and will ssh
  to the remote node, copy the needed files, and start ganeti-noded,
  allowing the master to do the rest via normal rpc calls.
381

Iustin Pop's avatar
Iustin Pop committed
382 383 384
  @param cluster_name: the cluster name
  @param node: the name of the new node
  @param ssh_key_check: whether to do a strict key check
385 386

  """
Iustin Pop's avatar
Iustin Pop committed
387
  sshrunner = ssh.SshRunner(cluster_name)
388 389

  noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
390
  rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
391
  hmac_key = utils.ReadFile(constants.HMAC_CLUSTER_KEY)
392

393 394 395
  # in the base64 pem encoding, neither '!' nor '.' are valid chars,
  # so we use this to detect an invalid certificate; as long as the
  # cert doesn't contain this, the here-document will be correctly
396 397 398 399 400
  # parsed by the shell sequence below. HMAC keys are hexadecimal strings,
  # so the same restrictions apply.
  for content in (noded_cert, rapi_cert, hmac_key):
    if re.search('^!EOF\.', content, re.MULTILINE):
      raise errors.OpExecError("invalid SSL certificate or HMAC key")
401 402 403

  if not noded_cert.endswith("\n"):
    noded_cert += "\n"
404 405
  if not rapi_cert.endswith("\n"):
    rapi_cert += "\n"
406 407
  if not hmac_key.endswith("\n"):
    hmac_key += "\n"
408 409 410 411 412 413 414

  # set up inter-node password and certificate and restarts the node daemon
  # and then connect with ssh to set password and start ganeti-noded
  # note that all the below variables are sanitized at this point,
  # either by being constants or by the checks above
  mycommand = ("umask 077 && "
               "cat > '%s' << '!EOF.' && \n"
415 416 417
               "%s!EOF.\n"
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
418 419 420
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
               "chmod 0400 %s %s %s && "
421
               "%s restart" %
422
               (constants.SSL_CERT_FILE, noded_cert,
423
                constants.RAPI_CERT_FILE, rapi_cert,
424
                constants.HMAC_CLUSTER_KEY, hmac_key,
425
                constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
426
                constants.HMAC_CLUSTER_KEY,
427 428
                constants.NODE_INITD_SCRIPT))

429 430 431 432
  result = sshrunner.Run(node, 'root', mycommand, batch=False,
                         ask_key=ssh_key_check,
                         use_cluster_key=False,
                         strict_host_check=ssh_key_check)
433 434 435 436 437
  if result.failed:
    raise errors.OpExecError("Remote command on node %s, error: %s,"
                             " output: %s" %
                             (node, result.fail_reason, result.output))

438

439
def MasterFailover(no_voting=False):
440 441 442 443 444 445
  """Failover the master node.

  This checks that we are not already the master, and will cause the
  current master to cease being master, and the non-master to become
  new master.

446 447 448 449
  @type no_voting: boolean
  @param no_voting: force the operation without remote nodes agreement
                      (dangerous)

450
  """
451
  sstore = ssconf.SimpleStore()
452

453 454 455
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
  node_list = sstore.GetNodeList()
  mc_list = sstore.GetMasterCandidates()
456 457 458 459 460

  if old_master == new_master:
    raise errors.OpPrereqError("This commands must be run on the node"
                               " where you want the new master to be."
                               " %s is already the master" %
461
                               old_master, errors.ECODE_INVAL)
462

463 464 465 466 467 468
  if new_master not in mc_list:
    mc_no_master = [name for name in mc_list if name != old_master]
    raise errors.OpPrereqError("This node is not among the nodes marked"
                               " as master candidates. Only these nodes"
                               " can become masters. Current list of"
                               " master candidates is:\n"
469 470
                               "%s" % ('\n'.join(mc_no_master)),
                               errors.ECODE_STATE)
471

472 473 474 475 476 477 478
  if not no_voting:
    vote_list = GatherMasterVotes(node_list)

    if vote_list:
      voted_master = vote_list[0][0]
      if voted_master is None:
        raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
479
                                   " not respond.", errors.ECODE_ENVIRON)
480 481 482 483 484
      elif voted_master != old_master:
        raise errors.OpPrereqError("I have a wrong configuration, I believe"
                                   " the master is %s but the other nodes"
                                   " voted %s. Please resync the configuration"
                                   " of this node." %
485 486
                                   (old_master, voted_master),
                                   errors.ECODE_STATE)
487 488 489 490
  # end checks

  rcode = 0

491
  logging.info("Setting master to %s, old master: %s", new_master, old_master)
492

493
  result = rpc.RpcRunner.call_node_stop_master(old_master, True)
494
  msg = result.fail_msg
495
  if msg:
496
    logging.error("Could not disable the master role on the old master"
497
                 " %s, please disable manually: %s", old_master, msg)
498

Michael Hanselmann's avatar
Michael Hanselmann committed
499
  # Here we have a phase where no master should be running
500

Iustin Pop's avatar
Iustin Pop committed
501 502 503
  # instantiate a real config writer, as we now know we have the
  # configuration data
  cfg = config.ConfigWriter()
504

Iustin Pop's avatar
Iustin Pop committed
505 506 507 508
  cluster_info = cfg.GetClusterInfo()
  cluster_info.master_node = new_master
  # this will also regenerate the ssconf files, since we updated the
  # cluster info
509
  cfg.Update(cluster_info, logging.error)
510

511
  result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
512
  msg = result.fail_msg
513
  if msg:
514
    logging.error("Could not start the master role on the new master"
515
                  " %s, please check: %s", new_master, msg)
516 517 518
    rcode = 1

  return rcode
519 520


521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
def GetMaster():
  """Returns the current master node.

  This is a separate function in bootstrap since it's needed by
  gnt-cluster, and instead of importing directly ssconf, it's better
  to abstract it in bootstrap, where we do use ssconf in other
  functions too.

  """
  sstore = ssconf.SimpleStore()

  old_master, _ = ssconf.GetMasterAndMyself(sstore)

  return old_master


537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
def GatherMasterVotes(node_list):
  """Check the agreement on who is the master.

  This function will return a list of (node, number of votes), ordered
  by the number of votes. Errors will be denoted by the key 'None'.

  Note that the sum of votes is the number of nodes this machine
  knows, whereas the number of entries in the list could be different
  (if some nodes vote for another master).

  We remove ourselves from the list since we know that (bugs aside)
  since we use the same source for configuration information for both
  backend and boostrap, we'll always vote for ourselves.

  @type node_list: list
  @param node_list: the list of nodes to query for master info; the current
Michael Hanselmann's avatar
Michael Hanselmann committed
553
      node will be removed if it is in the list
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
  @rtype: list
  @return: list of (node, votes)

  """
  myself = utils.HostInfo().name
  try:
    node_list.remove(myself)
  except ValueError:
    pass
  if not node_list:
    # no nodes left (eventually after removing myself)
    return []
  results = rpc.RpcRunner.call_master_info(node_list)
  if not isinstance(results, dict):
    # this should not happen (unless internal error in rpc)
    logging.critical("Can't complete rpc call, aborting master startup")
    return [(None, len(node_list))]
  votes = {}
  for node in results:
573
    nres = results[node]
574
    data = nres.payload
575
    msg = nres.fail_msg
576 577 578 579 580 581 582 583
    fail = False
    if msg:
      logging.warning("Error contacting node %s: %s", node, msg)
      fail = True
    elif not isinstance(data, (tuple, list)) or len(data) < 3:
      logging.warning("Invalid data received from node %s: %s", node, data)
      fail = True
    if fail:
584 585 586 587
      if None not in votes:
        votes[None] = 0
      votes[None] += 1
      continue
588
    master_node = data[2]
589 590 591 592 593 594 595 596 597 598 599
    if master_node not in votes:
      votes[master_node] = 0
    votes[master_node] += 1

  vote_list = [v for v in votes.items()]
  # sort first on number of votes then on name, since we want None
  # sorted later if we have the half of the nodes not responding, and
  # half voting all for the same master
  vote_list.sort(key=lambda x: (x[1], x[0]), reverse=True)

  return vote_list