bootstrap.py 19.5 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 time
31
32
33
34
35
36
37

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

43

44
def _InitSSHSetup():
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
  """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)

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


68
69
70
71
72
73
74
def GenerateHmacKey(file_name):
  """Writes a new HMAC key.

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

  """
75
  utils.WriteFile(file_name, data="%s\n" % utils.GenerateSecret(), mode=0400)
76
77


78
def _InitGanetiServerSetup(master_name):
79
80
81
82
83
84
  """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.

  """
85
  utils.GenerateSelfSignedSslCert(constants.SSL_CERT_FILE)
86

87
88
  # Don't overwrite existing file
  if not os.path.exists(constants.RAPI_CERT_FILE):
89
    utils.GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)
90

91
  if not os.path.exists(constants.HMAC_CLUSTER_KEY):
92
    GenerateHmacKey(constants.HMAC_CLUSTER_KEY)
93

94
  result = utils.RunCmd([constants.DAEMON_UTIL, "start", constants.NODED])
95
96
97
98
99
  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))

100
  # Wait for node daemon to become responsive
101
  def _CheckNodeDaemon():
102
    result = rpc.RpcRunner.call_version([master_name])[master_name]
103
104
    if result.fail_msg:
      raise utils.RetryAgain()
105

106
107
108
109
110
  try:
    utils.Retry(_CheckNodeDaemon, 1.0, 10.0)
  except utils.RetryTimeout:
    raise errors.OpExecError("Node daemon didn't answer queries within"
                             " 10 seconds")
111

112
def InitCluster(cluster_name, mac_prefix,
113
                master_netdev, file_storage_dir, candidate_pool_size,
114
115
                secondary_ip=None, vg_name=None, beparams=None,
                nicparams=None, hvparams=None, enabled_hypervisors=None,
116
                modify_etc_hosts=True, modify_ssh_setup=True):
117
118
  """Initialise the cluster.

119
120
121
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size

122
  """
123
  # TODO: complete the docstring
124
  if config.ConfigWriter.IsCluster():
125
126
    raise errors.OpPrereqError("Cluster is already initialised",
                               errors.ECODE_STATE)
127

128
129
  if not enabled_hypervisors:
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
130
                               " least one member", errors.ECODE_INVAL)
131
132
133
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
  if invalid_hvs:
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
134
135
                               " entries: %s" % invalid_hvs,
                               errors.ECODE_INVAL)
136

137
  hostname = utils.GetHostInfo()
138
139
140
141

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

145
  if not utils.OwnIpAddress(hostname.ip):
146
147
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
148
149
                               " belong to this host. Aborting." %
                               hostname.ip, errors.ECODE_ENVIRON)
150

151
  clustername = utils.GetHostInfo(cluster_name)
152
153
154

  if utils.TcpPing(clustername.ip, constants.DEFAULT_NODED_PORT,
                   timeout=5):
155
156
    raise errors.OpPrereqError("Cluster IP already active. Aborting.",
                               errors.ECODE_NOTUNIQUE)
157
158
159

  if secondary_ip:
    if not utils.IsValidIP(secondary_ip):
160
161
      raise errors.OpPrereqError("Invalid secondary ip given",
                                 errors.ECODE_INVAL)
162
    if (secondary_ip != hostname.ip and
163
        not utils.OwnIpAddress(secondary_ip)):
164
165
      raise errors.OpPrereqError("You gave %s as secondary IP,"
                                 " but it does not belong to this host." %
166
                                 secondary_ip, errors.ECODE_ENVIRON)
167
168
  else:
    secondary_ip = hostname.ip
169
170
171
172
173
174
175

  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"
176
177
                                 " you are not using lvm" % vgstatus,
                                 errors.ECODE_INVAL)
178
179
180
181
182

  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"
183
                               " not an absolute path.", errors.ECODE_INVAL)
184
185
186
187
188
189

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

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

  if not re.match("^[0-9a-z]{2}:[0-9a-z]{2}:[0-9a-z]{2}$", mac_prefix):
199
200
    raise errors.OpPrereqError("Invalid mac prefix given '%s'" % mac_prefix,
                               errors.ECODE_INVAL)
201
202
203
204
205

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

208
209
210
  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
  utils.EnsureDirs(dirs)

211
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
212
213
214
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
  objects.NIC.CheckParameterSyntax(nicparams)

215
216
217
218
219
  # 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)
220

221
  # set up the inter-node password and certificate
222
  _InitGanetiServerSetup(hostname.name)
223
224

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

228
229
230
  if modify_etc_hosts:
    utils.AddHostToEtcHosts(hostname.name)

231
232
  if modify_ssh_setup:
    _InitSSHSetup()
233

234
235
  now = time.time()

236
  # init of cluster config file
237
238
239
240
241
242
243
  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(),
244
245
246
247
248
    master_node=hostname.name,
    master_ip=clustername.ip,
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
249
    enabled_hypervisors=enabled_hypervisors,
250
    beparams={constants.PP_DEFAULT: beparams},
251
    nicparams={constants.PP_DEFAULT: nicparams},
252
    hvparams=hvparams,
253
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
254
    modify_etc_hosts=modify_etc_hosts,
255
    modify_ssh_setup=modify_ssh_setup,
256
257
258
    ctime=now,
    mtime=now,
    uuid=utils.NewUUID(),
259
260
261
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
262
                                    secondary_ip=secondary_ip,
263
264
                                    serial_no=1,
                                    master_candidate=True,
265
                                    offline=False, drained=False,
266
                                    )
267
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
268
  cfg = config.ConfigWriter()
269
  ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
270
  cfg.Update(cfg.GetClusterInfo(), logging.error)
271

Iustin Pop's avatar
Iustin Pop committed
272
273
  # start the master ip
  # TODO: Review rpc call from bootstrap
274
  # TODO: Warn on failed start master
275
  rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
Iustin Pop's avatar
Iustin Pop committed
276

277

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
278
279
def InitConfig(version, cluster_config, master_node_config,
               cfg_file=constants.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
280
281
282
283
284
285
  """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
