bootstrap.py 43.8 KB
Newer Older
1 2 3
#
#

4
# Copyright (C) 2006, 2007, 2008, 2010, 2011, 2012 Google Inc.
Klaus Aehlig's avatar
Klaus Aehlig committed
5
# All rights reserved.
6
#
Klaus Aehlig's avatar
Klaus Aehlig committed
7 8 9
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
10
#
Klaus Aehlig's avatar
Klaus Aehlig committed
11 12
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
13
#
Klaus Aehlig's avatar
Klaus Aehlig committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
# IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 30 31 32 33 34 35 36 37


"""Functions to bootstrap a new cluster.

"""

import os
import os.path
import re
38
import logging
39
import time
40
import tempfile
41

42
from ganeti.cmdlib import cluster
43
import ganeti.rpc.node as rpc
44 45 46 47 48
from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import config
from ganeti import constants
49
from ganeti import objects
50
from ganeti import ssconf
51
from ganeti import serializer
52
from ganeti import hypervisor
53
from ganeti.storage import drbd
54
from ganeti.storage import filestorage
55
from ganeti import netutils
56
from ganeti import luxi
57
from ganeti import jstore
58
from ganeti import pathutils
59
from ganeti import runtime
60

61

62 63 64
# ec_id for InitConfig's temporary reservation manager
_INITCONF_ECID = "initconfig-ecid"

65 66 67
#: After how many seconds daemon must be responsive
_DAEMON_READY_TIMEOUT = 10.0

68

69
def _InitSSHSetup():
70 71 72 73 74 75
  """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.

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
76
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
77 78 79 80 81 82 83 84 85 86 87 88 89

  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)

90
  utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
91 92


93 94 95 96 97 98 99
def GenerateHmacKey(file_name):
  """Writes a new HMAC key.

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

  """
100 101 102 103
  utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400,
                  backup=True)


104
# pylint: disable=R0913
105
def GenerateClusterCrypto(new_cluster_cert, new_rapi_cert, new_spice_cert,
106
                          new_confd_hmac_key, new_cds,
107 108
                          rapi_cert_pem=None, spice_cert_pem=None,
                          spice_cacert_pem=None, cds=None,
109 110 111 112 113 114
                          nodecert_file=pathutils.NODED_CERT_FILE,
                          rapicert_file=pathutils.RAPI_CERT_FILE,
                          spicecert_file=pathutils.SPICE_CERT_FILE,
                          spicecacert_file=pathutils.SPICE_CACERT_FILE,
                          hmackey_file=pathutils.CONFD_HMAC_KEY,
                          cds_file=pathutils.CLUSTER_DOMAIN_SECRET_FILE):
115 116 117 118 119 120
  """Updates the cluster certificates, keys and secrets.

  @type new_cluster_cert: bool
  @param new_cluster_cert: Whether to generate a new cluster certificate
  @type new_rapi_cert: bool
  @param new_rapi_cert: Whether to generate a new RAPI certificate
121 122
  @type new_spice_cert: bool
  @param new_spice_cert: Whether to generate a new SPICE certificate
123 124
  @type new_confd_hmac_key: bool
  @param new_confd_hmac_key: Whether to generate a new HMAC key
Michael Hanselmann's avatar
Michael Hanselmann committed
125 126
  @type new_cds: bool
  @param new_cds: Whether to generate a new cluster domain secret
127 128
  @type rapi_cert_pem: string
  @param rapi_cert_pem: New RAPI certificate in PEM format
129 130 131 132 133
  @type spice_cert_pem: string
  @param spice_cert_pem: New SPICE certificate in PEM format
  @type spice_cacert_pem: string
  @param spice_cacert_pem: Certificate of the CA that signed the SPICE
                           certificate, in PEM format
Michael Hanselmann's avatar
Michael Hanselmann committed
134 135
  @type cds: string
  @param cds: New cluster domain secret
136 137 138 139
  @type nodecert_file: string
  @param nodecert_file: optional override of the node cert file path
  @type rapicert_file: string
  @param rapicert_file: optional override of the rapi cert file path
140 141 142 143
  @type spicecert_file: string
  @param spicecert_file: optional override of the spice cert file path
  @type spicecacert_file: string
  @param spicecacert_file: optional override of the spice CA cert file path
144 145
  @type hmackey_file: string
  @param hmackey_file: optional override of the hmac key file path
