bootstrap.py 46.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
from ganeti import vcluster
61

62

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

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

69

70
def _InitSSHSetup():
71 72 73 74 75 76
  """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
77
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
78 79 80 81 82 83 84 85 86 87 88 89 90

  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)

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


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

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

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


105
# pylint: disable=R0913
106
def GenerateClusterCrypto(new_cluster_cert, new_rapi_cert, new_spice_cert,
107
                          new_confd_hmac_key, new_cds,
108 109
                          rapi_cert_pem=None, spice_cert_pem=None,
                          spice_cacert_pem=None, cds=None,
110 111 112 113 114 115
                          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):
116 117 118 119 120 121
  """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
122 123
  @type new_spice_cert: bool
  @param new_spice_cert: Whether to generate a new SPICE certificate
124 125
  @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
126 127
  @type new_cds: bool
  @param new_cds: Whether to generate a new cluster domain secret
128 129
  @type rapi_cert_pem: string
  @param rapi_cert_pem: New RAPI certificate in PEM format
130 131 132 133 134
  @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
135 136
  @type cds: string
  @param cds: New cluster domain secret
137 138 139 140
  @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
141 142 143 144
  @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
145 146
  @type hmackey_file: string
  @param hmackey_file: optional override of the hmac key file path
147 148

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

155
  # confd HMAC key
156 157 158
  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)
159 160 161

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

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

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  # 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)
187
    (_, cert_pem) = utils.GenerateSelfSignedSslCert(spicecert_file, 1)
188 189 190 191 192 193 194

    # 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
195 196
  # Cluster domain secret
  if cds:
197 198 199 200 201 202
    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
203

204

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

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

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

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

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

224 225 226 227 228 229 230
  _WaitForNodeDaemon(master_name)


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

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

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

264

265
def _WaitForSshDaemon(hostname, port):
266 267 268
  """Wait for SSH daemon to become responsive.

  """
269
  family = ssconf.SimpleStore().GetPrimaryIPFamily()
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  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))


287
def RunNodeSetupCmd(cluster_name, node, basecmd, debug, verbose,
288 289
                    use_cluster_key, ask_key, strict_host_check,
                    port, data):
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  """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}
308 309
  @type port: int
  @param port: The SSH port of the remote machine or None for the default
310 311 312 313 314 315 316 317 318 319 320 321
  @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")

322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
  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)

346 347 348
  if port is None:
    port = netutils.GetDaemonPort(constants.SSH)

349
  srun = ssh.SshRunner(cluster_name)
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)
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
def _PrepareFileBasedStorage(
    enabled_disk_templates, file_storage_dir,
406
    default_dir, file_disk_template, _storage_path_acceptance_fn,
407 408 409 410 411 412 413 414 415 416 417
    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 420 421 422 423 424
  @param file_disk_template: a disk template whose storage type is 'ST_FILE',
      'ST_SHARED_FILE' or 'ST_GLUSTER'
  @type _storage_path_acceptance_fn: function
  @param _storage_path_acceptance_fn: checks whether the given file-based
      storage directory is acceptable
  @see: C{cluster.CheckFileBasedStoragePathVsEnabledDiskTemplates} for details

425 426
  @rtype: string
  @returns: the name of the actual file storage directory
427 428

  """
429
  assert (file_disk_template in utils.storage.GetDiskTemplatesOfStorageTypes(
430
            constants.ST_FILE, constants.ST_SHARED_FILE, constants.ST_GLUSTER
431 432
         ))

433
  if file_storage_dir is None:
434
    file_storage_dir = default_dir
435 436 437 438 439
  if not acceptance_fn:
    acceptance_fn = \
        lambda path: filestorage.CheckFileStoragePathAcceptance(
            path, exact_match_ok=True)

440 441
  _storage_path_acceptance_fn(logging.warning, file_storage_dir,
                              enabled_disk_templates)
442

443
  file_storage_enabled = file_disk_template in enabled_disk_templates
444 445 446 447 448 449 450 451 452 453 454
  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


455 456 457 458 459 460 461 462 463 464 465
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,
466
      cluster.CheckFileStoragePathVsEnabledDiskTemplates,
467 468 469 470 471 472 473 474 475 476 477 478 479 480
      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,
481
      cluster.CheckSharedFileStoragePathVsEnabledDiskTemplates,
482 483 484
      init_fn=init_fn, acceptance_fn=acceptance_fn)