286
287
288
289
290
291
292
293
  @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
294
295
296
297
298
  """
  nodes = {
    master_node_config.name: master_node_config,
    }

299
  now = time.time()
Iustin Pop's avatar
Iustin Pop committed
300
301
302
303
  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
                                   nodes=nodes,
                                   instances={},
304
305
                                   serial_no=1,
                                   ctime=now, mtime=now)
306
307
308
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
309
310


Iustin Pop's avatar
Iustin Pop committed
311
312
313
314
315
316
317
def FinalizeClusterDestroy(master):
  """Execute the last steps of cluster destroy

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

  """
318
319
  cfg = config.ConfigWriter()
  modify_ssh_setup = cfg.GetClusterInfo().modify_ssh_setup
320
  result = rpc.RpcRunner.call_node_stop_master(master, True)
321
  msg = result.fail_msg
322
  if msg:
323
    logging.warning("Could not disable the master role: %s", msg)
324
  result = rpc.RpcRunner.call_node_leave_cluster(master, modify_ssh_setup)
325
  msg = result.fail_msg
326
327
328
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
329
330


Iustin Pop's avatar
Iustin Pop committed
331
def SetupNodeDaemon(cluster_name, node, ssh_key_check):
332
333
  """Add a node to the cluster.

334
335
336
  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.
337

Iustin Pop's avatar
Iustin Pop committed
338
339
340
  @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
341
342

  """
Iustin Pop's avatar
Iustin Pop committed
343
  sshrunner = ssh.SshRunner(cluster_name)
344
345

  noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
346
  rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
347
  hmac_key = utils.ReadFile(constants.HMAC_CLUSTER_KEY)
348

349
350
351
  # 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
352
353
354
355
356
  # 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")
357
358
359

  if not noded_cert.endswith("\n"):
    noded_cert += "\n"
360
361
  if not rapi_cert.endswith("\n"):
    rapi_cert += "\n"
362
363
  if not hmac_key.endswith("\n"):
    hmac_key += "\n"
364
365
366
367
368
369
370

  # 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"
371
372
373
               "%s!EOF.\n"
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
374
375
376
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
               "chmod 0400 %s %s %s && "
377
               "%s start %s" %
378
               (constants.SSL_CERT_FILE, noded_cert,
379
                constants.RAPI_CERT_FILE, rapi_cert,
380
                constants.HMAC_CLUSTER_KEY, hmac_key,
381
                constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
382
                constants.HMAC_CLUSTER_KEY,
383
                constants.DAEMON_UTIL, constants.NODED))
384

385
386
387
388
  result = sshrunner.Run(node, 'root', mycommand, batch=False,
                         ask_key=ssh_key_check,
                         use_cluster_key=False,
                         strict_host_check=ssh_key_check)
389
390
391
392
393
  if result.failed:
    raise errors.OpExecError("Remote command on node %s, error: %s,"
                             " output: %s" %
                             (node, result.fail_reason, result.output))

394

395
def MasterFailover(no_voting=False):
396
397
398
399
400
401
  """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.

402
403
404
405
  @type no_voting: boolean
  @param no_voting: force the operation without remote nodes agreement
                      (dangerous)

406
  """
407
  sstore = ssconf.SimpleStore()
408

409
410
411
  old_master, new_master = ssconf.GetMasterAndMyself(sstore)
  node_list = sstore.GetNodeList()
  mc_list = sstore.GetMasterCandidates()
412
413
414
415
416

  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" %
417
                               old_master, errors.ECODE_INVAL)
418

419
420
421
422
423
424
  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"
425
426
                               "%s" % ('\n'.join(mc_no_master)),
                               errors.ECODE_STATE)
427

428
429
430
431
432
433
434
  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"
435
                                   " not respond.", errors.ECODE_ENVIRON)
436
437
438
439
440
      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." %
441
442
                                   (old_master, voted_master),
                                   errors.ECODE_STATE)
443
444
445
446
  # end checks

  rcode = 0

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

449
  result = rpc.RpcRunner.call_node_stop_master(old_master, True)
450
  msg = result.fail_msg
451
  if msg:
452
    logging.error("Could not disable the master role on the old master"
453
                 " %s, please disable manually: %s", old_master, msg)
454

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

Iustin Pop's avatar
Iustin Pop committed
457
458
459
  # instantiate a real config writer, as we now know we have the
  # configuration data
  cfg = config.ConfigWriter()
460

Iustin Pop's avatar
Iustin Pop committed
461
462
463
464
  cluster_info = cfg.GetClusterInfo()
  cluster_info.master_node = new_master
  # this will also regenerate the ssconf files, since we updated the
  # cluster info
465
  cfg.Update(cluster_info, logging.error)
466

467
  result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
468
  msg = result.fail_msg
469
  if msg:
470
    logging.error("Could not start the master role on the new master"
471
                  " %s, please check: %s", new_master, msg)
472
473
474
    rcode = 1

  return rcode
475
476


477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
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


493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
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
509
      node will be removed if it is in the list
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  @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:
529
    nres = results[node]
530
    data = nres.payload
531
    msg = nres.fail_msg
532
533
534
535
536
537
538
539
    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:
540
541
542
543
      if None not in votes:
        votes[None] = 0
      votes[None] += 1
      continue
544
    master_node = data[2]
545
546
547
548
549
550
551
552
553
554
555
    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