config.py 41.1 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

Iustin Pop's avatar
Iustin Pop committed
210
211
212
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
213
214
215
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
216
217
218
219
220
221
222
223
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

224
225
226
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
227
228
229
    @rtype: list
    @return: the list of all DRBD secrets

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
    """
    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

246
247
248
249
250
251
252
253
254
255
256
257
258
259
  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 = []
260
261
262
263
264
265
266
267
268
269
    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)
270
271
272
273
274
275

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

276
  def _UnlockedVerifyConfig(self):
277
278
    """Verify function.

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

Iustin Pop's avatar
Iustin Pop committed
283
284
285
    """
    result = []
    seen_macs = []
286
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
287
    data = self._config_data
288
289
    seen_lids = []
    seen_pids = []
290
291
292
293
294
295
296
297
298
299
300
301
302
303

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

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

334
335
336
337
      # 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()])
338
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
339

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

361
362
363
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

364
    # master candidate checks
365
366
367
368
    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))
369

370
371
372
373
374
375
376
377
    # 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))

378
379
380
381
382
383
    # 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
384
385
    return result

386
387
388
389
390
391
392
393
394
395
396
397
398
  @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()

399
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
400
401
402
403
404
405
406
407
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
410
411
412
    """
    if disk.children:
      for child in disk.children:
413
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
414
415
416

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

437
438
439
440
441
442
443
444
445
446
447
448
449
450
  @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)
451
452
453
454
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
455
    if not isinstance(port, int):
456
      raise errors.ProgrammerError("Invalid type passed for port")
457

458
    self._config_data.cluster.tcpudp_port_pool.add(port)
459
460
    self._WriteConfig()

461
  @locking.ssynchronized(_config_lock, shared=1)
462
  def GetPortList(self):
463
464
465
    """Returns a copy of the current port list.

    """
466
    return self._config_data.cluster.tcpudp_port_pool.copy()
467

468
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
469
470
471
  def AllocatePort(self):
    """Allocate a port.

472
473
474
    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
475
476

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

    self._WriteConfig()
    return port

491
  def _UnlockedComputeDRBDMap(self):
492
493
    """Compute the used DRBD minor/nodes.

494
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
495
496
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
497
498
499
        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
500
501
502

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

518
    duplicates = []
519
    my_dict = dict((node, {}) for node in self._config_data.nodes)
520
521
522
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
523
    for (node, minor), instance in self._temporary_drbds.iteritems():
524
      if minor in my_dict[node] and my_dict[node][minor] != instance:
525
526
527
528
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
529

530
531
532
533
534
535
536
537
538
539
540
  @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).

    """
541
542
543
544
545
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
546

547
548
549
550
551
552
553
554
555
  @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.

556
557
558
    @type instance: string
    @param instance: the instance for which we allocate minors

559
    """
560
    assert isinstance(instance, basestring), \
561
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
562

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

603
  def _UnlockedReleaseDRBDMinors(self, instance):
604
605
606
607
608
609
610
    """Release temporary drbd minors allocated for a given instance.

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

    """
611
612
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
613
614
615
616
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
  @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)

634
635
636
637
638
639
640
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
  @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.

    """
689
    return self._config_data.cluster.enabled_hypervisors[0]
690

691
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
692
693
694
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
695
696
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
697
698
699
700

    """
    return self._config_data.cluster.rsahostkeypub

701
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
702
703
704
705
706
  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
707
708
709
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
710
711
712
713
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

714
715
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
716
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
717

718
719
720
721
722
723
    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))

724
    instance.serial_no = 1
725
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
726
    self._config_data.instances[instance.name] = instance
727
    self._config_data.cluster.serial_no += 1
728
    self._UnlockedReleaseDRBDMinors(instance.name)
729
730
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
731
732
    self._WriteConfig()

733
734
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
735
736

    """
737
738
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
739
740

    if instance_name not in self._config_data.instances:
741
742
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
743
    instance = self._config_data.instances[instance_name]
744
745
    if instance.admin_up != status:
      instance.admin_up = status
746
      instance.serial_no += 1
747
      instance.mtime = time.time()
748
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
749

750
  @locking.ssynchronized(_config_lock)
751
752
753
754
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
755
    self._SetInstanceStatus(instance_name, True)
756

757
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
758
759
760
761
762
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
763
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
764
    del self._config_data.instances[instance_name]
765
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
766
767
    self._WriteConfig()

768
  @locking.ssynchronized(_config_lock)
769
770
771
772
773
774
775
776
777
778
779
780
781
  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
782
783
784
785
786
787
788
789
790
791

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

792
793
794
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

795
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
796
797
798
799
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
800
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
801

802
803
804
805
806
807
808
809
  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()

810
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
811
812
813
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
814
815
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
816
817

    """
818
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
819

820
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
821
822
823
824
825
826
827
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

828
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
829
    """Returns information about an instance.
830
831
832
833
834
835
836
837
838

    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]

839
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
840
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
841
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
842

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

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

Iustin Pop's avatar
Iustin Pop committed
849
850
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
851
852

    """
853
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
854

855
856
857
858
859
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
860
    @return: dict of (instance, instance_info), where instance_info is what
861
862
863
              would GetInstanceInfo return for the node

    """
864
865
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
866
867
    return my_dict

868
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
869
870
871
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
872
873
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
874
875

    """
876
877
    logging.info("Adding node %s to configuration" % node.name)

878
    node.serial_no = 1
879
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
880
    self._config_data.nodes[node.name] = node
881
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
882
883
    self._WriteConfig()

