config.py 38.6 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
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
83
84
85
86
    # 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
87
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
88
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
89
90
91
92
93
94
95
96
97

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

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

120
  @locking.ssynchronized(_config_lock, shared=1)
121
122
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()
    return mac in all_macs

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

149
150
151
152
153
154
155
156
157
158
159
  def _ComputeAllLVs(self):
    """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

160
  @locking.ssynchronized(_config_lock, shared=1)
161
162
163
164
165
166
  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
167
168
169
170
    @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)
171

Iustin Pop's avatar
Iustin Pop committed
172
173
    @rtype: string
    @return: the unique id
174
175
176
177
178
179
180
181
182
183
184

    """
    existing = set()
    existing.update(self._temporary_ids)
    existing.update(self._ComputeAllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
    if exceptions is not None:
      existing.update(exceptions)
    retries = 64
    while retries > 0:
185
      unique_id = utils.NewUUID()
186
187
188
      if unique_id not in existing and unique_id is not None:
        break
    else:
189
190
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
191
192
193
    self._temporary_ids.add(unique_id)
    return unique_id

Iustin Pop's avatar
Iustin Pop committed
194
195
196
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
197
198
199
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
200
201
202
203
204
205
206
207
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

208
209
210
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
211
212
213
    @rtype: list
    @return: the list of all DRBD secrets

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    """
    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

230
  def _UnlockedVerifyConfig(self):
231
232
    """Verify function.

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

Iustin Pop's avatar
Iustin Pop committed
237
238
239
    """
    result = []
    seen_macs = []
240
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
241
242
243
244
    data = self._config_data
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
245
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
246
247
248
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
249
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
250
251
252
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
253
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
254
255
256
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271

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

272
273
274
275
276
      # 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()])

277
    # cluster-wide pool of free ports
278
    for free_port in data.cluster.tcpudp_port_pool:
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
      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:
294
      if keys[-1] > data.cluster.highest_used_port:
295
        result.append("Highest used port mismatch, saved %s, computed %s" %
296
297
                      (data.cluster.highest_used_port, keys[-1]))

298
299
300
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

301
    # master candidate checks
302
303
304
305
    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))
306

307
308
309
310
311
312
313
314
    # 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))

315
316
317
318
319
320
    # 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
321
322
    return result

323
324
325
326
327
328
329
330
331
332
333
334
335
  @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()

336
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
337
338
339
340
341
342
343
344
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
347
348
349
    """
    if disk.children:
      for child in disk.children:
350
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
351
352
353

    if disk.logical_id is None and disk.physical_id is not None:
      return
354
    if disk.dev_type == constants.LD_DRBD8:
355
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
356
      if node_name not in (pnode, snode):
357
358
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
359
360
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
361
362
363
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
364
365
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
366
      if pnode == node_name:
367
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
368
      else: # it must be secondary, we tested above
369
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
370
371
372
373
    else:
      disk.physical_id = disk.logical_id
    return

374
375
376
377
378
379
380
381
382
383
384
385
386
387
  @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)
388
389
390
391
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
392
    if not isinstance(port, int):
393
      raise errors.ProgrammerError("Invalid type passed for port")
394

395
    self._config_data.cluster.tcpudp_port_pool.add(port)
396
397
    self._WriteConfig()

398
  @locking.ssynchronized(_config_lock, shared=1)
399
  def GetPortList(self):
400
401
402
    """Returns a copy of the current port list.

    """
403
    return self._config_data.cluster.tcpudp_port_pool.copy()
404

405
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
406
407
408
  def AllocatePort(self):
    """Allocate a port.

409
410
411
    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
412
413

    """
414
    # If there are TCP/IP ports configured, we use them first.
415
416
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
417
418
419
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
420
421
422
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
423
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
424
425
426
427

    self._WriteConfig()
    return port

428
  def _UnlockedComputeDRBDMap(self):
429
430
    """Compute the used DRBD minor/nodes.

431
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
432
433
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
434
435
436
        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
437
438
439

    """
    def _AppendUsedPorts(instance_name, disk, used):
440
      duplicates = []
441
442
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
        nodeA, nodeB, dummy, minorA, minorB = disk.logical_id[:5]
443
        for node, port in ((nodeA, minorA), (nodeB, minorB)):
444
445
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
446
          if port in used[node]:
447
448
449
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
450
451
      if disk.children:
        for child in disk.children:
452
453
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
454

455
    duplicates = []
456
    my_dict = dict((node, {}) for node in self._config_data.nodes)
457
458
459
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
460
    for (node, minor), instance in self._temporary_drbds.iteritems():
461
      if minor in my_dict[node] and my_dict[node][minor] != instance:
462
463
464
465
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
466

467
468
469
470
471
472
473
474
475
476
477
  @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).

    """
478
479
480
481
482
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
483

484
485
486
487
488
489
490
491
492
  @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.

493
494
495
    @type instance: string
    @param instance: the instance for which we allocate minors

496
    """
497
    assert isinstance(instance, basestring), \
498
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
499

500
501
502
503
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
504
505
506
507
508
509
510
    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
511
        self._temporary_drbds[(nname, 0)] = instance
512
513
514
515
516
517
518
519
520
521
        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
522
523
524
525
526
      # 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]))
527
      ndata[minor] = instance
528
529
530
531
532
533
534
535
      # 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)
536
537
538
539
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

540
  def _UnlockedReleaseDRBDMinors(self, instance):
541
542
543
544
545
546
547
    """Release temporary drbd minors allocated for a given instance.

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

    """
548
549
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
550
551
552
553
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
  @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)

571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
  @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.

    """
626
    return self._config_data.cluster.default_hypervisor
627

628
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
629
630
631
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
632
633
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637

    """
    return self._config_data.cluster.rsahostkeypub

638
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
639
640
641
642
643
  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
644
645
646
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
647
648
649
650
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

651
652
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
653
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
654

655
    instance.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
656
    self._config_data.instances[instance.name] = instance
657
    self._config_data.cluster.serial_no += 1
658
    self._UnlockedReleaseDRBDMinors(instance.name)
Iustin Pop's avatar
Iustin Pop committed
659
660
    self._WriteConfig()

661
662
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
663
664

    """
665
666
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
667
668

    if instance_name not in self._config_data.instances:
669
670
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
671
    instance = self._config_data.instances[instance_name]
672
673
    if instance.admin_up != status:
      instance.admin_up = status
674
      instance.serial_no += 1
675
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
676

677
  @locking.ssynchronized(_config_lock)
678
679
680
681
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
682
    self._SetInstanceStatus(instance_name, True)
683

684
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
685
686
687
688
689
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
690
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
691
    del self._config_data.instances[instance_name]
692
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
693
694
    self._WriteConfig()

695
  @locking.ssynchronized(_config_lock)
696
697
698
699
700
701
702
703
704
705
706
707
708
  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
709
710
711
712
713
714
715
716
717
718

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

719
720
721
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

722
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
723
724
725
726
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
727
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
728

729
730
731
732
733
734
735
736
  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()

737
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
738
739
740
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
741
742
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
743
744

    """
745
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
746

747
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
748
749
750
751
752
753
754
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

755
756
757
758
759
760
761
762
763
764
765
  def _UnlockedGetInstanceInfo(self, instance_name):
    """Returns informations about an instance.

    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]

766
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
767
768
769
770
771
772
  def GetInstanceInfo(self, instance_name):
    """Returns informations about an instance.

    It takes the information from the configuration file. Other informations of
    an instance are taken from the live systems.

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

Iustin Pop's avatar
Iustin Pop committed
776
777
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
778
779

    """
780
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
781

782
783
784
785
786
787
788
789
790
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
    @returns: dict of (instance, instance_info), where instance_info is what
              would GetInstanceInfo return for the node

    """
791
792
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
793
794
    return my_dict

795
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
796
797
798
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
799
800
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
801
802

    """
803
804
    logging.info("Adding node %s to configuration" % node.name)

805
    node.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
806
    self._config_data.nodes[node.name] = node
807
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
808
809
    self._WriteConfig()

810
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
811
812
813
814
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
815
816
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
817
    if node_name not in self._config_data.nodes:
818
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
819
820

    del self._config_data.nodes[node_name]
821
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
822
823
    self._WriteConfig()

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

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

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

Iustin Pop's avatar
Iustin Pop committed
835
836
    This function is for internal use, when the config lock is already
    held.
837

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

Iustin Pop's avatar
Iustin Pop committed
840
841
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
842
843
844
845
846
847
848

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

    return self._config_data.nodes[node_name]

849
850
851
852
853

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

Iustin Pop's avatar
Iustin Pop committed
856
857
858
859
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
860
861
862
863
864

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
867
868
869
870
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
871

Iustin Pop's avatar
Iustin Pop committed
872
873
874
    """
    return self._config_data.nodes.keys()

875
876
877
878
879
880
881
882

  @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
883
884
885
886
887
888
889
890
891
  @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]

892
893
894
895
896
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
897
    @return: dict of (node, node_info), where node_info is what
898
899
900
901
902
903
904
              would GetNodeInfo return for the node

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

