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

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Configuration management for Ganeti

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

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

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

"""

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

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


48
49
50
_config_lock = locking.SharedLock()


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

  This only verifies the version of the configuration.

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

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

66

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

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

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

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

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

    This should check the current instances for duplicates.

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

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

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

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

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

    This checks the current disks for duplicates.

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

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

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

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

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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
186
187
    @rtype: string
    @return: the unique id
188
189

    """
190
    existing = self._AllIDs(include_temporary=True)
191
192
    retries = 64
    while retries > 0:
193
      unique_id = utils.NewUUID()
194
195
196
      if unique_id not in existing and unique_id is not None:
        break
    else:
197
198
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
199
200
201
    self._temporary_ids.add(unique_id)
    return unique_id

202
  @locking.ssynchronized(_config_lock, shared=1)
203
  def GenerateUniqueID(self):
204
205
206
207
208
    """Generate an unique ID.

    This is just a wrapper over the unlocked version.

    """
209
    return self._GenerateUniqueID()
210

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

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

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

    return result

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

386
387
388
389
390
391
    # 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))

392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
    # IP checks
    ips = { data.cluster.master_ip: ["cluster_ip"] }
    def _helper(ip, name):
      if ip in ips:
        ips[ip].append(name)
      else:
        ips[ip] = [name]

    for node in data.nodes.values():
      _helper(node.primary_ip, "node:%s/primary" % node.name)
      if node.secondary_ip != node.primary_ip:
        _helper(node.secondary_ip, "node:%s/secondary" % node.name)

    for ip, owners in ips.items():
      if len(owners) > 1:
        result.append("IP address %s is used by multiple owners: %s" %
                      (ip, ", ".join(owners)))
Iustin Pop's avatar
Iustin Pop committed
409
410
    return result

411
412
413
414
415
416
417
418
419
420
421
422
423
  @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()

424
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
425
426
427
428
429
430
431
432
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
435
436
437
    """
    if disk.children:
      for child in disk.children:
438
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
439
440
441

    if disk.logical_id is None and disk.physical_id is not None:
      return
442
    if disk.dev_type == constants.LD_DRBD8:
443
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
444
      if node_name not in (pnode, snode):
445
446
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
447
448
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
449
450
451
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
452
453
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
454
      if pnode == node_name:
455
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
456
      else: # it must be secondary, we tested above
457
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
458
459
460
461
    else:
      disk.physical_id = disk.logical_id
    return

462
463
464
465
466
467
468
469
470
471
472
473
474
475
  @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)
476
477
478
479
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
480
    if not isinstance(port, int):
481
      raise errors.ProgrammerError("Invalid type passed for port")
482

483
    self._config_data.cluster.tcpudp_port_pool.add(port)
484
485
    self._WriteConfig()

486
  @locking.ssynchronized(_config_lock, shared=1)
487
  def GetPortList(self):
488
489
490
    """Returns a copy of the current port list.

    """
491
    return self._config_data.cluster.tcpudp_port_pool.copy()
492

493
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
494
495
496
  def AllocatePort(self):
    """Allocate a port.

497
498
499
    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
500
501

    """
502
    # If there are TCP/IP ports configured, we use them first.
503
504
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
505
506
507
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
508
509
510
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
511
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
512
513
514
515

    self._WriteConfig()
    return port

516
  def _UnlockedComputeDRBDMap(self):
517
518
    """Compute the used DRBD minor/nodes.

519
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
520
521
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
522
523
524
        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
525
526
527

    """
    def _AppendUsedPorts(instance_name, disk, used):
528
      duplicates = []
529
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
530
531
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
532
533
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
534
          if port in used[node]:
535
536
537
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
538
539
      if disk.children:
        for child in disk.children:
540
541
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
542

543
    duplicates = []
544
    my_dict = dict((node, {}) for node in self._config_data.nodes)
545
546
547
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
548
    for (node, minor), instance in self._temporary_drbds.iteritems():
549
      if minor in my_dict[node] and my_dict[node][minor] != instance:
550
551
552
553
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
554

555
556
557
558
559
560
561
562
563
564
565
  @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).

    """
566
567
568
569
570
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
571

572
573
574
575
576
577
578
579
580
  @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.

581
582
583
    @type instance: string
    @param instance: the instance for which we allocate minors

