bootstrap.py 20.7 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
def GenerateHmacKey(file_name):
  """Writes a new HMAC key.

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

  """
110
  utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400)
111 112


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
  result = utils.RunCmd([constants.DAEMON_UTIL, "start", constants.NODED])
130 131 132 133 134
  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))

135
  # Wait for node daemon to become responsive
136
  def _CheckNodeDaemon():
137
    result = rpc.RpcRunner.call_version([master_name])[master_name]
138 139
    if result.fail_msg:
      raise utils.RetryAgain()
140

141 142 143 144 145
  try:
    utils.Retry(_CheckNodeDaemon, 1.0, 10.0)
  except utils.RetryTimeout:
    raise errors.OpExecError("Node daemon didn't answer queries within"
                             " 10 seconds")
146

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

154 155 156
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size

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

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

172
  hostname = utils.GetHostInfo()
173 174 175 176

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

180
  if not utils.OwnIpAddress(hostname.ip):
181 182
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
183 184
                               " belong to this host. Aborting." %
                               hostname.ip, errors.ECODE_ENVIRON)
185

186
  clustername = utils.GetHostInfo(cluster_name)
187 188 189

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

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

  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"
211 212
                                 " you are not using lvm" % vgstatus,
                                 errors.ECODE_INVAL)
213 214 215 216 217

  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"
218
                               " not an absolute path.", errors.ECODE_INVAL)
219 220 221 222 223 224

  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"
225 226
                                 " '%s': %s" % (file_storage_dir, err),
                                 errors.ECODE_ENVIRON)
227 228 229

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

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

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

243 244 245
  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
  utils.EnsureDirs(dirs)

246
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
247 248 249
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
  objects.NIC.CheckParameterSyntax(nicparams)

250 251 252 253 254
  # 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)
255

256
  # set up the inter-node password and certificate
257
  _InitGanetiServerSetup(hostname.name)
258 259

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

263 264 265
  if modify_etc_hosts:
    utils.AddHostToEtcHosts(hostname.name)

266 267
  if modify_ssh_setup:
    _InitSSHSetup()
268

269 270
  now = time.time()

271
  # init of cluster config file
272 273 274 275 276 277 278
  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(),
279 280 281 282 283
    master_node=hostname.name,
    master_ip=clustername.ip,
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
284
    enabled_hypervisors=enabled_hypervisors,
285
    beparams={constants.PP_DEFAULT: beparams},
286
    nicparams={constants.PP_DEFAULT: nicparams},
287
    hvparams=hvparams,
288
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
289
    modify_etc_hosts=modify_etc_hosts,
290
    modify_ssh_setup=modify_ssh_setup,
291 292 293
    ctime=now,
    mtime=now,
    uuid=utils.NewUUID(),
294 295 296
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
297
                                    secondary_ip=secondary_ip,
298 299
                                    serial_no=1,
                                    master_candidate=True,
300
                                    offline=False, drained=False,
301
                                    )
302
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
303
  cfg = config.ConfigWriter()
304
  ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
305
  cfg.Update(cfg.GetClusterInfo(), logging.error)
306

Iustin Pop's avatar
Iustin Pop committed
307 308
  # start the master ip
  # TODO: Review rpc call from bootstrap
309
  # TODO: Warn on failed start master
310
  rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
Iustin Pop's avatar
Iustin Pop committed
311

312

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
313 314
def InitConfig(version, cluster_config, master_node_config,
               cfg_file=constants.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
315 316 317 318 319 320
  """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
321 322 323 324 325 326 327 328
  @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
329 330 331 332 333
  """
  nodes = {
    master_node_config.name: master_node_config,
    }

334
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
335 336 337 338
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
                                   nodes=nodes,
                                   instances={},
339 340
                                   serial_no=1,
                                   ctime=now, mtime=now)
341 342 343
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
344 345


Iustin Pop's avatar
Iustin Pop committed
346 347 348 349 350 351 352
def FinalizeClusterDestroy(master):
  """Execute the last steps of cluster destroy

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

  """
353 354
  cfg = config.ConfigWriter()
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
355
  result = rpc.RpcRunner.call_node_stop_master(master, True)
356
  msg = result.fail_msg
357
  if msg:
358
    logging.warning("Could not disable the master role: %s", msg)
