config.py 41.5 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
36

"""

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

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


49
50
51
_config_lock = locking.SharedLock()


Michael Hanselmann's avatar
Michael Hanselmann committed
52
def _ValidateConfig(data):
Iustin Pop's avatar
Iustin Pop committed
53
54
55
56
57
58
59
60
  """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
61
  if data.version != constants.CONFIG_VERSION:
62
63
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
64
                                    (data.version,
65
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
66

67

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

71
  """
Iustin Pop's avatar
Iustin Pop committed
72
  def __init__(self, cfg_file=None, offline=False):
73
    self.write_count = 0
74
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
75
76
77
78
79
80
    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
81
    self._temporary_ids = set()
82
    self._temporary_drbds = {}
83
    self._temporary_macs = set()
84
85
86
87
88
    # 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
89
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
90
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
91
92
93
94
95
96
97
98
99

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

100
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
  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)
115
      if mac not in all_macs and mac not in self._temporary_macs:
Iustin Pop's avatar
Iustin Pop committed
116
117
118
        break
      retries -= 1
    else:
119
      raise errors.ConfigurationError("Can't generate unique MAC")
120
    self._temporary_macs.add(mac)
Iustin Pop's avatar
Iustin Pop committed
121
122
    return mac

123
  @locking.ssynchronized(_config_lock, shared=1)
124
125
126
127
128
129
130
131
  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()
132
    return mac in all_macs or mac in self._temporary_macs
133

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
  @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

152
  def _AllLVs(self):
153
154
155
156
157
158
159
160
161
162
    """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

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
  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())
    return existing

180
  @locking.ssynchronized(_config_lock, shared=1)
181
182
183
184
185
186
  def GenerateUniqueID(self, exceptions=None):
    """Generate an unique disk name.

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

Iustin Pop's avatar
Iustin Pop committed
187
188
189
190
    @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)
191

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

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

210
211
212
213
214
215
216
  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
217
218
219
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
220
221
222
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
223
224
225
226
227
228
229
230
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

231
232
233
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
234
235
236
    @rtype: list
    @return: the list of all DRBD secrets

237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    """
    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

253
254
255
256
257
258
259
260
261
262
263
264
265
266
  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 = []
267
268
269
270
271
272
273
274
275
276
    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)
277
278
279
280
281
282

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

283
  def _UnlockedVerifyConfig(self):
284
285
    """Verify function.

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

Iustin Pop's avatar
Iustin Pop committed
290
291
292
    """
    result = []
    seen_macs = []
293
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
294
    data = self._config_data
295
296
    seen_lids = []
    seen_pids = []
297
298
299
300
301
302
303
304
305
306
307
308
309
310

    # 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
311
312
313
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
314
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
315
316
317
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
318
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
319
320
321
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
322
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
323
324
325
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340

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

341
342
343
344
      # 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()])
345
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
346

347
    # cluster-wide pool of free ports
348
    for free_port in data.cluster.tcpudp_port_pool:
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
      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:
364
      if keys[-1] > data.cluster.highest_used_port:
365
        result.append("Highest used port mismatch, saved %s, computed %s" %
366
367
                      (data.cluster.highest_used_port, keys[-1]))

368
369
370
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

371
    # master candidate checks
372
373
374
375
    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
376

377
378
379
380
381
382
383
384
    # 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))

385
386
387
388
389
390
    # 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
391
392
    return result

393
394
395
396
397
398
399
400
401
402
403
404
405
  @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()

406
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
407
408
409
410
411
412
413
414
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
417
418
419
    """
    if disk.children:
      for child in disk.children:
420
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
421
422
423

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

444
445
446
447
448
449
450
451
452
453
454
455
456
457
  @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)
458
459
460
461
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
462
    if not isinstance(port, int):
463
      raise errors.ProgrammerError("Invalid type passed for port")
464

465
    self._config_data.cluster.tcpudp_port_pool.add(port)
466
467
    self._WriteConfig()

468
  @locking.ssynchronized(_config_lock, shared=1)
469
  def GetPortList(self):
470
471
472
    """Returns a copy of the current port list.

    """
473
    return self._config_data.cluster.tcpudp_port_pool.copy()
474

475
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
476
477
478
  def AllocatePort(self):
    """Allocate a port.

479
480
481
    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
482
483

    """
484
    # If there are TCP/IP ports configured, we use them first.
485
486
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
487
488
489
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
490
491
492
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
493
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
494
495
496
497

    self._WriteConfig()
    return port

498
  def _UnlockedComputeDRBDMap(self):
499
500
    """Compute the used DRBD minor/nodes.

501
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
502
503
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
504
505
506
        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
507
508
509

    """
    def _AppendUsedPorts(instance_name, disk, used):
510
      duplicates = []
511
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
512
513
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
514
515
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
516
          if port in used[node]:
517
518
519
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
520
521
      if disk.children:
        for child in disk.children:
522
523
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
524

525
    duplicates = []
526
    my_dict = dict((node, {}) for node in self._config_data.nodes)
527
528
529
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
530
    for (node, minor), instance in self._temporary_drbds.iteritems():
531
      if minor in my_dict[node] and my_dict[node][minor] != instance:
532
533
534
535
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
536

537
538
539
540
541
542
543
544
545
546
547
  @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).

    """
