objects.py 25 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
24
25
26
27
28
29
30
#

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


"""Transportable objects for Ganeti.

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

"""


import ConfigParser
31
import re
32
import copy
33
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
34
35

from ganeti import errors
36
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
37
38
39


__all__ = ["ConfigObject", "ConfigData", "NIC", "Disk", "Instance",
Guido Trotter's avatar
Guido Trotter committed
40
           "OS", "Node", "Cluster", "FillDict"]
Iustin Pop's avatar
Iustin Pop committed
41

Guido Trotter's avatar
Guido Trotter committed
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def FillDict(defaults_dict, custom_dict):
    """Basic function to apply settings on top a default dict.

    @type defaults_dict: dict
    @param defaults_dict: dictionary holding the default values
    @type custom_dict: dict
    @param custom_dict: dictionary holding customized value
    @rtype: dict
    @return: dict with the 'full' values

    """
    ret_dict = copy.deepcopy(defaults_dict)
    ret_dict.update(custom_dict)
    return ret_dict
Iustin Pop's avatar
Iustin Pop committed
56
57
58
59
60
61
62
63
64
65
66

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
67
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
68
69
70
71
72

  """
  __slots__ = []

  def __init__(self, **kwargs):
73
74
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
75
    self.UpgradeConfig()
Iustin Pop's avatar
Iustin Pop committed
76
77
78

  def __getattr__(self, name):
    if name not in self.__slots__:
79
80
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
81
82
    return None

83
84
  def __setitem__(self, key, value):
    if key not in self.__slots__:
85
      raise KeyError(key)
86
87
    setattr(self, key, value)

Iustin Pop's avatar
Iustin Pop committed
88
89
90
91
92
93
94
95
96
97
98
99
  def __getstate__(self):
    state = {}
    for name in self.__slots__:
      if hasattr(self, name):
        state[name] = getattr(self, name)
    return state

  def __setstate__(self, state):
    for name in state:
      if name in self.__slots__:
        setattr(self, name, state[name])

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
  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.

    """
    return dict([(k, getattr(self, k, None)) for k in self.__slots__])

  @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))
128
129
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
    obj = cls(**val_str)
130
131
132
133
134
135
136
137
138
139
140
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
169
170
171
172
173
174
    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))
    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

  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

175
176
177
178
179
180
181
182
183
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    This method will be called at object init time, and its implementation will
    be object dependent.

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
184

185
class TaggableObject(ConfigObject):
186
187
188
  """An generic class supporting tags.

  """
189
  __slots__ = ConfigObject.__slots__ + ["tags"]
Iustin Pop's avatar
Iustin Pop committed
190

191
192
193
194
195
196
197
198
199
  @staticmethod
  def ValidateTag(tag):
    """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):
200
      raise errors.TagError("Invalid tag type (not a string)")
201
    if len(tag) > constants.MAX_TAG_LEN:
202
203
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
204
    if not tag:
205
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
206
    if not re.match("^[\w.+*/:-]+$", tag):
207
      raise errors.TagError("Tag contains invalid characters")
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

  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:
225
      raise errors.TagError("Too many tags")
226
227
228
229
230
231
232
233
234
235
236
    self.GetTags().add(tag)

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

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

239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
  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

262

Iustin Pop's avatar
Iustin Pop committed
263
264
class ConfigData(ConfigObject):
  """Top-level config object."""
265
  __slots__ = ["version", "cluster", "nodes", "instances", "serial_no"]
Iustin Pop's avatar
Iustin Pop committed
266

267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
  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()
    for key in "nodes", "instances":
      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)
    return obj

Iustin Pop's avatar
Iustin Pop committed
292
293
294
295
296
297
298
299
300

class NIC(ConfigObject):
  """Config object representing a network card."""
  __slots__ = ["mac", "ip", "bridge"]


class Disk(ConfigObject):
  """Config object representing a block device."""
  __slots__ = ["dev_type", "logical_id", "physical_id",
301
               "children", "iv_name", "size", "mode"]
Iustin Pop's avatar
Iustin Pop committed
302
303
304

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

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

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

315
316
317
318
319
320
321
322
323
324
325
326
  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.

    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
    return None

327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
  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

Iustin Pop's avatar
Iustin Pop committed
343
344
345
346
347
348
349
350
351
  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.

    """
