Statistics
| Branch: | Tag: | Revision:

root / lib / bootstrap.py @ 3039e2dc

History | View | Annotate | Download (38 kB)

1
#
2
#
3

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

    
21

    
22
"""Functions to bootstrap a new cluster.
23

24
"""
25

    
26
import os
27
import os.path
28
import re
29
import logging
30
import time
31
import tempfile
32

    
33
from ganeti.cmdlib import cluster
34
from ganeti import rpc
35
from ganeti import ssh
36
from ganeti import utils
37
from ganeti import errors
38
from ganeti import config
39
from ganeti import constants
40
from ganeti import objects
41
from ganeti import ssconf
42
from ganeti import serializer
43
from ganeti import hypervisor
44
from ganeti.storage import drbd
45
from ganeti.storage import filestorage
46
from ganeti import netutils
47
from ganeti import luxi
48
from ganeti import jstore
49
from ganeti import pathutils
50

    
51

    
52
# ec_id for InitConfig's temporary reservation manager
53
_INITCONF_ECID = "initconfig-ecid"
54

    
55
#: After how many seconds daemon must be responsive
56
_DAEMON_READY_TIMEOUT = 10.0
57

    
58

    
59
def _InitSSHSetup():
60
  """Setup the SSH configuration for the cluster.
61

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

65
  """
66
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
67

    
68
  for name in priv_key, pub_key:
69
    if os.path.exists(name):
70
      utils.CreateBackup(name)
71
    utils.RemoveFile(name)
72

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

    
80
  utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
81

    
82

    
83
def GenerateHmacKey(file_name):
84
  """Writes a new HMAC key.
85

86
  @type file_name: str
87
  @param file_name: Path to output file
88

89
  """
90
  utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400,
91
                  backup=True)
92

    
93

    
94
def GenerateClusterCrypto(new_cluster_cert, new_rapi_cert, new_spice_cert,
95
                          new_confd_hmac_key, new_cds,
96
                          rapi_cert_pem=None, spice_cert_pem=None,
97
                          spice_cacert_pem=None, cds=None,
98
                          nodecert_file=pathutils.NODED_CERT_FILE,
99
                          rapicert_file=pathutils.RAPI_CERT_FILE,
100
                          spicecert_file=pathutils.SPICE_CERT_FILE,
101
                          spicecacert_file=pathutils.SPICE_CACERT_FILE,
102
                          hmackey_file=pathutils.CONFD_HMAC_KEY,
103
                          cds_file=pathutils.CLUSTER_DOMAIN_SECRET_FILE):
104
  """Updates the cluster certificates, keys and secrets.
105

106
  @type new_cluster_cert: bool
107
  @param new_cluster_cert: Whether to generate a new cluster certificate
108
  @type new_rapi_cert: bool
109
  @param new_rapi_cert: Whether to generate a new RAPI certificate
110
  @type new_spice_cert: bool
111
  @param new_spice_cert: Whether to generate a new SPICE certificate
112
  @type new_confd_hmac_key: bool
113
  @param new_confd_hmac_key: Whether to generate a new HMAC key
114
  @type new_cds: bool
115
  @param new_cds: Whether to generate a new cluster domain secret
116
  @type rapi_cert_pem: string
117
  @param rapi_cert_pem: New RAPI certificate in PEM format
118
  @type spice_cert_pem: string
119
  @param spice_cert_pem: New SPICE certificate in PEM format
120
  @type spice_cacert_pem: string
121
  @param spice_cacert_pem: Certificate of the CA that signed the SPICE
122
                           certificate, in PEM format
123
  @type cds: string
124
  @param cds: New cluster domain secret
125
  @type nodecert_file: string
126
  @param nodecert_file: optional override of the node cert file path
127
  @type rapicert_file: string
128
  @param rapicert_file: optional override of the rapi cert file path
129
  @type spicecert_file: string
130
  @param spicecert_file: optional override of the spice cert file path
131
  @type spicecacert_file: string
132
  @param spicecacert_file: optional override of the spice CA cert file path
133
  @type hmackey_file: string
134
  @param hmackey_file: optional override of the hmac key file path
135

136
  """
137
  # noded SSL certificate
138
  cluster_cert_exists = os.path.exists(nodecert_file)
139
  if new_cluster_cert or not cluster_cert_exists:
140
    if cluster_cert_exists:
141
      utils.CreateBackup(nodecert_file)
