objects.py 54.7 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
#

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# 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.


"""Transportable objects for Ganeti.

This module provides small, mostly data-only objects which are safe to
pass to and from external parties.

"""

29
# pylint: disable=E0203,W0201,R0902
Iustin Pop's avatar
Iustin Pop committed
30
31
32
33

# E0203: Access to member %r before its definition, since we use
# objects.py which doesn't explicitely initialise its members

Iustin Pop's avatar
Iustin Pop committed
34
# W0201: Attribute '%s' defined outside __init__
Iustin Pop's avatar
Iustin Pop committed
35

36
37
# R0902: Allow instances of these objects to have more than 20 attributes

Iustin Pop's avatar
Iustin Pop committed
38
import ConfigParser
39
import re
40
import copy
41
import time
42
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
43
44

from ganeti import errors
45
from ganeti import constants
46
from ganeti import netutils
47
from ganeti import utils
Iustin Pop's avatar
Iustin Pop committed
48

49
50
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
51
52

__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
53
           "OS", "Node", "NodeGroup", "Cluster", "FillDict"]
Iustin Pop's avatar
Iustin Pop committed
54

55
_TIMESTAMPS = ["ctime", "mtime"]
56
_UUID = ["uuid"]
57

58
59
# constants used to create InstancePolicy dictionary
TISPECS_GROUP_TYPES = {
60
61
  constants.ISPECS_MIN: constants.VTYPE_INT,
  constants.ISPECS_MAX: constants.VTYPE_INT,
62
  }
63
64

TISPECS_CLUSTER_TYPES = {
65
66
67
  constants.ISPECS_MIN: constants.VTYPE_INT,
  constants.ISPECS_MAX: constants.VTYPE_INT,
  constants.ISPECS_STD: constants.VTYPE_INT,
68
69
  }

70

71
def FillDict(defaults_dict, custom_dict, skip_keys=None):
Iustin Pop's avatar
Iustin Pop committed
72
  """Basic function to apply settings on top a default dict.
Guido Trotter's avatar
Guido Trotter committed
73

Iustin Pop's avatar
Iustin Pop committed
74
75
76
77
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
78
79
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
80
81
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
82

Iustin Pop's avatar
Iustin Pop committed
83
84
85
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
86
87
88
89
90
91
  if skip_keys:
    for k in skip_keys:
      try:
        del ret_dict[k]
      except KeyError:
        pass
Iustin Pop's avatar
Iustin Pop committed
92
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
93

94

95
96
def FillIPolicy(default_ipolicy, custom_ipolicy, skip_keys=None):
  """Fills an instance policy with defaults.
97
98

  """
99
  assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
100
  ret_dict = {}
101
102
103
  for key in constants.IPOLICY_PARAMETERS:
    ret_dict[key] = FillDict(default_ipolicy[key],
                             custom_ipolicy.get(key, {}),
104
                             skip_keys=skip_keys)
105
106
107
108
  # list items
  for key in [constants.ISPECS_DTS]:
    ret_dict[key] = list(custom_ipolicy.get(key, default_ipolicy[key]))

109
110
111
  return ret_dict


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def UpgradeGroupedParams(target, defaults):
  """Update all groups for the target parameter.

  @type target: dict of dicts
  @param target: {group: {parameter: value}}
  @type defaults: dict
  @param defaults: default parameter values

  """
  if target is None:
    target = {constants.PP_DEFAULT: defaults}
  else:
    for group in target:
      target[group] = FillDict(defaults, target[group])
  return target


129
130
131
132
133
134
135
136
137
138
139
def UpgradeBeParams(target):
  """Update the be parameters dict to the new format.

  @type target: dict
  @param target: "be" parameters dict

  """
  if constants.BE_MEMORY in target:
    memory = target[constants.BE_MEMORY]
    target[constants.BE_MAXMEM] = memory
    target[constants.BE_MINMEM] = memory
140
    del target[constants.BE_MEMORY]
141
142


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def UpgradeDiskParams(diskparams):
  """Upgrade the disk parameters.

  @type diskparams: dict
  @param diskparams: disk parameters to upgrade
  @rtype: dict
  @return: the upgraded disk parameters dit

  """
  result = dict()
  if diskparams is None:
    result = constants.DISK_DT_DEFAULTS.copy()
  else:
    # Update the disk parameter values for each disk template.
    # The code iterates over constants.DISK_TEMPLATES because new templates
    # might have been added.
    for template in constants.DISK_TEMPLATES:
      if template not in diskparams:
        result[template] = constants.DISK_DT_DEFAULTS[template].copy()
      else:
        result[template] = FillDict(constants.DISK_DT_DEFAULTS[template],
                                    diskparams[template])

  return result


169
170
171
172
173
def MakeEmptyIPolicy():
  """Create empty IPolicy dictionary.

  """
  return dict([
174
175
176
    (constants.ISPECS_MIN, {}),
    (constants.ISPECS_MAX, {}),
    (constants.ISPECS_STD, {}),
177
178
179
    ])


180
181
182
183
184
def CreateIPolicyFromOpts(ispecs_mem_size=None,
                          ispecs_cpu_count=None,
                          ispecs_disk_count=None,
                          ispecs_disk_size=None,
                          ispecs_nic_count=None,
185
                          ispecs_disk_templates=None,
186
                          group_ipolicy=False,
187
188
189
190
191
192
                          allowed_values=None,
                          fill_all=False):
  """Creation of instance policy based on command line options.

  @param fill_all: whether for cluster policies we should ensure that
    all values are filled
