bootstrap.py 20.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
#

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


"""Functions to bootstrap a new cluster.

"""

import os
import os.path
import re
29
import logging
30
import tempfile
31
import time
32
33
34
35
36
37
38

from ganeti import rpc
from ganeti import ssh
from ganeti import utils
from ganeti import errors
from ganeti import config
from ganeti import constants
39
from ganeti import objects
40
from ganeti import ssconf
41
from ganeti import serializer
42
from ganeti import hypervisor
43

44

45
def _InitSSHSetup():
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
  """Setup the SSH configuration for the cluster.

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

  """
  priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)

  for name in priv_key, pub_key:
    if os.path.exists(name):
      utils.CreateBackup(name)
    utils.RemoveFile(name)

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

66
  utils.AddAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
67
68


69
def GenerateSelfSignedSslCert(file_name, validity=(365 * 5)):
70
  """Generates a self-signed SSL certificate.
71

72
73
74
75
  @type file_name: str
  @param file_name: Path to output file
  @type validity: int
  @param validity: Validity for certificate in days
76
77

  """
78
79
  (fd, tmp_file_name) = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
    try:
      # Set permissions before writing key
      os.chmod(tmp_file_name, 0600)

      result = utils.RunCmd(["openssl", "req", "-new", "-newkey", "rsa:1024",
                             "-days", str(validity), "-nodes", "-x509",
                             "-keyout", tmp_file_name, "-out", tmp_file_name,
                             "-batch"])
      if result.failed:
        raise errors.OpExecError("Could not generate SSL certificate, command"
                                 " %s had exitcode %s and error message %s" %
                                 (result.cmd, result.exit_code, result.output))

      # Make read-only
      os.chmod(tmp_file_name, 0400)

      os.rename(tmp_file_name, file_name)
    finally:
      utils.RemoveFile(tmp_file_name)
99
  finally:
100
    os.close(fd)
101
102


103
104
105
106
107
108
109
110
111
112
def GenerateHmacKey(file_name):
  """Writes a new HMAC key.

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

  """
  utils.WriteFile(file_name, data=utils.GenerateSecret(), mode=0400)


113
def _InitGanetiServerSetup(master_name):
114
115
116
117
118
119
  """Setup the necessary configuration for the initial node daemon.

  This creates the nodepass file containing the shared password for
  the cluster and also generates the SSL certificate.

  """
120
  GenerateSelfSignedSslCert(constants.SSL_CERT_FILE)
121

122
123
  # Don't overwrite existing file
  if not os.path.exists(constants.RAPI_CERT_FILE):
124
    GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)
125

126
  if not os.path.exists(constants.HMAC_CLUSTER_KEY):
127
    GenerateHmacKey(constants.HMAC_CLUSTER_KEY)
128

129
130
131
132
133
134
135
  result = utils.RunCmd([constants.NODE_INITD_SCRIPT, "restart"])

  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))

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

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

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

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

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

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

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

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

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

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

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

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

  if vg_name is not None:
    # Check if volume group is valid
    vgstatus = utils.CheckVolumeGroupSize(utils.ListVolumeGroups(), vg_name,
                                          constants.MIN_VG_SIZE)
    if vgstatus:
      raise errors.OpPrereqError("Error: %s\nspecify --no-lvm-storage if"
212
213
                                 " you are not using lvm" % vgstatus,
                                 errors.ECODE_INVAL)
214
215
216
217
218

  file_storage_dir = os.path.normpath(file_storage_dir)

  if not os.path.isabs(file_storage_dir):
    raise errors.OpPrereqError("The file storage directory you passed is"
219
                               " not an absolute path.", errors.ECODE_INVAL)
220
221
222
223
224
225

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

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

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

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

  if not (os.path.isfile(constants.NODE_INITD_SCRIPT) and
          os.access(constants.NODE_INITD_SCRIPT, os.X_OK)):
    raise errors.OpPrereqError("Init.d script '%s' missing or not"
247
248
                               " executable." % constants.NODE_INITD_SCRIPT,
                               errors.ECODE_ENVIRON)
249

250
251
252
  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
  utils.EnsureDirs(dirs)

253
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
254
255
256
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
  objects.NIC.CheckParameterSyntax(nicparams)

257
258
259
260
261
  # 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)
262

263
  # set up the inter-node password and certificate
264
  _InitGanetiServerSetup(hostname.name)
265
266

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

270
271
272
  if modify_etc_hosts:
    utils.AddHostToEtcHosts(hostname.name)

273
274
  if modify_ssh_setup:
    _InitSSHSetup()
275

276
277
  now = time.time()

278
  # init of cluster config file