905
906
907
908
909
910
911
912
913
  def _UnlockedGetMasterCandidateStats(self):
    """Get the number of current and maximum desired and possible candidates.

    @rtype: tuple
    @return: tuple of (current, desired and possible)

    """
    mc_now = mc_max = 0
    for node in self._config_data.nodes.itervalues():
914
      if not (node.offline or node.drained):
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
        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)
  def GetMasterCandidateStats(self):
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

    @rtype: tuple
    @return: tuple of (current, max)

    """
    return self._UnlockedGetMasterCandidateStats()

  @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
938
    @return: list with the adjusted nodes (L{objects.Node} instances)
939
940
941
942
943
944
945
946
947
948
949

    """
    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]
950
        if node.master_candidate or node.offline or node.drained:
951
          continue
Iustin Pop's avatar
Iustin Pop committed
952
        mod_list.append(node)
953
954
955
956
957
958
959
960
961
962
963
964
965
        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
966
967
968
969
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
970
    self._config_data.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
971
972
973
974
975
976
977
978

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

    """
    f = open(self._cfg_file, 'r')
    try:
      try:
979
        data = objects.ConfigData.FromDict(serializer.Load(f.read()))
Iustin Pop's avatar
Iustin Pop committed
980
      except Exception, err:
981
        raise errors.ConfigurationError(err)
Iustin Pop's avatar
Iustin Pop committed
982
983
    finally:
      f.close()
Michael Hanselmann's avatar
Michael Hanselmann committed
984
985
986
987

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

Iustin Pop's avatar
Iustin Pop committed
988
    if (not hasattr(data, 'cluster') or
989
        not hasattr(data.cluster, 'rsahostkeypub')):
990
      raise errors.ConfigurationError("Incomplete configuration"
991
                                      " (missing cluster.rsahostkeypub)")
Iustin Pop's avatar
Iustin Pop committed
992
    self._config_data = data
993
    # reset the last serial as -1 so that the next write will cause
994
995
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007

  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

1008
1009
1010
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1011
1012
1013
1014
    # 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
1015
1016
1017
1018
1019
1020
1021
1022
    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)
1023

1024
1025
1026
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
                                            address_list=addr_list)
    for node in node_list:
Iustin Pop's avatar
Iustin Pop committed
1027
      if not result[node]:
Iustin Pop's avatar
Iustin Pop committed
1028
1029
        logging.error("copy of file %s to node %s failed",
                      self._cfg_file, node)
Iustin Pop's avatar
Iustin Pop committed
1030
1031
1032
1033
1034
1035
1036
        bad = True
    return not bad

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

    """
1037
1038
1039
1040
1041
    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
1042
1043
1044
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1045
    txt = serializer.Dump(self._config_data.ToDict())
Iustin Pop's avatar
Iustin Pop committed
1046
1047
1048
1049
    dir_name, file_name = os.path.split(destination)
    fd, name = tempfile.mkstemp('.newconfig', file_name, dir_name)
    f = os.fdopen(fd, 'w')
    try:
1050
      f.write(txt)
Iustin Pop's avatar
Iustin Pop committed
1051
1052
1053
1054
1055
      os.fsync(f.fileno())
    finally:
      f.close()
    # we don't need to do os.close(fd) as f.close() did it
    os.rename(name, destination)
1056
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
1057

1058
    # and redistribute the config file to master candidates
Iustin Pop's avatar
Iustin Pop committed
1059
1060
    self._DistributeConfig()

1061
    # Write ssconf files on all nodes (including locally)
1062
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1063
      if not self._offline:
1064
1065
        rpc.RpcRunner.call_write_ssconf_files(self._UnlockedGetNodeList(),
                                              self._UnlockedGetSsconfValues())
1066
      self._last_cluster_serial = self._config_data.cluster.serial_no
1067

1068
  def _UnlockedGetSsconfValues(self):
Iustin Pop's avatar
Iustin Pop committed
1069
1070
1071
1072
1073
1074
1075
    """Return the values needed by ssconf.

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

    """
1076
    fn = "\n".join
1077
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1078
1079
1080
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]

1081
    instance_data = fn(instance_names)
1082
    off_data = fn(node.name for node in node_info if node.offline)
1083
    on_data = fn(node.name for node in node_info if not node.offline)
1084
1085
    mc_data = fn(node.name for node in node_info if node.master_candidate)
    node_data = fn(node_names)
1086

Iustin Pop's avatar
Iustin Pop committed
1087
    cluster = self._config_data.cluster