485 486 487 488 489 490 491 492 493 494 495
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,
496
      cluster.CheckGlusterStoragePathVsEnabledDiskTemplates,
497 498 499
      init_fn=init_fn, acceptance_fn=acceptance_fn)


500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
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)


515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
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


535
def _InitCheckDrbdHelper(drbd_helper, drbd_enabled):
536 537 538 539 540 541 542
  """Checks the DRBD usermode helper.

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

  """
543 544 545
  if not drbd_enabled:
    return

546 547 548 549 550
  if drbd_helper is not None:
    try:
      curr_helper = drbd.DRBD8.GetUsermodeHelper()
    except errors.BlockDeviceError, err:
      raise errors.OpPrereqError("Error while checking drbd helper"
551 552
                                 " (disable drbd with --enabled-disk-templates"
                                 " if you are not using drbd): %s" % str(err),
553 554 555 556 557 558 559 560
                                 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)


561
def InitCluster(cluster_name, mac_prefix, # pylint: disable=R0913, R0914
562
                master_netmask, master_netdev, file_storage_dir,
563 564
                shared_file_storage_dir, gluster_storage_dir,
                candidate_pool_size, secondary_ip=None,
565
                vg_name=None, beparams=None, nicparams=None, ndparams=None,
566 567 568
                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,
569 570
                default_iallocator=None, default_iallocator_params=None,
                primary_ip_version=None, ipolicy=None,
571
                prealloc_wipe_disks=False, use_external_mip_script=False,
Hrvoje Ribicic's avatar
Hrvoje Ribicic committed
572
                hv_state=None, disk_state=None, enabled_disk_templates=None,
573
                install_image=None, zeroing_image=None, compression_tools=None,
574
                enabled_user_shutdown=False):
575 576
  """Initialise the cluster.

577 578
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size
579

580 581
  @type enabled_disk_templates: list of string
  @param enabled_disk_templates: list of disk_templates to be used in this
582
    cluster
583

584 585 586 587
  @type enabled_user_shutdown: bool
  @param enabled_user_shutdown: whether user shutdown is enabled cluster
                                wide

588
  """
589
  # TODO: complete the docstring
590
  if config.ConfigWriter.IsCluster():
591 592
    raise errors.OpPrereqError("Cluster is already initialised",
                               errors.ECODE_STATE)
593

594 595
  data_dir = vcluster.AddNodePrefix(pathutils.DATA_DIR)
  queue_dir = vcluster.AddNodePrefix(pathutils.QUEUE_DIR)
596 597 598 599 600 601 602 603 604
  archive_dir = vcluster.AddNodePrefix(pathutils.JOB_QUEUE_ARCHIVE_DIR)
  for ddir in [queue_dir, data_dir, archive_dir]:
    if os.path.isdir(ddir):
      for entry in os.listdir(ddir):
        if not os.path.isdir(os.path.join(ddir, entry)):
          raise errors.OpPrereqError(
            "%s contains non-directory enries like %s. Remove left-overs of an"
            " old cluster before initialising a new one" % (ddir, entry),
            errors.ECODE_STATE)
605

606 607
  if not enabled_hypervisors:
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
608
                               " least one member", errors.ECODE_INVAL)
609 610 611
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
  if invalid_hvs:
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
612 613
                               " entries: %s" % invalid_hvs,
                               errors.ECODE_INVAL)
614

615
  _InitCheckEnabledDiskTemplates(enabled_disk_templates)
616

617 618 619
  try:
    ipcls = netutils.IPAddress.GetClassFromIpVersion(primary_ip_version)
  except errors.ProgrammerError:
620
    raise errors.OpPrereqError("Invalid primary ip version: %d." %
621
                               primary_ip_version, errors.ECODE_INVAL)
622 623 624 625

  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"
626 627
                               " address." % (hostname.ip, primary_ip_version),
                               errors.ECODE_INVAL)
628 629

  if ipcls.IsLoopback(hostname.ip):
630 631
    raise errors.OpPrereqError("This host's IP (%s) resolves to a loopback"
                               " address. Please fix DNS or %s." %
632
                               (hostname.ip, pathutils.ETC_HOSTS),
633
                               errors.ECODE_ENVIRON)
634

635
  if not ipcls.Own(hostname.ip):
636 637
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
638
                               " belong to this host" %
639
                               hostname.ip, errors.ECODE_ENVIRON)
