config.py 39.8 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
    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
152
153
154
155
156
157
158
159
160
161
  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

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

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

    """
    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:
187
      unique_id = utils.NewUUID()
188
189
190
      if unique_id not in existing and unique_id is not None:
        break
    else:
191
192
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
193
194
195
    self._temporary_ids.add(unique_id)
    return unique_id

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

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

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

    return result

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

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

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

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
    """Compute duplicate disk IDs

    @type disk: L{objects.Disk}
    @param disk: the disk at which to start searching
    @type l_ids: list
    @param l_ids: list of current logical ids
    @type p_ids: list
    @param p_ids: list of current physical ids
    @rtype: list
    @return: a list of error messages

    """
    result = []
    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 in p_ids:
      result.append("duplicate physical id %s" % str(disk.physical_id))
    else:
      p_ids.append(disk.physical_id)

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

260
  def _UnlockedVerifyConfig(self):
261
262
    """Verify function.

263
264
265
266
    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

Iustin Pop's avatar
Iustin Pop committed
267
268
269
    """
    result = []
    seen_macs = []
270
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
271
    data = self._config_data
272
273
    seen_lids = []
    seen_pids = []
Iustin Pop's avatar
Iustin Pop committed
274
275
276
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
277
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
278
279
280
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
281
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
282
283
284
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
285
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
286
287
288
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303

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

304
305
306
307
      # 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()])
308
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
309

310
    # cluster-wide pool of free ports
311
    for free_port in data.cluster.tcpudp_port_pool:
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
      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:
327
      if keys[-1] > data.cluster.highest_used_port:
328
        result.append("Highest used port mismatch, saved %s, computed %s" %
329
330
                      (data.cluster.highest_used_port, keys[-1]))

331
332
333
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

334
    # master candidate checks
335
336
337
338
    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))
339

340
341
342
343
344
345
346
347
    # 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))

348
349
350
351
352
353
    # 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
354
355
    return result

356
357
358
359
360
361
362
363
364
365
366
367
368
  @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()

369
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
370
371
372
373
374
375
376
377
    """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.

378
379
    This function is for internal use, when the config lock is already held.

Iustin Pop's avatar
Iustin Pop committed
380
381
382
    """
    if disk.children:
      for child in disk.children:
383
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
384
385
386

    if disk.logical_id is None and disk.physical_id is not None:
      return
387
    if disk.dev_type == constants.LD_DRBD8:
388
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
389
      if node_name not in (pnode, snode):
390
391
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
392
393
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
394
395
396
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
397
398
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
399
      if pnode == node_name:
400
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
401
      else: # it must be secondary, we tested above
402
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
403
404
405
406
    else:
      disk.physical_id = disk.logical_id
    return

407
408
409
410
411
412
413
414
415
416
417
418
419
420
  @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)
421
422
423
424
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
425
    if not isinstance(port, int):
426
      raise errors.ProgrammerError("Invalid type passed for port")
427

428
    self._config_data.cluster.tcpudp_port_pool.add(port)
429
430
    self._WriteConfig()

431
  @locking.ssynchronized(_config_lock, shared=1)
432
  def GetPortList(self):
433
434
435
    """Returns a copy of the current port list.

    """
436
    return self._config_data.cluster.tcpudp_port_pool.copy()
437

438
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
439
440
441
  def AllocatePort(self):
    """Allocate a port.

442
443
444
    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
445
446

    """
447
    # If there are TCP/IP ports configured, we use them first.
448
449
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
450
451
452
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
453
454
455
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
456
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
457
458
459
460

    self._WriteConfig()
    return port

461
  def _UnlockedComputeDRBDMap(self):
462
463
    """Compute the used DRBD minor/nodes.

464
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
465
466
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
467
468
469
        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
470
471
472

    """
    def _AppendUsedPorts(instance_name, disk, used):
473
      duplicates = []
474
475
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
        nodeA, nodeB, dummy, minorA, minorB = disk.logical_id[:5]
476
        for node, port in ((nodeA, minorA), (nodeB, minorB)):
477
478
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
479
          if port in used[node]:
480
481
482
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
483
484
      if disk.children:
        for child in disk.children:
485
486
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
487

488
    duplicates = []
489
    my_dict = dict((node, {}) for node in self._config_data.nodes)
490
491
492
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
493
    for (node, minor), instance in self._temporary_drbds.iteritems():
494
      if minor in my_dict[node] and my_dict[node][minor] != instance:
495
496
497
498
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
499

500
501
502
503
504
505
506
507
508
509
510
  @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).

    """
511
512
513
514
515
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
516

517
518
519
520
521
522
523
524
525
  @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.

526
527
528
    @type instance: string
    @param instance: the instance for which we allocate minors

529
    """
530
    assert isinstance(instance, basestring), \
531
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
532

533
534
535
536
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
537
538
539
540
541
542
543
    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
544
        self._temporary_drbds[(nname, 0)] = instance
545
546
547
548
549
550
551
552
553
554
        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
555
556
557
558
559
      # 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]))
560
      ndata[minor] = instance
561
562
563
564
565
566
567
568
      # 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)
569
570
571
572
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

573
  def _UnlockedReleaseDRBDMinors(self, instance):
574
575
576
577
578
579
580
    """Release temporary drbd minors allocated for a given instance.

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

    """
581
582
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
583
584
585
586
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
  @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)

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
  @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.

    """