279
280
281
282
283
284
285
  cluster_config = objects.Cluster(
    serial_no=1,
    rsahostkeypub=sshkey,
    highest_used_port=(constants.FIRST_DRBD_PORT - 1),
    mac_prefix=mac_prefix,
    volume_group_name=vg_name,
    tcpudp_port_pool=set(),
286
287
288
289
290
    master_node=hostname.name,
    master_ip=clustername.ip,
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
291
    enabled_hypervisors=enabled_hypervisors,
292
    beparams={constants.PP_DEFAULT: beparams},
293
    nicparams={constants.PP_DEFAULT: nicparams},
294
    hvparams=hvparams,
295
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
296
    modify_etc_hosts=modify_etc_hosts,
297
    modify_ssh_setup=modify_ssh_setup,
298
299
300
    ctime=now,
    mtime=now,
    uuid=utils.NewUUID(),
301
302
303
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
304
                                    secondary_ip=secondary_ip,
305
306
                                    serial_no=1,
                                    master_candidate=True,
307
                                    offline=False, drained=False,
308
                                    )
309
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
310
  cfg = config.ConfigWriter()
311
  ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
312
  cfg.Update(cfg.GetClusterInfo(), logging.error)
313

Iustin Pop's avatar
Iustin Pop committed
314
315
  # start the master ip
  # TODO: Review rpc call from bootstrap
316
  # TODO: Warn on failed start master
317
  rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
Iustin Pop's avatar
Iustin Pop committed
318

319

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
320
321
def InitConfig(version, cluster_config, master_node_config,
               cfg_file=constants.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
322
323
324
325
326
327
  """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
328
329
330
331
332
333
334
335
  @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
336
337
338
339
340
  """
  nodes = {
    master_node_config.name: master_node_config,
    }

341
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
342
343
344
345
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
                                   nodes=nodes,
                                   instances={},
346
347
                                   serial_no=1,
                                   ctime=now, mtime=now)
348
349
350
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
351
352


Iustin Pop's avatar
Iustin Pop committed
353
354
355
356
357
358
359
def FinalizeClusterDestroy(master):
  """Execute the last steps of cluster destroy

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

  """
360
361
  cfg = config.ConfigWriter()
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
362
  result = rpc.RpcRunner.call_node_stop_master(master, True)
363
  msg = result.fail_msg
364
  if msg:
365
    logging.warning("Could not disable the master role: %s", msg)
366
  result = rpc.RpcRunner.call_node_leave_cluster(master, modify_ssh_setup)
367
  msg = result.fail_msg
368
369
370
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
371
372


Iustin Pop's avatar
Iustin Pop committed
373
def SetupNodeDaemon(cluster_name, node, ssh_key_check):
374
375
  """Add a node to the cluster.

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

Iustin Pop's avatar
Iustin Pop committed
380
381
382
  @param cluster_name: the cluster name
  @param node: the name of the new node
  @param ssh_key_check: whether to do a strict key check
383
384

  """
Iustin Pop's avatar
Iustin Pop committed
385
  sshrunner = ssh.SshRunner(cluster_name)
386
387

  noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
388
  rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
389
  hmac_key = utils.ReadFile(constants.HMAC_CLUSTER_KEY)
390

391
392
393
  # in the base64 pem encoding, neither '!' nor '.' are valid chars,
  # so we use this to detect an invalid certificate; as long as the
  # cert doesn't contain this, the here-document will be correctly
394
395
396
397
398
  # parsed by the shell sequence below. HMAC keys are hexadecimal strings,
  # so the same restrictions apply.
  for content in (noded_cert, rapi_cert, hmac_key):
    if re.search('^!EOF\.', content, re.MULTILINE):
      raise errors.OpExecError("invalid SSL certificate or HMAC key")
399
400
401

  if not noded_cert.endswith("\n"):
    noded_cert += "\n"
402
403
  if not rapi_cert.endswith("\n"):
    rapi_cert += "\n"
404
405
  if not hmac_key.endswith("\n"):
    hmac_key += "\n"
406
407
408
409
410
411
412

  # set up inter-node password and certificate and restarts the node daemon
  # and then connect with ssh to set password and start ganeti-noded
  # note that all the below variables are sanitized at this point,
  # either by being constants or by the checks above
  mycommand = ("umask 077 && "
               "cat > '%s' << '!EOF.' && \n"
413
414
415
               "%s!EOF.\n"
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
416
417
418
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
               "chmod 0400 %s %s %s && "
419
               "%s restart" %
420
               (constants.SSL_CERT_FILE, noded_cert,
421
                constants.RAPI_CERT_FILE, rapi_cert,
422
                constants.HMAC_CLUSTER_KEY, hmac_key,
423
                constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
424
                constants.HMAC_CLUSTER_KEY,
425
426
                constants.NODE_INITD_SCRIPT))

