bootstrap.py 19.1 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
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
65
66
67
68
69
70
71
  """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)

  f = open(pub_key, 'r')
  try:
    utils.AddAuthorizedKey(auth_keys, f.read(8192))
  finally:
    f.close()


72
73
def _GenerateSelfSignedSslCert(file_name, validity=(365 * 5)):
  """Generates a self-signed SSL certificate.
74

75
76
77
78
  @type file_name: str
  @param file_name: Path to output file
  @type validity: int
  @param validity: Validity for certificate in days
79
80

  """
81
82
  (fd, tmp_file_name) = tempfile.mkstemp(dir=os.path.dirname(file_name))
  try:
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
    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)
102
  finally:
103
    os.close(fd)
104
105
106
107
108
109
110
111
112
113


def _InitGanetiServerSetup():
  """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.

  """
  _GenerateSelfSignedSslCert(constants.SSL_CERT_FILE)
114

115
116
117
118
  # Don't overwrite existing file
  if not os.path.exists(constants.RAPI_CERT_FILE):
    _GenerateSelfSignedSslCert(constants.RAPI_CERT_FILE)

119
120
121
122
123
  if not os.path.exists(constants.HMAC_CLUSTER_KEY):
    utils.WriteFile(constants.HMAC_CLUSTER_KEY,
                    data=utils.GenerateSecret(),
                    mode=0400)

124
125
126
127
128
129
130
131
  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))


132
def InitCluster(cluster_name, mac_prefix,
133
                master_netdev, file_storage_dir, candidate_pool_size,
134
135
                secondary_ip=None, vg_name=None, beparams=None,
                nicparams=None, hvparams=None, enabled_hypervisors=None,
136
                modify_etc_hosts=True):
137
138
  """Initialise the cluster.

139
140
141
  @type candidate_pool_size: int
  @param candidate_pool_size: master candidate pool size

142
  """
143
  # TODO: complete the docstring
144
145
146
  if config.ConfigWriter.IsCluster():
    raise errors.OpPrereqError("Cluster is already initialised")

147
148
149
150
151
152
153
154
  if not enabled_hypervisors:
    raise errors.OpPrereqError("Enabled hypervisors list must contain at"
                               " least one member")
  invalid_hvs = set(enabled_hypervisors) - constants.HYPER_TYPES
  if invalid_hvs:
    raise errors.OpPrereqError("Enabled hypervisors contains invalid"
                               " entries: %s" % invalid_hvs)

155
156
157
158
159
160
161
  hostname = utils.HostInfo()

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

162
  if not utils.OwnIpAddress(hostname.ip):
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
    raise errors.OpPrereqError("Inconsistency: this host's name resolves"
                               " to %s,\nbut this ip address does not"
                               " belong to this host."
                               " Aborting." % hostname.ip)

  clustername = utils.HostInfo(cluster_name)

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

  if secondary_ip:
    if not utils.IsValidIP(secondary_ip):
      raise errors.OpPrereqError("Invalid secondary ip given")
    if (secondary_ip != hostname.ip and
178
        not utils.OwnIpAddress(secondary_ip)):
179
180
181
      raise errors.OpPrereqError("You gave %s as secondary IP,"
                                 " but it does not belong to this host." %
                                 secondary_ip)
182
183
  else:
    secondary_ip = hostname.ip
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

  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"
                                 " you are not using lvm" % vgstatus)

  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"
                               " not an absolute path.")

  if not os.path.exists(file_storage_dir):
    try:
      os.makedirs(file_storage_dir, 0750)
    except OSError, err:
      raise errors.OpPrereqError("Cannot create file storage directory"
                                 " '%s': %s" %
                                 (file_storage_dir, err))

  if not os.path.isdir(file_storage_dir):
    raise errors.OpPrereqError("The file storage directory '%s' is not"
                               " a directory." % file_storage_dir)

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

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

  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"
                               " executable." % constants.NODE_INITD_SCRIPT)

225
226
227
  dirs = [(constants.RUN_GANETI_DIR, constants.RUN_DIRS_MODE)]
  utils.EnsureDirs(dirs)

228
  utils.ForceDictType(beparams, constants.BES_PARAMETER_TYPES)
229
230
231
  utils.ForceDictType(nicparams, constants.NICS_PARAMETER_TYPES)
  objects.NIC.CheckParameterSyntax(nicparams)

232
233
234
235
236
  # 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)
237

238
  # set up the inter-node password and certificate
Michael Hanselmann's avatar
Michael Hanselmann committed
239
  _InitGanetiServerSetup()
240
241
242
243
244
245
246
247
248

  # set up ssh config and /etc/hosts
  f = open(constants.SSH_HOST_RSA_PUB, 'r')
  try:
    sshline = f.read()
  finally:
    f.close()
  sshkey = sshline.split(" ")[1]

249
250
251
  if modify_etc_hosts:
    utils.AddHostToEtcHosts(hostname.name)

252
  _InitSSHSetup()
253
254

  # init of cluster config file
255
256
257
258
259
260
261
  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(),
262
263
264
265
266
    master_node=hostname.name,
    master_ip=clustername.ip,
    master_netdev=master_netdev,
    cluster_name=clustername.name,
    file_storage_dir=file_storage_dir,
267
    enabled_hypervisors=enabled_hypervisors,
268
    beparams={constants.PP_DEFAULT: beparams},
269
    nicparams={constants.PP_DEFAULT: nicparams},
270
    hvparams=hvparams,
271
    candidate_pool_size=candidate_pool_size,
Guido Trotter's avatar
Guido Trotter committed
272
    modify_etc_hosts=modify_etc_hosts,
273
274
275
    )
  master_node_config = objects.Node(name=hostname.name,
                                    primary_ip=hostname.ip,
276
                                    secondary_ip=secondary_ip,
277
278
                                    serial_no=1,
                                    master_candidate=True,
279
                                    offline=False, drained=False,
280
                                    )
281
  InitConfig(constants.CONFIG_VERSION, cluster_config, master_node_config)
282
  cfg = config.ConfigWriter()
283
  ssh.WriteKnownHostsFile(cfg, constants.SSH_KNOWN_HOSTS_FILE)
284
  cfg.Update(cfg.GetClusterInfo())
285

Iustin Pop's avatar
Iustin Pop committed
286
287
  # start the master ip
  # TODO: Review rpc call from bootstrap
288
  # TODO: Warn on failed start master
289
  rpc.RpcRunner.call_node_start_master(hostname.name, True, False)
Iustin Pop's avatar
Iustin Pop committed
290

291

Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
292
293
def InitConfig(version, cluster_config, master_node_config,
               cfg_file=constants.CLUSTER_CONF_FILE):
Iustin Pop's avatar
Iustin Pop committed
294
295
296
297
298
299
  """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