142

    
143
    logging.debug("Generating new cluster certificate at %s", nodecert_file)
144
    utils.GenerateSelfSignedSslCert(nodecert_file)
145

    
146
  # confd HMAC key
147
  if new_confd_hmac_key or not os.path.exists(hmackey_file):
148
    logging.debug("Writing new confd HMAC key to %s", hmackey_file)
149
    GenerateHmacKey(hmackey_file)
150

    
151
  # RAPI
152
  rapi_cert_exists = os.path.exists(rapicert_file)
153

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

    
159
  elif new_rapi_cert or not rapi_cert_exists:
160
    if rapi_cert_exists:
161
      utils.CreateBackup(rapicert_file)
162

    
163
    logging.debug("Generating new RAPI certificate at %s", rapicert_file)
164
    utils.GenerateSelfSignedSslCert(rapicert_file)
165

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

    
181
    logging.debug("Generating new self-signed SPICE certificate at %s",
182
                  spicecert_file)
183
    (_, cert_pem) = utils.GenerateSelfSignedSslCert(spicecert_file)
184

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

    
191
  # Cluster domain secret
192
  if cds:
193
    logging.debug("Writing cluster domain secret to %s", cds_file)
194
    utils.WriteFile(cds_file, data=cds, backup=True)
195

    
196
  elif new_cds or not os.path.exists(cds_file):
197
    logging.debug("Generating new cluster domain secret at %s", cds_file)
198
    GenerateHmacKey(cds_file)
199

    
200

    
201
def _InitGanetiServerSetup(master_name):
202
  """Setup the necessary configuration for the initial node daemon.
203

204
  This creates the nodepass file containing the shared password for
205
  the cluster, generates the SSL certificate and starts the node daemon.
206

207
  @type master_name: str
208
  @param master_name: Name of the master node
209

210
  """
211
  # Generate cluster secrets
212
  GenerateClusterCrypto(True, False, False, False, False)
213

    
214
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start", constants.NODED])
215
  if result.failed:
216
    raise errors.OpExecError("Could not start the node daemon, command %s"
217
                             " had exitcode %s and error %s" %
218
                             (result.cmd, result.exit_code, result.output))
219

    
220
  _WaitForNodeDaemon(master_name)
221

    
222

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

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

    
234
  try:
235
    utils.Retry(_CheckNodeDaemon, 1.0, _DAEMON_READY_TIMEOUT)
236
  except utils.RetryTimeout:
237
    raise errors.OpExecError("Node daemon on %s didn't answer queries within"
238
                             " %s seconds" % (node_name, _DAEMON_READY_TIMEOUT))
239

    
240

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

244
  """
245
  def _CheckMasterDaemon():
246
    try:
247
      cl = luxi.Client()
248
      (cluster_name, ) = cl.QueryConfigValues(["cluster_name"])
249
    except Exception:
250
      raise utils.RetryAgain()
251

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

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

    
260

    
261
def _WaitForSshDaemon(hostname, port, family):
262
  """Wait for SSH daemon to become responsive.
263

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

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

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

    
281

    
282
def RunNodeSetupCmd(cluster_name, node, basecmd, debug, verbose,
283
                    use_cluster_key, ask_key, strict_host_check, data):
284
  """Runs a command to configure something on a remote machine.
285

286
  @type cluster_name: string
287
  @param cluster_name: Cluster name
288
  @type node: string
289
  @param node: Node name
290
  @type basecmd: string
291
  @param basecmd: Base command (path on the remote machine)
292
  @type debug: bool
293
  @param debug: Enable debug output
294
  @type verbose: bool
295
  @param verbose: Enable verbose output
296
  @type use_cluster_key: bool
297
  @param use_cluster_key: See L{ssh.SshRunner.BuildCmd}
298
  @type ask_key: bool
299
  @param ask_key: See L{ssh.SshRunner.BuildCmd}
300
  @type strict_host_check: bool
301
  @param strict_host_check: See L{ssh.SshRunner.BuildCmd}
302
  @param data: JSON-serializable input data for script (passed to stdin)
303

304
  """
305
  cmd = [basecmd]
306

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

    
311
  if verbose:
312
    cmd.append("--verbose")
313

    
314
  family = ssconf.SimpleStore().GetPrimaryIPFamily()
315
  srun = ssh.SshRunner(cluster_name,
316
                       ipv6=(family == netutils.IP6Address.family))
