config.py 44 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#

# Copyright (C) 2006, 2007 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.


"""Configuration management for Ganeti

24
This module provides the interface to the Ganeti cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
25

26
27
The configuration data is stored on every node but is updated on the master
only. After each update, the master distributes the data to the other nodes.
Iustin Pop's avatar
Iustin Pop committed
28

29
30
Currently, the data storage format is JSON. YAML was slow and consuming too
much memory.
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35

"""

import os
import random
36
import logging
37
import time
Iustin Pop's avatar
Iustin Pop committed
38
39

from ganeti import errors
40
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
41
42
43
44
from ganeti import utils
from ganeti import constants
from ganeti import rpc
from ganeti import objects
45
from ganeti import serializer
46
47


48
49
50
_config_lock = locking.SharedLock()


Michael Hanselmann's avatar
Michael Hanselmann committed
51
def _ValidateConfig(data):
Iustin Pop's avatar
Iustin Pop committed
52
53
54
55
56
57
58
59
  """Verifies that a configuration objects looks valid.

  This only verifies the version of the configuration.

  @raise errors.ConfigurationError: if the version differs from what
      we expect

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
60
  if data.version != constants.CONFIG_VERSION:
61
62
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
63
                                    (data.version,
64
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
65

66

Iustin Pop's avatar
Iustin Pop committed
67
class ConfigWriter:
68
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
69

70
  """
Iustin Pop's avatar
Iustin Pop committed
71
  def __init__(self, cfg_file=None, offline=False):
72
    self.write_count = 0
73
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
74
75
76
77
78
79
    self._config_data = None
    self._offline = offline
    if cfg_file is None:
      self._cfg_file = constants.CLUSTER_CONF_FILE
    else:
      self._cfg_file = cfg_file
80
    self._temporary_ids = set()
81
    self._temporary_drbds = {}
82
    self._temporary_macs = set()
83
84
85
86
87
    # Note: in order to prevent errors when resolving our name in
    # _DistributeConfig, we compute it here once and reuse it; it's
    # better to raise an error before starting to modify the config
    # file than after it was modified
    self._my_hostname = utils.HostInfo().name
88
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
89
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
90
91
92
93
94
95
96
97
98

  # this method needs to be static, so that we can call it on the class
  @staticmethod
  def IsCluster():
    """Check if the cluster is configured.

    """
    return os.path.exists(constants.CLUSTER_CONF_FILE)

99
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
  def GenerateMAC(self):
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
    prefix = self._config_data.cluster.mac_prefix
    all_macs = self._AllMACs()
    retries = 64
    while retries > 0:
      byte1 = random.randrange(0, 256)
      byte2 = random.randrange(0, 256)
      byte3 = random.randrange(0, 256)
      mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
114
      if mac not in all_macs and mac not in self._temporary_macs:
Iustin Pop's avatar
Iustin Pop committed
115
116
117
        break
      retries -= 1
    else:
118
      raise errors.ConfigurationError("Can't generate unique MAC")
119
    self._temporary_macs.add(mac)
Iustin Pop's avatar
Iustin Pop committed
120
121
    return mac

122
  @locking.ssynchronized(_config_lock, shared=1)
123
124
125
126
127
128
129
130
  def IsMacInUse(self, mac):
    """Predicate: check if the specified MAC is in use in the Ganeti cluster.

    This only checks instances managed by this cluster, it does not
    check for potential collisions elsewhere.

    """
    all_macs = self._AllMACs()
131
    return mac in all_macs or mac in self._temporary_macs
132

133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
  @locking.ssynchronized(_config_lock, shared=1)
  def GenerateDRBDSecret(self):
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
    all_secrets = self._AllDRBDSecrets()
    retries = 64
    while retries > 0:
      secret = utils.GenerateSecret()
      if secret not in all_secrets:
        break
      retries -= 1
    else:
      raise errors.ConfigurationError("Can't generate unique DRBD secret")
    return secret

151
  def _AllLVs(self):