359
  result = rpc.RpcRunner.call_node_leave_cluster(master, modify_ssh_setup)
360
  msg = result.fail_msg
361 362 363
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
364 365


Iustin Pop's avatar
Iustin Pop committed
366
def SetupNodeDaemon(cluster_name, node, ssh_key_check):
367 368
  """Add a node to the cluster.

369 370 371
  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.
372

Iustin Pop's avatar
Iustin Pop committed
373 374 375
  @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
376 377

  """
Iustin Pop's avatar
Iustin Pop committed
378
  sshrunner = ssh.SshRunner(cluster_name)
379 380

  noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
381
  rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
382
  hmac_key = utils.ReadFile(constants.HMAC_CLUSTER_KEY)
383

384 385 386
  # 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
387 388 389 390 391
  # 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")
392 393 394

  if not noded_cert.endswith("\n"):
    noded_cert += "\n"
395 396
  if not rapi_cert.endswith("\n"):
    rapi_cert += "\n"
397 398
  if not hmac_key.endswith("\n"):
    hmac_key += "\n"
399 400 401 402 403 404 405

  # 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"
406 407 408
               "%s!EOF.\n"
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
409 410 411
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
               "chmod 0400 %s %s %s && "
412
               "%s start %s" %
413
               (constants.SSL_CERT_FILE, noded_cert,
414
                constants.RAPI_CERT_FILE, rapi_cert,
415
                constants.HMAC_CLUSTER_KEY, hmac_key,
416
                constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
417
                constants.HMAC_CLUSTER_KEY,
418
                constants.DAEMON_UTIL, constants.NODED))
419

420 421 422 423
  result = sshrunner.Run(node, 'root', mycommand, batch=False,
                         ask_key=ssh_key_check,
                         use_cluster_key=False,
                         strict_host_check=ssh_key_check)
424 425 426 427 428
  if result.failed:
    raise errors.OpExecError("Remote command on node %s, error: %s,"
                             " output: %s" %
                             (node, result.fail_reason, result.output))

429

430
def MasterFailover(no_voting=False):
431 432 433 434 435 436
  """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.

437 438 439 440
  @type no_voting: boolean
  @param no_voting: force the operation without remote nodes agreement
                      (dangerous)

441
  """
442
  sstore = ssconf.SimpleStore()
443

444 445 446
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
  node_list = sstore.GetNodeList()
  mc_list = sstore.GetMasterCandidates()
447 448 449 450 451

  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" %
452
                               old_master, errors.ECODE_INVAL)
453

454 455 456 457 458 459
  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"
460 461
                               "%s" % ('\n'.join(mc_no_master)),
                               errors.ECODE_STATE)
462

463 464 465 466 467 468 469
  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"
470
                                   " not respond.", errors.ECODE_ENVIRON)
471 472 473 474 475
      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." %
476 477
                                   (old_master, voted_master),
                                   errors.ECODE_STATE)
478 479 480 481
  # end checks

  rcode = 0

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

484
  result = rpc.RpcRunner.call_node_stop_master(old_master, True)
485
  msg = result.fail_msg
486
  if msg:
487
    logging.error("Could not disable the master role on the old master"
488
                 " %s, please disable manually: %s", old_master, msg)
489

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

Iustin Pop's avatar
Iustin Pop committed
492 493 494
  # instantiate a real config writer, as we now know we have the
  # configuration data
  cfg = config.ConfigWriter()
495

Iustin Pop's avatar
Iustin Pop committed
496 497 498 499
  cluster_info = cfg.GetClusterInfo()
  cluster_info.master_node = new_master
  # this will also regenerate the ssconf files, since we updated the
  # cluster info
500
  cfg.Update(cluster_info, logging.error)
501

502
  result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
503
  msg = result.fail_msg
504
  if msg:
505
    logging.error("Could not start the master role on the new master"
506
                  " %s, please check: %s", new_master, msg)
507 508 509
    rcode = 1

  return rcode
510 511


512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
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


528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
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
544
      node will be removed if it is in the list
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
  @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:
564
    nres = results[node]
565
    data = nres.payload
566
    msg = nres.fail_msg
567 568 569 570 571 572 573 574
    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:
575 576 577 578
      if None not in votes:
        votes[None] = 0
      votes[None] += 1
      continue
579
    master_node = data[2]
580 581 582 583 584 585 586 587 588 589 590
    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