317
  scmd = srun.BuildCmd(node, constants.SSH_LOGIN_USER,
318
                       utils.ShellQuoteArgs(cmd),
319
                       batch=False, ask_key=ask_key, quiet=False,
320
                       strict_host_check=strict_host_check,
321
                       use_cluster_key=use_cluster_key)
322

    
323
  tempfh = tempfile.TemporaryFile()
324
  try:
325
    tempfh.write(serializer.DumpJson(data))
326
    tempfh.seek(0)
327

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

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

    
336
  _WaitForSshDaemon(node, netutils.GetDaemonPort(constants.SSH), family)
337

    
338

    
339
def _InitFileStorageDir(file_storage_dir):
340
  """Initialize if needed the file storage.
341

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

346
  """
347
  file_storage_dir = os.path.normpath(file_storage_dir)
348

    
349
  if not os.path.isabs(file_storage_dir):
350
    raise errors.OpPrereqError("File storage directory '%s' is not an absolute"
351
                               " path" % file_storage_dir, errors.ECODE_INVAL)
352

    
353
  if not os.path.exists(file_storage_dir):
354
    try:
355
      os.makedirs(file_storage_dir, 0750)
356
    except OSError, err:
357
      raise errors.OpPrereqError("Cannot create file storage directory"
358
                                 " '%s': %s" % (file_storage_dir, err),
359
                                 errors.ECODE_ENVIRON)
360

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

    
366
  return file_storage_dir
367

    
368

    
369
def _PrepareFileStorage(
370
    enabled_disk_templates, file_storage_dir, init_fn=_InitFileStorageDir,
371
    acceptance_fn=None):
372
  """Checks if file storage is enabled and inits the dir.
373

374
  """
375
  if file_storage_dir is None:
376
    file_storage_dir = pathutils.DEFAULT_FILE_STORAGE_DIR
377
  if not acceptance_fn:
378
    acceptance_fn = \
379
        lambda path: filestorage.CheckFileStoragePathAcceptance(
380
            path, exact_match_ok=True)
381

    
382
  cluster.CheckFileStoragePathVsEnabledDiskTemplates(
383
      logging.warning, file_storage_dir, enabled_disk_templates)
384

    
385
  file_storage_enabled = constants.DT_FILE in enabled_disk_templates
386
  if file_storage_enabled:
387
    try:
388
      acceptance_fn(file_storage_dir)
389
    except errors.FileStoragePathError as e:
390
      raise errors.OpPrereqError(str(e))
391
    result_file_storage_dir = init_fn(file_storage_dir)
392
  else:
393
    result_file_storage_dir = file_storage_dir
394
  return result_file_storage_dir
395

    
396

    
397
def _InitCheckEnabledDiskTemplates(enabled_disk_templates):
398
  """Checks the sanity of the enabled disk templates.
399

400
  """
401
  if not enabled_disk_templates:
402
    raise errors.OpPrereqError("Enabled disk templates list must contain at"
403
                               " least one member", errors.ECODE_INVAL)
404
  invalid_disk_templates = \
405
    set(enabled_disk_templates) - constants.DISK_TEMPLATES
406
  if invalid_disk_templates:
407
    raise errors.OpPrereqError("Enabled disk templates list contains invalid"
408
                               " entries: %s" % invalid_disk_templates,
409
                               errors.ECODE_INVAL)
410

    
411

    
412
def InitCluster(cluster_name, mac_prefix, # pylint: disable=R0913, R0914
413
                master_netmask, master_netdev, file_storage_dir,
414
                shared_file_storage_dir, candidate_pool_size, secondary_ip=None,
415
                vg_name=None, beparams=None, nicparams=None, ndparams=None,
416
                hvparams=None, diskparams=None, enabled_hypervisors=None,
417
                modify_etc_hosts=True, modify_ssh_setup=True,
418
                maintain_node_health=False, drbd_helper=None, uid_pool=None,
419
                default_iallocator=None, primary_ip_version=None, ipolicy=None,
420
                prealloc_wipe_disks=False, use_external_mip_script=False,
421
                hv_state=None, disk_state=None, enabled_disk_templates=None):
422
  """Initialise the cluster.
423

424
  @type candidate_pool_size: int
425
  @param candidate_pool_size: master candidate pool size
426
  @type enabled_disk_templates: list of string
427
  @param enabled_disk_templates: list of disk_templates to be used in this
428
    cluster
429

430
  """
431
  # TODO: complete the docstring