884
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
885
886
887
888
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
889
890
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
891
    if node_name not in self._config_data.nodes:
892
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
893
894

    del self._config_data.nodes[node_name]
895
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
896
897
    self._WriteConfig()

898
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
899
900
901
902
903
904
905
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

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

Iustin Pop's avatar
Iustin Pop committed
909
910
    This function is for internal use, when the config lock is already
    held.
911

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

Iustin Pop's avatar
Iustin Pop committed
914
915
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
916
917
918
919
920
921
922

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

    return self._config_data.nodes[node_name]

923
924
925
926
927

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

Iustin Pop's avatar
Iustin Pop committed
930
931
932
933
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
934
935
936
937
938

    """
    return self._UnlockedGetNodeInfo(node_name)

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

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

    @rtype: list
945

Iustin Pop's avatar
Iustin Pop committed
946
947
948
    """
    return self._config_data.nodes.keys()

949
950
951
952
953
954
955
956

  @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
957
958
959
960
961
962
963
964
965
  @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]

966
967
968
969
970
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
971
    @return: dict of (node, node_info), where node_info is what
972
973
974
975
976
977
978
              would GetNodeInfo return for the node

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

979
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
980
981
    """Get the number of current and maximum desired and possible candidates.

982
983
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
984
985
986
987
988
    @rtype: tuple
    @return: tuple of (current, desired and possible)

    """
    mc_now = mc_max = 0
989
990
991
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
992
      if not (node.offline or node.drained):
993
994
995
996
997
998
999
        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)
1000
  def GetMasterCandidateStats(self, exceptions=None):
1001
1002
1003
1004
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1005
1006
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1007
1008
1009
1010
    @rtype: tuple
    @return: tuple of (current, max)

    """
1011
    return self._UnlockedGetMasterCandidateStats(exceptions)
1012
1013
1014
1015
1016
1017

  @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
1018
    @return: list with the adjusted nodes (L{objects.Node} instances)
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029

    """
    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]
1030
        if node.master_candidate or node.offline or node.drained:
1031
          continue
Iustin Pop's avatar
Iustin Pop committed
1032
        mod_list.append(node)
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
        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
1046
1047
1048
1049
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1050
    self._config_data.serial_no += 1
1051
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1052
1053
1054
1055
1056

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

    """
1057
1058
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1059
    try:
1060
1061
1062
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1063
1064
1065
1066

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

Iustin Pop's avatar
Iustin Pop committed
1067
    if (not hasattr(data, 'cluster') or
1068
        not hasattr(data.cluster, 'rsahostkeypub')):
1069
      raise errors.ConfigurationError("Incomplete configuration"
1070
                                      " (missing cluster.rsahostkeypub)")
1071
1072
1073
1074

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1075
    self._config_data = data
1076
    # reset the last serial as -1 so that the next write will cause
1077
1078
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090

  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

1091
1092
1093
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1094
1095
1096
1097
    # 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
1098
1099
1100
1101
1102
1103
1104
1105
    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)
1106

1107
1108
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
                                            address_list=addr_list)
1109
    for to_node, to_result in result.items():
1110
      msg = to_result.fail_msg
1111
1112
      if msg:
        msg = ("Copy of file %s to node %s failed: %s" %
1113
               (self._cfg_file, to_node, msg))
1114
        logging.error(msg)
Iustin Pop's avatar
Iustin Pop committed
1115
1116
1117
1118
1119
1120
1121
        bad = True
    return not bad

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

    """
1122
1123
1124
1125
1126
    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
1127
1128
1129
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1130
    txt = serializer.Dump(self._config_data.ToDict())
1131
1132
1133

    utils.WriteFile(destination, data=txt)

1134
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
1135

1136
    # and redistribute the config file to master candidates
Iustin Pop's avatar
Iustin Pop committed
1137
1138
    self._DistributeConfig()

1139
    # Write ssconf files on all nodes (including locally)
1140
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1141
      if not self._offline:
1142
1143
1144
1145
        result = rpc.RpcRunner.call_write_ssconf_files(\
          self._UnlockedGetNodeList(),
          self._UnlockedGetSsconfValues())
        for nname, nresu in result.items():
1146
          msg = nresu.fail_msg
1147
1148
1149
          if msg:
            logging.warning("Error while uploading ssconf files to"
                            " node %s: %s", nname, msg)
1150
      self._last_cluster_serial = self._config_data.cluster.serial_no
1151

1152
  def _UnlockedGetSsconfValues(self):
Iustin Pop's avatar
Iustin Pop committed
1153
1154
1155
1156
1157
1158
1159
    """Return the values needed by ssconf.

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

    """
1160
    fn = "\n".join
1161
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1162
1163
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1164
    node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1165
                    for ninfo in node_info]
1166
    node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1167
                    for ninfo in node_info]
1168

1169
    instance_data = fn(instance_names)
1170
    off_data = fn(node.name for node in node_info if node.offline)
1171
    on_data = fn(node.name for node in node_info if not node.offline)
1172
    mc_data = fn(node.name for node in node_info if node.master_candidate)
1173
1174
    mc_ips_data = fn(node.primary_ip for node in node_info
                     if node.master_candidate)
1175
    node_data = fn(node_names)
1176
1177
    node_pri_ips_data = fn(node_pri_ips)
    node_snd_ips_data = fn(node_snd_ips)
1178

Iustin Pop's avatar
Iustin Pop committed
1179
    cluster = self._config_data.cluster
1180
    cluster_tags = fn(cluster.GetTags())
1181
    return {