146 147

  """
148
  # pylint: disable=R0913
149
  # noded SSL certificate
150
  utils.GenerateNewSslCert(
151
    new_cluster_cert, nodecert_file, 1,
152
    "Generating new cluster certificate at %s" % nodecert_file)
153

154
  # confd HMAC key
155 156 157
  if new_confd_hmac_key or not os.path.exists(hmackey_file):
    logging.debug("Writing new confd HMAC key to %s", hmackey_file)
    GenerateHmacKey(hmackey_file)
158 159 160

  if rapi_cert_pem:
    # Assume rapi_pem contains a valid PEM-formatted certificate and key
161 162
    logging.debug("Writing RAPI certificate at %s", rapicert_file)
    utils.WriteFile(rapicert_file, data=rapi_cert_pem, backup=True)
163

164 165
  else:
    utils.GenerateNewSslCert(
166
      new_rapi_cert, rapicert_file, 1,
167
      "Generating new RAPI certificate at %s" % rapicert_file)
168

169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  # SPICE
  spice_cert_exists = os.path.exists(spicecert_file)
  spice_cacert_exists = os.path.exists(spicecacert_file)
  if spice_cert_pem:
    # spice_cert_pem implies also spice_cacert_pem
    logging.debug("Writing SPICE certificate at %s", spicecert_file)
    utils.WriteFile(spicecert_file, data=spice_cert_pem, backup=True)
    logging.debug("Writing SPICE CA certificate at %s", spicecacert_file)
    utils.WriteFile(spicecacert_file, data=spice_cacert_pem, backup=True)
  elif new_spice_cert or not spice_cert_exists:
    if spice_cert_exists:
      utils.CreateBackup(spicecert_file)
    if spice_cacert_exists:
      utils.CreateBackup(spicecacert_file)

    logging.debug("Generating new self-signed SPICE certificate at %s",
                  spicecert_file)
186
    (_, cert_pem) = utils.GenerateSelfSignedSslCert(spicecert_file, 1)
187 188 189 190 191 192 193

    # Self-signed certificate -> the public certificate is also the CA public
    # certificate
    logging.debug("Writing the public certificate to %s",
                  spicecert_file)
    utils.io.WriteFile(spicecacert_file, mode=0400, data=cert_pem)

Michael Hanselmann's avatar
Michael Hanselmann committed
194 195
  # Cluster domain secret
  if cds:
196 197 198 199 200 201
    logging.debug("Writing cluster domain secret to %s", cds_file)
    utils.WriteFile(cds_file, data=cds, backup=True)

  elif new_cds or not os.path.exists(cds_file):
    logging.debug("Generating new cluster domain secret at %s", cds_file)
    GenerateHmacKey(cds_file)
Michael Hanselmann's avatar
Michael Hanselmann committed
202

203

204
def _InitGanetiServerSetup(master_name):
205 206 207
  """Setup the necessary configuration for the initial node daemon.

  This creates the nodepass file containing the shared password for
208 209 210 211
  the cluster, generates the SSL certificate and starts the node daemon.

  @type master_name: str
  @param master_name: Name of the master node
212 213

  """
214
  # Generate cluster secrets
215
  GenerateClusterCrypto(True, False, False, False, False)
216

217
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start", constants.NODED])
218 219 220 221 222
  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))

223 224 225 226 227 228 229
  _WaitForNodeDaemon(master_name)


def _WaitForNodeDaemon(node_name):
  """Wait for node daemon to become responsive.

  """
230
  def _CheckNodeDaemon():
231 232
    # Pylint bug <http://www.logilab.org/ticket/35642>
    # pylint: disable=E1101
233
    result = rpc.BootstrapRunner().call_version([node_name])[node_name]
234 235
    if result.fail_msg:
      raise utils.RetryAgain()
236

237
  try:
238
    utils.Retry(_CheckNodeDaemon, 1.0, _DAEMON_READY_TIMEOUT)
239
  except utils.RetryTimeout:
240
    raise errors.OpExecError("Node daemon on %s didn't answer queries within"
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
                             " %s seconds" % (node_name, _DAEMON_READY_TIMEOUT))


def _WaitForMasterDaemon():
  """Wait for master daemon to become responsive.

  """
  def _CheckMasterDaemon():
    try:
      cl = luxi.Client()
      (cluster_name, ) = cl.QueryConfigValues(["cluster_name"])
    except Exception:
      raise utils.RetryAgain()

    logging.debug("Received cluster name %s from master", cluster_name)

  try:
    utils.Retry(_CheckMasterDaemon, 1.0, _DAEMON_READY_TIMEOUT)
  except utils.RetryTimeout:
    raise errors.OpExecError("Master daemon didn't answer queries within"
                             " %s seconds" % _DAEMON_READY_TIMEOUT)
262

263

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
def _WaitForSshDaemon(hostname, port, family):
  """Wait for SSH daemon to become responsive.

  """
  hostip = netutils.GetHostname(name=hostname, family=family).ip

  def _CheckSshDaemon():
    if netutils.TcpPing(hostip, port, timeout=1.0, live_port_needed=True):
      logging.debug("SSH daemon on %s:%s (IP address %s) has become"
                    " responsive", hostname, port, hostip)
    else:
      raise utils.RetryAgain()

  try:
    utils.Retry(_CheckSshDaemon, 1.0, _DAEMON_READY_TIMEOUT)
  except utils.RetryTimeout:
    raise errors.OpExecError("SSH daemon on %s:%s (IP address %s) didn't"
                             " become responsive within %s seconds" %
                             (hostname, port, hostip, _DAEMON_READY_TIMEOUT))


285
def RunNodeSetupCmd(cluster_name, node, basecmd, debug, verbose,
286 287
                    use_cluster_key, ask_key, strict_host_check,
                    port, data):
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  """Runs a command to configure something on a remote machine.

  @type cluster_name: string
  @param cluster_name: Cluster name
  @type node: string
  @param node: Node name
  @type basecmd: string
  @param basecmd: Base command (path on the remote machine)
  @type debug: bool
  @param debug: Enable debug output
  @type verbose: bool
  @param verbose: Enable verbose output
  @type use_cluster_key: bool
  @param use_cluster_key: See L{ssh.SshRunner.BuildCmd}
  @type ask_key: bool
  @param ask_key: See L{ssh.SshRunner.BuildCmd}
  @type strict_host_check: bool
  @param strict_host_check: See L{ssh.SshRunner.BuildCmd}