548
549
550
551
552
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
553

554
555
556
557
558
559
560
561
562
  @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.

563
564
565
    @type instance: string
    @param instance: the instance for which we allocate minors

566
    """
567
    assert isinstance(instance, basestring), \
568
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
569

570
571
572
573
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
574
575
576
577
578
579
580
    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
581
        self._temporary_drbds[(nname, 0)] = instance
582
583
584
585
586
587
588
589
590
591
        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
592
593
594
595
596
      # 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]))
597
      ndata[minor] = instance
598
599
600
601
602
603
604
605
      # 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)
606
607
608
609
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

610
  def _UnlockedReleaseDRBDMinors(self, instance):
611
612
613
614
615
616
617
    """Release temporary drbd minors allocated for a given instance.

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

    """
618
619
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
620
621
622
623
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
  @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)

641
642
643
644
645
646
647
648
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
  @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.

    """
696
    return self._config_data.cluster.enabled_hypervisors[0]
697

698
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
699
700
701
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
702
703
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
704
705
706
707

    """
    return self._config_data.cluster.rsahostkeypub

708
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
709
710
711
712
713
  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
714
715
716
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
717
718
719
720
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

721
722
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
723
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
724

725
726
727
728
729
730
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
          " MAC address '%s' already in use." % (instance.name, nic.mac))

731
    instance.serial_no = 1
732
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
733
    self._config_data.instances[instance.name] = instance
734
    self._config_data.cluster.serial_no += 1
735
    self._UnlockedReleaseDRBDMinors(instance.name)
736
737
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
738
739
    self._WriteConfig()

740
741
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
742
743

    """
744
745
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
746
747

    if instance_name not in self._config_data.instances:
748
749
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
750
    instance = self._config_data.instances[instance_name]
751
752
    if instance.admin_up != status:
      instance.admin_up = status
753
      instance.serial_no += 1
754
      instance.mtime = time.time()
755
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
756

757
  @locking.ssynchronized(_config_lock)
758
759
760
761
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
762
    self._SetInstanceStatus(instance_name, True)
763

764
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
765
766
767
768
769
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
770
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
771
    del self._config_data.instances[instance_name]
772
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
773
774
    self._WriteConfig()

775
  @locking.ssynchronized(_config_lock)
776
777
778
779
780
781
782
783
784
785
786
787
788
  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
789
790
791
792
793
794
795
796
797
798

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

799
800
801
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

802
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
803
804
805
806
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
807
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
808

809
810
811
812
813
814
815
816
  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()

817
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
818
819
820
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
821
822
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
823
824

    """
825
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
826

827
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
828
829
830
831
832
833
834
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
                                    self._config_data.instances.keys())

835
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
836
    """Returns information about an instance.
837
838
839
840
841
842
843
844
845

    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]

846
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
847
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
848
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
849

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

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

Iustin Pop's avatar
Iustin Pop committed
856
857
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
858
859

    """
860
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
861

862
863
864
865
866
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
867
    @return: dict of (instance, instance_info), where instance_info is what
868
869
870
              would GetInstanceInfo return for the node

    """
871
872
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
873
874
    return my_dict

875
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
876
877
878
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
879
880
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
881
882

    """
883
884
    logging.info("Adding node %s to configuration" % node.name)

885
    node.serial_no = 1
886
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
887
    self._config_data.nodes[node.name] = node
888
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
889
890
    self._WriteConfig()

891
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
892
893
894
895
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
896
897
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
898
    if node_name not in self._config_data.nodes:
899
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
900
901

    del self._config_data.nodes[node_name]
902
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
903
904
    self._WriteConfig()

905
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
906
907
908
909
910
911
912
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
                                    self._config_data.nodes.keys())

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

Iustin Pop's avatar
Iustin Pop committed
916
917
    This function is for internal use, when the config lock is already
    held.
918

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

Iustin Pop's avatar
Iustin Pop committed
921
922
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
923
924
925
926
927
928
929

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

    return self._config_data.nodes[node_name]

930
931
932
933
934

  @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
935
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
936

Iustin Pop's avatar
Iustin Pop committed
937
938
939
940
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
941
942
943
944
945

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
948
949
950
951
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
952

Iustin Pop's avatar
Iustin Pop committed
953
954
955
    """
    return self._config_data.nodes.keys()

956
957
958
959
960
961
962
963

  @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
964
965
966
967
968
969
970
971
972
  @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]

973
974
975
976
977
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
978
    @return: dict of (node, node_info), where node_info is what
979
980
981
982
983
984
985
              would GetNodeInfo return for the node

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

986
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
987
988
    """Get the number of current and maximum desired and possible candidates.

989
990
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
991
992
993
994
995
    @rtype: tuple
    @return: tuple of (current, desired and possible)

    """
    mc_now = mc_max = 0
