config.py 30 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
52
def _ValidateConfig(data):
  if data.version != constants.CONFIG_VERSION:
53
54
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
55
                                    (data.version,
56
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
57

58

Iustin Pop's avatar
Iustin Pop committed
59
class ConfigWriter:
60
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
61

62
  """
Iustin Pop's avatar
Iustin Pop committed
63
  def __init__(self, cfg_file=None, offline=False):
64
    self.write_count = 0
65
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
66
67
68
69
70
71
    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
72
    self._temporary_ids = set()
73
    self._temporary_drbds = {}
74
75
76
77
78
    # 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
Iustin Pop's avatar
Iustin Pop committed
79
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
80
81
82
83
84
85
86
87
88

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

89
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
  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:
108
      raise errors.ConfigurationError("Can't generate unique MAC")
Iustin Pop's avatar
Iustin Pop committed
109
110
    return mac

111
  @locking.ssynchronized(_config_lock, shared=1)
112
113
114
115
116
117
118
119
120
121
  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

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
  @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

140
141
142
143
144
145
146
147
148
149
150
  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

151
  @locking.ssynchronized(_config_lock, shared=1)
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  def GenerateUniqueID(self, exceptions=None):
    """Generate an unique disk name.

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

    Args:
      - 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

    Returns: the unique id as a string

    """
    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:
176
      unique_id = utils.NewUUID()
177
178
179
      if unique_id not in existing and unique_id is not None:
        break
    else:
180
181
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
182
183
184
    self._temporary_ids.add(unique_id)
    return unique_id

Iustin Pop's avatar
Iustin Pop committed
185
186
187
188
189
190
191
192
193
194
195
  def _AllMACs(self):
    """Return all MACs present in the config.

    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

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

215
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
216
217
218
219
220
  def VerifyConfig(self):
    """Stub verify function.
    """
    result = []
    seen_macs = []
221
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
222
223
224
225
    data = self._config_data
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
226
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
227
228
229
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
230
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
231
232
233
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
234
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
235
236
237
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274

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

    # cluster-wide pool of free ports
    for free_port in self._config_data.cluster.tcpudp_port_pool:
      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:
      if keys[-1] > self._config_data.cluster.highest_used_port:
        result.append("Highest used port mismatch, saved %s, computed %s" %
                      (self._config_data.cluster.highest_used_port,
                       keys[-1]))

Iustin Pop's avatar
Iustin Pop committed
275
276
    return result

277
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
278
279
280
281
282
283
284
285
    """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.

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

Iustin Pop's avatar
Iustin Pop committed
288
289
290
    """
    if disk.children:
      for child in disk.children:
291
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
292
293
294

    if disk.logical_id is None and disk.physical_id is not None:
      return
295
    if disk.dev_type == constants.LD_DRBD8:
296
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
297
      if node_name not in (pnode, snode):
298
299
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
300
301
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
302
303
304
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
305
306
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
307
      if pnode == node_name:
308
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
309
      else: # it must be secondary, we tested above
310
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
311
312
313
314
    else:
      disk.physical_id = disk.logical_id
    return

315
316
317
318
319
320
321
322
323
324
325
326
327
328
  @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)
329
330
331
332
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
333
    if not isinstance(port, int):
334
      raise errors.ProgrammerError("Invalid type passed for port")
335

336
    self._config_data.cluster.tcpudp_port_pool.add(port)
337
338
    self._WriteConfig()

339
  @locking.ssynchronized(_config_lock, shared=1)
340
  def GetPortList(self):
341
342
343
    """Returns a copy of the current port list.

    """
344
    return self._config_data.cluster.tcpudp_port_pool.copy()
345

346
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
347
348
349
  def AllocatePort(self):
    """Allocate a port.

350
351
352
    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
353
354

    """
355
    # If there are TCP/IP ports configured, we use them first.
356
357
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
358
359
360
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
361
362
363
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
364
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
365
366
367
368

    self._WriteConfig()
    return port

369
370
371
372
373
374
375
376
377
  def _ComputeDRBDMap(self, instance):
    """Compute the used DRBD minor/nodes.

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

    """
    def _AppendUsedPorts(instance_name, disk, used):
378
379
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
        nodeA, nodeB, dummy, minorA, minorB = disk.logical_id[:5]
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
        for node, port in ((nodeA, minorA), (nodeB, minorB)):
          assert node in used, "Instance node not found in node list"
          if port in used[node]:
            raise errors.ProgrammerError("DRBD minor already used:"
                                         " %s/%s, %s/%s" %
                                         (node, port, instance_name,
                                          used[node][port]))

          used[node][port] = instance_name
      if disk.children:
        for child in disk.children:
          _AppendUsedPorts(instance_name, child, used)

    my_dict = dict((node, {}) for node in self._config_data.nodes)
    for (node, minor), instance in self._temporary_drbds.iteritems():
      my_dict[node][minor] = instance
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        _AppendUsedPorts(instance.name, disk, my_dict)
    return my_dict

  @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.

    """
    d_map = self._ComputeDRBDMap(instance)
    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
419
        self._temporary_drbds[(nname, 0)] = instance
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
        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
      result.append(minor)
      ndata[minor] = instance
      assert (nname, minor) not in self._temporary_drbds, \
             "Attempt to reuse reserved DRBD minor"
      self._temporary_drbds[(nname, minor)] = instance
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

  @locking.ssynchronized(_config_lock)
  def ReleaseDRBDMinors(self, instance):
    """Release temporary drbd minors allocated for a given instance.

    This should be called on both the error paths and on the success
    paths (after the instance has been added or updated).

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

    """
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
  @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.

    """