300
301
302
303
304
305
306
307
  @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
308
309
310
311
312
313
314
315
316
317
  """
  nodes = {
    master_node_config.name: master_node_config,
    }

  config_data = objects.ConfigData(version=version,
                                   cluster=cluster_config,
                                   nodes=nodes,
                                   instances={},
                                   serial_no=1)
318
319
320
  utils.WriteFile(cfg_file,
                  data=serializer.Dump(config_data.ToDict()),
                  mode=0600)
Oleksiy Mishchenko's avatar
Oleksiy Mishchenko committed
321
322


Iustin Pop's avatar
Iustin Pop committed
323
324
325
326
327
328
329
def FinalizeClusterDestroy(master):
  """Execute the last steps of cluster destroy

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

  """
330
  result = rpc.RpcRunner.call_node_stop_master(master, True)
331
332
333
  msg = result.RemoteFailMsg()
  if msg:
    logging.warning("Could not disable the master role: %s" % msg)
334
  result = rpc.RpcRunner.call_node_leave_cluster(master)
335
336
337
338
  msg = result.RemoteFailMsg()
  if msg:
    logging.warning("Could not shutdown the node daemon and cleanup"
                    " the node: %s", msg)
Iustin Pop's avatar
Iustin Pop committed
339
340


Iustin Pop's avatar
Iustin Pop committed
341
def SetupNodeDaemon(cluster_name, node, ssh_key_check):
342
343
  """Add a node to the cluster.

344
345
346
  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.
347

Iustin Pop's avatar
Iustin Pop committed
348
349
350
  @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
351
352

  """
Iustin Pop's avatar
Iustin Pop committed
353
  sshrunner = ssh.SshRunner(cluster_name)
354
355

  noded_cert = utils.ReadFile(constants.SSL_CERT_FILE)
356
  rapi_cert = utils.ReadFile(constants.RAPI_CERT_FILE)
357

358
359
360
361
  # 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
  # parsed by the shell sequence below
362
363
  if (re.search('^!EOF\.', noded_cert, re.MULTILINE) or
      re.search('^!EOF\.', rapi_cert, re.MULTILINE)):
364
    raise errors.OpExecError("invalid PEM encoding in the SSL certificate")
365
366
367

  if not noded_cert.endswith("\n"):
    noded_cert += "\n"
368
369
  if not rapi_cert.endswith("\n"):
    rapi_cert += "\n"
370
371
372
373
374
375
376

  # 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"
377
378
379
               "%s!EOF.\n"
               "cat > '%s' << '!EOF.' && \n"
               "%s!EOF.\n"
380
               "chmod 0400 %s %s && "
381
               "%s restart" %
382
               (constants.SSL_CERT_FILE, noded_cert,
383
                constants.RAPI_CERT_FILE, rapi_cert,
384
                constants.SSL_CERT_FILE, constants.RAPI_CERT_FILE,
385
386
                constants.NODE_INITD_SCRIPT))

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

396

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

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

408
  """
409
  sstore = ssconf.SimpleStore()
410

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

  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" %
                               old_master)
420

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

429
430
431
432
433
434
435
436
437
438
439
440
441
442
  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"
                                   " not respond.")
      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." %
                                   (old_master, voted_master))
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
451
  msg = result.RemoteFailMsg()
  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
465
  cluster_info = cfg.GetClusterInfo()
  cluster_info.master_node = new_master
  # this will also regenerate the ssconf files, since we updated the
  # cluster info
  cfg.Update(cluster_info)
466

467
  result = rpc.RpcRunner.call_node_start_master(new_master, True, no_voting)
468
469
  msg = result.RemoteFailMsg()
  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
531
532
533
534
535
536
537
538
539
    data = nres.payload
    msg = nres.RemoteFailMsg()
    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