193
194
195
196
197


  """
  # prepare ipolicy dict
  ipolicy_transposed = {
198
199
200
201
202
    constants.ISPEC_MEM_SIZE: ispecs_mem_size,
    constants.ISPEC_CPU_COUNT: ispecs_cpu_count,
    constants.ISPEC_DISK_COUNT: ispecs_disk_count,
    constants.ISPEC_DISK_SIZE: ispecs_disk_size,
    constants.ISPEC_NIC_COUNT: ispecs_nic_count,
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    }

  # first, check that the values given are correct
  if group_ipolicy:
    forced_type = TISPECS_GROUP_TYPES
  else:
    forced_type = TISPECS_CLUSTER_TYPES

  for specs in ipolicy_transposed.values():
    utils.ForceDictType(specs, forced_type, allowed_values=allowed_values)

  # then transpose
  ipolicy_out = MakeEmptyIPolicy()
  for name, specs in ipolicy_transposed.iteritems():
    assert name in constants.ISPECS_PARAMETERS
    for key, val in specs.items(): # {min: .. ,max: .., std: ..}
      ipolicy_out[key][name] = val

221
222
223
224
225
226
  # no filldict for lists
  if not group_ipolicy and fill_all and ispecs_disk_templates is None:
    ispecs_disk_templates = constants.DISK_TEMPLATES
  if ispecs_disk_templates is not None:
    ipolicy_out[constants.ISPECS_DTS] = list(ispecs_disk_templates)

227
228
  assert not (frozenset(ipolicy_out.keys()) - constants.IPOLICY_ALL_KEYS)

229
230
231
  return ipolicy_out


Iustin Pop's avatar
Iustin Pop committed
232
233
234
235
236
237
238
239
240
241
class ConfigObject(object):
  """A generic config object.

  It has the following properties:

    - provides somewhat safe recursive unpickling and pickling for its classes
    - unset attributes which are defined in slots are always returned
      as None instead of raising an error

  Classes derived from this must always declare __slots__ (we use many
242
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
243
244
245
246
247

  """
  __slots__ = []

  def __init__(self, **kwargs):
248
249
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
250
251

  def __getattr__(self, name):
252
    if name not in self._all_slots():
253
254
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
255
256
257
    return None

  def __setstate__(self, state):
258
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
259
    for name in state:
260
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
261
262
        setattr(self, name, state[name])

263
264
265
266
267
268
269
270
271
272
  @classmethod
  def _all_slots(cls):
    """Compute the list of all declared slots for a class.

    """
    slots = []
    for parent in cls.__mro__:
      slots.extend(getattr(parent, "__slots__", []))
    return slots

273
274
275
276
277
278
279
280
281
282
  def ToDict(self):
    """Convert to a dict holding only standard python types.

    The generic routine just dumps all of this object's attributes in
    a dict. It does not work if the class has children who are
    ConfigObjects themselves (e.g. the nics list in an Instance), in
    which case the object should subclass the function in order to
    make sure all objects returned are only standard python types.

    """
283
    result = {}
284
    for name in self._all_slots():
285
286
287
288
289
290
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

  @classmethod
  def FromDict(cls, val):
    """Create an object from a dictionary.

    This generic routine takes a dict, instantiates a new instance of
    the given class, and sets attributes based on the dict content.

    As for `ToDict`, this does not work if the class has children
    who are ConfigObjects themselves (e.g. the nics list in an
    Instance), in which case the object should subclass the function
    and alter the objects.

    """
    if not isinstance(val, dict):
      raise errors.ConfigurationError("Invalid object passed to FromDict:"
                                      " expected dict, got %s" % type(val))
308
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
309
    obj = cls(**val_str) # pylint: disable=W0142
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
    return obj

  @staticmethod
  def _ContainerToDicts(container):
    """Convert the elements of a container to standard python types.

    This method converts a container with elements derived from
    ConfigData to standard python types. If the container is a dict,
    we don't touch the keys, only the values.

    """
    if isinstance(container, dict):
      ret = dict([(k, v.ToDict()) for k, v in container.iteritems()])
    elif isinstance(container, (list, tuple, set, frozenset)):
      ret = [elem.ToDict() for elem in container]
    else:
      raise TypeError("Invalid type %s passed to _ContainerToDicts" %
                      type(container))
    return ret

  @staticmethod
  def _ContainerFromDicts(source, c_type, e_type):
    """Convert a container from standard python types.

    This method converts a container with standard python types to
    ConfigData objects. If the container is a dict, we don't touch the
    keys, only the values.

    """
    if not isinstance(c_type, type):
      raise TypeError("Container type %s passed to _ContainerFromDicts is"
                      " not a type" % type(c_type))
342
343
    if source is None:
      source = c_type()
344
345
346
347
348
349
350
351
352
    if c_type is dict:
      ret = dict([(k, e_type.FromDict(v)) for k, v in source.iteritems()])
    elif c_type in (list, tuple, set, frozenset):
      ret = c_type([e_type.FromDict(elem) for elem in source])
    else:
      raise TypeError("Invalid container type %s passed to"
                      " _ContainerFromDicts" % c_type)
    return ret

353
354
355
356
357
358
359
360
  def Copy(self):
    """Makes a deep copy of the current object and its children.

    """
    dict_form = self.ToDict()
    clone_obj = self.__class__.FromDict(dict_form)
    return clone_obj

361
362
363
364
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

365
366
367
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

368
369
    This method will be called at configuration load time, and its
    implementation will be object dependent.
370
371
372
373

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
374

375
class TaggableObject(ConfigObject):
376
377
378
  """An generic class supporting tags.

  """
Balazs Lecz's avatar
Balazs Lecz committed
379
  __slots__ = ["tags"]
Iustin Pop's avatar
Iustin Pop committed
380
  VALID_TAG_RE = re.compile("^[\w.+*/:@-]+$")
Iustin Pop's avatar
Iustin Pop committed
381

Iustin Pop's avatar
Iustin Pop committed
382
383
  @classmethod
  def ValidateTag(cls, tag):
384
385
386
387
388
389
390
    """Check if a tag is valid.

    If the tag is invalid, an errors.TagError will be raised. The
    function has no return value.

    """
    if not isinstance(tag, basestring):
391
      raise errors.TagError("Invalid tag type (not a string)")
392
    if len(tag) > constants.MAX_TAG_LEN:
393
394
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
395
    if not tag:
396
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
397
    if not cls.VALID_TAG_RE.match(tag):
398
      raise errors.TagError("Tag contains invalid characters")
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415

  def GetTags(self):
    """Return the tags list.

    """
    tags = getattr(self, "tags", None)
    if tags is None:
      tags = self.tags = set()
    return tags

  def AddTag(self, tag):
    """Add a new tag.

    """
    self.ValidateTag(tag)
    tags = self.GetTags()
    if len(tags) >= constants.MAX_TAGS_PER_OBJ:
416
      raise errors.TagError("Too many tags")
417
418
419
420
421
422
423
424
425
426
427
    self.GetTags().add(tag)

  def RemoveTag(self, tag):
    """Remove a tag.

    """
    self.ValidateTag(tag)
    tags = self.GetTags()
    try:
      tags.remove(tag)
    except KeyError:
428
      raise errors.TagError("Tag not found")
429

430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
  def ToDict(self):
    """Taggable-object-specific conversion to standard python types.

    This replaces the tags set with a list.

    """
    bo = super(TaggableObject, self).ToDict()

    tags = bo.get("tags", None)
    if isinstance(tags, set):
      bo["tags"] = list(tags)
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for instances.

    """
    obj = super(TaggableObject, cls).FromDict(val)
    if hasattr(obj, "tags") and isinstance(obj.tags, list):
      obj.tags = set(obj.tags)
    return obj

453

454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
class MasterNetworkParameters(ConfigObject):
  """Network configuration parameters for the master

  @ivar name: master name
  @ivar ip: master IP
  @ivar netmask: master netmask
  @ivar netdev: master network device
  @ivar ip_family: master IP family

  """
  __slots__ = [
    "name",
    "ip",
    "netmask",
    "netdev",
    "ip_family"
    ]


Iustin Pop's avatar
Iustin Pop committed
473
474
class ConfigData(ConfigObject):
  """Top-level config object."""
475
476
477
478
479
480
481
482
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
483

484
485
486
487
488
489
490
491
492
  def ToDict(self):
    """Custom function for top-level config data.

    This just replaces the list of instances, nodes and the cluster
    with standard python types.

    """
    mydict = super(ConfigData, self).ToDict()
    mydict["cluster"] = mydict["cluster"].ToDict()
493
    for key in "nodes", "instances", "nodegroups":
494
495
496
497
498
499
500
501
502
503
504
505
506
      mydict[key] = self._ContainerToDicts(mydict[key])

    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for top-level config data

    """
    obj = super(ConfigData, cls).FromDict(val)
    obj.cluster = Cluster.FromDict(obj.cluster)
    obj.nodes = cls._ContainerFromDicts(obj.nodes, dict, Node)
    obj.instances = cls._ContainerFromDicts(obj.instances, dict, Instance)
507
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
508
509
    return obj

510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
  def HasAnyDiskOfType(self, dev_type):
    """Check if in there is at disk of the given type in the configuration.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a disk of the given type was found or not

    """
    for instance in self.instances.values():
      for disk in instance.disks:
        if disk.IsBasedOnDiskType(dev_type):
          return True
    return False

525
526
527
528
529
530
531
532
533
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    self.cluster.UpgradeConfig()
    for node in self.nodes.values():
      node.UpgradeConfig()
    for instance in self.instances.values():
      instance.UpgradeConfig()
534
535
536
537
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
538
539
540
541
542
543
    if self.cluster.drbd_usermode_helper is None:
      # To decide if we set an helper let's check if at least one instance has
      # a DRBD disk. This does not cover all the possible scenarios but it
      # gives a good approximation.
      if self.HasAnyDiskOfType(constants.LD_DRBD8):
        self.cluster.drbd_usermode_helper = constants.DEFAULT_DRBD_HELPER
544

Iustin Pop's avatar
Iustin Pop committed
545
546
547

class NIC(ConfigObject):
  """Config object representing a network card."""
Guido Trotter's avatar
Guido Trotter committed
548
  __slots__ = ["mac", "ip", "nicparams"]
Iustin Pop's avatar
Iustin Pop committed
549

Guido Trotter's avatar
Guido Trotter committed
550
551
552
553
554
555
556
557
558
  @classmethod
  def CheckParameterSyntax(cls, nicparams):
    """Check the given parameters for validity.

    @type nicparams:  dict
    @param nicparams: dictionary with parameter names/value
    @raise errors.ConfigurationError: when a parameter is not valid

    """
559
560
    if (nicparams[constants.NIC_MODE] not in constants.NIC_VALID_MODES and
        nicparams[constants.NIC_MODE] != constants.VALUE_AUTO):
Guido Trotter's avatar
Guido Trotter committed
561
562
563
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

564
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
565
566
567
568
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

Iustin Pop's avatar
Iustin Pop committed
569
570
571
572

class Disk(ConfigObject):
  """Config object representing a block device."""
  __slots__ = ["dev_type", "logical_id", "physical_id",
573
               "children", "iv_name", "size", "mode", "params"]
Iustin Pop's avatar
Iustin Pop committed
574
575
576

  def CreateOnSecondary(self):
    """Test if this device needs to be created on a secondary node."""
577
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
578
579
580

  def AssembleOnSecondary(self):
    """Test if this device needs to be assembled on a secondary node."""
581
    return self.dev_type in (constants.LD_DRBD8, constants.LD_LV)
Iustin Pop's avatar
Iustin Pop committed
582
583
584

  def OpenOnSecondary(self):
    """Test if this device needs to be opened on a secondary node."""
585
    return self.dev_type in (constants.LD_LV,)
Iustin Pop's avatar
Iustin Pop committed
586

587
588
589
590
591
592
593
  def StaticDevPath(self):
    """Return the device path if this device type has a static one.

    Some devices (LVM for example) live always at the same /dev/ path,
    irrespective of their status. For such devices, we return this
    path, for others we return None.

594
595
596
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

597
598
599
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
600
601
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
602
603
    return None

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
  def ChildrenNeeded(self):
    """Compute the needed number of children for activation.

    This method will return either -1 (all children) or a positive
    number denoting the minimum number of children needed for
    activation (only mirrored devices will usually return >=0).

    Currently, only DRBD8 supports diskless activation (therefore we
    return 0), for all other we keep the previous semantics and return
    -1.

    """
    if self.dev_type == constants.LD_DRBD8:
      return 0
    return -1

620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
  def IsBasedOnDiskType(self, dev_type):
    """Check if the disk or its children are based on the given type.

    @type dev_type: L{constants.LDS_BLOCK}
    @param dev_type: the type to look for
    @rtype: boolean
    @return: boolean indicating if a device of the given type was found or not

    """
    if self.children:
      for child in self.children:
        if child.IsBasedOnDiskType(dev_type):
          return True
    return self.dev_type == dev_type

Iustin Pop's avatar
Iustin Pop committed
635
636
637
638
639
640
641
642
643
  def GetNodes(self, node):
    """This function returns the nodes this device lives on.

    Given the node on which the parent of the device lives on (or, in
    case of a top-level device, the primary node of the devices'
    instance), this function will return a list of nodes on which this
    devices needs to (or can) be assembled.

    """
644
645
    if self.dev_type in [constants.LD_LV, constants.LD_FILE,
                         constants.LD_BLOCKDEV]:
Iustin Pop's avatar
Iustin Pop committed
646
      result = [node]
647
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
648
649
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
650
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
651
    else:
652
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
653
654
655
656
657
658
659
    return result

  def ComputeNodeTree(self, parent_node):
    """Compute the node/disk tree for this disk and its children.

    This method, given the node on which the parent disk lives, will
    return the list of all (node, disk) pairs which describe the disk
660
661
662
    tree in the most compact way. For example, a drbd/lvm stack
    will be returned as (primary_node, drbd) and (secondary_node, drbd)
    which represents all the top-level devices on the nodes.
Iustin Pop's avatar
Iustin Pop committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689

    """
    my_nodes = self.GetNodes(parent_node)
    result = [(node, self) for node in my_nodes]
    if not self.children:
      # leaf device
      return result
    for node in my_nodes:
      for child in self.children:
        child_result = child.ComputeNodeTree(node)
        if len(child_result) == 1:
          # child (and all its descendants) is simple, doesn't split
          # over multiple hosts, so we don't need to describe it, our
          # own entry for this node describes it completely
          continue
        else:
          # check if child nodes differ from my nodes; note that
          # subdisk can differ from the child itself, and be instead
          # one of its descendants
          for subnode, subdisk in child_result:
            if subnode not in my_nodes:
              result.append((subnode, subdisk))
            # otherwise child is under our own node, so we ignore this
            # entry (but probably the other results in the list will
            # be different)
    return result

Iustin Pop's avatar
Iustin Pop committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
  def ComputeGrowth(self, amount):
    """Compute the per-VG growth requirements.

    This only works for VG-based disks.

    @type amount: integer
    @param amount: the desired increase in (user-visible) disk space
    @rtype: dict
    @return: a dictionary of volume-groups and the required size

    """
    if self.dev_type == constants.LD_LV:
      return {self.logical_id[0]: amount}
    elif self.dev_type == constants.LD_DRBD8:
      if self.children:
        return self.children[0].ComputeGrowth(amount)
      else:
        return {}
    else:
      # Other disk types do not require VG space
      return {}

712
713
714
715
716
717
718
719
  def RecordGrow(self, amount):
    """Update the size of this disk after growth.

    This method recurses over the disks's children and updates their
    size correspondigly. The method needs to be kept in sync with the
    actual algorithms from bdev.

    """
720
    if self.dev_type in (constants.LD_LV, constants.LD_FILE):
721
722
723
724
725
726
727
728
729
      self.size += amount
    elif self.dev_type == constants.LD_DRBD8:
      if self.children:
        self.children[0].RecordGrow(amount)
      self.size += amount
    else:
      raise errors.ProgrammerError("Disk.RecordGrow called for unsupported"
                                   " disk type %s" % self.dev_type)

730
731
732
733
734
735
736
737
738
  def UnsetSize(self):
    """Sets recursively the size to zero for the disk and its children.

    """
    if self.children:
      for child in self.children:
        child.UnsetSize()
    self.size = 0

739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
  def SetPhysicalID(self, target_node, nodes_ip):
    """Convert the logical ID to the physical ID.

    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.

    Arguments:
      - target_node: the node we wish to configure for
      - nodes_ip: a mapping of node name to ip

    The target_node must exist in in nodes_ip, and must be one of the
    nodes in the logical ID for each of the DRBD devices encountered
    in the disk tree.

    """
    if self.children:
      for child in self.children:
        child.SetPhysicalID(target_node, nodes_ip)

    if self.logical_id is None and self.physical_id is not None:
      return
    if self.dev_type in constants.LDS_DRBD:
764
      pnode, snode, port, pminor, sminor, secret = self.logical_id
765
766
767
768
769
770
771
772
      if target_node not in (pnode, snode):
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        target_node)
      pnode_ip = nodes_ip.get(pnode, None)
      snode_ip = nodes_ip.get(snode, None)
      if pnode_ip is None or snode_ip is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(self))