584
    """
585
    assert isinstance(instance, basestring), \
586
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
587

588
589
590
591
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
592
593
594
595
596
597
598
    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
599
        self._temporary_drbds[(nname, 0)] = instance
600
601
602
603
604
605
606
607
608
609
        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
610
611
612
613
614
      # 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]))
615
      ndata[minor] = instance
616
617
618
619
620
621
622
623
      # 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)
624
625
626
627
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

628
  def _UnlockedReleaseDRBDMinors(self, instance):
629
630
631
632
633
634
635
    """Release temporary drbd minors allocated for a given instance.

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

    """
636
637
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
638
639
640
641
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
  @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)

659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
  @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.

    """
714
    return self._config_data.cluster.enabled_hypervisors[0]
715

716
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
717
718
719
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
720
721
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
722
723
724
725

    """
    return self._config_data.cluster.rsahostkeypub

726
  @locking.ssynchronized(_config_lock)
727
  def AddInstance(self, instance, ec_id):
Iustin Pop's avatar
Iustin Pop committed
728
729
730
731
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
732
733
734
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
735
736
737
738
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

739
740
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
741
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
742

743
744
745
746
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
747
748
749
                                        " MAC address '%s' already in use." %
                                        (instance.name, nic.mac))

750
    self._EnsureUUID(instance, ec_id)
751

752
    instance.serial_no = 1
753
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
754
    self._config_data.instances[instance.name] = instance
755
    self._config_data.cluster.serial_no += 1
756
    self._UnlockedReleaseDRBDMinors(instance.name)
757
758
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
759
760
    self._WriteConfig()

761
  def _EnsureUUID(self, item, ec_id):
762
763
764
    """Ensures a given object has a valid UUID.

    @param item: the instance or node to be checked
765
    @param ec_id: the execution context id for the uuid reservation
766
767
768
769
770
771
772
773

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

774
775
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
776
777

    """
778
779
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
780
781

    if instance_name not in self._config_data.instances:
782
783
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
784
    instance = self._config_data.instances[instance_name]
785
786
    if instance.admin_up != status:
      instance.admin_up = status
787
      instance.serial_no += 1
788
      instance.mtime = time.time()
789
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
790

791
  @locking.ssynchronized(_config_lock)
792
793
794
795
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
796
    self._SetInstanceStatus(instance_name, True)
797

798
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
799
800
801
802
803
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
804
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
805
    del self._config_data.instances[instance_name]
806
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
807
808
    self._WriteConfig()

809
  @locking.ssynchronized(_config_lock)
810
811
812
813
814
815
816
817
818
819
820
821
822
  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
823
824
825
826
827
828
829
830
831
832

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

833
834
835
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

836
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
837
838
839
840
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
841
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
842

843
844
845
846
847
848
849
850
  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()

851
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
852
853
854
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
855
856
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
857
858

    """
859
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
860

861
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
862
863
864
865
866
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
867
868
                                    self._config_data.instances.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
869

870
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
871
    """Returns information about an instance.
872
873
874
875
876
877
878
879
880

    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]

881
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
882
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
883
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
884

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

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

Iustin Pop's avatar
Iustin Pop committed
891
892
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
893
894

    """
895
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
896

897
898
899
900
901
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
902
    @return: dict of (instance, instance_info), where instance_info is what
903
904
905
              would GetInstanceInfo return for the node

    """
906
907
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
908
909
    return my_dict

910
  @locking.ssynchronized(_config_lock)
911
  def AddNode(self, node, ec_id):
Iustin Pop's avatar
Iustin Pop committed
912
913
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
914
915
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
916
917

    """
918
    logging.info("Adding node %s to configuration", node.name)
919

920
    self._EnsureUUID(node, ec_id)
921

922
    node.serial_no = 1
923
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
924
    self._config_data.nodes[node.name] = node
925
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
926
927
    self._WriteConfig()

928
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
929
930
931
932
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
933
    logging.info("Removing node %s from configuration", node_name)
934

Iustin Pop's avatar
Iustin Pop committed
935
    if node_name not in self._config_data.nodes:
936
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
937
938

    del self._config_data.nodes[node_name]
939
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
940
941
    self._WriteConfig()

942
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
943
944
945
946
947
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
948
949
                                    self._config_data.nodes.keys(),
                                    case_sensitive=False)
Iustin Pop's avatar
Iustin Pop committed
950

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

Iustin Pop's avatar
Iustin Pop committed
954
955
    This function is for internal use, when the config lock is already
    held.
956

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

Iustin Pop's avatar
Iustin Pop committed
959
960
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
961
962
963
964
965
966
967

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

    return self._config_data.nodes[node_name]

968
969
970
971
972

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