640

641
  clustername = netutils.GetHostname(name=cluster_name, family=ipcls.family)
642

643
  if netutils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT, timeout=5):
644
    raise errors.OpPrereqError("Cluster IP already active",
645
                               errors.ECODE_NOTUNIQUE)
646

647 648 649
  if not secondary_ip:
    if primary_ip_version == constants.IP6_VERSION:
      raise errors.OpPrereqError("When using a IPv6 primary address, a valid"
650 651
                                 " IPv4 address must be given as secondary",
                                 errors.ECODE_INVAL)
652
    secondary_ip = hostname.ip
653

654 655 656 657 658 659 660 661 662 663
  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)

664 665 666
  if master_netmask is not None:
    if not ipcls.ValidateNetmask(master_netmask):
      raise errors.OpPrereqError("CIDR netmask (%s) not valid for IPv%s " %
667 668
                                  (master_netmask, primary_ip_version),
                                 errors.ECODE_INVAL)
669 670 671
  else:
    master_netmask = ipcls.iplen

672
  if vg_name:
673 674 675 676
    # Check if volume group is valid
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
                                          constants.MIN_VG_SIZE)
    if vgstatus:
677
      raise errors.OpPrereqError("Error: %s" % vgstatus, errors.ECODE_INVAL)
678

679 680
  drbd_enabled = constants.DT_DRBD8 in enabled_disk_templates
  _InitCheckDrbdHelper(drbd_helper, drbd_enabled)
681

682 683 684 685 686 687 688
  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))

689 690
  file_storage_dir = _PrepareFileStorage(enabled_disk_templates,
                                         file_storage_dir)
691 692
  shared_file_storage_dir = _PrepareSharedFileStorage(enabled_disk_templates,
                                                      shared_file_storage_dir)
693 694
  gluster_storage_dir = _PrepareGlusterStorage(enabled_disk_templates,
                                               gluster_storage_dir)
695 696

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

700
  if not nicparams.get('mode', None) == constants.NIC_MODE_OVS:
701 702 703 704 705 706 707
    # 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)
708

709
  dirs = [(pathutils.RUN_DIR, constants.RUN_DIRS_MODE)]
710 711
  utils.EnsureDirs(dirs)

712
  objects.UpgradeBeParams(beparams)
713
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
714
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
715

716
  objects.NIC.CheckParameterSyntax(nicparams)
717

718
  full_ipolicy = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy)
719
  _RestrictIpolicyToEnabledDiskTemplates(full_ipolicy, enabled_disk_templates)
720

721 722 723 724 725
  if ndparams is not None:
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
  else:
    ndparams = dict(constants.NDC_DEFAULTS)

726
  # This is ugly, as we modify the dict itself
727 728
  # FIXME: Make utils.ForceDictType pure functional or write a wrapper
  # around it
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
  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)

747 748 749 750 751
  # 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)
752

753 754 755 756 757 758 759 760
  # 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,
761 762
                                          utils.CommaJoin(unknown_params)),
                                 errors.ECODE_INVAL)
763
    utils.ForceDictType(dt_params, constants.DISK_DT_TYPES)
764 765 766 767 768
    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

769 770 771 772 773
  try:
    utils.VerifyDictOptions(diskparams, constants.DISK_DT_DEFAULTS)
  except errors.OpPrereqError, err:
    raise errors.OpPrereqError("While verify diskparam options: %s" % err,
                               errors.ECODE_INVAL)
774

775
  # set up ssh config and /etc/hosts
776 777 778 779 780 781 782 783 784 785 786
  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)
787

788
  if modify_etc_hosts:
789
    utils.AddHostToEtcHosts(hostname.name, hostname.ip)
790

791 792
  if modify_ssh_setup:
    _InitSSHSetup()
793

794 795 796 797 798 799 800 801
  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)
802 803
  else:
    # default to htools
804 805 806 807
    if utils.FindFile(constants.IALLOC_HAIL,
                      constants.IALLOCATOR_SEARCH_PATH,
                      os.path.isfile):
      default_iallocator = constants.IALLOC_HAIL
808

809 810 811 812 813 814 815
  # 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)

816 817
  candidate_certs = {}

818 819
  now = time.time()

820 821 822
  if compression_tools is not None:
    cluster.CheckCompressionTools(compression_tools)

823
  # init of cluster config file