659
    return self._config_data.cluster.default_hypervisor
660

661
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
662
663
664
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
665
666
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
667
668
669
670

    """
    return self._config_data.cluster.rsahostkeypub

671
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
672
673
674
675
676
  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
677
678
679
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
680
681
682
683
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

684
685
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
686
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
687

688
    instance.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
689
    self._config_data.instances[instance.name] = instance
690
    self._config_data.cluster.serial_no += 1
691
    self._UnlockedReleaseDRBDMinors(instance.name)
692
693
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
694
695
    self._WriteConfig()

696
697
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
698
699

    """
700
701
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
702
703

    if instance_name not in self._config_data.instances:
704
705
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
706
    instance = self._config_data.instances[instance_name]
707
708
    if instance.admin_up != status:
      instance.admin_up = status
709
      instance.serial_no += 1
710
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
711

712
  @locking.ssynchronized(_config_lock)
713
714
715
716
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
717
    self._SetInstanceStatus(instance_name, True)
718

719
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
720
721
722
723
724
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
725
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
726
    del self._config_data.instances[instance_name]
727
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
728
729
    self._WriteConfig()

730
  @locking.ssynchronized(_config_lock)
731
732
733
734
735
736
737
738
739
740
741
742
743
  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
744
745
746
747
748
749
750
751
752
753

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

754
755
756
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

757
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
758
759
760
761
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
762
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
763

764
765
766
767
768
769
770
771
  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()

772
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
773
774
775
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
776
777
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
778
779

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

782
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
783
784
785
786
787
788
789
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

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

790
791
792
793
794
795
796
797
798
799
800
  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]

801
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
802
803
804
805
806
807
  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
808
809
    @param instance_name: name of the instance, e.g.
        I{instance1.example.com}
Iustin Pop's avatar
Iustin Pop committed
810

Iustin Pop's avatar
Iustin Pop committed
811
812
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
813
814

    """
815
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
816

817
818
819
820
821
822
823
824
825
  @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

    """
826
827
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
828
829
    return my_dict

830
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
831
832
833
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
834
835
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
836
837

    """
838
839
    logging.info("Adding node %s to configuration" % node.name)

840
    node.serial_no = 1
Iustin Pop's avatar
Iustin Pop committed
841
    self._config_data.nodes[node.name] = node
842
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
843
844
    self._WriteConfig()

845
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
846
847
848
849
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
850
851
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
852
    if node_name not in self._config_data.nodes:
853
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
854
855

    del self._config_data.nodes[node_name]
856
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
857
858
    self._WriteConfig()

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

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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
875
876
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
877
878
879
880
881
882
883

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

    return self._config_data.nodes[node_name]

884
885
886
887
888

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

Iustin Pop's avatar
Iustin Pop committed
891
892
893
894
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
895
896
897
898
899

    """
    return self._UnlockedGetNodeInfo(node_name)

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

Iustin Pop's avatar
Iustin Pop committed
902
903
904
905
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
906

Iustin Pop's avatar
Iustin Pop committed
907
908
909
    """
    return self._config_data.nodes.keys()

910
911
912
913
914
915
916
917

  @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
918
919
920
921
922
923
924
925
926
  @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]

927
928
929
930
931
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
932
    @return: dict of (node, node_info), where node_info is what
933
934
935
936
937
938
939
              would GetNodeInfo return for the node

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

940
941
942
943
944
945
946
947
948
  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():
949
      if not (node.offline or node.drained):
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
        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
973
    @return: list with the adjusted nodes (L{objects.Node} instances)
974
975
976
977
978
979
980
981
982
983
984

    """
    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]
985
        if node.master_candidate or node.offline or node.drained:
986
          continue
Iustin Pop's avatar
Iustin Pop committed
987
        mod_list.append(node)
988
989
990
991
992
993
994
995
996
997
998
999
1000
        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
1001
1002
1003
1004
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1005
    self._config_data.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
1006
1007
1008
1009
1010
1011
1012
1013

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

    """
    f = open(self._cfg_file, 'r')
    try:
      try:
1014
        data = objects.ConfigData.FromDict(serializer.Load(f.read()))
Iustin Pop's avatar
Iustin Pop committed
1015
      except Exception, err:
1016
        raise errors.ConfigurationError(err)
Iustin Pop's avatar
Iustin Pop committed
1017
1018
    finally:
      f.close()
Michael Hanselmann's avatar
Michael Hanselmann committed
1019
1020
1021
1022

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

Iustin Pop's avatar
Iustin Pop committed
1023
    if (not hasattr(data, 'cluster') or
1024
        not hasattr(data.cluster, 'rsahostkeypub')):
1025
      raise errors.ConfigurationError("Incomplete configuration"
1026
                                      " (missing cluster.rsahostkeypub)")
Iustin Pop's avatar
Iustin Pop committed
1027
    self._config_data = data
1028
    # reset the last serial as -1 so that the next write will cause
1029
1030
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042

  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

1043
1044
1045
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1046
1047
1048
1049
    # 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
1050
1051
1052
1053
1054
1055
1056
1057
    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)
1058

1059
1060
1061
    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
1062
      if not result[node]:
Iustin Pop's avatar
Iustin Pop committed
1063
1064
        logging.error("copy of file %s to node %s failed",
                      self._cfg_file, node)
Iustin Pop's avatar
Iustin Pop committed
1065
1066
1067
1068
1069
1070
1071
        bad = True
    return not bad

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

    """