152
153
154
155
156
157
158
159
160
161
    """Compute the list of all LVs.

    """
    lvnames = set()
    for instance in self._config_data.instances.values():
      node_data = instance.MapLVsByNode()
      for lv_list in node_data.values():
        lvnames.update(lv_list)
    return lvnames

162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
  def _AllIDs(self, include_temporary):
    """Compute the list of all UUIDs and names we have.

    @type include_temporary: boolean
    @param include_temporary: whether to include the _temporary_ids set
    @rtype: set
    @return: a set of IDs

    """
    existing = set()
    if include_temporary:
      existing.update(self._temporary_ids)
    existing.update(self._AllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
177
    existing.update([i.uuid for i in self._AllUUIDObjects() if i.uuid])
178
179
    return existing

180
181
  def _GenerateUniqueID(self, exceptions=None):
    """Generate an unique UUID.
182
183
184
185

    This checks the current node, instances and disk names for
    duplicates.

186
187
188
189
    @param exceptions: a list with some other names which should be
        checked for uniqueness (used for example when you want to get
        more than one id at one time without adding each one in turn
        to the config file)
190

Iustin Pop's avatar
Iustin Pop committed
191
192
    @rtype: string
    @return: the unique id
193
194

    """
195
    existing = self._AllIDs(include_temporary=True)
196
197
198
199
    if exceptions is not None:
      existing.update(exceptions)
    retries = 64
    while retries > 0:
200
      unique_id = utils.NewUUID()
201
202
203
      if unique_id not in existing and unique_id is not None:
        break
    else:
204
205
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
206
207
208
    self._temporary_ids.add(unique_id)
    return unique_id

209
210
211
212
213
214
215
216
217
  @locking.ssynchronized(_config_lock, shared=1)
  def GenerateUniqueID(self, exceptions=None):
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

    """
    return self._GenerateUniqueID(exceptions=exceptions)

218
219
220
221
222
223
224
  def _CleanupTemporaryIDs(self):
    """Cleanups the _temporary_ids structure.

    """
    existing = self._AllIDs(include_temporary=False)
    self._temporary_ids = self._temporary_ids - existing

Iustin Pop's avatar
Iustin Pop committed
225
226
227
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
228
229
230
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
231
232
233
234
235
236
237
238
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

239
240
241
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
242
243
244
    @rtype: list
    @return: the list of all DRBD secrets

245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
    """
    def helper(disk, result):
      """Recursively gather secrets from this disk."""
      if disk.dev_type == constants.DT_DRBD8:
        result.append(disk.logical_id[5])
      if disk.children:
        for child in disk.children:
          helper(child, result)

    result = []
    for instance in self._config_data.instances.values():
      for disk in instance.disks:
        helper(disk, result)

    return result

261
262
263
264
265
266
267
268
269
270
271
272
273
274
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
    """Compute duplicate disk IDs

    @type disk: L{objects.Disk}
    @param disk: the disk at which to start searching
    @type l_ids: list
    @param l_ids: list of current logical ids
    @type p_ids: list
    @param p_ids: list of current physical ids
    @rtype: list
    @return: a list of error messages

    """
    result = []
275
276
277
278
279
280
281
282
283
284
    if disk.logical_id is not None:
      if disk.logical_id in l_ids:
        result.append("duplicate logical id %s" % str(disk.logical_id))
      else:
        l_ids.append(disk.logical_id)
    if disk.physical_id is not None:
      if disk.physical_id in p_ids:
        result.append("duplicate physical id %s" % str(disk.physical_id))
      else:
        p_ids.append(disk.physical_id)
285
286
287
288
289
290

    if disk.children:
      for child in disk.children:
        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
    return result

291
  def _UnlockedVerifyConfig(self):
292
293
    """Verify function.

294
295
296
297
    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

Iustin Pop's avatar
Iustin Pop committed
298
299
300
    """
    result = []
    seen_macs = []
301
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
302
    data = self._config_data
303
304
    seen_lids = []
    seen_pids = []
305
306
307
308
309
310
311
312
313
314
315
316
317
318

    # global cluster checks
    if not data.cluster.enabled_hypervisors:
      result.append("enabled hypervisors list doesn't have any entries")
    invalid_hvs = set(data.cluster.enabled_hypervisors) - constants.HYPER_TYPES
    if invalid_hvs:
      result.append("enabled hypervisors contains invalid entries: %s" %
                    invalid_hvs)

    if data.cluster.master_node not in data.nodes:
      result.append("cluster has invalid primary node '%s'" %
                    data.cluster.master_node)

    # per-instance checks
Iustin Pop's avatar
Iustin Pop committed
319
320
321
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
322
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
323
324
325
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
326
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
327
328
329
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
330
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
331
332
333
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348

      # gather the drbd ports for duplicate checks
      for dsk in instance.disks:
        if dsk.dev_type in constants.LDS_DRBD:
          tcp_port = dsk.logical_id[2]
          if tcp_port not in ports:
            ports[tcp_port] = []
          ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
      # gather network port reservation
      net_port = getattr(instance, "network_port", None)
      if net_port is not None:
        if net_port not in ports:
          ports[net_port] = []
        ports[net_port].append((instance.name, "network port"))

349
350
351
352
      # instance disk verify
      for idx, disk in enumerate(instance.disks):
        result.extend(["instance '%s' disk %d error: %s" %
                       (instance.name, idx, msg) for msg in disk.Verify()])
353
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
354

355
    # cluster-wide pool of free ports
356
    for free_port in data.cluster.tcpudp_port_pool:
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
      if free_port not in ports:
        ports[free_port] = []
      ports[free_port].append(("cluster", "port marked as free"))

    # compute tcp/udp duplicate ports
    keys = ports.keys()
    keys.sort()
    for pnum in keys:
      pdata = ports[pnum]
      if len(pdata) > 1:
        txt = ", ".join(["%s/%s" % val for val in pdata])
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))

    # highest used tcp port check
    if keys:
