Statistics
| Branch: | Tag: | Revision:

root / lib / bootstrap.py @ f7f03738

History | View | Annotate | Download (36 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 import rpc
34
from ganeti import ssh
35
from ganeti import utils
36
from ganeti import errors
37
from ganeti import config
38
from ganeti import constants
39
from ganeti import objects
40
from ganeti import ssconf
41
from ganeti import serializer
42
from ganeti import hypervisor
43
from ganeti import bdev
44
from ganeti import netutils
45
from ganeti import luxi
46
from ganeti import jstore
47
from ganeti import pathutils
48

    
49

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

    
53
#: After how many seconds daemon must be responsive
54
_DAEMON_READY_TIMEOUT = 10.0
55

    
56

    
57
def _InitSSHSetup():
58
  """Setup the SSH configuration for the cluster.
59

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

63
  """
64
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.SSH_LOGIN_USER)
65

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

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

    
78
  utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
79

    
80

    
81
def GenerateHmacKey(file_name):
82
  """Writes a new HMAC key.
83

84
  @type file_name: str
85
  @param file_name: Path to output file
86

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

    
91

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

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

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

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

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

    
149
  # RAPI
150
  rapi_cert_exists = os.path.exists(rapicert_file)
151

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

    
157
  elif new_rapi_cert or not rapi_cert_exists:
158
    if rapi_cert_exists:
159
      utils.CreateBackup(rapicert_file)
160

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

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

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

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

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

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

    
198

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

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

205
  @type master_name: str
206
  @param master_name: Name of the master node
207

208
  """
209
  # Generate cluster secrets
210
  GenerateClusterCrypto(True, False, False, False, False)
211

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

    
218
  _WaitForNodeDaemon(master_name)
219

    
220

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

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

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

    
238

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

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

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

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

    
258

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

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

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

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

    
279

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

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

302
  """
303
  cmd = [basecmd]
304

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

    
309
  if verbose:
310
    cmd.append("--verbose")
311

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

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

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

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

    
334
  _WaitForSshDaemon(node, netutils.GetDaemonPort(constants.SSH), family)
335

    
336

    
337
def _InitFileStorage(file_storage_dir):
338
  """Initialize if needed the file storage.
339

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

344
  """
345
  file_storage_dir = os.path.normpath(file_storage_dir)
346

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

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

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

    
365

    
366
def InitCluster(cluster_name, mac_prefix, # pylint: disable=R0913, R0914
367
                master_netmask, master_netdev, file_storage_dir,
368
                shared_file_storage_dir, candidate_pool_size, secondary_ip=None,
369
                vg_name=None, beparams=None, nicparams=None, ndparams=None,
370
                hvparams=None, diskparams=None, enabled_hypervisors=None,
371
                modify_etc_hosts=True, modify_ssh_setup=True,
372
                maintain_node_health=False, drbd_helper=None, uid_pool=None,
373
                default_iallocator=None, primary_ip_version=None, ipolicy=None,
374
                prealloc_wipe_disks=False, use_external_mip_script=False,
375
                hv_state=None, disk_state=None, enabled_storage_types=None):
376
  """Initialise the cluster.
377

378
  @type candidate_pool_size: int
379
  @param candidate_pool_size: master candidate pool size
380
  @type enabled_storage_types: list of string
381
  @param enabled_storage_types: list of storage types to be used in this
382
    cluster
383