510
    return self._config_data.cluster.default_hypervisor
511

512
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
513
514
515
516
517
518
519
520
521
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

    Args: None

    Returns: rsa hostkey
    """
    return self._config_data.cluster.rsahostkeypub

522
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
523
524
525
526
527
528
529
530
531
532
533
  def AddInstance(self, instance):
    """Add an instance to the config.

    This should be used after creating a new instance.

    Args:
      instance: the instance object
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

534
535
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
536
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
537

538
    instance.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
539
    self._config_data.instances[instance.name] = instance
540
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
541
542
    self._WriteConfig()

543
544
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
545
546

    """
547
548
549
550
    if status not in ("up", "down"):
      raise errors.ProgrammerError("Invalid status '%s' passed to"
                                   " ConfigWriter._SetInstanceStatus()" %
                                   status)
Iustin Pop's avatar
Iustin Pop committed
551
552

    if instance_name not in self._config_data.instances:
553
554
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
555
    instance = self._config_data.instances[instance_name]
556
557
    if instance.status != status:
      instance.status = status
558
      instance.serial_no += 1
559
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
560

561
  @locking.ssynchronized(_config_lock)
562
563
564
565
566
567
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
    self._SetInstanceStatus(instance_name, "up")

568
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
569
570
571
572
573
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
574
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
575
    del self._config_data.instances[instance_name]
576
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
577
578
    self._WriteConfig()

579
  @locking.ssynchronized(_config_lock)
580
581
582
583
584
585
586
587
588
589
590
591
592
  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
593
594
595
596
597
598
599
600
601
602

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

603
    self._config_data.instances[inst.name] = inst
604
    self._config_data.cluster.serial_no += 1
605
606
    self._WriteConfig()

607
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
608
609
610
611
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
612
    self._SetInstanceStatus(instance_name, "down")
Iustin Pop's avatar
Iustin Pop committed
613

614
615
616
617
618
619
620
621
  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()

622
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
623
624
625
626
627
628
629
630
  def GetInstanceList(self):
    """Get the list of instances.

    Returns:
      array of instances, ex. ['instance2.example.com','instance1.example.com']
      these contains all the instances, also the ones in Admin_down state

    """
631
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
632

633
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637
638
639
640
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

641
642
643
644
645
646
647
648
649
650
651
  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]

652
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
653
654
655
656
657
658
659
660
661
662
663
664
665
  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.

    Args:
      instance: name of the instance, ex instance1.example.com

    Returns:
      the instance object

    """
666
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
667

668
669
670
671
672
673
674
675
676
  @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

    """
677
678
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
679
680
    return my_dict

681
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
682
683
684
685
686
687
688
  def AddNode(self, node):
    """Add a node to the configuration.

    Args:
      node: an object.Node instance

    """
689
690
    logging.info("Adding node %s to configuration" % node.name)

691
    node.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
692
    self._config_data.nodes[node.name] = node
693
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
694
695
    self._WriteConfig()

696
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
697
698
699
700
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
701
702
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
703
    if node_name not in self._config_data.nodes:
704
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
705
706

    del self._config_data.nodes[node_name]
707
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
708
709
    self._WriteConfig()

710
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
711
712
713
714
715
716
717
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

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

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

Iustin Pop's avatar
Iustin Pop committed
723
724
725
726
727
728
729
730
731
732
    Args: node: nodename (tuple) of the node

    Returns: the node object

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

    return self._config_data.nodes[node_name]

733
734
735
736
737
738
739
740
741
742
743
744
745

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

    Args: node: nodename (tuple) of the node

    Returns: the node object

    """
    return self._UnlockedGetNodeInfo(node_name)

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

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

Iustin Pop's avatar
Iustin Pop committed
750
751
752
    """
    return self._config_data.nodes.keys()

753
754
755
756
757
758
759
760

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

    """
    return self._UnlockedGetNodeList()

761
762
763
764
765
766
767
768
769
770
771
772
773
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
    @returns: dict of (node, node_info), where node_info is what
              would GetNodeInfo return for the node

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

Iustin Pop's avatar
Iustin Pop committed
774
775
776
777
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
778
    self._config_data.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