372
      if keys[-1] > data.cluster.highest_used_port:
373
        result.append("Highest used port mismatch, saved %s, computed %s" %
374
375
                      (data.cluster.highest_used_port, keys[-1]))

376
377
378
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

379
    # master candidate checks
380
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats()
381
382
383
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
384

385
386
387
388
389
390
391
392
    # node checks
    for node in data.nodes.values():
      if [node.master_candidate, node.drained, node.offline].count(True) > 1:
        result.append("Node %s state is invalid: master_candidate=%s,"
                      " drain=%s, offline=%s" %
                      (node.name, node.master_candidate, node.drain,
                       node.offline))

393
394
395
396
397
398
    # drbd minors check
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    for node, minor, instance_a, instance_b in duplicates:
      result.append("DRBD minor %d on node %s is assigned twice to instances"
                    " %s and %s" % (minor, node, instance_a, instance_b))

Iustin Pop's avatar
Iustin Pop committed
399
400
    return result

401
402
403
404
405
406
407
408
409
410
411
412
413
  @locking.ssynchronized(_config_lock, shared=1)
  def VerifyConfig(self):
    """Verify function.

    This is just a wrapper over L{_UnlockedVerifyConfig}.

    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

    """
    return self._UnlockedVerifyConfig()

414
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
415
416
417
418
419
420
421
422
    """Convert the unique ID to the ID needed on the target nodes.

    This is used only for drbd, which needs ip/port configuration.

    The routine descends down and updates its children also, because
    this helps when the only the top device is passed to the remote
    node.

423
424
    This function is for internal use, when the config lock is already held.

Iustin Pop's avatar
Iustin Pop committed
425
426
427
    """
    if disk.children:
      for child in disk.children:
428
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
429
430
431

    if disk.logical_id is None and disk.physical_id is not None:
      return
432
    if disk.dev_type == constants.LD_DRBD8:
433
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
434
      if node_name not in (pnode, snode):
435
436
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
437
438
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
439
440
441
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
442
443
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
444
      if pnode == node_name:
445
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
446
      else: # it must be secondary, we tested above
447
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
448
449
450
451
    else:
      disk.physical_id = disk.logical_id
    return

452
453
454
455
456
457
458
459
460
461
462
463
464
465
  @locking.ssynchronized(_config_lock)
  def SetDiskID(self, disk, node_name):
    """Convert the unique ID to the ID needed on the target nodes.

    This is used only for drbd, which needs ip/port configuration.

    The routine descends down and updates its children also, because
    this helps when the only the top device is passed to the remote
    node.

    """
    return self._UnlockedSetDiskID(disk, node_name)

  @locking.ssynchronized(_config_lock)
466
467
468
469
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
470
    if not isinstance(port, int):
471
      raise errors.ProgrammerError("Invalid type passed for port")
472

473
    self._config_data.cluster.tcpudp_port_pool.add(port)
474
475
    self._WriteConfig()

476
  @locking.ssynchronized(_config_lock, shared=1)
477
  def GetPortList(self):
478
479
480
    """Returns a copy of the current port list.

    """
481
    return self._config_data.cluster.tcpudp_port_pool.copy()
482

483
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
484
485
486
  def AllocatePort(self):
    """Allocate a port.

487
488
489
    The port will be taken from the available port pool or from the
    default port range (and in this case we increase
    highest_used_port).
Iustin Pop's avatar
Iustin Pop committed
490
491

    """
492
    # If there are TCP/IP ports configured, we use them first.
493
494
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
495
496
497
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
498
499
500
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
501
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
502
503
504
505

    self._WriteConfig()
    return port

506
  def _UnlockedComputeDRBDMap(self):
507
508
    """Compute the used DRBD minor/nodes.

509
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
510
511
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
512
513
514
        an empty list), and a list of duplicates; if the duplicates
        list is not empty, the configuration is corrupted and its caller
        should raise an exception
515
516
517

    """
    def _AppendUsedPorts(instance_name, disk, used):
518
      duplicates = []
519
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
520
521
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
522
523
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
524
          if port in used[node]:
525
526
527
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
528
529
      if disk.children:
        for child in disk.children:
530
531
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
532

533
    duplicates = []
534
    my_dict = dict((node, {}) for node in self._config_data.nodes)
535
536
537
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
538
    for (node, minor), instance in self._temporary_drbds.iteritems():
539
      if minor in my_dict[node] and my_dict[node][minor] != instance:
540
541
542
543
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
544

545
546
547
548
549
550
551
552
553
554
555
  @locking.ssynchronized(_config_lock)
  def ComputeDRBDMap(self):
    """Compute the used DRBD minor/nodes.

    This is just a wrapper over L{_UnlockedComputeDRBDMap}.

    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
        an empty list).

    """
556
557
558
559
560
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
561

562
563
564
565
566
567
568
569
570
  @locking.ssynchronized(_config_lock)
  def AllocateDRBDMinor(self, nodes, instance):
    """Allocate a drbd minor.

    The free minor will be automatically computed from the existing
    devices. A node can be given multiple times in order to allocate
    multiple minors. The result is the list of minors, in the same
    order as the passed nodes.

571
572
573
    @type instance: string
    @param instance: the instance for which we allocate minors

574
    """
575
    assert isinstance(instance, basestring), \
576
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
577

578
579
580
581
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
582
583
584
585
586
587
588
    result = []
    for nname in nodes:
      ndata = d_map[nname]
      if not ndata:
        # no minors used, we can start at 0
        result.append(0)
        ndata[0] = instance
589
        self._temporary_drbds[(nname, 0)] = instance
590
591
592
593
594
595
596
597
598
599
        continue
      keys = ndata.keys()
      keys.sort()
      ffree = utils.FirstFree(keys)
      if ffree is None:
        # return the next minor
        # TODO: implement high-limit check
        minor = keys[-1] + 1
      else:
        minor = ffree
600
601
602
603
604
      # double-check minor against current instances
      assert minor not in d_map[nname], \
             ("Attempt to reuse allocated DRBD minor %d on node %s,"
              " already allocated to instance %s" %
              (minor, nname, d_map[nname][minor]))