384
  """
385
  # TODO: complete the docstring
386
  if config.ConfigWriter.IsCluster():
387
    raise errors.OpPrereqError("Cluster is already initialised",
388
                               errors.ECODE_STATE)
389

    
390
  if not enabled_hypervisors:
391
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
392
                               " least one member", errors.ECODE_INVAL)
393
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
394
  if invalid_hvs:
395
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
396
                               " entries: %s" % invalid_hvs,
397
                               errors.ECODE_INVAL)
398

    
399
  if not enabled_storage_types:
400
    raise errors.OpPrereqError("Enabled storage types list must contain at"
401
                               " least one member", errors.ECODE_INVAL)
402
  invalid_storage_types = \
403
    set(enabled_storage_types) - constants.VALID_STORAGE_TYPES
404
  if invalid_storage_types:
405
    raise errors.OpPrereqError("Enabled storage_types contains invalid"
406
                               " entries: %s" % invalid_storage_types,
407
                               errors.ECODE_INVAL)
408

    
409
  try:
410
    ipcls = netutils.IPAddress.GetClassFromIpVersion(primary_ip_version)
411
  except errors.ProgrammerError:
412
    raise errors.OpPrereqError("Invalid primary ip version: %d." %
413
                               primary_ip_version, errors.ECODE_INVAL)
414

    
415
  hostname = netutils.GetHostname(family=ipcls.family)
416
  if not ipcls.IsValid(hostname.ip):
417
    raise errors.OpPrereqError("This host's IP (%s) is not a valid IPv%d"
418
                               " address." % (hostname.ip, primary_ip_version),
419
                               errors.ECODE_INVAL)
420

    
421
  if ipcls.IsLoopback(hostname.ip):
422
    raise errors.OpPrereqError("This host's IP (%s) resolves to a loopback"
423
                               " address. Please fix DNS or %s." %
424
                               (hostname.ip, pathutils.ETC_HOSTS),
425
                               errors.ECODE_ENVIRON)
426

    
427
  if not ipcls.Own(hostname.ip):
428
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
429
                               " to %s,\nbut this ip address does not"
430
                               " belong to this host" %
431
                               hostname.ip, errors.ECODE_ENVIRON)
432

    
433
  clustername = netutils.GetHostname(name=cluster_name, family=ipcls.family)
434

    
435
  if netutils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT, timeout=5):
436
    raise errors.OpPrereqError("Cluster IP already active",
437
                               errors.ECODE_NOTUNIQUE)
438

    
439
  if not secondary_ip:
440
    if primary_ip_version == constants.IP6_VERSION:
441
      raise errors.OpPrereqError("When using a IPv6 primary address, a valid"
442
                                 " IPv4 address must be given as secondary",
443
                                 errors.ECODE_INVAL)
444
    secondary_ip = hostname.ip
445

    
446
  if not netutils.IP4Address.IsValid(secondary_ip):
447
    raise errors.OpPrereqError("Secondary IP address (%s) has to be a valid"
448
                               " IPv4 address." % secondary_ip,
449
                               errors.ECODE_INVAL)
450

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

    
456
  if master_netmask is not None:
457
    if not ipcls.ValidateNetmask(master_netmask):
458
      raise errors.OpPrereqError("CIDR netmask (%s) not valid for IPv%s " %
459
                                  (master_netmask, primary_ip_version),
460
                                 errors.ECODE_INVAL)
461
  else:
462
    master_netmask = ipcls.iplen
463

    
464
  if vg_name is not None:
465
    # Check if volume group is valid
466
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
467
                                          constants.MIN_VG_SIZE)
468
    if vgstatus:
469
      raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
470
                                 " you are not using lvm" % vgstatus,
471
                                 errors.ECODE_INVAL)
472

    
473
  if drbd_helper is not None:
474
    try:
475
      curr_helper = bdev.BaseDRBD.GetUsermodeHelper()
476
    except errors.BlockDeviceError, err:
477
      raise errors.OpPrereqError("Error while checking drbd helper"
478
                                 " (specify --no-drbd-storage if you are not"
479
                                 " using drbd): %s" % str(err),
480
                                 errors.ECODE_ENVIRON)
481
    if drbd_helper != curr_helper:
482
      raise errors.OpPrereqError("Error: requiring %s as drbd helper but %s"
483
                                 " is the current helper" % (drbd_helper,
484
                                                             curr_helper),
485
                                 errors.ECODE_INVAL)
486

    
487
  logging.debug("Stopping daemons (if any are running)")
488
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "stop-all"])
489
  if result.failed:
490
    raise errors.OpExecError("Could not stop daemons, command %s"
491
                             " had exitcode %s and error '%s'" %
492
                             (result.cmd, result.exit_code, result.output))
493

    
494
  if constants.ENABLE_FILE_STORAGE:
495
    file_storage_dir = _InitFileStorage(file_storage_dir)
496
  else:
497
    file_storage_dir = ""
498

    
499
  if constants.ENABLE_SHARED_FILE_STORAGE:
500
    shared_file_storage_dir = _InitFileStorage(shared_file_storage_dir)
501
  else:
502
    shared_file_storage_dir = ""
503

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

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

    
514
  dirs = [(pathutils.RUN_DIR, constants.RUN_DIRS_MODE)]
515
  utils.EnsureDirs(dirs)
516

    
517
  objects.UpgradeBeParams(beparams)
518
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
519
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
520

    
521
  objects.NIC.CheckParameterSyntax(nicparams)
522

    
523
  full_ipolicy = objects.FillIPolicy(constants.IPOLICY_DEFAULTS, ipolicy)
524

    
525
  if ndparams is not None:
526
    utils.ForceDictType(ndparams, constants.NDS_PARAMETER_TYPES)
527
  else:
528
    ndparams = dict(constants.NDC_DEFAULTS)
529

    
530
  # This is ugly, as we modify the dict itself
531
  # FIXME: Make utils.ForceDictType pure functional or write a wrapper
532
  # around it
533
  if hv_state:
534
    for hvname, hvs_data in hv_state.items():
535
      utils.ForceDictType(hvs_data, constants.HVSTS_PARAMETER_TYPES)
536
      hv_state[hvname] = objects.Cluster.SimpleFillHvState(hvs_data)
537
  else:
538
    hv_state = dict((hvname, constants.HVST_DEFAULTS)
539
                    for hvname in enabled_hypervisors)
540

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

    
551
  # hvparams is a mapping of hypervisor->hvparams dict
552
  for hv_name, hv_params in hvparams.iteritems():
553
    utils.ForceDictType(hv_params, constants.HVS_PARAMETER_TYPES)
554
    hv_class = hypervisor.GetHypervisor(hv_name)
555
    hv_class.CheckParameterSyntax(hv_params)
556

    
557
  # diskparams is a mapping of disk-template->diskparams dict
558
  for template, dt_params in diskparams.items():
559
    param_keys = set(dt_params.keys())
560
    default_param_keys = set(constants.DISK_DT_DEFAULTS[template].keys())
561
    if not (param_keys <= default_param_keys):
562
      unknown_params = param_keys - default_param_keys
563
      raise errors.OpPrereqError("Invalid parameters for disk template %s:"
564
                                 " %s" % (template,
565
                                          utils.CommaJoin(unknown_params)),
566
                                 errors.ECODE_INVAL)
567
    utils.ForceDictType(dt_params, constants.DISK_DT_TYPES)
568
  try:
569
    utils.VerifyDictOptions(diskparams, constants.DISK_DT_DEFAULTS)
570
  except errors.OpPrereqError, err:
571
    raise errors.OpPrereqError("While verify diskparam options: %s" % err,
572
                               errors.ECODE_INVAL)
573

    
574
  # set up ssh config and /etc/hosts
575
  sshline = utils.ReadFile(pathutils.SSH_HOST_RSA_PUB)
576
  sshkey = sshline.split(" ")[1]
577

    
578
  if modify_etc_hosts:
579
    utils.AddHostToEtcHosts(hostname.name, hostname.ip)
580

    
581
  if modify_ssh_setup:
582
    _InitSSHSetup()
583

    
584
  if default_iallocator is not None:
585
    alloc_script = utils.FindFile(default_iallocator,
586
                                  constants.IALLOCATOR_SEARCH_PATH,
587
                                  os.path.isfile)
588
    if alloc_script is None:
589
      raise errors.OpPrereqError("Invalid default iallocator script '%s'"
590
                                 " specified" % default_iallocator,
591
                                 errors.ECODE_INVAL)
592
  elif constants.HTOOLS:
593
    # htools was enabled at build-time, we default to it
594
    if utils.FindFile(constants.IALLOC_HAIL,
595
                      constants.IALLOCATOR_SEARCH_PATH,
596
                      os.path.isfile):
597
      default_iallocator = constants.IALLOC_HAIL
598

    
599
  now = time.time()
600

    
601
  # init of cluster config file
602
  cluster_config = objects.Cluster(
603
    serial_no=1,
604
    rsahostkeypub=sshkey,
605
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
606
    mac_prefix=mac_prefix,
607
    volume_group_name=vg_name,
608
    tcpudp_port_pool=set(),
609
    master_node=hostname.name,
610
    master_ip=clustername.ip,
611
    master_netmask=master_netmask,
612
    master_netdev=master_netdev,
613
    cluster_name=clustername.name,
614
    file_storage_dir=file_storage_dir,
615
    shared_file_storage_dir=shared_file_storage_dir,
616
    enabled_hypervisors=enabled_hypervisors,
617
    beparams={constants.PP_DEFAULT: beparams},
618
    nicparams={constants.PP_DEFAULT: nicparams},
619
    ndparams=ndparams,
620
    hvparams=hvparams,
621
    diskparams=diskparams,
622
    candidate_pool_size=candidate_pool_size,
623
    modify_etc_hosts=modify_etc_hosts,
624
    modify_ssh_setup=modify_ssh_setup,
625
    uid_pool=uid_pool,
626
    ctime=now,
627
    mtime=now,
628
    maintain_node_health=maintain_node_health,
629
    drbd_usermode_helper=drbd_helper,
630
    default_iallocator=default_iallocator,
631
    primary_ip_family=ipcls.family,
632
    prealloc_wipe_disks=prealloc_wipe_disks,
633
    use_external_mip_script=use_external_mip_script,
634
    ipolicy=full_ipolicy,
635
    hv_state_static=hv_state,
636
    disk_state_static=disk_state,
637
    enabled_storage_types=enabled_storage_types,
638
    )
639
  master_node_config = objects.Node(name=hostname.name,
640
                                    primary_ip=hostname.ip,
641
                                    secondary_ip=secondary_ip,
642
                                    serial_no=1,
643
                                    master_candidate=True,
644
                                    offline=False, drained=False,
645
                                    ctime=now, mtime=now,
646
                                    )
647
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
648
  cfg = config.ConfigWriter(offline=True)
649
  ssh.WriteKnownHostsFile(cfg, pathutils.SSH_KNOWN_HOSTS_FILE)
650
  cfg.Update(cfg.GetClusterInfo(), logging.error)
651
  ssconf.WriteSsconfFiles(cfg.GetSsconfValues())
652

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

    
656
  logging.debug("Starting daemons")
657
  result = utils.RunCmd([pathutils.DAEMON_UTIL, "start-all"])
658
  if result.failed:
659
    raise errors.OpExecError("Could not start daemons, command %s"
660
                             " had exitcode %s and error %s" %
661
                             (result.cmd, result.exit_code, result.output))
662

    
663
  _WaitForMasterDaemon()
664

    
665

    
666
def InitConfig(version, cluster_config, master_node_config,
667
               cfg_file=pathutils.CLUSTER_CONF_FILE):
668
  """Create the initial cluster configuration.