352
    if self.dev_type in [constants.LD_LV, constants.LD_FILE]:
Iustin Pop's avatar
Iustin Pop committed
353
      result = [node]
354
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
355
356
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
357
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
358
    else:
359
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
360
361
362
363
364
365
366
    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
367
368
369
    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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396

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

397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
  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.

    """
    if self.dev_type == constants.LD_LV:
      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)

415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
  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:
440
      pnode, snode, port, pminor, sminor, secret = self.logical_id
441
442
443
444
445
446
447
448
      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))
449
450
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
451
      if pnode == target_node:
452
        self.physical_id = p_data + s_data + (pminor, secret)
453
      else: # it must be secondary, we tested above
454
        self.physical_id = s_data + p_data + (sminor, secret)
455
456
457
458
    else:
      self.physical_id = self.logical_id
    return

459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
  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)
486
487
488
489
    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))
490
491
    return obj

492
493
494
495
496
497
498
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
      val =  "<LogicalVolume(/dev/%s/%s" % self.logical_id
    elif self.dev_type in constants.LDS_DRBD:
499
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
500
      val = "<DRBD8("
501
502
503
504
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
505
506
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
507

508
509
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
510
511
512
513
514
515
516
517
518
519
520
      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
521
522
523
524
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
525
526
    return val

527
528
529
530
531
532
533
534
535
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
    errors = []
    if self.mode not in constants.DISK_ACCESS_SET:
      errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return errors

Iustin Pop's avatar
Iustin Pop committed
536

537
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
538
  """Config object representing an instance."""
539
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
540
541
542
    "name",
    "primary_node",
    "os",
543
    "hypervisor",
544
545
    "hvparams",
    "beparams",
546
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
547
548
549
    "nics",
    "disks",
    "disk_template",
550
    "network_port",
551
    "serial_no",
Iustin Pop's avatar
Iustin Pop committed
552
553
554
555
556
    ]

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

557
558
559
560
561
562
563
564
565
566
567
568
569
    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
570
571
572
573
574
575
    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.

    """
576
577
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
578
      if device.dev_type in constants.LDS_DRBD:
579
580
581
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
582
583
      if device.children:
        for child in device.children:
584
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
585

586
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
587
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
588
    for device in self.disks:
589
590
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
591

592
593
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
594
595
596
597

  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
598
599
    This function figures out what logical volumes should belong on
    which nodes, recursing through a device tree.
Iustin Pop's avatar
Iustin Pop committed
600

Iustin Pop's avatar
Iustin Pop committed
601
602
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
603

Iustin Pop's avatar
Iustin Pop committed
604
605
    @return: None if lvmap arg is given, otherwise, a dictionary
        of the form { 'nodename' : ['volume1', 'volume2', ...], ... }
Iustin Pop's avatar
Iustin Pop committed
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622

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

    if lvmap is None:
      lvmap = { node : [] }
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

    for dev in devs:
623
      if dev.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
624
625
        lvmap[node].append(dev.logical_id[1])

626
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
627
628
629
630
631
632
633
634
635
        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

636
637
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
638

639
    This is just a wrapper that does validation of the index.
640

641
642
643
644
645
    @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
646

647
648
649
650
651
652
653
654
655
    """
    try:
      idx = int(idx)
      return self.disks[idx]
    except ValueError, err:
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err))
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
                                 " 0 to %d" % (idx, len(self.disks)))
656

657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
  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.

    """
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

Iustin Pop's avatar
Iustin Pop committed
685
686
687
688
689
690

class OS(ConfigObject):
  """Config object representing an operating system."""
  __slots__ = [
    "name",
    "path",
691
    "status",
692
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
693
694
    "create_script",
    "export_script",
695
696
    "import_script",
    "rename_script",
Iustin Pop's avatar
Iustin Pop committed
697
698
    ]