605
      ndata[minor] = instance
606
607
608
609
610
611
612
613
      # double-check minor against reservation
      r_key = (nname, minor)
      assert r_key not in self._temporary_drbds, \
             ("Attempt to reuse reserved DRBD minor %d on node %s,"
              " reserved for instance %s" %
              (minor, nname, self._temporary_drbds[r_key]))
      self._temporary_drbds[r_key] = instance
      result.append(minor)
614
615
616
617
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

618
  def _UnlockedReleaseDRBDMinors(self, instance):
619
620
621
622
623
624
625
    """Release temporary drbd minors allocated for a given instance.

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
626
627
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
628
629
630
631
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
  @locking.ssynchronized(_config_lock)
  def ReleaseDRBDMinors(self, instance):
    """Release temporary drbd minors allocated for a given instance.

    This should be called on the error paths, on the success paths
    it's automatically called by the ConfigWriter add and update
    functions.

    This function is just a wrapper over L{_UnlockedReleaseDRBDMinors}.

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
    self._UnlockedReleaseDRBDMinors(instance)

649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
  @locking.ssynchronized(_config_lock, shared=1)
  def GetConfigVersion(self):
    """Get the configuration version.

    @return: Config version

    """
    return self._config_data.version

  @locking.ssynchronized(_config_lock, shared=1)
  def GetClusterName(self):
    """Get cluster name.

    @return: Cluster name

    """
    return self._config_data.cluster.cluster_name

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterNode(self):
    """Get the hostname of the master node for this cluster.

    @return: Master hostname

    """
    return self._config_data.cluster.master_node

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterIP(self):
    """Get the IP of the master node for this cluster.

    @return: Master IP

    """
    return self._config_data.cluster.master_ip

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterNetdev(self):
    """Get the master network device for this cluster.

    """
    return self._config_data.cluster.master_netdev

  @locking.ssynchronized(_config_lock, shared=1)
  def GetFileStorageDir(self):
    """Get the file storage dir for this cluster.

    """
    return self._config_data.cluster.file_storage_dir

  @locking.ssynchronized(_config_lock, shared=1)
  def GetHypervisorType(self):
    """Get the hypervisor type for this cluster.

    """
704
    return self._config_data.cluster.enabled_hypervisors[0]
705

706
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
707
708
709
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
710
711
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
712
713
714
715

    """
    return self._config_data.cluster.rsahostkeypub

716
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
717
718
719
720
721
  def AddInstance(self, instance):
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
722
723
724
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
725
726
727
728
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

729
730
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
731
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
732

733
734
735
736
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
737
738
739
740
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

    self._EnsureUUID(instance)
741

742
    instance.serial_no = 1
743
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
744
    self._config_data.instances[instance.name] = instance
745
    self._config_data.cluster.serial_no += 1
746
    self._UnlockedReleaseDRBDMinors(instance.name)
747
748
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
749
750
    self._WriteConfig()

751
752
753
754
755
756
757
758
759
760
761
762
  def _EnsureUUID(self, item):
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked

    """
    if not item.uuid:
      item.uuid = self._GenerateUniqueID()
    elif item.uuid in self._AllIDs(temporary=True):
      raise errors.ConfigurationError("Cannot add '%s': UUID already in use" %
                                      (item.name, item.uuid))

