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

Iustin Pop's avatar
Iustin Pop committed
4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 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
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

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

from ganeti import errors
43
from ganeti import constants
Iustin Pop's avatar
Iustin Pop committed
44

45
46
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
47
48

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

51
_TIMESTAMPS = ["ctime", "mtime"]
52
_UUID = ["uuid"]
53

54

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

Iustin Pop's avatar
Iustin Pop committed
58
59
60
61
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
62
63
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
64
65
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
66

Iustin Pop's avatar
Iustin Pop committed
67
68
69
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
70
71
72
73
74
75
  if skip_keys:
    for k in skip_keys:
      try:
        del ret_dict[k]
      except KeyError:
        pass
Iustin Pop's avatar
Iustin Pop committed
76
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
77

78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

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


Iustin Pop's avatar
Iustin Pop committed
96
97
98
99
100
101
102
103
104
105
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
106
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
107
108
109
110
111

  """
  __slots__ = []

  def __init__(self, **kwargs):
112
113
    for k, v in kwargs.iteritems():
      setattr(self, k, v)
Iustin Pop's avatar
Iustin Pop committed
114
115

  def __getattr__(self, name):
116
    if name not in self._all_slots():
117
118
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
119
120
121
    return None

  def __setstate__(self, state):
122
    slots = self._all_slots()
Iustin Pop's avatar
Iustin Pop committed
123
    for name in state:
124
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
125
126
        setattr(self, name, state[name])

127
128
129
130
131
132
133
134
135
136
  @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

137
138
139
140
141
142
143
144
145
146
  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.

    """
147
    result = {}
148
    for name in self._all_slots():
149
150
151
152
153
154
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

  @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))
172
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
173
    obj = cls(**val_str) # pylint: disable=W0142
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
    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))
206
207
    if source is None:
      source = c_type()
208
209
210
211
212
213
214
215
216
    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

217
218
219
220
221
222
223
224
  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

225
226
227
228
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

229
230
231
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

232
233
    This method will be called at configuration load time, and its
    implementation will be object dependent.
234
235
236
237

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
238

239
class TaggableObject(ConfigObject):
240
241
242
  """An generic class supporting tags.

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

Iustin Pop's avatar
Iustin Pop committed
246
247
  @classmethod
  def ValidateTag(cls, tag):
248
249
250
251
252
253
254
    """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):
255
      raise errors.TagError("Invalid tag type (not a string)")
256
    if len(tag) > constants.MAX_TAG_LEN:
257
258
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
259
    if not tag:
260
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
261
    if not cls.VALID_TAG_RE.match(tag):
262
      raise errors.TagError("Tag contains invalid characters")
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

  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:
280
      raise errors.TagError("Too many tags")
281
282
283
284
285
286
287
288
289
290
291
    self.GetTags().add(tag)

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

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

294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
  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

317

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
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
337
338
class ConfigData(ConfigObject):
  """Top-level config object."""
339
340
341
342
343
344
345
346
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
347

348
349
350
351
352
353
354
355
356
  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()
357
    for key in "nodes", "instances", "nodegroups":
358
359
360
361
362
363
364
365
366
367
368
369
370
      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)
371
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
372
373
    return obj

374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
  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

389
390
391
392
393
394
395
396
397
  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()
398
399
400
401
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
402
403
404
405
406
407
    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
408

Iustin Pop's avatar
Iustin Pop committed
409
410
411

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

Guido Trotter's avatar
Guido Trotter committed
414
415
416
417
418
419
420
421
422
  @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

    """
423
424
    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
425
426
427
      err = "Invalid nic mode: %s" % nicparams[constants.NIC_MODE]
      raise errors.ConfigurationError(err)

428
    if (nicparams[constants.NIC_MODE] == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
429
430
431
432
        not nicparams[constants.NIC_LINK]):
      err = "Missing bridged nic link"
      raise errors.ConfigurationError(err)

Iustin Pop's avatar
Iustin Pop committed
433
434
435
436

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

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

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

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

451
452
453
454
455
456
457
  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.

458
459
460
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

461
462
463
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
464
465
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
466
467
    return None

468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
  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

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
  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
499
500
501
502
503
504
505
506
507
  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.

    """