306 307
  @type port: int
  @param port: The SSH port of the remote machine or None for the default
308 309 310 311 312 313 314 315 316 317 318 319
  @param data: JSON-serializable input data for script (passed to stdin)

  """
  cmd = [basecmd]

  # Pass --debug/--verbose to the external script if set on our invocation
  if debug:
    cmd.append("--debug")

  if verbose:
    cmd.append("--verbose")

320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
  logging.debug("Node setup command: %s", cmd)

  version = constants.DIR_VERSION
  all_cmds = [["test", "-d", os.path.join(pathutils.PKGLIBDIR, version)]]
  if constants.HAS_GNU_LN:
    all_cmds.extend([["ln", "-s", "-f", "-T",
                      os.path.join(pathutils.PKGLIBDIR, version),
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/lib")],
                     ["ln", "-s", "-f", "-T",
                      os.path.join(pathutils.SHAREDIR, version),
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/share")]])
  else:
    all_cmds.extend([["rm", "-f",
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/lib")],
                     ["ln", "-s", "-f",
                      os.path.join(pathutils.PKGLIBDIR, version),
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/lib")],
                     ["rm", "-f",
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/share")],
                     ["ln", "-s", "-f",
                      os.path.join(pathutils.SHAREDIR, version),
                      os.path.join(pathutils.SYSCONFDIR, "ganeti/share")]])
  all_cmds.append(cmd)

344 345 346
  if port is None:
    port = netutils.GetDaemonPort(constants.SSH)

347 348 349
  family = ssconf.SimpleStore().GetPrimaryIPFamily()
  srun = ssh.SshRunner(cluster_name,
                       ipv6=(family == netutils.IP6Address.family))
350
  scmd = srun.BuildCmd(node, constants.SSH_LOGIN_USER,
351 352
                       utils.ShellQuoteArgs(
                           utils.ShellCombineCommands(all_cmds)),
353 354
                       batch=False, ask_key=ask_key, quiet=False,
                       strict_host_check=strict_host_check,
355 356
                       use_cluster_key=use_cluster_key,
                       port=port)
357 358 359 360 361 362 363 364 365 366 367 368 369 370

  tempfh = tempfile.TemporaryFile()
  try:
    tempfh.write(serializer.DumpJson(data))
    tempfh.seek(0)

    result = utils.RunCmd(scmd, interactive=True, input_fd=tempfh)
  finally:
    tempfh.close()

  if result.failed:
    raise errors.OpExecError("Command '%s' failed: %s" %
                             (result.cmd, result.fail_reason))

371
  _WaitForSshDaemon(node, port, family)
372

373

374
def _InitFileStorageDir(file_storage_dir):
375 376 377 378 379 380 381 382 383 384
  """Initialize if needed the file storage.

  @param file_storage_dir: the user-supplied value
  @return: either empty string (if file storage was disabled at build
      time) or the normalized path to the storage directory

  """
  file_storage_dir = os.path.normpath(file_storage_dir)

  if not os.path.isabs(file_storage_dir):
385 386
    raise errors.OpPrereqError("File storage directory '%s' is not an absolute"
                               " path" % file_storage_dir, errors.ECODE_INVAL)
387 388 389 390 391 392 393 394 395 396 397 398 399

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

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

401 402 403
  return file_storage_dir


404 405 406 407 408 409 410 411 412 413 414 415 416 417
def _PrepareFileBasedStorage(
    enabled_disk_templates, file_storage_dir,
    default_dir, file_disk_template,
    init_fn=_InitFileStorageDir, acceptance_fn=None):
  """Checks if a file-base storage type is enabled and inits the dir.

  @type enabled_disk_templates: list of string
  @param enabled_disk_templates: list of enabled disk templates
  @type file_storage_dir: string
  @param file_storage_dir: the file storage directory
  @type default_dir: string
  @param default_dir: default file storage directory when C{file_storage_dir}
      is 'None'
  @type file_disk_template: string