1072
1073
1074
1075
1076
    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
1077
1078
1079
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1080
    txt = serializer.Dump(self._config_data.ToDict())
Iustin Pop's avatar
Iustin Pop committed
1081
1082
1083
1084
    dir_name, file_name = os.path.split(destination)
    fd, name = tempfile.mkstemp('.newconfig', file_name, dir_name)
    f = os.fdopen(fd, 'w')
    try:
1085
      f.write(txt)
Iustin Pop's avatar
Iustin Pop committed
1086
1087
1088
1089
1090
      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)
1091
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
1092

1093
    # and redistribute the config file to master candidates
Iustin Pop's avatar
Iustin Pop committed
1094
1095
    self._DistributeConfig()

1096
    # Write ssconf files on all nodes (including locally)
1097
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1098
      if not self._offline:
1099
1100
        rpc.RpcRunner.call_write_ssconf_files(self._UnlockedGetNodeList(),
                                              self._UnlockedGetSsconfValues())
1101
      self._last_cluster_serial = self._config_data.cluster.serial_no
1102

1103
  def _UnlockedGetSsconfValues(self):
Iustin Pop's avatar
Iustin Pop committed
1104
1105
1106
1107
1108
1109
1110
    """Return the values needed by ssconf.

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

    """
1111
    fn = "\n".join
1112
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1113
1114
1115
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]

1116
    instance_data = fn(instance_names)
1117
    off_data = fn(node.name for node in node_info if node.offline)
1118
    on_data = fn(node.name for node in node_info if not node.offline)
1119
1120
    mc_data = fn(node.name for node in node_info if node.master_candidate)
    node_data = fn(node_names)
1121

Iustin Pop's avatar
Iustin Pop committed
1122
    cluster = self._config_data.cluster
1123
    return {
Iustin Pop's avatar
Iustin Pop committed
1124
1125
      constants.SS_CLUSTER_NAME: cluster.cluster_name,
      constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1126
      constants.SS_MASTER_CANDIDATES: mc_data,
Iustin Pop's avatar
Iustin Pop committed
1127
1128
1129
      constants.SS_MASTER_IP: cluster.master_ip,
      constants.SS_MASTER_NETDEV: cluster.master_netdev,
      constants.SS_MASTER_NODE: cluster.master_node,
1130
1131
      constants.SS_NODE_LIST: node_data,
      constants.SS_OFFLINE_NODES: off_data,
1132
1133
      constants.SS_ONLINE_NODES: on_data,
      constants.SS_INSTANCE_LIST: instance_data,
1134
      constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1135
1136
      }

1137
  @locking.ssynchronized(_config_lock)
1138
  def InitConfig(self, version, cluster_config, master_node_config):
Iustin Pop's avatar
Iustin Pop committed
1139
1140
1141
    """Create the initial cluster configuration.

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

1144
1145
    @type version: int
    @param version: Configuration version
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
    @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,
      }

1156
1157
    self._config_data = objects.ConfigData(version=version,
                                           cluster=cluster_config,
1158
                                           nodes=nodes,
Iustin Pop's avatar
Iustin Pop committed
1159
                                           instances={},
1160
                                           serial_no=1)
Iustin Pop's avatar
Iustin Pop committed
1161
1162
    self._WriteConfig()

1163
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1164
1165
1166
1167
1168
1169
  def GetVGName(self):
    """Return the volume group name.

    """
    return self._config_data.cluster.volume_group_name

1170
  @locking.ssynchronized(_config_lock)
1171
1172
1173
1174
  def SetVGName(self, vg_name):
    """Set the volume group name.

    """
1175
    self._config_data.cluster.volume_group_name = vg_name
1176
    self._config_data.cluster.serial_no += 1
1177
1178
    self._WriteConfig()

1179
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1180
1181
1182
1183
1184
1185
  def GetDefBridge(self):
    """Return the default bridge.

    """
    return self._config_data.cluster.default_bridge

1186
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1187
1188
1189
1190
1191
  def GetMACPrefix(self):
    """Return the mac prefix.

    """
    return self._config_data.cluster.mac_prefix
1192

1193
  @locking.ssynchronized(_config_lock, shared=1)
1194
1195
1196
  def GetClusterInfo(self):
    """Returns informations about the cluster

Iustin Pop's avatar
Iustin Pop committed
1197
1198
    @rtype: L{objects.Cluster}
    @return: the cluster object
1199
1200
1201

    """
    return self._config_data.cluster
1202

1203
  @locking.ssynchronized(_config_lock)
1204
1205
1206
1207
1208
1209
1210
1211
1212
  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