508
509
    if self.dev_type in [constants.LD_LV, constants.LD_FILE,
                         constants.LD_BLOCKDEV]:
Iustin Pop's avatar
Iustin Pop committed
510
      result = [node]
511
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
512
513
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
514
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
515
    else:
516
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
517
518
519
520
521
522
523
    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
524
525
526
    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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553

    """
    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
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
  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 {}

576
577
578
579
580
581
582
583
  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.

    """
584
    if self.dev_type in (constants.LD_LV, constants.LD_FILE):
585
586
587
588
589
590
591
592
593
      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)

594
595
596
597
598
599
600
601
602
  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

603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
  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:
628
      pnode, snode, port, pminor, sminor, secret = self.logical_id
629
630
631
632
633
634
635
636
      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))
637
638
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
639
      if pnode == target_node:
640
        self.physical_id = p_data + s_data + (pminor, secret)
641
      else: # it must be secondary, we tested above
642
        self.physical_id = s_data + p_data + (sminor, secret)
643
644
645
646
    else:
      self.physical_id = self.logical_id
    return

647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
  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)
674
675
676
677
    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))
678
679
    return obj

680
681
682
683
684
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
685
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
686
    elif self.dev_type in constants.LDS_DRBD:
687
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
688
      val = "<DRBD8("
689
690
691
692
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
693
694
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
695

696
697
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
698
699
700
701
702
703
704
705
706
707
708
      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
709
710
711
712
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
713
714
    return val

715
716
717
718
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
719
    all_errors = []
720
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
721
722
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
723

724
725
726
727
728
729
730
731
732
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.children:
      for child in self.children:
        child.UpgradeConfig()
    # add here config upgrade for this disk

Iustin Pop's avatar
Iustin Pop committed
733

734
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
735
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
736
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
737
738
739
    "name",
    "primary_node",
    "os",
740
    "hypervisor",
741
742
    "hvparams",
    "beparams",
743
    "osparams",
744
    "admin_up",
Iustin Pop's avatar
Iustin Pop committed
745
746
747
    "nics",
    "disks",
    "disk_template",
748
    "network_port",
749
    "serial_no",
750
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
751
752
753
754

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

755
756
757
758
759
760
761
762
763
764
765
766
767
    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
768
769
770
771
772
773
    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.

    """
774
775
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
776
      if device.dev_type in constants.LDS_DRBD:
777
778
779
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
780
781
      if device.children:
        for child in device.children:
782
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
783

784
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
785
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
786
    for device in self.disks:
787
788
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
789

790
791
  all_nodes = property(_ComputeAllNodes, None, None,
                       "List of all nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
792
793
794
795

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

Iustin Pop's avatar
Iustin Pop committed
799
800
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
801

802
803
804
805
    @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
806
807
808
809
810
811

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

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
812
813
814
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
815
816
817
818
819
820
821
822
823
824
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

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

828
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
829
830
831
832
833
834
835
836
837
        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

838
839
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
840

841
    This is just a wrapper that does validation of the index.
842

843
844
845
846
847
    @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
848

849
850
851
852
    """
    try:
      idx = int(idx)
      return self.disks[idx]
853
    except (TypeError, ValueError), err:
854
855
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
856
857
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
858
                                 " 0 to %d" % (idx, len(self.disks) - 1),
859
                                 errors.ECODE_INVAL)
860

861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
  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

889
890
891
892
893
894
895
896
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
897
898
899
900
901
902
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
903
904
    if self.osparams is None:
      self.osparams = {}
905

Iustin Pop's avatar
Iustin Pop committed
906
907