418 419
  @param file_disk_template: a disk template whose storage type is 'ST_FILE' or
      'ST_SHARED_FILE'
420 421
  @rtype: string
  @returns: the name of the actual file storage directory
422 423

  """
424 425 426 427
  assert (file_disk_template in utils.storage.GetDiskTemplatesOfStorageTypes(
            constants.ST_FILE, constants.ST_SHARED_FILE
         ))

428
  if file_storage_dir is None:
429
    file_storage_dir = default_dir
430 431 432 433 434 435 436 437
  if not acceptance_fn:
    acceptance_fn = \
        lambda path: filestorage.CheckFileStoragePathAcceptance(
            path, exact_match_ok=True)

  cluster.CheckFileStoragePathVsEnabledDiskTemplates(
      logging.warning, file_storage_dir, enabled_disk_templates)

438
  file_storage_enabled = file_disk_template in enabled_disk_templates
439 440 441 442 443 444 445 446 447 448 449
  if file_storage_enabled:
    try:
      acceptance_fn(file_storage_dir)
    except errors.FileStoragePathError as e:
      raise errors.OpPrereqError(str(e))
    result_file_storage_dir = init_fn(file_storage_dir)
  else:
    result_file_storage_dir = file_storage_dir
  return result_file_storage_dir


450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
def _PrepareFileStorage(
    enabled_disk_templates, file_storage_dir, init_fn=_InitFileStorageDir,
    acceptance_fn=None):
  """Checks if file storage is enabled and inits the dir.

  @see: C{_PrepareFileBasedStorage}

  """
  return _PrepareFileBasedStorage(
      enabled_disk_templates, file_storage_dir,
      pathutils.DEFAULT_FILE_STORAGE_DIR, constants.DT_FILE,
      init_fn=init_fn, acceptance_fn=acceptance_fn)


def _PrepareSharedFileStorage(
    enabled_disk_templates, file_storage_dir, init_fn=_InitFileStorageDir,
    acceptance_fn=None):
  """Checks if shared file storage is enabled and inits the dir.

  @see: C{_PrepareFileBasedStorage}

  """
  return _PrepareFileBasedStorage(
      enabled_disk_templates, file_storage_dir,
      pathutils.DEFAULT_SHARED_FILE_STORAGE_DIR, constants.DT_SHARED_FILE,
      init_fn=init_fn, acceptance_fn=acceptance_fn)


478 479 480 481 482 483 484 485 486 487 488 489 490 491
def _PrepareGlusterStorage(
    enabled_disk_templates, file_storage_dir, init_fn=_InitFileStorageDir,
    acceptance_fn=None):
  """Checks if gluster storage is enabled and inits the dir.

  @see: C{_PrepareFileBasedStorage}

  """
  return _PrepareFileBasedStorage(
      enabled_disk_templates, file_storage_dir,
      pathutils.DEFAULT_GLUSTER_STORAGE_DIR, constants.DT_GLUSTER,
      init_fn=init_fn, acceptance_fn=acceptance_fn)


492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
def _InitCheckEnabledDiskTemplates(enabled_disk_templates):
  """Checks the sanity of the enabled disk templates.

  """
  if not enabled_disk_templates:
    raise errors.OpPrereqError("Enabled disk templates list must contain at"
                               " least one member", errors.ECODE_INVAL)
  invalid_disk_templates = \
    set(enabled_disk_templates) - constants.DISK_TEMPLATES
  if invalid_disk_templates:
    raise errors.OpPrereqError("Enabled disk templates list contains invalid"
                               " entries: %s" % invalid_disk_templates,
                               errors.ECODE_INVAL)


507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
def _RestrictIpolicyToEnabledDiskTemplates(ipolicy, enabled_disk_templates):
  """Restricts the ipolicy's disk templates to the enabled ones.

  This function clears the ipolicy's list of allowed disk templates from the
  ones that are not enabled by the cluster.

  @type ipolicy: dict
  @param ipolicy: the instance policy
  @type enabled_disk_templates: list of string
  @param enabled_disk_templates: the list of cluster-wide enabled disk
    templates

  """
  assert constants.IPOLICY_DTS in ipolicy
  allowed_disk_templates = ipolicy[constants.IPOLICY_DTS]
  restricted_disk_templates = list(set(allowed_disk_templates)
                                   .intersection(set(enabled_disk_templates)))
  ipolicy[constants.IPOLICY_DTS] = restricted_disk_templates


527
def _InitCheckDrbdHelper(drbd_helper, drbd_enabled):
528 529 530 531 532 533 534
  """Checks the DRBD usermode helper.

  @type drbd_helper: string
  @param drbd_helper: name of the DRBD usermode helper that the system should
    use

  """
535 536 537
  if not drbd_enabled:
    return

538 539 540 541 542
  if drbd_helper is not None:
    try:
      curr_helper = drbd.DRBD8.GetUsermodeHelper()
    except errors.BlockDeviceError, err:
      raise errors.OpPrereqError("Error while checking drbd helper"
543 544
                                 " (disable drbd with --enabled-disk-templates"
                                 " if you are not using drbd): %s" % str(err),
545 546 547 548 549 550 551 552
                                 errors.ECODE_ENVIRON)
    if drbd_helper != curr_helper:
      raise errors.OpPrereqError("Error: requiring %s as drbd helper but %s"
                                 " is the current helper" % (drbd_helper,
                                                             curr_helper),
                                 errors.ECODE_INVAL)


553
def InitCluster(cluster_name, mac_prefix, # pylint: disable=R0913, R0914
554
                master_netmask, master_netdev, file_storage_dir,
555 556
                shared_file_storage_dir, gluster_storage_dir,
                candidate_pool_size, secondary_ip=None,
557
                vg_name=None, beparams=None, nicparams=None, ndparams=None,
558 559 560
                hvparams=None, diskparams=None, enabled_hypervisors=None,
                modify_etc_hosts=True, modify_ssh_setup=True,
                maintain_node_health=False, drbd_helper=None, uid_pool=None,
561 562
                default_iallocator=None, default_iallocator_params=None,
                primary_ip_version=None, ipolicy=None,
563
                prealloc_wipe_disks=False, use_external_mip_script=False,
564 565
                hv_state=None, disk_state=None, enabled_disk_templates=None,
                enabled_user_shutdown=False):
566 567
  """Initialise the cluster.