432
  if config.ConfigWriter.IsCluster():
433
    raise errors.OpPrereqError("Cluster is already initialised",
434
                               errors.ECODE_STATE)
435

    
436
  if not enabled_hypervisors:
437
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
438
                               " least one member", errors.ECODE_INVAL)
439
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
440
  if invalid_hvs:
441
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
442
                               " entries: %s" % invalid_hvs,
443
                               errors.ECODE_INVAL)
444

    
445
  _InitCheckEnabledDiskTemplates(enabled_disk_templates)
446

    
447
  try:
448
    ipcls = netutils.IPAddress.GetClassFromIpVersion(primary_ip_version)
449
  except errors.ProgrammerError:
450
    raise errors.OpPrereqError("Invalid primary ip version: %d." %
451
                               primary_ip_version, errors.ECODE_INVAL)
452

    
453
  hostname = netutils.GetHostname(family=ipcls.family)
454
  if not ipcls.IsValid(hostname.ip):
455
    raise errors.OpPrereqError("This host's IP (%s) is not a valid IPv%d"
456
                               " address." % (hostname.ip, primary_ip_version),
457
                               errors.ECODE_INVAL)
458

    
459
  if ipcls.IsLoopback(hostname.ip):
460
    raise errors.OpPrereqError("This host's IP (%s) resolves to a loopback"
461
                               " address. Please fix DNS or %s." %
462
                               (hostname.ip, pathutils.ETC_HOSTS),
463
                               errors.ECODE_ENVIRON)
464

    
465
  if not ipcls.Own(hostname.ip):
466
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
467
                               " to %s,\nbut this ip address does not"
468
                               " belong to this host" %
469
                               hostname.ip, errors.ECODE_ENVIRON)
470

    
471
  clustername = netutils.GetHostname(name=cluster_name, family=ipcls.family)
472

    
473
  if netutils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT, timeout=5):
474
    raise errors.OpPrereqError("Cluster IP already active",
475
                               errors.ECODE_NOTUNIQUE)
476

    
477
  if not secondary_ip:
478
    if primary_ip_version == constants.IP6_VERSION:
479
      raise errors.OpPrereqError("When using a IPv6 primary address, a valid"
480
                                 " IPv4 address must be given as secondary",
481
                                 errors.ECODE_INVAL)
482
    secondary_ip = hostname.ip
483

    
484
  if not netutils.IP4Address.IsValid(secondary_ip):
485
    raise errors.OpPrereqError("Secondary IP address (%s) has to be a valid"
486
                               " IPv4 address." % secondary_ip,
487
                               errors.ECODE_INVAL)
488

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

    
494
  if master_netmask is not None:
495
    if not ipcls.ValidateNetmask(master_netmask):
496
      raise errors.OpPrereqError("CIDR netmask (%s) not valid for IPv%s " %
497
                                  (master_netmask, primary_ip_version),
498
                                 errors.ECODE_INVAL)
499
  else:
500
    master_netmask = ipcls.iplen
501

    
502
  if vg_name:
503
    # Check if volume group is valid
504
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
505
                                          constants.MIN_VG_SIZE)
506
    if vgstatus:
507
      raise errors.OpPrereqError("Error: %s" % vgstatus, errors.ECODE_INVAL)
508

    
509
  if drbd_helper is not None:
510
    try:
511
      curr_helper = drbd.DRBD8.GetUsermodeHelper()
512
    except errors.BlockDeviceError, err:
513
      raise errors.OpPrereqError("Error while checking drbd helper"
514
                                 " (specify --no-drbd-storage if you are not"
515
                                 " using drbd): %s" % str(err),
516
                                 errors.ECODE_ENVIRON)
517
    if drbd_helper != curr_helper:
518
      raise errors.OpPrereqError("Error: requiring %s as drbd helper but %s"
519
                                 " is the current helper" % (drbd_helper,
520
                                                             curr_helper),
521
                                 errors.ECODE_INVAL)
522

    
523
  logging.debug("Stopping daemons (if any are running)")
524
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "stop-all"])
525
  if result.failed:
526
    raise errors.OpExecError("Could not stop daemons, command %s"
527
                             " had exitcode %s and error '%s'" %
528
                             (result.cmd, result.exit_code, result.output))
529

    
530
  file_storage_dir = _PrepareFileStorage(enabled_disk_templates,
531
                                         file_storage_dir)
532

    
533
  if constants.ENABLE_SHARED_FILE_STORAGE:
534
    shared_file_storage_dir = _InitFileStorageDir(shared_file_storage_dir)
535
  else:
536
    shared_file_storage_dir = ""
537

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

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

    
548
  dirs = [(pathutils.RUN_DIR, constants.RUN_DIRS_MODE)]
549
  utils.EnsureDirs(dirs)
550

    
551
  objects.UpgradeBeParams(beparams)
552
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
553
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
554

    
555
  objects.NIC.CheckParameterSyntax(nicparams)
556

    
557
  full_ipolicy = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy)
558

    
559
  if ndparams is not None:
560
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
561
  else:
562
    ndparams = dict(constants.NDC_DEFAULTS)
563

    
564
  # This is ugly, as we modify the dict itself
565
  # FIXME: Make utils.ForceDictType pure functional or write a wrapper
566
  # around it
567
  if hv_state:
568
    for hvname, hvs_data in hv_state.items():
569
      utils.ForceDictType(hvs_data, constants.HVSTS_PARAMETER_TYPES)
570
      hv_state[hvname] = objects.Cluster.SimpleFillHvState(hvs_data)
571
  else:
572
    hv_state = dict((hvname, constants.HVST_DEFAULTS)
573
                    for hvname in enabled_hypervisors)
574

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

    
585
  # hvparams is a mapping of hypervisor->hvparams dict
586
  for hv_name, hv_params in hvparams.iteritems():
587
    utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
588
    hv_class = hypervisor.GetHypervisor(hv_name)
589
    hv_class.CheckParameterSyntax(hv_params)
590

    
591
  # diskparams is a mapping of disk-template->diskparams dict
592
  for template, dt_params in diskparams.items():
593
    param_keys = set(dt_params.keys())
594
    default_param_keys = set(constants.DISK_DT_DEFAULTS[template].keys())
595
    if not (param_keys <= default_param_keys):
596
      unknown_params = param_keys - default_param_keys
597
      raise errors.OpPrereqError("Invalid parameters for disk template %s:"
598
                                 " %s" % (template,
599
                                          utils.CommaJoin(unknown_params)),
600
                                 errors.ECODE_INVAL)
601
    utils.ForceDictType(dt_params, constants.DISK_DT_TYPES)
602
    if template == constants.DT_DRBD8 and vg_name is not None:
603
      # The default METAVG value is equal to the VG name set at init time,
604
      # if provided
605
      dt_params[constants.DRBD_DEFAULT_METAVG] = vg_name
606

    
607
  try:
608
    utils.VerifyDictOptions(diskparams, constants.DISK_DT_DEFAULTS)
609
  except errors.OpPrereqError, err:
610
    raise errors.OpPrereqError("While verify diskparam options: %s" % err,
611
                               errors.ECODE_INVAL)
612

    
613
  # set up ssh config and /etc/hosts
614
  sshline = utils.ReadFile(pathutils.SSH_HOST_RSA_PUB)
615
  sshkey = sshline.split(" ")[1]
616

    
617
  if modify_etc_hosts:
618
    utils.AddHostToEtcHosts(hostname.name, hostname.ip)
619

    
620
  if modify_ssh_setup:
621
    _InitSSHSetup()
622

    
623
  if default_iallocator is not None:
624
    alloc_script = utils.FindFile(default_iallocator,
625
                                  constants.IALLOCATOR_SEARCH_PATH,
626
                                  os.path.isfile)
627
    if alloc_script is None:
628
      raise errors.OpPrereqError("Invalid default iallocator script '%s'"
629
                                 " specified" % default_iallocator,
630
                                 errors.ECODE_INVAL)
631
  elif constants.HTOOLS:
632
    # htools was enabled at build-time, we default to it
633
    if utils.FindFile(constants.IALLOC_HAIL,
634
                      constants.IALLOCATOR_SEARCH_PATH,
635
                      os.path.isfile):
636
      default_iallocator = constants.IALLOC_HAIL
637

    
638
  now = time.time()
639

    
640
  # init of cluster config file