763
764
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
765
766

    """
767
768
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
769
770

    if instance_name not in self._config_data.instances:
771
772
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
773
    instance = self._config_data.instances[instance_name]
774
775
    if instance.admin_up != status:
      instance.admin_up = status
776
      instance.serial_no += 1
777
      instance.mtime = time.time()
778
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
779

780
  @locking.ssynchronized(_config_lock)
781
782
783
784
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
785
    self._SetInstanceStatus(instance_name, True)
786

787
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
788
789
790
791
792
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
793
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
794
    del self._config_data.instances[instance_name]
795
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
796
797
    self._WriteConfig()

798
  @locking.ssynchronized(_config_lock)
799
800
801
802
803
804
805
806
807
808
809
810
811
  def RenameInstance(self, old_name, new_name):
    """Rename an instance.

    This needs to be done in ConfigWriter and not by RemoveInstance
    combined with AddInstance as only we can guarantee an atomic
    rename.

    """
    if old_name not in self._config_data.instances:
      raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
    inst = self._config_data.instances[old_name]
    del self._config_data.instances[old_name]
    inst.name = new_name
812
813
814
815
816
817
818
819
820
821

    for disk in inst.disks:
      if disk.dev_type == constants.LD_FILE:
        # rename the file paths in logical and physical id
        file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
        disk.physical_id = disk.logical_id = (disk.logical_id[0],
                                              os.path.join(file_storage_dir,
                                                           inst.name,
                                                           disk.iv_name))

822
823
824
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

825
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
826
827
828
829
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
830
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
831

832
833
834
835
836
837
838
839
  def _UnlockedGetInstanceList(self):
    """Get the list of instances.

    This function is for internal use, when the config lock is already held.

    """
    return self._config_data.instances.keys()

840
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
841
842
843
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
844
845
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
846
847

    """
848
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
849

850
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
851
852
853
854
855
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
856
857
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
858

859
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
860
    """Returns information about an instance.
861
862
863
864
865
866
867
868
869

    This function is for internal use, when the config lock is already held.

    """
    if instance_name not in self._config_data.instances:
      return None

    return self._config_data.instances[instance_name]

870
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
871
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
872
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
873

Michael Hanselmann's avatar
Michael Hanselmann committed
874
    It takes the information from the configuration file. Other information of
Iustin Pop's avatar
Iustin Pop committed
875
876
    an instance are taken from the live systems.

Iustin Pop's avatar
Iustin Pop committed
877
878
    @param instance_name: name of the instance, e.g.
        I{instance1.example.com}
Iustin Pop's avatar
Iustin Pop committed
879

Iustin Pop's avatar
Iustin Pop committed
880
881
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
882
883

    """
884
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
885

886
887
888
889
890
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
891
    @return: dict of (instance, instance_info), where instance_info is what
892
893
894
              would GetInstanceInfo return for the node

    """
895
896
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
897
898
    return my_dict

899
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
900
901
902
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
903
904
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
905
906

    """
907
    logging.info("Adding node %s to configuration", node.name)
908

909
910
    self._EnsureUUID(node)

911
    node.serial_no = 1
912
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
913
    self._config_data.nodes[node.name] = node
914
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
915
916
    self._WriteConfig()

917
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
918
919
920
921
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
922
    logging.info("Removing node %s from configuration", node_name)
923

Iustin Pop's avatar
Iustin Pop committed
924
    if node_name not in self._config_data.nodes:
925
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
926
927

    del self._config_data.nodes[node_name]
928
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
929
930
    self._WriteConfig()

931
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
932
933
934
935
936
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
937
938
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
939

940
  def _UnlockedGetNodeInfo(self, node_name):
Iustin Pop's avatar
Iustin Pop committed
941
942
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
943
944
    This function is for internal use, when the config lock is already
    held.
945

Iustin Pop's avatar
Iustin Pop committed
946
    @param node_name: the node name, e.g. I{node1.example.com}
Iustin Pop's avatar
Iustin Pop committed
947

Iustin Pop's avatar
Iustin Pop committed
948
949
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
950
951
952
953
954
955
956

    """
    if node_name not in self._config_data.nodes:
      return None

    return self._config_data.nodes[node_name]

957
958
959
960
961

  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeInfo(self, node_name):
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
962
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
963

Iustin Pop's avatar
Iustin Pop committed
964
965
966
967
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
968
969
970
971
972

    """
    return self._UnlockedGetNodeInfo(node_name)

  def _UnlockedGetNodeList(self):
Iustin Pop's avatar
Iustin Pop committed
973
974
    """Return the list of nodes which are in the configuration.