568 569
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size
570

571 572
  @type enabled_disk_templates: list of string
  @param enabled_disk_templates: list of disk_templates to be used in this
573
    cluster
574

575 576 577 578
  @type enabled_user_shutdown: bool
  @param enabled_user_shutdown: whether user shutdown is enabled cluster
                                wide

579
  """
580
  # TODO: complete the docstring
581
  if config.ConfigWriter.IsCluster():
582 583
    raise errors.OpPrereqError("Cluster is already initialised",
                               errors.ECODE_STATE)
584

585 586
  if not enabled_hypervisors:
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
587
                               " least one member", errors.ECODE_INVAL)
588 589 590
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
  if invalid_hvs:
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
591 592
                               " entries: %s" % invalid_hvs,
                               errors.ECODE_INVAL)
593

594
  _InitCheckEnabledDiskTemplates(enabled_disk_templates)
595

596 597 598
  try:
    ipcls = netutils.IPAddress.GetClassFromIpVersion(primary_ip_version)
  except errors.ProgrammerError:
599
    raise errors.OpPrereqError("Invalid primary ip version: %d." %
600
                               primary_ip_version, errors.ECODE_INVAL)
601 602 603 604

  hostname = netutils.GetHostname(family=ipcls.family)
  if not ipcls.IsValid(hostname.ip):
    raise errors.OpPrereqError("This host's IP (%s) is not a valid IPv%d"
605 606
                               " address." % (hostname.ip, primary_ip_version),
                               errors.ECODE_INVAL)
607 608

  if ipcls.IsLoopback(hostname.ip):
609 610
    raise errors.OpPrereqError("This host's IP (%s) resolves to a loopback"
                               " address. Please fix DNS or %s." %
611
                               (hostname.ip, pathutils.ETC_HOSTS),
612
                               errors.ECODE_ENVIRON)
613

614
  if not ipcls.Own(hostname.ip):
615 616
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
617
                               " belong to this host" %
618
                               hostname.ip, errors.ECODE_ENVIRON)
619

620
  clustername = netutils.GetHostname(name=cluster_name, family=ipcls.family)
621

622
  if netutils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT, timeout=5):
623
    raise errors.OpPrereqError("Cluster IP already active",
624
                               errors.ECODE_NOTUNIQUE)
625

626 627 628
  if not secondary_ip:
    if primary_ip_version == constants.IP6_VERSION:
      raise errors.OpPrereqError("When using a IPv6 primary address, a valid"
629 630
                                 " IPv4 address must be given as secondary",
                                 errors.ECODE_INVAL)
631
    secondary_ip = hostname.ip
632

633 634 635 636 637 638 639 640 641 642
  if not netutils.IP4Address.IsValid(secondary_ip):
    raise errors.OpPrereqError("Secondary IP address (%s) has to be a valid"
                               " IPv4 address." % secondary_ip,
                               errors.ECODE_INVAL)

  if not netutils.IP4Address.Own(secondary_ip):
    raise errors.OpPrereqError("You gave %s as secondary IP,"
                               " but it does not belong to this host." %
                               secondary_ip, errors.ECODE_ENVIRON)

643 644 645
  if master_netmask is not None:
    if not ipcls.ValidateNetmask(master_netmask):
      raise errors.OpPrereqError("CIDR netmask (%s) not valid for IPv%s " %
646 647
                                  (master_netmask, primary_ip_version),
                                 errors.ECODE_INVAL)
648 649 650
  else:
    master_netmask = ipcls.iplen

651
  if vg_name:
652 653 654 655
    # Check if volume group is valid
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
                                          constants.MIN_VG_SIZE)
    if vgstatus:
656
      raise errors.OpPrereqError("Error: %s" % vgstatus, errors.ECODE_INVAL)
657

658 659
  drbd_enabled = constants.DT_DRBD8 in enabled_disk_templates
  _InitCheckDrbdHelper(drbd_helper, drbd_enabled)
660

661 662 663 664 665 666 667
  logging.debug("Stopping daemons (if any are running)")
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "stop-all"])
  if result.failed:
    raise errors.OpExecError("Could not stop daemons, command %s"
                             " had exitcode %s and error '%s'" %
                             (result.cmd, result.exit_code, result.output))

668 669
  file_storage_dir = _PrepareFileStorage(enabled_disk_templates,
                                         file_storage_dir)
670 671
  shared_file_storage_dir = _PrepareSharedFileStorage(enabled_disk_templates,
                                                      shared_file_storage_dir)
672 673

  if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
674 675
    raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix,
                               errors.ECODE_INVAL)
676

677
  if not nicparams.get('mode', None) == constants.NIC_MODE_OVS:
678 679 680 681 682 683 684
    # Do not do this check if mode=openvswitch, since the openvswitch is not
    # created yet
    result = utils.RunCmd(["ip", "link", "show", "dev", master_netdev])
    if result.failed:
      raise errors.OpPrereqError("Invalid master netdev given (%s): '%s'" %
                                 (master_netdev,
                                  result.output.strip()), errors.ECODE_INVAL)
685

686
  dirs = [(pathutils.RUN_DIR, constants.RUN_DIRS_MODE)]
687 688
  utils.EnsureDirs(dirs)

689
  objects.UpgradeBeParams(beparams)
690
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
691
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
692

693
  objects.NIC.CheckParameterSyntax(nicparams)
694

695
  full_ipolicy = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy)
696
  _RestrictIpolicyToEnabledDiskTemplates(full_ipolicy, enabled_disk_templates)
697

698 699 700 701 702
  if ndparams is not None:
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
  else:
    ndparams = dict(constants.NDC_DEFAULTS)

703
  # This is ugly, as we modify the dict itself
704 705
  # FIXME: Make utils.ForceDictType pure functional or write a wrapper
  # around it
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
  if hv_state:
    for hvname, hvs_data in hv_state.items():
      utils.ForceDictType(hvs_data, constants.HVSTS_PARAMETER_TYPES)
      hv_state[hvname] = objects.Cluster.SimpleFillHvState(hvs_data)
  else:
    hv_state = dict((hvname, constants.HVST_DEFAULTS)
                    for hvname in enabled_hypervisors)

  # FIXME: disk_state has no default values yet
  if disk_state:
    for storage, ds_data in disk_state.items():
      if storage not in constants.DS_VALID_TYPES:
        raise errors.OpPrereqError("Invalid storage type in disk state: %s" %
                                   storage, errors.ECODE_INVAL)
      for ds_name, state in ds_data.items():
        utils.ForceDictType(state, constants.DSS_PARAMETER_TYPES)
        ds_data[ds_name] = objects.Cluster.SimpleFillDiskState(state)

724 725 726 727 728
  # 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)
729

730 731 732 733 734 735 736 737
  # diskparams is a mapping of disk-template->diskparams dict
  for template, dt_params in diskparams.items():
    param_keys = set(dt_params.keys())
    default_param_keys = set(constants.DISK_DT_DEFAULTS[template].keys())
    if not (param_keys <= default_param_keys):
      unknown_params = param_keys - default_param_keys
      raise errors.OpPrereqError("Invalid parameters for disk template %s:"
                                 " %s" % (template,
738 739
                                          utils.CommaJoin(unknown_params)),
                                 errors.ECODE_INVAL)
740
    utils.ForceDictType(dt_params, constants.DISK_DT_TYPES)
741 742 743 744 745
    if template == constants.DT_DRBD8 and vg_name is not None:
      # The default METAVG value is equal to the VG name set at init time,
      # if provided
      dt_params[constants.DRBD_DEFAULT_METAVG] = vg_name

746 747 748 749 750
  try:
    utils.VerifyDictOptions(diskparams, constants.DISK_DT_DEFAULTS)
  except errors.OpPrereqError, err:
    raise errors.OpPrereqError("While verify diskparam options: %s" % err,
                               errors.ECODE_INVAL)
751

752
  # set up ssh config and /etc/hosts
753 754 755 756 757 758 759 760 761 762 763
  rsa_sshkey = ""
  dsa_sshkey = ""
  if os.path.isfile(pathutils.SSH_HOST_RSA_PUB):
    sshline = utils.ReadFile(pathutils.SSH_HOST_RSA_PUB)
    rsa_sshkey = sshline.split(" ")[1]
  if os.path.isfile(pathutils.SSH_HOST_DSA_PUB):
    sshline = utils.ReadFile(pathutils.SSH_HOST_DSA_PUB)
    dsa_sshkey = sshline.split(" ")[1]
  if not rsa_sshkey and not dsa_sshkey:
    raise errors.OpPrereqError("Failed to find SSH public keys",
                               errors.ECODE_ENVIRON)
764

765
  if modify_etc_hosts:
766
    utils.AddHostToEtcHosts(hostname.name, hostname.ip)
767

768 769
  if modify_ssh_setup:
    _InitSSHSetup()
770

771 772 773 774 775 776 777 778
  if default_iallocator is not None:
    alloc_script = utils.FindFile(default_iallocator,
                                  constants.IALLOCATOR_SEARCH_PATH,
                                  os.path.isfile)
    if alloc_script is None:
      raise errors.OpPrereqError("Invalid default iallocator script '%s'"
                                 " specified" % default_iallocator,
                                 errors.ECODE_INVAL)
779 780
  else:
    # default to htools
781 782 783 784
    if utils.FindFile(constants.IALLOC_HAIL,
                      constants.IALLOCATOR_SEARCH_PATH,
                      os.path.isfile):
      default_iallocator = constants.IALLOC_HAIL
785

786 787 788 789 790 791 792
  # check if we have all the users we need
  try:
    runtime.GetEnts()
  except errors.ConfigurationError, err:
    raise errors.OpPrereqError("Required system user/group missing: %s" %
                               err, errors.ECODE_ENVIRON)

793 794
  candidate_certs = {}

795 796
  now = time.time()

797
  # init of cluster config file
798 799
  cluster_config = objects.Cluster(
    serial_no=1,
800 801
    rsahostkeypub=rsa_sshkey,
    dsahostkeypub=dsa_sshkey,
802 803 804 805
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
    mac_prefix=mac_prefix,
    volume_group_name=vg_name,
    tcpudp_port_pool=set(),
806
    master_ip=clustername.ip,
807
    master_netmask=master_netmask,
808 809 810
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
811
    shared_file_storage_dir=shared_file_storage_dir,
812
    gluster_storage_dir=gluster_storage_dir,
813
    enabled_hypervisors=enabled_hypervisors,
814
    beparams={constants.PP_DEFAULT: beparams},
815
    nicparams={constants.PP_DEFAULT: nicparams},
816
    ndparams=ndparams,
817
    hvparams=hvparams,
818
    diskparams=diskparams,
819
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
820
    modify_etc_hosts=modify_etc_hosts,
821
    modify_ssh_setup=modify_ssh_setup,
822
    uid_pool=uid_pool,
823 824
    ctime=now,
    mtime=now,
825
    maintain_node_health=maintain_node_health,
826
    drbd_usermode_helper=drbd_helper,
827
    default_iallocator=default_iallocator,
828
    default_iallocator_params=default_iallocator_params,
829
    primary_ip_family=ipcls.family,
830
    prealloc_wipe_disks=prealloc_wipe_disks,
831
    use_external_mip_script=use_external_mip_script,
832
    ipolicy=full_ipolicy,
833 834
    hv_state_static=hv_state,
    disk_state_static=disk_state,
835
    enabled_disk_templates=enabled_disk_templates,
836
    candidate_certs=candidate_certs,
837
    enabled_user_shutdown=enabled_user_shutdown,
838 839 840
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
841
                                    secondary_ip=secondary_ip,
842 843
                                    serial_no=1,
                                    master_candidate=True,
844
                                    offline=False, drained=False,
845
                                    ctime=now, mtime=now,
846
                                    )
847
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
848
  cfg = config.ConfigWriter(offline=True)
849
  ssh.WriteKnownHostsFile(cfg, pathutils.SSH_KNOWN_HOSTS_FILE)
850
  cfg.Update(cfg.GetClusterInfo(), logging.error)
851
  ssconf.WriteSsconfFiles(cfg.GetSsconfValues())
852 853 854

  # set up the inter-node password and certificate
  _InitGanetiServerSetup(hostname.name)
855

856
  logging.debug("Starting daemons")
857
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-all"])
858 859 860 861
  if result.failed:
    raise errors.OpExecError("Could not start daemons, command %s"
                             " had exitcode %s and error %s" %
                             (result.cmd, result.exit_code, result.output))
Iustin Pop's avatar
Iustin Pop committed
862

863
  _WaitForMasterDaemon()
Iustin Pop's avatar
Iustin Pop committed
864

865

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
866
def InitConfig(version, cluster_config, master_node_config,
867
               cfg_file=pathutils.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
868 869 870 871 872 873
  """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