773
774
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
775
      if pnode == target_node:
776
        self.physical_id = p_data + s_data + (pminor, secret)
777
      else: # it must be secondary, we tested above
778
        self.physical_id = s_data + p_data + (sminor, secret)
779
780
781
782
    else:
      self.physical_id = self.logical_id
    return

783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
  def ToDict(self):
    """Disk-specific conversion to standard python types.

    This replaces the children lists of objects with lists of
    standard python types.

    """
    bo = super(Disk, self).ToDict()

    for attr in ("children",):
      alist = bo.get(attr, None)
      if alist:
        bo[attr] = self._ContainerToDicts(alist)
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for Disks

    """
    obj = super(Disk, cls).FromDict(val)
    if obj.children:
      obj.children = cls._ContainerFromDicts(obj.children, list, Disk)
    if obj.logical_id and isinstance(obj.logical_id, list):
      obj.logical_id = tuple(obj.logical_id)
    if obj.physical_id and isinstance(obj.physical_id, list):
      obj.physical_id = tuple(obj.physical_id)
810
811
812
813
    if obj.dev_type in constants.LDS_DRBD:
      # we need a tuple of length six here
      if len(obj.logical_id) < 6:
        obj.logical_id += (None,) * (6 - len(obj.logical_id))
814
815
    return obj

816
817
818
819
820
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
821
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
822
    elif self.dev_type in constants.LDS_DRBD:
823
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
824
      val = "<DRBD8("
825
826
827
828
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
829
830
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
831

832
833
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
834
835
836
837
838
839
840
841
842
843
844
      if self.children and self.children.count(None) == 0:
        val += "backend=%s, metadev=%s" % (self.children[0], self.children[1])
      else:
        val += "no local storage"
    else:
      val = ("<Disk(type=%s, logical_id=%s, physical_id=%s, children=%s" %
             (self.dev_type, self.logical_id, self.physical_id, self.children))
    if self.iv_name is None:
      val += ", not visible"
    else:
      val += ", visible as /dev/%s" % self.iv_name
Iustin Pop's avatar
Iustin Pop committed
845
846
847
848
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
849
850
    return val

851
852
853
854
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
855
    all_errors = []
856
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
857
858
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
859

860
861
862
863
864
865
866
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.children:
      for child in self.children:
        child.UpgradeConfig()
867
868
869
870
871
872

    if not self.params:
      self.params = constants.DISK_LD_DEFAULTS[self.dev_type].copy()
    else:
      self.params = FillDict(constants.DISK_LD_DEFAULTS[self.dev_type],
                             self.params)
873
874
    # add here config upgrade for this disk

Iustin Pop's avatar
Iustin Pop committed
875

876
877
class InstancePolicy(ConfigObject):
  """Config object representing instance policy limits dictionary."""
878
  __slots__ = ["min", "max", "std", "disk_templates"]
879
880
881
882
883
884
885
886

  @classmethod
  def CheckParameterSyntax(cls, ipolicy):
    """ Check the instance policy for validity.

    """
    for param in constants.ISPECS_PARAMETERS:
      InstancePolicy.CheckISpecSyntax(ipolicy, param)
887
888
    if constants.ISPECS_DTS in ipolicy:
      InstancePolicy.CheckDiskTemplates(ipolicy[constants.ISPECS_DTS])
889
890
891
892
    wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
    if wrong_keys:
      raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
                                      utils.CommaJoin(wrong_keys))
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907

  @classmethod
  def CheckISpecSyntax(cls, ipolicy, name):
    """Check the instance policy for validity on a given key.

    We check if the instance policy makes sense for a given key, that is
    if ipolicy[min][name] <= ipolicy[std][name] <= ipolicy[max][name].

    @type ipolicy: dict
    @param ipolicy: dictionary with min, max, std specs
    @type name: string
    @param name: what are the limits for
    @raise errors.ConfigureError: when specs for given name are not valid

    """
908
909
910
    min_v = ipolicy[constants.ISPECS_MIN].get(name, 0)
    std_v = ipolicy[constants.ISPECS_STD].get(name, min_v)
    max_v = ipolicy[constants.ISPECS_MAX].get(name, std_v)
911
912
    err = ("Invalid specification of min/max/std values for %s: %s/%s/%s" %
           (name,
913
914
915
            ipolicy[constants.ISPECS_MIN].get(name, "-"),
            ipolicy[constants.ISPECS_MAX].get(name, "-"),
            ipolicy[constants.ISPECS_STD].get(name, "-")))
916
917
918
    if min_v > std_v or std_v > max_v:
      raise errors.ConfigurationError(err)

919
920
921
922
923
924
925
926
927
928
  @classmethod
  def CheckDiskTemplates(cls, disk_templates):
    """Checks the disk templates for validity.

    """
    wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
    if wrong:
      raise errors.ConfigurationError("Invalid disk template(s) %s" %
                                      utils.CommaJoin(wrong))

929

930
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
931
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
932
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
933
934
935
    "name",
    "primary_node",
    "os",
936
    "hypervisor",
937
938
    "hvparams",
    "beparams",
939
    "osparams",
940
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
941
942
943
    "nics",
    "disks",
    "disk_template",
944
    "network_port",
945
    "serial_no",
946
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
947
948
949
950

  def _ComputeSecondaryNodes(self):
    """Compute the list of secondary nodes.