427
428
429
430
  result = sshrunner.Run(node, 'root', mycommand, batch=False,
                         ask_key=ssh_key_check,
                         use_cluster_key=False,
                         strict_host_check=ssh_key_check)
431
432
433
434
435
  if result.failed:
    raise errors.OpExecError("Remote command on node %s, error: %s,"
                             " output: %s" %
                             (node, result.fail_reason, result.output))

436

437
def MasterFailover(no_voting=False):
438
439
440
441
442
443
  """Failover the master node.

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

444
445
446
447
  @type no_voting: boolean
  @param no_voting: force the operation without remote nodes agreement
                      (dangerous)

448
  """
449
  sstore = ssconf.SimpleStore()
450

451
452
453
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
  node_list = sstore.GetNodeList()
  mc_list = sstore.GetMasterCandidates()
454
455
456
457
458

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

461
462
463
464
465
466
  if new_master not in mc_list:
    mc_no_master = [name for name in mc_list if name != old_master]
    raise errors.OpPrereqError("This node is not among the nodes marked"
                               " as master candidates. Only these nodes"
                               " can become masters. Current list of"
                               " master candidates is:\n"
467
468
                               "%s" % ('\n'.join(mc_no_master)),
                               errors.ECODE_STATE)
469

470
471
472
473
474
475
476
  if not no_voting:
    vote_list = GatherMasterVotes(node_list)

    if vote_list:
      voted_master = vote_list[0][0]
      if voted_master is None:
        raise errors.OpPrereqError("Cluster is inconsistent, most nodes did"
477
                                   " not respond.", errors.ECODE_ENVIRON)
478
479
480
481
482
      elif voted_master != old_master:
        raise errors.OpPrereqError("I have a wrong configuration, I believe"
                                   " the master is %s but the other nodes"
                                   " voted %s. Please resync the configuration"
                                   " of this node." %
483
484
                                   (old_master, voted_master),
                                   errors.ECODE_STATE)
485
486
487
488
  # end checks

  rcode = 0

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

491
  result = rpc.RpcRunner.call_node_stop_master(old_master, True)
492
  msg = result.fail_msg
493
  if msg:
494
    logging.error("Could not disable the master role on the old master"
495
                 " %s, please disable manually: %s", old_master, msg)
496

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

Iustin Pop's avatar
Iustin Pop committed
499
500
501
  # instantiate a real config writer, as we now know we have the
  # configuration data
  cfg = config.ConfigWriter()
502

Iustin Pop's avatar
Iustin Pop committed
503
504
505
506
  cluster_info = cfg.GetClusterInfo()
  cluster_info.master_node = new_master
  # this will also regenerate the ssconf files, since we updated the
  # cluster info
507
  cfg.Update(cluster_info, logging.error)
508

509
  result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
510
  msg = result.fail_msg
511
  if msg:
512
    logging.error("Could not start the master role on the new master"
513
                  " %s, please check: %s", new_master, msg)
514
515
516
    rcode = 1

  return rcode
517
518


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
def GetMaster():
  """Returns the current master node.

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

  """
  sstore = ssconf.SimpleStore()

  old_master, _ = ssconf.GetMasterAndMyself(sstore)

  return old_master


535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
def GatherMasterVotes(node_list):
  """Check the agreement on who is the master.

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

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

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

  @type node_list: list
  @param node_list: the list of nodes to query for master info; the current
Michael Hanselmann's avatar
Michael Hanselmann committed
551
      node will be removed if it is in the list
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  @rtype: list
  @return: list of (node, votes)

  """
  myself = utils.HostInfo().name
  try:
    node_list.remove(myself)
  except ValueError:
    pass
  if not node_list:
    # no nodes left (eventually after removing myself)
    return []
  results = rpc.RpcRunner.call_master_info(node_list)
  if not isinstance(results, dict):
    # this should not happen (unless internal error in rpc)
    logging.critical("Can't complete rpc call, aborting master startup")
    return [(None, len(node_list))]
  votes = {}
  for node in results:
571
    nres = results[node]
572
    data = nres.payload
573
    msg = nres.fail_msg
574
575
576
577
578
579
580
581
    fail = False
    if msg:
      logging.warning("Error contacting node %s: %s", node, msg)
      fail = True
    elif not isinstance(data, (tuple, list)) or len(data) < 3:
      logging.warning("Invalid data received from node %s: %s", node, data)
      fail = True
    if fail:
582
583
584
585
      if None not in votes:
        votes[None] = 0
      votes[None] += 1
      continue
586
    master_node = data[2]
587
588
589
590
591
592
593
594
595
596
597
    if master_node not in votes:
      votes[master_node] = 0
    votes[master_node] += 1

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

  return vote_list