996
997
998
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
999
      if not (node.offline or node.drained):
1000
1001
1002
1003
1004
1005
1006
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
    mc_max = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_max)

  @locking.ssynchronized(_config_lock, shared=1)
1007
  def GetMasterCandidateStats(self, exceptions=None):
1008
1009
1010
1011
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1012
1013
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1014
1015
1016
1017
    @rtype: tuple
    @return: tuple of (current, max)

    """
1018
    return self._UnlockedGetMasterCandidateStats(exceptions)
1019
1020
1021
1022
1023
1024

  @locking.ssynchronized(_config_lock)
  def MaintainCandidatePool(self):
    """Try to grow the candidate pool to the desired size.

    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1025
    @return: list with the adjusted nodes (L{objects.Node} instances)
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036

    """
    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()
    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]
1037
        if node.master_candidate or node.offline or node.drained:
1038
          continue
Iustin Pop's avatar
Iustin Pop committed
1039
        mod_list.append(node)
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
        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
1053
1054
1055
1056
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1057
    self._config_data.serial_no += 1
1058
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1059
1060
1061
1062
1063

  def _OpenConfig(self):
    """Read the config data from disk.

    """
1064
1065
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1066
    try:
1067
1068
1069
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1070
1071
1072
1073

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

Iustin Pop's avatar
Iustin Pop committed
1074
    if (not hasattr(data, 'cluster') or
1075
        not hasattr(data.cluster, 'rsahostkeypub')):
1076
      raise errors.ConfigurationError("Incomplete configuration"
1077
                                      " (missing cluster.rsahostkeypub)")
1078
1079
1080
1081

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1082
    self._config_data = data
1083
    # reset the last serial as -1 so that the next write will cause
1084
1085
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097

  def _DistributeConfig(self):
    """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
    bad = False

1098
1099
1100
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1101
1102
1103
1104
    # 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
1105
1106
1107
1108
1109
1110
1111
1112
    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)
1113

1114
1115
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
                                            address_list=addr_list)
1116
    for to_node, to_result in result.items():
1117
      msg = to_result.fail_msg
1118
1119
      if msg:
        msg = ("Copy of file %s to node %s failed: %s" %
1120
               (self._cfg_file, to_node, msg))
1121
        logging.error(msg)
Iustin Pop's avatar
Iustin Pop committed
1122
1123
1124
1125
1126
1127
1128
        bad = True
    return not bad

  def _WriteConfig(self, destination=None):
    """Write the configuration data to persistent storage.

    """
1129
1130
1131
1132
    # first, cleanup the _temporary_ids set, if an ID is now in the
    # other objects it should be discarded to prevent unbounded growth
    # of that structure
    self._CleanupTemporaryIDs()
1133
1134
1135
1136
1137
    config_errors = self._UnlockedVerifyConfig()
    if config_errors:
      raise errors.ConfigurationError("Configuration data is not"
                                      " consistent: %s" %
                                      (", ".join(config_errors)))
Iustin Pop's avatar
Iustin Pop committed
1138
1139
1140
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1141
    txt = serializer.Dump(self._config_data.ToDict())
1142
1143
1144

    utils.WriteFile(destination, data=txt)

1145
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
1146

1147
    # and redistribute the config file to master candidates
Iustin Pop's avatar
Iustin Pop committed
1148
1149
    self._DistributeConfig()

1150
    # Write ssconf files on all nodes (including locally)
1151
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1152
      if not self._offline:
1153
1154
1155
1156
        result = rpc.RpcRunner.call_write_ssconf_files(\
          self._UnlockedGetNodeList(),
          self._UnlockedGetSsconfValues())
        for nname, nresu in result.items():
1157
          msg = nresu.fail_msg
1158
1159
1160
          if msg:
            logging.warning("Error while uploading ssconf files to"
                            " node %s: %s", nname, msg)
1161
      self._last_cluster_serial = self._config_data.cluster.serial_no
1162

1163
  def _UnlockedGetSsconfValues(self):
Iustin Pop's avatar
Iustin Pop committed
1164
1165
1166
1167
1168
1169
1170
    """Return the values needed by ssconf.

    @rtype: dict
    @return: a dictionary with keys the ssconf names and values their
        associated value

    """
1171
    fn = "\n".join
1172
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1173
1174
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1175
    node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1176
                    for ninfo in node_info]
1177
    node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1178
                    for ninfo in node_info]
1179

1180
    instance_data = fn(instance_names)
1181
    off_data = fn(node.name for node in node_info if node.offline)
1182
    on_data = fn(node.name for node in node_info if not node.offline)
1183
    mc_data = fn(node.name for node in node_info if node.master_candidate)
1184
1185
    mc_ips_data = fn(node.primary_ip for node in node_info
                     if node.master_candidate)
1186
    node_data = fn(node_names)
1187
1188
    node_pri_ips_data = fn(node_pri_ips)
    node_snd_ips_data = fn(node_snd_ips)
1189