951
952
953
954
955
956
957
958
959
960
961
962
963
    This is a simple wrapper over _ComputeAllNodes.

    """
    all_nodes = set(self._ComputeAllNodes())
    all_nodes.discard(self.primary_node)
    return tuple(all_nodes)

  secondary_nodes = property(_ComputeSecondaryNodes, None, None,
                             "List of secondary nodes")

  def _ComputeAllNodes(self):
    """Compute the list of all nodes.

Iustin Pop's avatar
Iustin Pop committed
964
965
966
967
968
969
    Since the data is already there (in the drbd disks), keeping it as
    a separate normal attribute is redundant and if not properly
    synchronised can cause problems. Thus it's better to compute it
    dynamically.

    """
970
971
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
972
      if device.dev_type in constants.LDS_DRBD:
973
974
975
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
976
977
      if device.children:
        for child in device.children:
978
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
979

980
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
981
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
982
    for device in self.disks:
983
984
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
985

986
987
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
988
989
990
991

  def MapLVsByNode(self, lvmap=None, devs=None, node=None):
    """Provide a mapping of nodes to LVs this instance owns.

Iustin Pop's avatar
Iustin Pop committed
992
993
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
994

Iustin Pop's avatar
Iustin Pop committed
995
996
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
997

998
999
1000
1001
    @return: None if lvmap arg is given, otherwise, a dictionary of
        the form { 'nodename' : ['volume1', 'volume2', ...], ... };
        volumeN is of the form "vg_name/lv_name", compatible with
        GetVolumeList()