669

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

673
  @type version: int
674
  @param version: configuration version
675
  @type cluster_config: L{objects.Cluster}
676
  @param cluster_config: cluster configuration
677
  @type master_node_config: L{objects.Node}
678
  @param master_node_config: master node configuration
679
  @type cfg_file: string
680
  @param cfg_file: configuration file path
681

682
  """
683
  uuid_generator = config.TemporaryReservationManager()
684
  cluster_config.uuid = uuid_generator.Generate([], utils.NewUUID,
685
                                                _INITCONF_ECID)
686
  master_node_config.uuid = uuid_generator.Generate([], utils.NewUUID,
687
                                                    _INITCONF_ECID)
688
  nodes = {
689
    master_node_config.name: master_node_config,
690
    }
691
  default_nodegroup = objects.NodeGroup(
692
    uuid=uuid_generator.Generate([], utils.NewUUID, _INITCONF_ECID),
693
    name=constants.INITIAL_NODE_GROUP_NAME,
694
    members=[master_node_config.name],
695
    diskparams={},
696
    )
697
  nodegroups = {
698
    default_nodegroup.uuid: default_nodegroup,
699
    }
700
  now = time.time()
701
  config_data = objects.ConfigData(version=version,
702
                                   cluster=cluster_config,
703
                                   nodegroups=nodegroups,
704
                                   nodes=nodes,
705
                                   instances={},
706
                                   networks={},
707
                                   serial_no=1,
708
                                   ctime=now, mtime=now)
709
  utils.WriteFile(cfg_file,
710
                  data=serializer.Dump(config_data.ToDict()),
711
                  mode=0600)
712

    
713

    
714
def FinalizeClusterDestroy(master):
715
  """Execute the last steps of cluster destroy