699
700
701
702
703
704
705
706
707
708
709
710
711
712
  @classmethod
  def FromInvalidOS(cls, err):
    """Create an OS from an InvalidOS error.

    This routine knows how to convert an InvalidOS error to an OS
    object representing the broken OS with a meaningful error message.

    """
    if not isinstance(err, errors.InvalidOS):
      raise errors.ProgrammerError("Trying to initialize an OS from an"
                                   " invalid object of type %s" % type(err))

    return cls(name=err.args[0], path=err.args[1], status=err.args[2])

713
714
715
716
  def __nonzero__(self):
    return self.status == constants.OS_VALID_STATUS

  __bool__ = __nonzero__
Iustin Pop's avatar
Iustin Pop committed
717

718

719
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
720
  """Config object representing a node."""
721
722
723
724
  __slots__ = TaggableObject.__slots__ + [
    "name",
    "primary_ip",
    "secondary_ip",
725
    "serial_no",
726
    "master_candidate",
727
    "offline",
728
    "drained",
729
    ]
Iustin Pop's avatar
Iustin Pop committed
730
731


732
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
733
  """Config object representing the cluster."""
734
  __slots__ = TaggableObject.__slots__ + [
Iustin Pop's avatar
Iustin Pop committed
735
736
737
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
738
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
739
740
741
    "mac_prefix",
    "volume_group_name",
    "default_bridge",
742
    "default_hypervisor",
743
744
745
746
747
    "master_node",
    "master_ip",
    "master_netdev",
    "cluster_name",
    "file_storage_dir",
748
    "enabled_hypervisors",
749
750
    "hvparams",
    "beparams",
751
    "candidate_pool_size",
752
    "modify_etc_hosts",
Iustin Pop's avatar
Iustin Pop committed
753
754
    ]

755
756
757
758
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
759
760
761
762
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
763
        self.hvparams[hypervisor] = FillDict(
764
765
766
767
768
769
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

    if self.beparams is None:
      self.beparams = {constants.BEGR_DEFAULT: constants.BEC_DEFAULTS}
    else:
      for begroup in self.beparams:
Guido Trotter's avatar
Guido Trotter committed
770
        self.beparams[begroup] = FillDict(constants.BEC_DEFAULTS,
771
772
                                               self.beparams[begroup])

773
774
775
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

776
777
778
779
  def ToDict(self):
    """Custom function for cluster.

    """
780
    mydict = super(Cluster, self).ToDict()
781
782
783
784
785
786
787
788
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
789
    obj = super(Cluster, cls).FromDict(val)
790
791
792
793
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

794
795
796
797
798
799
800
801
802
803
  def FillHV(self, instance):
    """Fill an instance's hvparams dict.

    @type instance: object
    @param instance: the instance parameter to fill
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
Guido Trotter's avatar
Guido Trotter committed
804
    return FillDict(self.hvparams.get(instance.hypervisor, {}),
805
806
807
808
809
810
811
812
813
814
815
816
                         instance.hvparams)

  def FillBE(self, instance):
    """Fill an instance's beparams dict.

    @type instance: object
    @param instance: the instance parameter to fill
    @rtype: dict
    @return: a copy of the instance's beparams with missing keys filled from
        the cluster defaults

    """
Guido Trotter's avatar
Guido Trotter committed
817
    return FillDict(self.beparams.get(constants.BEGR_DEFAULT, {}),
818
819
                         instance.beparams)

820

Iustin Pop's avatar
Iustin Pop committed
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
class SerializableConfigParser(ConfigParser.SafeConfigParser):
  """Simple wrapper over ConfigParse that allows serialization.

  This class is basically ConfigParser.SafeConfigParser with two
  additional methods that allow it to serialize/unserialize to/from a
  buffer.

  """
  def Dumps(self):
    """Dump this instance and return the string representation."""
    buf = StringIO()
    self.write(buf)
    return buf.getvalue()

  @staticmethod
  def Loads(data):
    """Load data from a string."""
    buf = StringIO(data)
    cfp = SerializableConfigParser()
    cfp.readfp(buf)
    return cfp