Iustin Pop's avatar
Iustin Pop committed
1002
1003
1004
1005
1006
1007

    """
    if node == None:
      node = self.primary_node

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1008
1009
1010
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

    for dev in devs:
1021
      if dev.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
1022
        lvmap[node].append(dev.logical_id[0] + "/" + dev.logical_id[1])
Iustin Pop's avatar
Iustin Pop committed
1023

1024
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
1025
1026
1027
1028
1029
1030
1031
1032
1033
        if dev.children:
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[0])
          self.MapLVsByNode(lvmap, dev.children, dev.logical_id[1])

      elif dev.children:
        self.MapLVsByNode(lvmap, dev.children, node)

    return ret

1034
1035
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
1036

1037
    This is just a wrapper that does validation of the index.
1038

1039
1040
1041
1042
1043
    @type idx: int
    @param idx: the disk index
    @rtype: L{Disk}
    @return: the corresponding disk
    @raise errors.OpPrereqError: when the given index is not valid
1044

1045
1046
1047
1048
    """
    try:
      idx = int(idx)
      return self.disks[idx]
1049
    except (TypeError, ValueError), err:
1050
1051
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
1052
1053
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1054
                                 " 0 to %d" % (idx, len(self.disks) - 1),
1055
                                 errors.ECODE_INVAL)