716

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

720
  """
721
  cfg = config.ConfigWriter()
722
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
723
  runner = rpc.BootstrapRunner()
724

    
725
  master_params = cfg.GetMasterNetworkParameters()
726
  master_params.name = master
727
  ems = cfg.GetUseExternalMipScript()
728
  result = runner.call_node_deactivate_master_ip(master_params.name,
729
                                                 master_params, ems)
730

    
731
  msg = result.fail_msg
732
  if msg:
733
    logging.warning("Could not disable the master IP: %s", msg)
734

    
735
  result = runner.call_node_stop_master(master)
736
  msg = result.fail_msg
737
  if msg:
738
    logging.warning("Could not disable the master role: %s", msg)
739

    
740
  result = runner.call_node_leave_cluster(master, modify_ssh_setup)
741
  msg = result.fail_msg
742
  if msg:
743
    logging.warning("Could not shutdown the node daemon and cleanup"
744
                    " the node: %s", msg)
745

    
746

    
747
def SetupNodeDaemon(opts, cluster_name, node):
748
  """Add a node to the cluster.
749

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

754
  @param cluster_name: the cluster name
755
  @param node: the name of the new node
756

757
  """
758
  data = {
759
    constants.NDS_CLUSTER_NAME: cluster_name,
760
    constants.NDS_NODE_DAEMON_CERTIFICATE:
761
      utils.ReadFile(pathutils.NODED_CERT_FILE),
762
    constants.NDS_SSCONF: ssconf.SimpleStore().ReadAll(),
763
    constants.NDS_START_NODE_DAEMON: True,
764
    }
765

    
766
  RunNodeSetupCmd(cluster_name, node, pathutils.NODE_DAEMON_SETUP,
767
                  opts.debug, opts.verbose,
768
                  True, opts.ssh_key_check, opts.ssh_key_check, data)
769

    
770
  _WaitForNodeDaemon(node)
771

    
772

    
773
def MasterFailover(no_voting=False):
774
  """Failover the master node.