Iustin Pop's avatar
Iustin Pop committed
975
976
977
978
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
979

Iustin Pop's avatar
Iustin Pop committed
980
981
982
    """
    return self._config_data.nodes.keys()

983
984
985
986
987
988
989
990

  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeList(self):
    """Return the list of nodes which are in the configuration.

    """
    return self._UnlockedGetNodeList()

Iustin Pop's avatar
Iustin Pop committed
991
992
993
994
995
996
997
998
999
  @locking.ssynchronized(_config_lock, shared=1)
  def GetOnlineNodeList(self):
    """Return the list of nodes which are online.

    """
    all_nodes = [self._UnlockedGetNodeInfo(node)
                 for node in self._UnlockedGetNodeList()]
    return [node.name for node in all_nodes if not node.offline]

1000
1001
1002
1003
1004
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1005
    @return: dict of (node, node_info), where node_info is what
1006
1007
1008
1009
1010
1011
1012
              would GetNodeInfo return for the node

    """
    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
                    for node in self._UnlockedGetNodeList()])
    return my_dict

1013
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1014
1015
    """Get the number of current and maximum desired and possible candidates.

1016
1017
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1018
    @rtype: tuple
1019
    @return: tuple of (current, desired and possible, possible)
1020
1021

    """
1022
    mc_now = mc_should = mc_max = 0
1023
1024
1025
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1026
      if not (node.offline or node.drained):
1027
1028
1029
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1030
1031
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1032
1033

  @locking.ssynchronized(_config_lock, shared=1)
1034
  def GetMasterCandidateStats(self, exceptions=None):
1035
1036
1037
1038
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1039
1040
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1041
1042
1043
1044
    @rtype: tuple
    @return: tuple of (current, max)

    """
1045
    return self._UnlockedGetMasterCandidateStats(exceptions)
1046
1047

  @locking.ssynchronized(_config_lock)
Guido Trotter's avatar
Guido Trotter committed
1048
  def MaintainCandidatePool(self, exceptions):
1049
1050
    """Try to grow the candidate pool to the desired size.

Guido Trotter's avatar
Guido Trotter committed
1051
1052
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1053
    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1054
    @return: list with the adjusted nodes (L{objects.Node} instances)