class OS(ConfigObject):
908
909
910
911
912
913
  """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

914
915
916
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

917
  """
Iustin Pop's avatar
Iustin Pop committed
918
919
920
  __slots__ = [
    "name",
    "path",
921
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
922
923
    "create_script",
    "export_script",
924
925
    "import_script",
    "rename_script",
926
    "verify_script",
927
    "supported_variants",
928
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
929
930
    ]

931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
  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]

966

967
class Node(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
968
  """Config object representing a node."""
Balazs Lecz's avatar
Balazs Lecz committed
969
  __slots__ = [
970
971
972
    "name",
    "primary_ip",
    "secondary_ip",
973
    "serial_no",
974
    "master_candidate",
975
    "offline",
976
    "drained",
977
    "group",
978
979
    "master_capable",
    "vm_capable",
980
    "ndparams",
981
    "powered",
982
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
983

984
985
986
987
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
988
    # pylint: disable=E0203
989
990
991
992
993
994
995
    # 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

996
997
998
    if self.ndparams is None:
      self.ndparams = {}

999
1000
1001
    if self.powered is None:
      self.powered = True

Iustin Pop's avatar
Iustin Pop committed
1002

1003
class NodeGroup(TaggableObject):
1004
1005
1006
1007
  """Config object representing a node group."""
  __slots__ = [
    "name",
    "members",
1008
    "ndparams",
1009
    "serial_no",
1010
    "alloc_policy",
1011
1012
1013
1014
1015
    ] + _TIMESTAMPS + _UUID

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

1016
1017
    This discards the members object, which gets recalculated and is only kept
    in memory.
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034

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

1035
1036
1037
1038
1039
1040
1041
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

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

1042
1043
1044
    if self.serial_no is None:
      self.serial_no = 1

1045
1046
1047
    if self.alloc_policy is None:
      self.alloc_policy = constants.ALLOC_POLICY_PREFERRED

1048
1049
1050
1051
1052
    # We only update mtime, and not ctime, since we would not be able to provide
    # a correct value for creation time.
    if self.mtime is None:
      self.mtime = time.time()

1053
  def FillND(self, node):
1054
    """Return filled out ndparams for L{objects.Node}
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069

    @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
1070
        from the node group defaults
1071
1072
1073
1074

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

1075

1076
class Cluster(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1077
  """Config object representing the cluster."""
Balazs Lecz's avatar
Balazs Lecz committed
1078
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1079
1080
1081
    "serial_no",
    "rsahostkeypub",
    "highest_used_port",
1082
    "tcpudp_port_pool",
Iustin Pop's avatar
Iustin Pop committed
1083
1084
    "mac_prefix",
    "volume_group_name",
1085
    "reserved_lvs",
1086
    "drbd_usermode_helper",
Iustin Pop's avatar
Iustin Pop committed
1087
    "default_bridge",
1088
    "default_hypervisor",
1089
1090
1091
    "master_node",
    "master_ip",
    "master_netdev",
1092
    "master_netmask",
1093
1094
    "cluster_name",
    "file_storage_dir",
1095
    "shared_file_storage_dir",
1096
    "enabled_hypervisors",
1097
    "hvparams",
1098
    "os_hvp",
1099
    "beparams",
1100
    "osparams",
1101
    "nicparams",
1102
    "ndparams",
1103
    "candidate_pool_size",
1104
    "modify_etc_hosts",
1105
    "modify_ssh_setup",
1106
    "maintain_node_health",
Balazs Lecz's avatar
Balazs Lecz committed
1107
    "uid_pool",
1108
    "default_iallocator",
1109
1110
    "hidden_os",
    "blacklisted_os",
1111
    "primary_ip_family",
1112
    "prealloc_wipe_disks",
1113
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1114

1115
1116
1117
1118
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
1119
    # pylint: disable=E0203
Iustin Pop's avatar
Iustin Pop committed
1120
    # because these are "defined" via slots, not manually
1121
1122
1123
1124
    if self.hvparams is None:
      self.hvparams = constants.HVC_DEFAULTS
    else:
      for hypervisor in self.hvparams:
Guido Trotter's avatar
Guido Trotter committed
1125
        self.hvparams[hypervisor] = FillDict(
1126
1127
            constants.HVC_DEFAULTS[hypervisor], self.hvparams[hypervisor])

1128
1129
1130
    if self.os_hvp is None:
      self.os_hvp = {}

1131
1132
1133
1134
    # osparams added before 2.2
    if self.osparams is None:
      self.osparams = {}

1135
1136
1137
    if self.ndparams is None:
      self.ndparams = constants.NDC_DEFAULTS

1138
1139
    self.beparams = UpgradeGroupedParams(self.beparams,
                                         constants.BEC_DEFAULTS)
1140
1141
1142
1143
1144
1145
    migrate_default_bridge = not self.nicparams
    self.nicparams = UpgradeGroupedParams(self.nicparams,
                                          constants.NICC_DEFAULTS)
    if migrate_default_bridge:
      self.nicparams[constants.PP_DEFAULT][constants.NIC_LINK] = \
        self.default_bridge
1146

1147
1148
1149
    if self.modify_etc_hosts is None:
      self.modify_etc_hosts = True

1150
1151
1152
    if self.modify_ssh_setup is None:
      self.modify_ssh_setup = True

Stephen Shirley's avatar
Stephen Shirley committed
1153
    # default_bridge is no longer used in 2.1. The slot is left there to
1154
1155
    # support auto-upgrading. It can be removed once we decide to deprecate
    # upgrading straight from 2.0.
1156
1157
1158
    if self.default_bridge is not None:
      self.default_bridge = None

1159
1160
    # default_hypervisor is just the first enabled one in 2.1. This slot and
    # code can be removed once upgrading straight from 2.0 is deprecated.
1161
    if self.default_hypervisor is not None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1162
      self.enabled_hypervisors = ([self.default_hypervisor] +
1163
        [hvname for hvname in self.enabled_hypervisors
Michael Hanselmann's avatar
Michael Hanselmann committed
1164
         if hvname != self.default_hypervisor])
1165
1166
      self.default_hypervisor = None

1167
1168
1169
1170
    # maintain_node_health added after 2.1.1
    if self.maintain_node_health is None:
      self.maintain_node_health = False

Balazs Lecz's avatar
Balazs Lecz committed
1171
1172
1173
    if self.uid_pool is None:
      self.uid_pool = []

1174
1175
1176
    if self.default_iallocator is None:
      self.default_iallocator = ""

1177
1178
1179
1180
    # reserved_lvs added before 2.2
    if self.reserved_lvs is None:
      self.reserved_lvs = []

Iustin Pop's avatar
Iustin Pop committed
1181
    # hidden and blacklisted operating systems added before 2.2.1
1182
1183
    if self.hidden_os is None:
      self.hidden_os = []
Iustin Pop's avatar
Iustin Pop committed
1184

1185
1186
    if self.blacklisted_os is None:
      self.blacklisted_os = []
Iustin Pop's avatar
Iustin Pop committed
1187

1188
1189
1190
1191
    # primary_ip_family added before 2.3
    if self.primary_ip_family is None:
      self.primary_ip_family = AF_INET

1192
1193
1194
    if self.prealloc_wipe_disks is None:
      self.prealloc_wipe_disks = False

1195
1196
1197
1198
    # shared_file_storage_dir added before 2.5
    if self.shared_file_storage_dir is None:
      self.shared_file_storage_dir = ""

1199
1200
1201
1202
  def ToDict(self):
    """Custom function for cluster.

    """
1203
    mydict = super(Cluster, self).ToDict()
1204
1205
1206
1207
1208
1209
1210
1211
    mydict["tcpudp_port_pool"] = list(self.tcpudp_port_pool)
    return mydict

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

    """
1212
    obj = super(Cluster, cls).FromDict(val)
1213
1214
1215
1216
    if not isinstance(obj.tcpudp_port_pool, set):
      obj.tcpudp_port_pool = set(obj.tcpudp_port_pool)
    return obj

1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
  def GetHVDefaults(self, hypervisor, os_name=None, skip_keys=None):
    """Get the default hypervisor parameters for the cluster.

    @param hypervisor: the hypervisor name
    @param os_name: if specified, we'll also update the defaults for this OS
    @param skip_keys: if passed, list of keys not to use
    @return: the defaults dict

    """
    if skip_keys is None:
      skip_keys = []

    fill_stack = [self.hvparams.get(hypervisor, {})]
    if os_name is not None:
      os_hvp = self.os_hvp.get(os_name, {}).get(hypervisor, {})
      fill_stack.append(os_hvp)

    ret_dict = {}
    for o_dict in fill_stack:
      ret_dict = FillDict(ret_dict, o_dict, skip_keys=skip_keys)

    return ret_dict

1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
  def SimpleFillHV(self, hv_name, os_name, hvparams, skip_globals=False):
    """Fill a given hvparams dict with cluster defaults.

    @type hv_name: string
    @param hv_name: the hypervisor to use
    @type os_name: string
    @param os_name: the OS to use for overriding the hypervisor defaults
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
    @rtype: dict
    @return: a copy of the given hvparams with missing keys filled from
        the cluster defaults

    """
    if skip_globals:
      skip_keys = constants.HVC_GLOBALS
    else:
      skip_keys = []

    def_dict = self.GetHVDefaults(hv_name, os_name, skip_keys=skip_keys)
    return FillDict(def_dict, hvparams, skip_keys=skip_keys)
1262

1263
  def FillHV(self, instance, skip_globals=False):
1264
    """Fill an instance's hvparams dict with cluster defaults.
1265

1266
    @type instance: L{objects.Instance}
1267
    @param instance: the instance parameter to fill
1268
1269
1270
    @type skip_globals: boolean
    @param skip_globals: if True, the global hypervisor parameters will
        not be filled
1271
1272
1273
1274
1275
    @rtype: dict
    @return: a copy of the instance's hvparams with missing keys filled from
        the cluster defaults

    """
1276
1277
    return self.SimpleFillHV(instance.hypervisor, instance.os,
                             instance.hvparams, skip_globals)
1278

1279
1280
1281
  def SimpleFillBE(self, beparams):
    """Fill a given beparams dict with cluster defaults.

1282
1283
    @type beparams: dict
    @param beparams: the dict to fill
1284
1285
1286
1287
1288
1289
    @rtype: dict
    @return: a copy of the passed in beparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.beparams.get(constants.PP_DEFAULT, {}), beparams)
1290
1291

  def FillBE(self, instance):
1292
    """Fill an instance's beparams dict with cluster defaults.
1293

1294
    @type instance: L{objects.Instance}
1295
1296
1297
1298
1299
1300
    @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

    """
1301
1302
1303
1304
1305
    return self.SimpleFillBE(instance.beparams)

  def SimpleFillNIC(self, nicparams):
    """Fill a given nicparams dict with cluster defaults.

1306
1307
    @type nicparams: dict
    @param nicparams: the dict to fill
1308
1309
1310
1311
1312
1313
    @rtype: dict
    @return: a copy of the passed in nicparams with missing keys filled
        from the cluster defaults

    """
    return FillDict(self.nicparams.get(constants.PP_DEFAULT, {}), nicparams)
1314

1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
  def SimpleFillOS(self, os_name, os_params):
    """Fill an instance's osparams dict with cluster defaults.

    @type os_name: string
    @param os_name: the OS name to use
    @type os_params: dict
    @param os_params: the dict to fill with default values
    @rtype: dict
    @return: a copy of the instance's osparams with missing keys filled from
        the cluster defaults

    """
    name_only =