1056

1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
  def ToDict(self):
    """Instance-specific conversion to standard python types.

    This replaces the children lists of objects with lists of standard
    python types.

    """
    bo = super(Instance, self).ToDict()

    for attr in "nics", "disks":
      alist = bo.get(attr, None)
      if alist:
        nlist = self._ContainerToDicts(alist)
      else:
        nlist = []
      bo[attr] = nlist
    return bo

  @classmethod
  def FromDict(cls, val):
    """Custom function for instances.

    """
1080
1081
1082
1083
1084
1085
1086
    if "admin_state" not in val:
      if val.get("admin_up", False):
        val["admin_state"] = constants.ADMINST_UP
      else:
        val["admin_state"] = constants.ADMINST_DOWN
    if "admin_up" in val:
      del val["admin_up"]
1087
1088
1089
1090
1091
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

1092
1093
1094
1095
1096
1097
1098
1099
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
1100
1101
1102
1103
1104
1105
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
1106
1107
    if self.osparams is None:
      self.osparams = {}
1108
    UpgradeBeParams(self.beparams)
1109

Iustin Pop's avatar
Iustin Pop committed
1110
1111

class OS(ConfigObject):
1112
1113
1114
1115
1116
1117
  """Config object representing an operating system.

  @type supported_parameters: list
  @ivar supported_parameters: a list of tuples, name and description,
      containing the supported parameters by this OS

1118
1119
1120
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

1121
  """