641
  cluster_config = objects.Cluster(
642
    serial_no=1,
643
    rsahostkeypub=sshkey,
644
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
645
    mac_prefix=mac_prefix,
646
    volume_group_name=vg_name,
647
    tcpudp_port_pool=set(),
648
    master_ip=clustername.ip,
649
    master_netmask=master_netmask,
650
    master_netdev=master_netdev,
651
    cluster_name=clustername.name,
652
    file_storage_dir=file_storage_dir,
653
    shared_file_storage_dir=shared_file_storage_dir,
654
    enabled_hypervisors=enabled_hypervisors,
655
    beparams={constants.PP_DEFAULT: beparams},
656
    nicparams={constants.PP_DEFAULT: nicparams},
657
    ndparams=ndparams,
658
    hvparams=hvparams,
659
    diskparams=diskparams,
660
    candidate_pool_size=candidate_pool_size,
661
    modify_etc_hosts=modify_etc_hosts,
662
    modify_ssh_setup=modify_ssh_setup,
663
    uid_pool=uid_pool,
664
    ctime=now,
665
    mtime=now,
666
    maintain_node_health=maintain_node_health,
667
    drbd_usermode_helper=drbd_helper,
668
    default_iallocator=default_iallocator,
669
    primary_ip_family=ipcls.family,
670
    prealloc_wipe_disks=prealloc_wipe_disks,
671
    use_external_mip_script=use_external_mip_script,
672
    ipolicy=full_ipolicy,
673
    hv_state_static=hv_state,
674
    disk_state_static=disk_state,
675
    enabled_disk_templates=enabled_disk_templates,
676
    )
677
  master_node_config = objects.Node(name=hostname.name,
678
                                    primary_ip=hostname.ip,
679
                                    secondary_ip=secondary_ip,
680
                                    serial_no=1,
681
                                    master_candidate=True,
682
                                    offline=False, drained=False,
683
                                    ctime=now, mtime=now,
684
                                    )
685
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
686
  cfg = config.ConfigWriter(offline=True)
687
  ssh.WriteKnownHostsFile(cfg, pathutils.SSH_KNOWN_HOSTS_FILE)
688
  cfg.Update(cfg.GetClusterInfo(), logging.error)
689
  ssconf.WriteSsconfFiles(cfg.GetSsconfValues())
690

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

    
694
  logging.debug("Starting daemons")
695
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-all"])
696
  if result.failed:
697
    raise errors.OpExecError("Could not start daemons, command %s"
698
                             " had exitcode %s and error %s" %
699
                             (result.cmd, result.exit_code, result.output))
700

    
701
  _WaitForMasterDaemon()
702

    
703

    
704
def InitConfig(version, cluster_config, master_node_config,
705
               cfg_file=pathutils.CLUSTER_CONF_FILE):
706
  """Create the initial cluster configuration.
707

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

711
  @type version: int
712
  @param version: configuration version
713
  @type cluster_config: L{objects.Cluster}
714
  @param cluster_config: cluster configuration
715
  @type master_node_config: L{objects.Node}
716
  @param master_node_config: master node configuration
717
  @type cfg_file: string
718
  @param cfg_file: configuration file path
719

720
  """
721
  uuid_generator = config.TemporaryReservationManager()
722
  cluster_config.uuid = uuid_generator.Generate([], utils.NewUUID,
723
                                                _INITCONF_ECID)
724
  master_node_config.uuid = uuid_generator.Generate([], utils.NewUUID,
725
                                                    _INITCONF_ECID)
726
  cluster_config.master_node = master_node_config.uuid
727
  nodes = {
728
    master_node_config.uuid: master_node_config,
729
    }
730
  default_nodegroup = objects.NodeGroup(
731
    uuid=uuid_generator.Generate([], utils.NewUUID, _INITCONF_ECID),
732
    name=constants.INITIAL_NODE_GROUP_NAME,
733
    members=[master_node_config.uuid],
734
    diskparams={},
735
    )
736
  nodegroups = {
737
    default_nodegroup.uuid: default_nodegroup,
738
    }
739
  now = time.time()
740
  config_data = objects.ConfigData(version=version,
741
                                   cluster=cluster_config,
742
                                   nodegroups=nodegroups,
743
                                   nodes=nodes,
744
                                   instances={},
745
                                   networks={},
746
                                   serial_no=1,
747
                                   ctime=now, mtime=now)
748
  utils.WriteFile(cfg_file,
749
                  data=serializer.Dump(config_data.ToDict()),
750
                  mode=0600)
751

    
752

    
753
def FinalizeClusterDestroy(master_uuid):
754
  """Execute the last steps of cluster destroy
755

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

759
  """
760
  cfg = config.ConfigWriter()
761
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
762
  runner = rpc.BootstrapRunner()
763

    
764
  master_name = cfg.GetNodeName(master_uuid)