775

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

780
  @type no_voting: boolean
781
  @param no_voting: force the operation without remote nodes agreement
782
                      (dangerous)
783

784
  """
785
  sstore = ssconf.SimpleStore()
786

    
787
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
788
  node_list = sstore.GetNodeList()
789
  mc_list = sstore.GetMasterCandidates()
790

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

    
797
  if new_master not in mc_list:
798
    mc_no_master = [name for name in mc_list if name != old_master]
799
    raise errors.OpPrereqError("This node is not among the nodes marked"
800
                               " as master candidates. Only these nodes"
801
                               " can become masters. Current list of"
802
                               " master candidates is:\n"
803
                               "%s" % ("\n".join(mc_no_master)),
804
                               errors.ECODE_STATE)
805

    
806
  if not no_voting:
807
    vote_list = GatherMasterVotes(node_list)
808

    
809
    if vote_list:
810
      voted_master = vote_list[0][0]
811
      if voted_master is None:
812
        raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
813
                                   " not respond.", errors.ECODE_ENVIRON)
814
      elif voted_master != old_master:
815
        raise errors.OpPrereqError("I have a wrong configuration, I believe"
816
                                   " the master is %s but the other nodes"
817
                                   " voted %s. Please resync the configuration"
818
                                   " of this node." %
819
                                   (old_master, voted_master),
820
                                   errors.ECODE_STATE)
821
  # end checks
822

    
823
  rcode = 0
824

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

    
827
  try:
828
    # instantiate a real config writer, as we now know we have the
829
    # configuration data
830
    cfg = config.ConfigWriter(accept_foreign=True)
831

    
832
    cluster_info = cfg.GetClusterInfo()
833
    cluster_info.master_node = new_master
834
    # this will also regenerate the ssconf files, since we updated the
835
    # cluster info
836
    cfg.Update(cluster_info, logging.error)
837
  except errors.ConfigurationError, err:
838
    logging.error("Error while trying to set the new master: %s",
839
                  str(err))
840
    return 1
841

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

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

    
849
  runner = rpc.BootstrapRunner()
850
  master_params = cfg.GetMasterNetworkParameters()
851
  master_params.name = old_master
852
  ems = cfg.GetUseExternalMipScript()
853
  result = runner.call_node_deactivate_master_ip(master_params.name,
854
                                                 master_params, ems)
855

    
856
  msg = result.fail_msg
857
  if msg:
858
    logging.warning("Could not disable the master IP: %s", msg)
859

    
860
  result = runner.call_node_stop_master(old_master)
861
  msg = result.fail_msg
862
  if msg:
863
    logging.error("Could not disable the master role on the old master"
864
                  " %s, please disable manually: %s", old_master, msg)
865

    
866
  logging.info("Checking master IP non-reachability...")
867

    
868
  master_ip = sstore.GetMasterIP()
869
  total_timeout = 30
870

    
871
  # Here we have a phase where no master should be running
872
  def _check_ip():
873
    if netutils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
874
      raise utils.RetryAgain()
875

    
876
  try:
877
    utils.Retry(_check_ip, (1, 1.5, 5), total_timeout)
878
  except utils.RetryTimeout:
879
    logging.warning("The master IP is still reachable after %s seconds,"
880
                    " continuing but activating the master on the current"
881
                    " node will probably fail", total_timeout)
882

    
883
  if jstore.CheckDrainFlag():
884
    logging.info("Undraining job queue")
885
    jstore.SetDrainFlag(False)
886

    
887
  logging.info("Starting the master daemons on the new master")
888

    
889
  result = rpc.BootstrapRunner().call_node_start_master_daemons(new_master,
890
                                                                no_voting)
891
  msg = result.fail_msg
892
  if msg:
893
    logging.error("Could not start the master role on the new master"
894
                  " %s, please check: %s", new_master, msg)
895
    rcode = 1
896

    
897
  logging.info("Master failed over from %s to %s", old_master, new_master)
898
  return rcode
899

    
900

    
901
def GetMaster():
902
  """Returns the current master node.