Iustin Pop's avatar
Iustin Pop committed
975
976
977
978
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
979
980
981
982
983

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
986
987
988
989
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
990

Iustin Pop's avatar
Iustin Pop committed
991
992
993
    """
    return self._config_data.nodes.keys()

994
995
996
997
998
999
1000
1001

  @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
1002
1003
1004
1005
1006
1007
1008
1009
1010
  @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]

1011
1012
1013
1014
1015
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
1016
    @return: dict of (node, node_info), where node_info is what
1017
1018
1019
1020
1021
1022
1023
              would GetNodeInfo return for the node

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

1024
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
1025
1026
    """Get the number of current and maximum desired and possible candidates.

1027
1028
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1029
    @rtype: tuple
1030
    @return: tuple of (current, desired and possible, possible)
1031
1032

    """
1033
    mc_now = mc_should = mc_max = 0
1034
1035
1036
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
1037
      if not (node.offline or node.drained):
1038
1039
1040
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
1041
1042
    mc_should = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_should, mc_max)
1043
1044

  @locking.ssynchronized(_config_lock, shared=1)
1045
  def GetMasterCandidateStats(self, exceptions=None):
1046
1047
1048
1049
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

1050
1051
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1052
1053
1054
1055
    @rtype: tuple
    @return: tuple of (current, max)

    """
1056
    return self._UnlockedGetMasterCandidateStats(exceptions)
1057
1058

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

Guido Trotter's avatar
Guido Trotter committed
1062
1063
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
1064
    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1065
    @return: list with the adjusted nodes (L{objects.Node} instances)
1066
1067

    """
Guido Trotter's avatar
Guido Trotter committed
1068
    mc_now, mc_max, _ = self._UnlockedGetMasterCandidateStats(exceptions)
1069
1070
1071
1072
1073
1074
1075
1076
    mod_list = []
    if mc_now < mc_max:
      node_list = self._config_data.nodes.keys()
      random.shuffle(node_list)
      for name in node_list:
        if mc_now >= mc_max:
          break
        node = self._config_data.nodes[name]
Guido Trotter's avatar
Guido Trotter committed
1077
1078
        if (node.master_candidate or node.offline or node.drained or
            node.name in exceptions):
1079
          continue
Iustin Pop's avatar
Iustin Pop committed
1080
        mod_list.append(node)
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
        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
1094
1095
1096
1097
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1098
    self._config_data.serial_no += 1
1099
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1100

1101
1102
1103
1104
1105
1106
1107
1108
  def _AllUUIDObjects(self):
    """Returns all objects with uuid attributes.

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

Iustin Pop's avatar
Iustin Pop committed
1109
1110
1111
1112
  def _OpenConfig(self):
    """Read the config data from disk.

    """
1113
1114
    raw_data = utils.ReadFile(self._cfg_file)

Iustin Pop's avatar
Iustin Pop committed
1115
    try:
1116
1117
1118
      data = objects.ConfigData.FromDict(serializer.Load(raw_data))
    except Exception, err:
      raise errors.ConfigurationError(err)
Michael Hanselmann's avatar
Michael Hanselmann committed
1119
1120
1121
1122

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

Iustin Pop's avatar
Iustin Pop committed
1123
    if (not hasattr(data, 'cluster') or
1124
        not hasattr(data.cluster, 'rsahostkeypub')):
1125
      raise errors.ConfigurationError("Incomplete configuration"
1126
                                      " (missing cluster.rsahostkeypub)")
1127
1128
1129
1130

    # Upgrade configuration if needed
    data.UpgradeConfig()

Iustin Pop's avatar
Iustin Pop committed
1131
    self._config_data = data
1132
    # reset the last serial as -1 so that the next write will cause
1133
1134
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1135

1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
    # And finally run our (custom) config upgrade sequence
    self._UpgradeConfig()

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

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

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

    """
    modified = False
    for item in self._AllUUIDObjects():
      if item.uuid is None:
1153
        item.uuid = self._GenerateUniqueID()
1154
1155
1156
1157
        modified = True
    if modified:
      self._WriteConfig()

1158
  def _DistributeConfig(self, feedback_fn):
Iustin Pop's avatar
Iustin Pop committed
1159
1160
1161
1162
1163
1164
1165
1166
    """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
1167

Iustin Pop's avatar
Iustin Pop committed
1168
1169
    bad = False

1170
1171
1172
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1173
1174
1175
1176
    # 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
1177
1178
1179
1180
1181
1182
1183
1184
    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)