Iustin Pop's avatar
Iustin Pop committed
1122
1123
1124
  __slots__ = [
    "name",
    "path",
1125
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
1126
1127
    "create_script",
    "export_script",
1128
1129
    "import_script",
    "rename_script",
1130
    "verify_script",
1131
    "supported_variants",
1132
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
1133
1134
    ]

1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
  VARIANT_DELIM = "+"

  @classmethod
  def SplitNameVariant(cls, name):
    """Splits the name into the proper name and variant.

    @param name: the OS (unprocessed) name
    @rtype: list
    @return: a list of two elements; if the original name didn't
        contain a variant, it's returned as an empty string

    """
    nv = name.split(cls.VARIANT_DELIM, 1)
    if len(nv) == 1:
      nv.append("")
    return nv

  @classmethod
  def GetName(cls, name):
    """Returns the proper name of the os (without the variant).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[0]

  @classmethod
  def GetVariant(cls, name):
    """Returns the variant the os (without the base name).

    @param name: the OS (unprocessed) name

    """
    return cls.SplitNameVariant(name)[1]

1170

1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
class NodeHvState(ConfigObject):
  """Hypvervisor state on a node.

  @ivar mem_total: Total amount of memory
  @ivar mem_node: Memory used by, or reserved for, the node itself (not always
    available)
  @ivar mem_hv: Memory used by hypervisor or lost due to instance allocation
    rounding
  @ivar mem_inst: Memory used by instances living on node
  @ivar cpu_total: Total node CPU core count
  @ivar cpu_node: Number of CPU cores reserved for the node itself

  """
  __slots__ = [
    "mem_total",
    "mem_node",
    "mem_hv",
    "mem_inst",
    "cpu_total",
    "cpu_node",
    ] + _TIMESTAMPS


class NodeDiskState(ConfigObject):
  """Disk state on a node.

  """
  __slots__ = [
    "total",
    "reserved",
    "overhead",
    ] + _TIMESTAMPS


1205
class Node(TaggableObject):
1206
1207
1208
1209
1210
1211
1212
1213
  """Config object representing a node.

  @ivar hv_state: Hypervisor state (e.g. number of CPUs)
  @ivar hv_state_static: Hypervisor state overriden by user
  @ivar disk_state: Disk state (e.g. free space)
  @ivar disk_state_static: Disk state overriden by user

  """
Balazs Lecz's avatar
Balazs Lecz committed
1214
  __slots__ = [
1215
1216
1217
    "name",
    "primary_ip",
    "secondary_ip",
1218
    "serial_no",
1219
    "master_candidate",
1220
    "offline",
1221
    "drained",
1222
    "group",
1223
1224
    "master_capable",
    "vm_capable",
1225
    "ndparams",
1226
    "powered",
1227
    "hv_state",
1228
    "hv_state_static",
1229
    "disk_state",
1230
    "disk_state_static",
1231
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1232

1233
1234
1235
1236
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1237
    # pylint: disable=E0203
1238
1239
1240
1241
1242
1243
1244
    # because these are "defined" via slots, not manually
    if self.master_capable is None:
      self.master_capable = True

    if self.vm_capable is None:
      self.vm_capable = True

1245
1246
1247
    if self.ndparams is None:
      self.ndparams = {}

1248
1249
1250
    if self.powered is None:
      self.powered = True

1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
  def ToDict(self):
    """Custom function for serializing.

    """
    data = super(Node, self).ToDict()

    hv_state = data.get("hv_state", None)
    if hv_state is not None:
      data["hv_state"] = self._ContainerToDicts(hv_state)

    disk_state = data.get("disk_state", None)
    if disk_state is not None:
      data["disk_state"] = \
        dict((key, self._ContainerToDicts(value))
             for (key, value) in disk_state.items())

    return data

  @classmethod
  def FromDict(cls, val):
    """Custom function for deserializing.

    """
    obj = super(Node, cls).FromDict(val)

    if obj.hv_state is not None:
      obj.hv_state = cls._ContainerFromDicts(obj.hv_state, dict, NodeHvState)

    if obj.disk_state is not None:
      obj.disk_state = \
        dict((key, cls._ContainerFromDicts(value, dict, NodeDiskState))
             for (key, value) in obj.disk_state.items())

    return obj

Iustin Pop's avatar
Iustin Pop committed
1286

1287
class NodeGroup(TaggableObject):
1288
1289
1290
1291
  """Config object representing a node group."""
  __slots__ = [
    "name",
    "members",
1292
    "ndparams",
1293
    "diskparams",
1294
    "ipolicy",
1295
    "serial_no",
1296
1297
    "hv_state_static",
    "disk_state_static",
1298
    "alloc_policy",
1299
1300
1301
1302
1303
    ] + _TIMESTAMPS + _UUID

  def ToDict(self):
    """Custom function for nodegroup.