1088
    return {
Iustin Pop's avatar
Iustin Pop committed
1089
1090
      constants.SS_CLUSTER_NAME: cluster.cluster_name,
      constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1091
      constants.SS_MASTER_CANDIDATES: mc_data,
Iustin Pop's avatar
Iustin Pop committed
1092
1093
1094
      constants.SS_MASTER_IP: cluster.master_ip,
      constants.SS_MASTER_NETDEV: cluster.master_netdev,
      constants.SS_MASTER_NODE: cluster.master_node,
1095
1096
      constants.SS_NODE_LIST: node_data,
      constants.SS_OFFLINE_NODES: off_data,
1097
1098
      constants.SS_ONLINE_NODES: on_data,
      constants.SS_INSTANCE_LIST: instance_data,
1099
      constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1100
1101
      }

1102
  @locking.ssynchronized(_config_lock)
1103
  def InitConfig(self, version, cluster_config, master_node_config):
Iustin Pop's avatar
Iustin Pop committed
1104
1105
1106
    """Create the initial cluster configuration.

    It will contain the current node, which will also be the master
1107
    node, and no instances.
Iustin Pop's avatar
Iustin Pop committed
1108

1109
1110
    @type version: int
    @param version: Configuration version
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
    @type cluster_config: objects.Cluster
    @param cluster_config: Cluster configuration
    @type master_node_config: objects.Node
    @param master_node_config: Master node configuration

    """
    nodes = {
      master_node_config.name: master_node_config,
      }

1121
1122
    self._config_data = objects.ConfigData(version=version,
                                           cluster=cluster_config,
1123
                                           nodes=nodes,
Iustin Pop's avatar
Iustin Pop committed
1124
                                           instances={},
1125
                                           serial_no=1)
Iustin Pop's avatar
Iustin Pop committed
1126
1127
    self._WriteConfig()

1128
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1129
1130
1131
1132
1133
1134
  def GetVGName(self):
    """Return the volume group name.

    """
    return self._config_data.cluster.volume_group_name

1135
  @locking.ssynchronized(_config_lock)
1136
1137
1138
1139
  def SetVGName(self, vg_name):
    """Set the volume group name.

    """
1140
    self._config_data.cluster.volume_group_name = vg_name
1141
    self._config_data.cluster.serial_no += 1
1142
1143
    self._WriteConfig()

1144
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1145
1146
1147
1148
1149
1150
  def GetDefBridge(self):
    """Return the default bridge.

    """
    return self._config_data.cluster.default_bridge

1151
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1152
1153
1154
1155
1156
  def GetMACPrefix(self):
    """Return the mac prefix.

    """
    return self._config_data.cluster.mac_prefix
1157

1158
  @locking.ssynchronized(_config_lock, shared=1)
1159
1160
1161
  def GetClusterInfo(self):
    """Returns informations about the cluster

Iustin Pop's avatar
Iustin Pop committed
1162
1163
    @rtype: L{objects.Cluster}
    @return: the cluster object
1164
1165
1166

    """
    return self._config_data.cluster
1167

1168
  @locking.ssynchronized(_config_lock)
1169
1170
1171
1172
1173
1174
1175
1176
1177
  def Update(self, target):
    """Notify function to be called after updates.

    This function must be called when an object (as returned by
    GetInstanceInfo, GetNodeInfo, GetCluster) has been updated and the
    caller wants the modifications saved to the backing store. Note
    that all modified objects will be saved, but the target argument
    is the one the caller wants to ensure that it's saved.

Iustin Pop's avatar
Iustin Pop committed
1178
1179
1180
1181
    @param target: an instance of either L{objects.Cluster},
        L{objects.Node} or L{objects.Instance} which is existing in
        the cluster

1182
1183
    """
    if self._config_data is None:
1184
1185
      raise errors.ProgrammerError("Configuration file not read,"
                                   " cannot save.")
Iustin Pop's avatar
Iustin Pop committed
1186
    update_serial = False
1187
1188
1189
1190
    if isinstance(target, objects.Cluster):
      test = target == self._config_data.cluster
    elif isinstance(target, objects.Node):
      test = target in self._config_data.nodes.values()
Iustin Pop's avatar
Iustin Pop committed
1191
      update_serial = True
1192
1193
1194
    elif isinstance(target, objects.Instance):
      test = target in self._config_data.instances.values()
    else:
1195
1196
      raise errors.ProgrammerError("Invalid object type (%s) passed to"
                                   " ConfigWriter.Update" % type(target))
1197
    if not test:
1198
1199
      raise errors.ConfigurationError("Configuration updated since object"
                                      " has been read or unknown object")
Iustin Pop's avatar
Iustin Pop committed
1200
1201
    target.serial_no += 1

1202
    if update_serial:
Iustin Pop's avatar
Iustin Pop committed
1203
1204
      # for node updates, we need to increase the cluster serial too
      self._config_data.cluster.serial_no += 1
1205