1055
1056

    """
Guido Trotter's avatar
Guido Trotter committed
1057
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1058
1059
1060
1061
1062
1063
1064
1065
    mod_list = []
    if mc_now < mc_max:
      node_list = self._config_data.nodes.keys()
      random.shuffle(node_list)
      for name in node_list:
        if mc_now >= mc_max:
          break
        node = self._config_data.nodes[name]
Guido Trotter's avatar
Guido Trotter committed
1066
1067
        if (node.master_candidate or node.offline or node.drained or
            node.name in exceptions):
1068
          continue
Iustin Pop's avatar
Iustin Pop committed
1069
        mod_list.append(node)
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
        node.master_candidate = True
        node.serial_no += 1
        mc_now += 1
      if mc_now != mc_max:
        # this should not happen
        logging.warning("Warning: MaintainCandidatePool didn't manage to"
                        " fill the candidate pool (%d/%d)", mc_now, mc_max)
      if mod_list:
        self._config_data.cluster.serial_no += 1
        self._WriteConfig()

    return mod_list

Iustin Pop's avatar
Iustin Pop committed
1083
1084
1085
1086
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1087
    self._config_data.serial_no += 1
1088
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1089

1090
1091
1092
1093
1094
1095
1096
1097
  def _AllUUIDObjects(self):
    """Returns all objects with uuid attributes.

    """
    return (self._config_data.instances.values() +
            self._config_data.nodes.values() +
            [self._config_data.cluster])

Iustin Pop's avatar
Iustin Pop committed
1098
1099
1100
1101
  def _OpenConfig(self):
    """Read the config data from disk.

    """
1102
1103
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1104
    try:
1105
1106
1107
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1108
1109
1110
1111

    # Make sure the configuration has the right version
    _ValidateConfig(data)

Iustin Pop's avatar
Iustin Pop committed
1112
    if (not hasattr(data, 'cluster') or
1113
        not hasattr(data.cluster, 'rsahostkeypub')):
1114
      raise errors.ConfigurationError("Incomplete configuration"
1115
                                      " (missing cluster.rsahostkeypub)")
1116
1117
1118
1119

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1120
    self._config_data = data
1121
    # reset the last serial as -1 so that the next write will cause
1122
1123
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1124

1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
    # And finally run our (custom) config upgrade sequence
    self._UpgradeConfig()

  def _UpgradeConfig(self):
    """Run upgrade steps that cannot be done purely in the objects.

    This is because some data elements need uniqueness across the
    whole configuration, etc.

    @warning: this function will call L{_WriteConfig()}, so it needs
        to either be called with the lock held or from a safe place
        (the constructor)

    """
    modified = False
    for item in self._AllUUIDObjects():
      if item.uuid is None:
1142
        item.uuid = self._GenerateUniqueID()
1143
1144
1145
1146
        modified = True
    if modified:
      self._WriteConfig()

1147
  def _DistributeConfig(self, feedback_fn):
Iustin Pop's avatar
Iustin Pop committed
1148
1149
1150
1151
1152
1153
1154
1155
    """Distribute the configuration to the other nodes.

    Currently, this only copies the configuration file. In the future,
    it could be used to encapsulate the 2/3-phase update mechanism.

    """
    if self._offline:
      return True
1156

Iustin Pop's avatar
Iustin Pop committed
1157
1158
    bad = False

1159
1160
1161
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1162
1163
1164
1165
    # we can skip checking whether _UnlockedGetNodeInfo returns None
    # since the node list comes from _UnlocketGetNodeList, and we are
    # called with the lock held, so no modifications should take place
    # in between
1166
1167
1168
1169
1170
1171
1172
1173
    for node_name in self._UnlockedGetNodeList():
      if node_name == myhostname:
        continue
      node_info = self._UnlockedGetNodeInfo(node_name)
      if not node_info.master_candidate:
        continue
      node_list.append(node_info.name)
      addr_list.append(node_info.primary_ip)
1174

1175
1176
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
                                            address_list=addr_list)
1177
    for to_node, to_result in result.items():
1178
      msg = to_result.fail_msg
1179
1180
      if msg:
        msg = ("Copy of file %s to node %s failed: %s" %
1181
               (self._cfg_file, to_node, msg))
1182
        logging.error(msg)
1183
1184
1185
1186

        if feedback_fn:
          feedback_fn(msg)

Iustin Pop's avatar
Iustin Pop committed
1187
        bad = True
1188

Iustin Pop's avatar
Iustin Pop committed
1189
1190
    return not bad

1191
  def _WriteConfig(self, destination=None, feedback_fn=None):
Iustin Pop's avatar
Iustin Pop committed
1192
1193
1194
    """Write the configuration data to persistent storage.

    """
1195
1196
    assert feedback_fn is None or callable(feedback_fn)

1197
    # First, cleanup the _temporary_ids set, if an ID is now in the
1198
1199
1200
    # other objects it should be discarded to prevent unbounded growth
    # of that structure
    self._CleanupTemporaryIDs()
1201
1202
1203
1204
1205

    # Warn on config errors, but don't abort the save - the
    # configuration has already been modified, and we can't revert;
    # the best we can do is to warn the user and save as is, leaving
    # recovery to the user
1206
1207
    config_errors = self._UnlockedVerifyConfig()
    if config_errors:
1208
1209
1210
1211
1212
1213
      errmsg = ("Configuration data is not consistent: %s" %
                (", ".join(config_errors)))
      logging.critical(errmsg)
      if feedback_fn:
        feedback_fn(errmsg)

Iustin Pop's avatar
Iustin Pop committed
1214
1215
1216
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1217
    txt = serializer.Dump(self._config_data.ToDict())
1218
1219
1220

    utils.WriteFile(destination, data=txt)