765

    
766
  master_params = cfg.GetMasterNetworkParameters()
767
  master_params.uuid = master_uuid
768
  ems = cfg.GetUseExternalMipScript()
769
  result = runner.call_node_deactivate_master_ip(master_name, master_params,
770
                                                 ems)
771

    
772
  msg = result.fail_msg
773
  if msg:
774
    logging.warning("Could not disable the master IP: %s", msg)
775

    
776
  result = runner.call_node_stop_master(master_name)
777
  msg = result.fail_msg
778
  if msg:
779
    logging.warning("Could not disable the master role: %s", msg)
780

    
781
  result = runner.call_node_leave_cluster(master_name, modify_ssh_setup)
782
  msg = result.fail_msg
783
  if msg:
784
    logging.warning("Could not shutdown the node daemon and cleanup"
785
                    " the node: %s", msg)
786

    
787

    
788
def SetupNodeDaemon(opts, cluster_name, node):
789
  """Add a node to the cluster.
790

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

795
  @param cluster_name: the cluster name
796
  @param node: the name of the new node
797

798
  """
799
  data = {
800
    constants.NDS_CLUSTER_NAME: cluster_name,
801
    constants.NDS_NODE_DAEMON_CERTIFICATE:
802
      utils.ReadFile(pathutils.NODED_CERT_FILE),
803
    constants.NDS_SSCONF: ssconf.SimpleStore().ReadAll(),
804
    constants.NDS_START_NODE_DAEMON: True,
805
    }
806

    
807
  RunNodeSetupCmd(cluster_name, node, pathutils.NODE_DAEMON_SETUP,
808
                  opts.debug, opts.verbose,
809
                  True, opts.ssh_key_check, opts.ssh_key_check, data)
810

    
811
  _WaitForNodeDaemon(node)
812

    
813

    
814
def MasterFailover(no_voting=False):
815
  """Failover the master node.
816

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

821
  @type no_voting: boolean
822
  @param no_voting: force the operation without remote nodes agreement
823
                      (dangerous)
824

825
  """
826
  sstore = ssconf.SimpleStore()
827

    
828
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
829
  node_names = sstore.GetNodeList()
830
  mc_list = sstore.GetMasterCandidates()
831

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

    
838
  if new_master not in mc_list:
839
    mc_no_master = [name for name in mc_list if name != old_master]
840
    raise errors.OpPrereqError("This node is not among the nodes marked"
841
                               " as master candidates. Only these nodes"
842
                               " can become masters. Current list of"
843
                               " master candidates is:\n"
844
                               "%s" % ("\n".join(mc_no_master)),
845
                               errors.ECODE_STATE)
846

    
847
  if not no_voting:
848
    vote_list = GatherMasterVotes(node_names)
849

    
850
    if vote_list:
851
      voted_master = vote_list[0][0]
852
      if voted_master is None:
853
        raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
854
                                   " not respond.", errors.ECODE_ENVIRON)
855
      elif voted_master != old_master:
856
        raise errors.OpPrereqError("I have a wrong configuration, I believe"
857
                                   " the master is %s but the other nodes"
858
                                   " voted %s. Please resync the configuration"
859
                                   " of this node." %
860
                                   (old_master, voted_master),
861
                                   errors.ECODE_STATE)
862
  # end checks
863

    
864
  rcode = 0
865

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

    
868
  try:
869
    # instantiate a real config writer, as we now know we have the
870
    # configuration data
871
    cfg = config.ConfigWriter(accept_foreign=True)
872

    
873
    old_master_node = cfg.GetNodeInfoByName(old_master)
874
    if old_master_node is None:
875
      raise errors.OpPrereqError("Could not find old master node '%s' in"
876
                                 " cluster configuration." % old_master,
877
                                 errors.ECODE_NOENT)
878

    
879
    cluster_info = cfg.GetClusterInfo()
880
    new_master_node = cfg.GetNodeInfoByName(new_master)
881
    if new_master_node is None:
882
      raise errors.OpPrereqError("Could not find new master node '%s' in"
883
                                 " cluster configuration." % new_master,
884
                                 errors.ECODE_NOENT)
885

    
886
    cluster_info.master_node = new_master_node.uuid
887
    # this will also regenerate the ssconf files, since we updated the
888
    # cluster info
889
    cfg.Update(cluster_info, logging.error)
890
  except errors.ConfigurationError, err:
891
    logging.error("Error while trying to set the new master: %s",
892
                  str(err))
893
    return 1
894

    
895
  # if cfg.Update worked, then it means the old master daemon won't be
896
  # able now to write its own config file (we rely on locking in both
897
  # backend.UploadFile() and ConfigWriter._Write(); hence the next
898
  # step is to kill the old master
899

    
900
  logging.info("Stopping the master daemon on node %s", old_master)
901

    
902
  runner = rpc.BootstrapRunner()
903
  master_params = cfg.GetMasterNetworkParameters()
904
  master_params.uuid = old_master_node.uuid
905
  ems = cfg.GetUseExternalMipScript()
906
  result = runner.call_node_deactivate_master_ip(old_master,
907
                                                 master_params, ems)
908

    
909
  msg = result.fail_msg
910
  if msg:
911
    logging.warning("Could not disable the master IP: %s", msg)
912

    
913
  result = runner.call_node_stop_master(old_master)
914
  msg = result.fail_msg
915
  if msg:
916
    logging.error("Could not disable the master role on the old master"
917
                  " %s, please disable manually: %s", old_master, msg)
918

    
919
  logging.info("Checking master IP non-reachability...")
920

    
921
  master_ip = sstore.GetMasterIP()
922
  total_timeout = 30
923

    
924
  # Here we have a phase where no master should be running
925
  def _check_ip():
926
    if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
927
      raise utils.RetryAgain()
928

    
929
  try:
930
    utils.Retry(_check_ip, (1, 1.5, 5), total_timeout)
931
  except utils.RetryTimeout:
932
    logging.warning("The master IP is still reachable after %s seconds,"
933
                    " continuing but activating the master on the current"
934
                    " node will probably fail", total_timeout)
935

    
936
  if jstore.CheckDrainFlag():
937
    logging.info("Undraining job queue")
938
    jstore.SetDrainFlag(False)
939

    
940
  logging.info("Starting the master daemons on the new master")
941

    
942
  result = rpc.BootstrapRunner().call_node_start_master_daemons(new_master,
943
                                                                no_voting)
944
  msg = result.fail_msg
945
  if msg:
946
    logging.error("Could not start the master role on the new master"
947
                  " %s, please check: %s", new_master, msg)
948
    rcode = 1
949

    
950
  logging.info("Master failed over from %s to %s", old_master, new_master)
951
  return rcode
952

    
953

    
954
def GetMaster():
955
  """Returns the current master node.
956

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

962
  """
963
  sstore = ssconf.SimpleStore()
964

    
965
  old_master, _ = ssconf.GetMasterAndMyself(sstore)
966

    
967
  return old_master
968

    
969

    
970
def GatherMasterVotes(node_names):
971
  """Check the agreement on who is the master.
972

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

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

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

984
  @type node_names: list
985
  @param node_names: the list of nodes to query for master info; the current
986
      node will be removed if it is in the list
987
  @rtype: list
988
  @return: list of (node, votes)
989

990
  """
991
  myself = netutils.Hostname.GetSysName()
992
  try:
993
    node_names.remove(myself)
994
  except ValueError:
995
    pass
996
  if not node_names:
997
    # no nodes left (eventually after removing myself)
998
    return []
999
  results = rpc.BootstrapRunner().call_master_info(node_names)
1000
  if not isinstance(results, dict):
1001
    # this should not happen (unless internal error in rpc)
1002
    logging.critical("Can't complete rpc call, aborting master startup")
1003
    return [(None, len(node_names))]
1004
  votes = {}
1005
  for node_name in results:
1006
    nres = results[node_name]
1007
    data = nres.payload
1008
    msg = nres.fail_msg
1009
    fail = False
1010
    if msg:
1011
      logging.warning("Error contacting node %s: %s", node_name, msg)
1012
      fail = True
1013
    # for now we accept both length 3, 4 and 5 (data[3] is primary ip version
1014
    # and data[4] is the master netmask)
1015
    elif not isinstance(data, (tuple, list)) or len(data) < 3:
1016
      logging.warning("Invalid data received from node %s: %s",
1017
                      node_name, data)
1018
      fail = True
1019
    if fail:
1020
      if None not in votes:
1021
        votes[None] = 0
1022
      votes[None] += 1
1023
      continue
1024
    master_node = data[2]
1025
    if master_node not in votes:
1026
      votes[master_node] = 0
1027
    votes[master_node] += 1
1028

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

    
1035
  return vote_list