1304
1305
    This discards the members object, which gets recalculated and is only kept
    in memory.
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322

    """
    mydict = super(NodeGroup, self).ToDict()
    del mydict["members"]
    return mydict

  @classmethod
  def FromDict(cls, val):
    """Custom function for nodegroup.

    The members slot is initialized to an empty list, upon deserialization.

    """
    obj = super(NodeGroup, cls).FromDict(val)
    obj.members = []
    return obj

1323
1324
1325
1326
1327
1328
1329
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.ndparams is None:
      self.ndparams = {}

1330
1331
1332
    if self.serial_no is None:
      self.serial_no = 1

1333
1334
1335
    if self.alloc_policy is None:
      self.alloc_policy = constants.ALLOC_POLICY_PREFERRED

Iustin Pop's avatar
Iustin Pop committed
1336
1337
    # We only update mtime, and not ctime, since we would not be able
    # to provide a correct value for creation time.
1338
1339
1340
    if self.mtime is None:
      self.mtime = time.time()

1341
    self.diskparams = UpgradeDiskParams(self.diskparams)
1342
1343
    if self.ipolicy is None:
      self.ipolicy = MakeEmptyIPolicy()
1344

1345
  def FillND(self, node):
1346
    """Return filled out ndparams for L{objects.Node}
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361

    @type node: L{objects.Node}
    @param node: A Node object to fill
    @return a copy of the node's ndparams with defaults filled

    """
    return self.SimpleFillND(node.ndparams)

  def SimpleFillND(self, ndparams):
    """Fill a given ndparams dict with defaults.

    @type ndparams: dict
    @param ndparams: the dict to fill
    @rtype: dict
    @return: a copy of the passed in ndparams with missing keys filled
1362
        from the node group defaults
1363
1364
1365
1366

    """
    return FillDict(self.ndparams, ndparams)

1367

1368
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1369
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
1370
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1371
1372
1373
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
1374
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
1375
1376
    "mac_prefix",
    "volume_group_name",
1377
    "reserved_lvs",
1378
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
1379
    "default_bridge",
1380
    "default_hypervisor",
1381
1382
1383
    "master_node",
    "master_ip",
    "master_netdev",
1384
    "master_netmask",
1385
    "use_external_mip_script",
1386
1387
    "cluster_name",
    "file_storage_dir",
1388
    "shared_file_storage_dir",
1389
    "enabled_hypervisors",
1390
    "hvparams",
1391
    "ipolicy",
1392
    "os_hvp",
1393
    "beparams",
1394
    "osparams",
1395
    "nicparams",
1396
    "ndparams",
1397
    "diskparams",
1398
    "candidate_pool_size",
1399
    "modify_etc_hosts",
1400
    "modify_ssh_setup",
1401
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
1402
    "uid_pool",
1403
    "default_iallocator",
</