824 825
  cluster_config = objects.Cluster(
    serial_no=1,
826 827
    rsahostkeypub=rsa_sshkey,
    dsahostkeypub=dsa_sshkey,
828 829 830 831
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
    mac_prefix=mac_prefix,
    volume_group_name=vg_name,
    tcpudp_port_pool=set(),
832
    master_ip=clustername.ip,
833
    master_netmask=master_netmask,
834 835 836
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
837
    shared_file_storage_dir=shared_file_storage_dir,
838
    gluster_storage_dir=gluster_storage_dir,
839
    enabled_hypervisors=enabled_hypervisors,
840
    beparams={constants.PP_DEFAULT: beparams},
841
    nicparams={constants.PP_DEFAULT: nicparams},
842
    ndparams=ndparams,
843
    hvparams=hvparams,
844
    diskparams=diskparams,
845
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
846
    modify_etc_hosts=modify_etc_hosts,
847
    modify_ssh_setup=modify_ssh_setup,
848
    uid_pool=uid_pool,
849 850
    ctime=now,
    mtime=now,
851
    maintain_node_health=maintain_node_health,
852
    drbd_usermode_helper=drbd_helper,
853
    default_iallocator=default_iallocator,
854
    default_iallocator_params=default_iallocator_params,
855
    primary_ip_family=ipcls.family,
856
    prealloc_wipe_disks=prealloc_wipe_disks,
857
    use_external_mip_script=use_external_mip_script,
858
    ipolicy=full_ipolicy,
859 860
    hv_state_static=hv_state,
    disk_state_static=disk_state,
861
    enabled_disk_templates=enabled_disk_templates,
862
    candidate_certs=candidate_certs,
863
    osparams={},
Hrvoje Ribicic's avatar
Hrvoje Ribicic committed
864
    osparams_private_cluster={},
865
    install_image=install_image,
866
    zeroing_image=zeroing_image,
867
    compression_tools=compression_tools,
868
    enabled_user_shutdown=enabled_user_shutdown,
869 870 871
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
872
                                    secondary_ip=secondary_ip,
873 874
                                    serial_no=1,
                                    master_candidate=True,
875
                                    offline=False, drained=False,
876
                                    ctime=now, mtime=now,
877
                                    )
878
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
879
  cfg = config.ConfigWriter(offline=True)
880
  ssh.WriteKnownHostsFile(cfg, pathutils.SSH_KNOWN_HOSTS_FILE)
881
  cfg.Update(cfg.GetClusterInfo(), logging.error)
882
  ssconf.WriteSsconfFiles(cfg.GetSsconfValues())
883 884 885

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

887
  logging.debug("Starting daemons")
888
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-all"])
889 890 891 892
  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
893

894
  _WaitForMasterDaemon()
Iustin Pop's avatar
Iustin Pop committed
895

896

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
897
def InitConfig(version, cluster_config, master_node_config,
898
               cfg_file=pathutils.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
899 900 901 902 903 904
  """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
905 906 907 908 909 910 911 912
  @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
913
  """
914 915 916 917 918
  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
919
  cluster_config.master_node = master_node_config.uuid
Iustin Pop's avatar
Iustin Pop committed
920
  nodes = {
Thomas Thrainer's avatar
Thomas Thrainer committed
921
    master_node_config.uuid: master_node_config,
Iustin Pop's avatar
Iustin Pop committed
922
    }
923 924
  default_nodegroup = objects.NodeGroup(
    uuid=uuid_generator.Generate([], utils.NewUUID, _INITCONF_ECID),
925
    name=constants.INITIAL_NODE_GROUP_NAME,
Thomas Thrainer's avatar
Thomas Thrainer committed
926
    members=[master_node_config.uuid],
927
    diskparams={},
928 929 930 931
    )
  nodegroups = {
    default_nodegroup.uuid: default_nodegroup,
    }
932
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
933 934
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
935
                                   nodegroups=nodegroups,
Iustin Pop's avatar
Iustin Pop committed
936 937
                                   nodes=nodes,
                                   instances={},
938
                                   networks={},
939
                                   disks={},
940 941
                                   serial_no=1,
                                   ctime=now, mtime=now)
942 943 944
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
945 946


Thomas Thrainer's avatar
Thomas Thrainer committed
947
def FinalizeClusterDestroy(master_uuid):
Iustin Pop's avatar
Iustin Pop committed
948 949 950