874 875 876 877 878 879 880 881
  @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
882
  """
883 884 885 886 887
  uuid_generator = config.TemporaryReservationManager()
  cluster_config.uuid = uuid_generator.Generate([], utils.NewUUID,
                                                _INITCONF_ECID)
  master_node_config.uuid = uuid_generator.Generate([], utils.NewUUID,
                                                    _INITCONF_ECID)
Thomas Thrainer's avatar
Thomas Thrainer committed
888
  cluster_config.master_node = master_node_config.uuid
Iustin Pop's avatar
Iustin Pop committed
889
  nodes = {
Thomas Thrainer's avatar
Thomas Thrainer committed
890
    master_node_config.uuid: master_node_config,
Iustin Pop's avatar
Iustin Pop committed
891
    }
892 893
  default_nodegroup = objects.NodeGroup(
    uuid=uuid_generator.Generate([], utils.NewUUID, _INITCONF_ECID),
894
    name=constants.INITIAL_NODE_GROUP_NAME,
Thomas Thrainer's avatar
Thomas Thrainer committed
895
    members=[master_node_config.uuid],
896
    diskparams={},
897 898 899 900
    )
  nodegroups = {
    default_nodegroup.uuid: default_nodegroup,
    }
901
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
902 903
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
904
                                   nodegroups=nodegroups,
Iustin Pop's avatar
Iustin Pop committed
905 906
                                   nodes=nodes,
                                   instances={},
907
                                   networks={},
908 909
                                   serial_no=1,
                                   ctime=now, mtime=now)
910 911 912
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
913 914


Thomas Thrainer's avatar
Thomas Thrainer committed
915
def FinalizeClusterDestroy(master_uuid):
Iustin Pop's avatar
Iustin Pop committed
916 917 918 919 920 921
  """Execute the last steps of cluster destroy

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

  """
922 923
  cfg = config.ConfigWriter()
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
924 925
  runner = rpc.BootstrapRunner()

Thomas Thrainer's avatar
Thomas Thrainer committed
926 927
  master_name = cfg.GetNodeName(master_uuid)

928
  master_params = cfg.GetMasterNetworkParameters()
Thomas Thrainer's avatar
Thomas Thrainer committed
929
  master_params.uuid = master_uuid
930
  ems = cfg.GetUseExternalMipScript()
Thomas Thrainer's avatar
Thomas Thrainer committed
931 932
  result = runner.call_node_deactivate_master_ip(master_name, master_params,
                                                 ems)
933

934 935 936 937
  msg = result.fail_msg
  if msg:
    logging.warning("Could not disable the master IP: %s", msg)

Thomas Thrainer's avatar
Thomas Thrainer committed
938
  result = runner.call_node_stop_master(master_name)
939
  msg = result.fail_msg
940
  if msg:
941
    logging.warning("Could not disable the master role: %s", msg)
942

Thomas Thrainer's avatar
Thomas Thrainer committed
943
  result = runner.call_node_leave_cluster(master_name, modify_ssh_setup)
944
  msg = result.fail_msg
945 946 947
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
948 949


950
def SetupNodeDaemon(opts, cluster_name, node, ssh_port):
951 952
  """Add a node to the cluster.

953 954 955
  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.
956

Iustin Pop's avatar
Iustin Pop committed
957 958
  @param cluster_name: the cluster name
  @param node: the name of the new node
959
  @param ssh_port: the SSH port of the new node
960 961

  """
962 963 964 965 966