779
780
781
782
783
784
785
786
787
788
789
790

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

    In case we already have configuration data and the config file has
    the same mtime as when we read it, we skip the parsing of the
    file, since de-serialisation could be slow.

    """
    f = open(self._cfg_file, 'r')
    try:
      try:
791
        data = objects.ConfigData.FromDict(serializer.Load(f.read()))
Iustin Pop's avatar
Iustin Pop committed
792
      except Exception, err:
793
        raise errors.ConfigurationError(err)
Iustin Pop's avatar
Iustin Pop committed
794
795
    finally:
      f.close()
Michael Hanselmann's avatar
Michael Hanselmann committed
796
797
798
799

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

Iustin Pop's avatar
Iustin Pop committed
800
    if (not hasattr(data, 'cluster') or
801
        not hasattr(data.cluster, 'rsahostkeypub')):
802
      raise errors.ConfigurationError("Incomplete configuration"
803
                                      " (missing cluster.rsahostkeypub)")
Iustin Pop's avatar
Iustin Pop committed
804
805
806
807
808
809
810
811
812
813
814
815
    self._config_data = data

  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
816
    nodelist = self._UnlockedGetNodeList()
817
    myhostname = self._my_hostname
Iustin Pop's avatar
Iustin Pop committed
818

819
820
821
822
    try:
      nodelist.remove(myhostname)
    except ValueError:
      pass
823
824
825
826
827
828
829
830
831
    # 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
    address_list = [self._UnlockedGetNodeInfo(name).primary_ip
                    for name in nodelist]

    result = rpc.RpcRunner.call_upload_file(nodelist, self._cfg_file,
                                            address_list=address_list)
832
    for node in nodelist:
Iustin Pop's avatar
Iustin Pop committed
833
      if not result[node]:
Iustin Pop's avatar
Iustin Pop committed
834
835
        logging.error("copy of file %s to node %s failed",
                      self._cfg_file, node)
Iustin Pop's avatar
Iustin Pop committed
836
837
838
839
840
841
842
843
844
845
        bad = True
    return not bad

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

    """
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
846
    txt = serializer.Dump(self._config_data.ToDict())
Iustin Pop's avatar
Iustin Pop committed
847
848
849
850
    dir_name, file_name = os.path.split(destination)
    fd, name = tempfile.mkstemp('.newconfig', file_name, dir_name)
    f = os.fdopen(fd, 'w')
    try:
851
      f.write(txt)
Iustin Pop's avatar
Iustin Pop committed
852
853
854
855
856
      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)
857
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
858

859
    # and redistribute the config file
Iustin Pop's avatar
Iustin Pop committed
860
861
    self._DistributeConfig()

862
863
864
    # Write ssconf files on all nodes (including locally)
    rpc.RpcRunner.call_write_ssconf_files(self._UnlockedGetNodeList())

865
  @locking.ssynchronized(_config_lock)
866
  def InitConfig(self, version, cluster_config, master_node_config):
Iustin Pop's avatar
Iustin Pop committed
867
868
869
    """Create the initial cluster configuration.

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

872
873
    @type version: int
    @param version: Configuration version
874
875
876
877
878
879
880
881
882
883
    @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,
      }

884
885
    self._config_data = objects.ConfigData(version=version,
                                           cluster=cluster_config,
886
                                           nodes=nodes,
Iustin Pop's avatar
Iustin Pop committed
887
                                           instances={},
888
                                           serial_no=1)
Iustin Pop's avatar
Iustin Pop committed
889
890
    self._WriteConfig()

891
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
892
893
894
895
896
897
  def GetVGName(self):
    """Return the volume group name.

    """
    return self._config_data.cluster.volume_group_name

898
  @locking.ssynchronized(_config_lock)
899
900
901
902
  def SetVGName(self, vg_name):
    """Set the volume group name.

    """
903
    self._config_data.cluster.volume_group_name = vg_name
904
    self._config_data.cluster.serial_no += 1
905
906
    self._WriteConfig()

907
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
908
909
910
911
912
913
  def GetDefBridge(self):
    """Return the default bridge.

    """
    return self._config_data.cluster.default_bridge

914
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
915
916
917
918
919
  def GetMACPrefix(self):
    """Return the mac prefix.

    """
    return self._config_data.cluster.mac_prefix
920

921
  @locking.ssynchronized(_config_lock, shared=1)
922
923
924
925
926
927
928
929
  def GetClusterInfo(self):
    """Returns informations about the cluster

    Returns:
      the cluster object

    """
    return self._config_data.cluster
930

931
  @locking.ssynchronized(_config_lock)
932
933
934
935
936
937
938
939
940
941
942
  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.

    """
    if self._config_data is None:
943
944
      raise errors.ProgrammerError("Configuration file not read,"
                                   " cannot save.")
945
946
947
948
949
950
951
    if isinstance(target, objects.Cluster):
      test = target == self._config_data.cluster
    elif isinstance(target, objects.Node):
      test = target in self._config_data.nodes.values()
    elif isinstance(target, objects.Instance):
      test = target in self._config_data.instances.values()
    else:
952
953
      raise errors.ProgrammerError("Invalid object type (%s) passed to"
                                   " ConfigWriter.Update" % type(target))
954
    if not test:
955
956
      raise errors.ConfigurationError("Configuration updated since object"
                                      " has been read or unknown object")
957
958
    target.serial_no += 1

959
    self._WriteConfig()