903

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

909
  """
910
  sstore = ssconf.SimpleStore()
911

    
912
  old_master, _ = ssconf.GetMasterAndMyself(sstore)
913

    
914
  return old_master
915

    
916

    
917
def GatherMasterVotes(node_list):
918
  """Check the agreement on who is the master.
919

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

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

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

931
  @type node_list: list
932
  @param node_list: the list of nodes to query for master info; the current
933
      node will be removed if it is in the list
934
  @rtype: list
935
  @return: list of (node, votes)
936

937
  """
938
  myself = netutils.Hostname.GetSysName()
939
  try:
940
    node_list.remove(myself)
941
  except ValueError:
942
    pass
943
  if not node_list:
944
    # no nodes left (eventually after removing myself)
945
    return []
946
  results = rpc.BootstrapRunner().call_master_info(node_list)
947
  if not isinstance(results, dict):
948
    # this should not happen (unless internal error in rpc)
949
    logging.critical("Can't complete rpc call, aborting master startup")
950
    return [(None, len(node_list))]
951
  votes = {}
952
  for node in results:
953
    nres = results[node]
954
    data = nres.payload
955
    msg = nres.fail_msg
956
    fail = False
957
    if msg:
958
      logging.warning("Error contacting node %s: %s", node, msg)
959
      fail = True
960
    # for now we accept both length 3, 4 and 5 (data[3] is primary ip version
961
    # and data[4] is the master netmask)
962
    elif not isinstance(data, (tuple, list)) or len(data) < 3:
963
      logging.warning("Invalid data received from node %s: %s", node, data)
964
      fail = True
965
    if fail:
966
      if None not in votes:
967
        votes[None] = 0
968
      votes[None] += 1
969
      continue
970
    master_node = data[2]
971
    if master_node not in votes:
972
      votes[master_node] = 0
973
    votes[master_node] += 1
974

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

    
981
  return vote_list