objects.py 62.8 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, 2013 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

# E0203: Access to member %r before its definition, since we use
Iustin Pop's avatar
Iustin Pop committed
32
# objects.py which doesn't explicitly initialise its members
Iustin Pop's avatar
Iustin Pop committed
33

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 logging
42
import time
43
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
44
45

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

51
52
from socket import AF_INET

Iustin Pop's avatar
Iustin Pop committed
53
54

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

57
_TIMESTAMPS = ["ctime", "mtime"]
58
_UUID = ["uuid"]
59

60

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

Iustin Pop's avatar
Iustin Pop committed
64
65
66
67
  @type defaults_dict: dict
  @param defaults_dict: dictionary holding the default values
  @type custom_dict: dict
  @param custom_dict: dictionary holding customized value
68
69
  @type skip_keys: list
  @param skip_keys: which keys not to fill
Iustin Pop's avatar
Iustin Pop committed
70
71
  @rtype: dict
  @return: dict with the 'full' values
Guido Trotter's avatar
Guido Trotter committed
72

Iustin Pop's avatar
Iustin Pop committed
73
74
75
  """
  ret_dict = copy.deepcopy(defaults_dict)
  ret_dict.update(custom_dict)
76
77
78
79
80
81
  if skip_keys:
    for k in skip_keys:
      try:
        del ret_dict[k]
      except KeyError:
        pass
Iustin Pop's avatar
Iustin Pop committed
82
  return ret_dict
Iustin Pop's avatar
Iustin Pop committed
83

84

85
86
87
88
89
90
91
92
93
94
def _FillMinMaxISpecs(default_specs, custom_specs):
  assert frozenset(default_specs.keys()) == constants.ISPECS_MINMAX_KEYS
  ret_specs = {}
  for key in constants.ISPECS_MINMAX_KEYS:
    ret_specs[key] = FillDict(default_specs[key],
                              custom_specs.get(key, {}))
  return ret_specs


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

  """
98
  assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
99
  ret_dict = {}
100
101
102
103
104
105
106
  # Instance specs
  new_mm = _FillMinMaxISpecs(default_ipolicy[constants.ISPECS_MINMAX],
                             custom_ipolicy.get(constants.ISPECS_MINMAX, {}))
  ret_dict[constants.ISPECS_MINMAX] = new_mm
  new_std = FillDict(default_ipolicy[constants.ISPECS_STD],
                     custom_ipolicy.get(constants.ISPECS_STD, {}))
  ret_dict[constants.ISPECS_STD] = new_std
107
  # list items
108
  for key in [constants.IPOLICY_DTS]:
109
    ret_dict[key] = list(custom_ipolicy.get(key, default_ipolicy[key]))
110
111
112
  # other items which we know we can directly copy (immutables)
  for key in constants.IPOLICY_PARAMETERS:
    ret_dict[key] = custom_ipolicy.get(key, default_ipolicy[key])
113

114
115
116
  return ret_dict


117
118
119
def FillDiskParams(default_dparams, custom_dparams, skip_keys=None):
  """Fills the disk parameter defaults.

120
  @see: L{FillDict} for parameters and return value
121
122
123
124
125
126
127
128
129

  """
  assert frozenset(default_dparams.keys()) == constants.DISK_TEMPLATES

  return dict((dt, FillDict(default_dparams[dt], custom_dparams.get(dt, {}),
                             skip_keys=skip_keys))
              for dt in constants.DISK_TEMPLATES)


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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


147
148
149
150
151
152
153
154
155
156
157
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
158
    del target[constants.BE_MEMORY]
159
160


161
162
163
164
165
166
def UpgradeDiskParams(diskparams):
  """Upgrade the disk parameters.

  @type diskparams: dict
  @param diskparams: disk parameters to upgrade
  @rtype: dict
167
  @return: the upgraded disk parameters dict
168
169

  """
170
171
  if not diskparams:
    result = {}
172
  else:
173
    result = FillDiskParams(constants.DISK_DT_DEFAULTS, diskparams)
174
175
176
177

  return result


Iustin Pop's avatar
Iustin Pop committed
178
179
180
181
182
183
184
185
186
187
188
189
def UpgradeNDParams(ndparams):
  """Upgrade ndparams structure.

  @type ndparams: dict
  @param ndparams: disk parameters to upgrade
  @rtype: dict
  @return: the upgraded node parameters dict

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

190
191
192
193
  if (constants.ND_OOB_PROGRAM in ndparams and
      ndparams[constants.ND_OOB_PROGRAM] is None):
    # will be reset by the line below
    del ndparams[constants.ND_OOB_PROGRAM]
Iustin Pop's avatar
Iustin Pop committed
194
195
196
  return FillDict(constants.NDC_DEFAULTS, ndparams)


197
198
199
200
def MakeEmptyIPolicy():
  """Create empty IPolicy dictionary.

  """
201
202
203
204
205
206
207
  return {
    constants.ISPECS_MINMAX: {
      constants.ISPECS_MIN: {},
      constants.ISPECS_MAX: {},
      },
    constants.ISPECS_STD: {},
    }
208
209


210
class ConfigObject(outils.ValidatedSlots):
Iustin Pop's avatar
Iustin Pop committed
211
212
213
214
215
216
217
218
219
  """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
220
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
221
222
223
224
225

  """
  __slots__ = []

  def __getattr__(self, name):
226
    if name not in self.GetAllSlots():
227
228
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
229
230
231
    return None

  def __setstate__(self, state):
232
    slots = self.GetAllSlots()
Iustin Pop's avatar
Iustin Pop committed
233
    for name in state:
234
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
235
236
        setattr(self, name, state[name])

237
238
  def Validate(self):
    """Validates the slots.
239
240

    """
241

242
243
244
245
246
247
248
249
250
251
  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.

    """
252
    result = {}
253
    for name in self.GetAllSlots():
254
255
256
257
258
259
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

  @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))
277
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
278
    obj = cls(**val_str) # pylint: disable=W0142
279
280
    return obj

281
282
283
284
285
286
287
288
  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

289
290
291
292
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

293
294
295
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

296
297
    This method will be called at configuration load time, and its
    implementation will be object dependent.
298
299
300
301

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
302

303
class TaggableObject(ConfigObject):
304
305
306
  """An generic class supporting tags.

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

Iustin Pop's avatar
Iustin Pop committed
310
311
  @classmethod
  def ValidateTag(cls, tag):
312
313
314
315
316
317
318
    """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):
319
      raise errors.TagError("Invalid tag type (not a string)")
320
    if len(tag) > constants.MAX_TAG_LEN:
321
322
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
323
    if not tag:
324
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
325
    if not cls.VALID_TAG_RE.match(tag):
326
      raise errors.TagError("Tag contains invalid characters")
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343

  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:
344
      raise errors.TagError("Too many tags")
345
346
347
348
349
350
351
352
353
354
355
    self.GetTags().add(tag)

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

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

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
  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

381

382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
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",
397
    "ip_family",
398
399
400
    ]


Iustin Pop's avatar
Iustin Pop committed
401
402
class ConfigData(ConfigObject):
  """Top-level config object."""
403
404
405
406
407
408
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
409
    "networks",
410
411
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
412

413
414
415
416
417
418
419
420
421
  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()
422
    for key in "nodes", "instances", "nodegroups", "networks":
Iustin Pop's avatar
Iustin Pop committed
423
      mydict[key] = outils.ContainerToDicts(mydict[key])
424
425
426
427
428
429
430
431
432
433

    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)
Iustin Pop's avatar
Iustin Pop committed
434
    obj.nodes = outils.ContainerFromDicts(obj.nodes, dict, Node)
435
    obj.instances = \
Iustin Pop's avatar
Iustin Pop committed
436
      outils.ContainerFromDicts(obj.instances, dict, Instance)
437
    obj.nodegroups = \
Iustin Pop's avatar
Iustin Pop committed
438
439
      outils.ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
    obj.networks = outils.ContainerFromDicts(obj.networks, dict, Network)
440
441
    return obj

442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
  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

457
458
459
460
461
462
463
464
465
  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()
466
467
468
469
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
470
471
472
473
474
475
    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
476
477
    if self.networks is None:
      self.networks = {}
478
479
    for network in self.networks.values():
      network.UpgradeConfig()
480
    self._UpgradeEnabledDiskTemplates()
481

482
483
484
  def _UpgradeEnabledDiskTemplates(self):
    """Upgrade the cluster's enabled disk templates by inspecting the currently
       enabled and/or used disk templates.
485
486

    """
487
488
489
490
491
492
    # enabled_disk_templates in the cluster config were introduced in 2.8.
    # Remove this code once upgrading from earlier versions is deprecated.
    if not self.cluster.enabled_disk_templates:
      template_set = \
        set([inst.disk_template for inst in self.instances.values()])
      # Add drbd and plain, if lvm is enabled (by specifying a volume group)
493
      if self.cluster.volume_group_name:
494
495
        template_set.add(constants.DT_DRBD8)
        template_set.add(constants.DT_PLAIN)
496
      # FIXME: Adapt this when dis/enabling at configure time is removed.
497
498
      # Enable 'file' and 'sharedfile', if they are enabled, even though they
      # might currently not be used.
499
      if constants.ENABLE_FILE_STORAGE:
500
        template_set.add(constants.DT_FILE)
501
      if constants.ENABLE_SHARED_FILE_STORAGE:
502
503
        template_set.add(constants.DT_SHARED_FILE)
      # Set enabled_disk_templates to the inferred disk templates. Order them
504
      # according to a preference list that is based on Ganeti's history of
505
506
507
508
509
510
511
      # supported disk templates.
      self.cluster.enabled_disk_templates = []
      for preferred_template in constants.DISK_TEMPLATE_PREFERENCE:
        if preferred_template in template_set:
          self.cluster.enabled_disk_templates.append(preferred_template)
          template_set.remove(preferred_template)
      self.cluster.enabled_disk_templates.extend(list(template_set))
512

Iustin Pop's avatar
Iustin Pop committed
513
514
515

class NIC(ConfigObject):
  """Config object representing a network card."""
Dimitris Aragiorgis's avatar
Dimitris Aragiorgis committed
516
  __slots__ = ["mac", "ip", "network", "nicparams", "netinfo"]
Iustin Pop's avatar
Iustin Pop committed
517

Guido Trotter's avatar
Guido Trotter committed
518
519
520
521
522
523
524
525
526
  @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

    """
527
528
529
530
    mode = nicparams[constants.NIC_MODE]
    if (mode not in constants.NIC_VALID_MODES and
        mode != constants.VALUE_AUTO):
      raise errors.ConfigurationError("Invalid NIC mode '%s'" % mode)
Guido Trotter's avatar
Guido Trotter committed
531

532
    if (mode == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
533
        not nicparams[constants.NIC_LINK]):
534
      raise errors.ConfigurationError("Missing bridged NIC link")
Guido Trotter's avatar
Guido Trotter committed
535

Iustin Pop's avatar
Iustin Pop committed
536
537
538
539

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

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

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

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

554
555
556
557
558
559
560
  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.

561
562
563
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

564
565
566
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
567
568
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
569
570
    elif self.dev_type == constants.LD_RBD:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
571
572
    return None

573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
  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

589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
  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
604
605
606
607
608
609
610
611
612
  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.

    """
613
    if self.dev_type in [constants.LD_LV, constants.LD_FILE,
614
615
                         constants.LD_BLOCKDEV, constants.LD_RBD,
                         constants.LD_EXT]:
Iustin Pop's avatar
Iustin Pop committed
616
      result = [node]
617
    elif self.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
618
619
      result = [self.logical_id[0], self.logical_id[1]]
      if node not in result:
620
        raise errors.ConfigurationError("DRBD device passed unknown node")
Iustin Pop's avatar
Iustin Pop committed
621
    else:
622
      raise errors.ProgrammerError("Unhandled device type %s" % self.dev_type)
Iustin Pop's avatar
Iustin Pop committed
623
624
625
626
627
628
629
    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
630
631
632
    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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659

    """
    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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
  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 {}

682
683
684
685
686
687
688
689
  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.

    """
690
    if self.dev_type in (constants.LD_LV, constants.LD_FILE,
691
                         constants.LD_RBD, constants.LD_EXT):
692
693
694
695
696
697
698
699
700
      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)

701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
  def Update(self, size=None, mode=None):
    """Apply changes to size and mode.

    """
    if self.dev_type == constants.LD_DRBD8:
      if self.children:
        self.children[0].Update(size=size, mode=mode)
    else:
      assert not self.children

    if size is not None:
      self.size = size
    if mode is not None:
      self.mode = mode

716
717
718
719
720
721
722
723
724
  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

725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
  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:
750
      pnode, snode, port, pminor, sminor, secret = self.logical_id
751
752
753
754
755
756
757
758
      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))
759
760
      p_data = (pnode_ip, port)
      s_data = (snode_ip, port)
761
      if pnode == target_node:
762
        self.physical_id = p_data + s_data + (pminor, secret)
763
      else: # it must be secondary, we tested above
764
        self.physical_id = s_data + p_data + (sminor, secret)
765
766
767
768
    else:
      self.physical_id = self.logical_id
    return

769
770
771
772
773
774
775
776
777
778
779
780
  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:
Iustin Pop's avatar
Iustin Pop committed
781
        bo[attr] = outils.ContainerToDicts(alist)
782
783
784
785
786
787
788
789
790
    return bo

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

    """
    obj = super(Disk, cls).FromDict(val)
    if obj.children:
Iustin Pop's avatar
Iustin Pop committed
791
      obj.children = outils.ContainerFromDicts(obj.children, list, Disk)
792
793
794
795
    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)
796
797
798
799
    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))
800
801
    return obj

802
803
804
805
806
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
807
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
808
    elif self.dev_type in constants.LDS_DRBD:
809
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
810
      val = "<DRBD8("
811
812
813
814
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
815
816
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
817

818
819
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
820
821
822
823
824
825
826
827
828
829
830
      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
831
832
833
834
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
835
836
    return val

837
838
839
840
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
841
    all_errors = []
842
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
843
844
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
845

846
847
848
849
850
851
852
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    if self.children:
      for child in self.children:
        child.UpgradeConfig()
853

854
    # FIXME: Make this configurable in Ganeti 2.7
855
    self.params = {}
856
857
    # add here config upgrade for this disk

858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
  @staticmethod
  def ComputeLDParams(disk_template, disk_params):
    """Computes Logical Disk parameters from Disk Template parameters.

    @type disk_template: string
    @param disk_template: disk template, one of L{constants.DISK_TEMPLATES}
    @type disk_params: dict
    @param disk_params: disk template parameters;
                        dict(template_name -> parameters
    @rtype: list(dict)
    @return: a list of dicts, one for each node of the disk hierarchy. Each dict
      contains the LD parameters of the node. The tree is flattened in-order.

    """
    if disk_template not in constants.DISK_TEMPLATES:
      raise errors.ProgrammerError("Unknown disk template %s" % disk_template)

    assert disk_template in disk_params

    result = list()
    dt_params = disk_params[disk_template]
    if disk_template == constants.DT_DRBD8:
880
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], {
881
882
883
884
885
886
887
888
889
890
891
892
        constants.LDP_RESYNC_RATE: dt_params[constants.DRBD_RESYNC_RATE],
        constants.LDP_BARRIERS: dt_params[constants.DRBD_DISK_BARRIERS],
        constants.LDP_NO_META_FLUSH: dt_params[constants.DRBD_META_BARRIERS],
        constants.LDP_DEFAULT_METAVG: dt_params[constants.DRBD_DEFAULT_METAVG],
        constants.LDP_DISK_CUSTOM: dt_params[constants.DRBD_DISK_CUSTOM],
        constants.LDP_NET_CUSTOM: dt_params[constants.DRBD_NET_CUSTOM],
        constants.LDP_DYNAMIC_RESYNC: dt_params[constants.DRBD_DYNAMIC_RESYNC],
        constants.LDP_PLAN_AHEAD: dt_params[constants.DRBD_PLAN_AHEAD],
        constants.LDP_FILL_TARGET: dt_params[constants.DRBD_FILL_TARGET],
        constants.LDP_DELAY_TARGET: dt_params[constants.DRBD_DELAY_TARGET],
        constants.LDP_MAX_RATE: dt_params[constants.DRBD_MAX_RATE],
        constants.LDP_MIN_RATE: dt_params[constants.DRBD_MIN_RATE],
893
        }))
894
895

      # data LV
896
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
897
        constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
898
        }))
899
900

      # metadata LV
901
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
902
        constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
903
904
905
        }))

    elif disk_template in (constants.DT_FILE, constants.DT_SHARED_FILE):
906
907
908
      result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE])

    elif disk_template == constants.DT_PLAIN:
909
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
910
        constants.LDP_STRIPES: dt_params[constants.LV_STRIPES],
911
        }))
912
913
914
915
916

    elif disk_template == constants.DT_BLOCK:
      result.append(constants.DISK_LD_DEFAULTS[constants.LD_BLOCKDEV])

    elif disk_template == constants.DT_RBD:
917
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], {
918
        constants.LDP_POOL: dt_params[constants.RBD_POOL],
919
        }))
920

921
922
923
    elif disk_template == constants.DT_EXT:
      result.append(constants.DISK_LD_DEFAULTS[constants.LD_EXT])

924
925
    return result

Iustin Pop's avatar
Iustin Pop committed
926

927
class InstancePolicy(ConfigObject):
928
  """Config object representing instance policy limits dictionary.
929

930
931
932
933
  Note that this object is not actually used in the config, it's just
  used as a placeholder for a few functions.

  """
934
  @classmethod
935
  def CheckParameterSyntax(cls, ipolicy, check_std):
936
937
    """ Check the instance policy for validity.

938
939
940
941
942
943
    @type ipolicy: dict
    @param ipolicy: dictionary with min/max/std specs and policies
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
    @raise errors.ConfigurationError: when the policy is not legal

944
    """
945
946
947
948
949
950
951
952
    if constants.ISPECS_MINMAX in ipolicy:
      if check_std and constants.ISPECS_STD not in ipolicy:
        msg = "Missing key in ipolicy: %s" % constants.ISPECS_STD
        raise errors.ConfigurationError(msg)
      minmaxspecs = ipolicy[constants.ISPECS_MINMAX]
      stdspec = ipolicy.get(constants.ISPECS_STD)
      for param in constants.ISPECS_PARAMETERS:
        InstancePolicy.CheckISpecSyntax(minmaxspecs, stdspec, param, check_std)
953
954
    if constants.IPOLICY_DTS in ipolicy:
      InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
955
956
957
    for key in constants.IPOLICY_PARAMETERS:
      if key in ipolicy:
        InstancePolicy.CheckParameter(key, ipolicy[key])
958
959
960
961
    wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
    if wrong_keys:
      raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
                                      utils.CommaJoin(wrong_keys))
962
963

  @classmethod
964
965
  def CheckISpecSyntax(cls, minmaxspecs, stdspec, name, check_std):
    """Check the instance policy specs for validity on a given key.
966

967
968
    We check if the instance specs makes sense for a given key, that is
    if minmaxspecs[min][name] <= stdspec[name] <= minmaxspec[max][name].
969

970
971
972
973
    @type minmaxspecs: dict
    @param minmaxspecs: dictionary with min and max instance spec
    @type stdspec: dict
    @param stdspec: dictionary with standard instance spec
974
975
    @type name: string
    @param name: what are the limits for
976
977
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
978
979
    @raise errors.ConfigurationError: when specs for the given name are not
        valid
980
981

    """
982
983
984
985
986
987
988
989
    missing = constants.ISPECS_MINMAX_KEYS - frozenset(minmaxspecs.keys())
    if missing:
      msg = "Missing instance specification: %s" % utils.CommaJoin(missing)
      raise errors.ConfigurationError(msg)

    minspec = minmaxspecs[constants.ISPECS_MIN]
    maxspec = minmaxspecs[constants.ISPECS_MAX]
    min_v = minspec.get(name, 0)
990
991

    if check_std:
992
      std_v = stdspec.get(name, min_v)
993
994
995
996
997
      std_msg = std_v
    else:
      std_v = min_v
      std_msg = "-"

998
    max_v = maxspec.get(name, std_v)
999
    if min_v > std_v or std_v > max_v:
1000
1001
1002
1003
1004
      err = ("Invalid specification of min/max/std values for %s: %s/%s/%s" %
             (name,
              minspec.get(name, "-"),
              maxspec.get(name, "-"),
              std_msg))
1005
1006
      raise errors.ConfigurationError(err)

1007
1008
1009
1010
1011
  @classmethod
  def CheckDiskTemplates(cls, disk_templates):
    """Checks the disk templates for validity.

    """
1012
1013
1014
    if not disk_templates:
      raise errors.ConfigurationError("Instance policy must contain" +
                                      " at least one disk template")
1015
1016
1017
1018
1019
    wrong = frozenset(disk_templates).difference(constants.DISK_TEMPLATES)
    if wrong:
      raise errors.ConfigurationError("Invalid disk template(s) %s" %
                                      utils.CommaJoin(wrong))

1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
  @classmethod
  def CheckParameter(cls, key, value):
    """Checks a parameter.

    Currently we expect all parameters to be float values.

    """
    try:
      float(value)
    except (TypeError, ValueError), err:
      raise errors.ConfigurationError("Invalid value for key" " '%s':"
                                      " '%s', error: %s" % (key, value, err))

1033

1034
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1035
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
1036
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1037
1038
1039
    "name",
    "primary_node",
    "os",
1040
    "hypervisor",
1041
1042
    "hvparams",
    "beparams",
1043
    "osparams",
1044
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
1045
1046
1047
    "nics",
    "disks",
    "disk_template",
1048
    "network_port",
1049
    "serial_no",
1050
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1051
1052
1053
1054

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

1055
1056
1057
1058
1059
1060
1061
1062
    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,
1063
                             "List of names of secondary nodes")
1064
1065
1066
1067

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

Iustin Pop's avatar
Iustin Pop committed
1068
1069
1070
1071
1072
1073
    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.

    """
1074
1075
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
1076
      if device.dev_type in constants.LDS_DRBD:
1077
1078
1079
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
1080
1081
      if device.children:
        for child in device.children:
1082
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
1083

1084
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
1085
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
1086
    for device in self.disks:
1087
1088
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
1089

1090
  all_nodes = property(_ComputeAllNodes, None, None,
1091
                       "List of names of all the nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
1092
1093
1094
1095

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

Iustin Pop's avatar
Iustin Pop committed
1099
1100
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
1101

1102
1103
1104
1105
    @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
1106
1107

    """
Iustin Pop's avatar
Iustin Pop committed
1108
    if node is None:
Iustin Pop's avatar
Iustin Pop committed
1109
1110
1111
      node = self.primary_node

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1112
1113
1114
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

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

1128
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
1129
1130
1131
1132
1133
1134
1135
1136
1137
        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

1138
1139
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
1140

1141
    This is just a wrapper that does validation of the index.
1142

1143
1144
1145
1146
1147
    @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
1148

1149
1150
1151
1152
    """
    try:
      idx = int(idx)
      return self.disks[idx]
1153
    except (TypeError, ValueError), err:
1154
1155
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
1156
1157
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1158
                                 " 0 to %d" % (idx, len(self.disks) - 1),
1159
                                 errors.ECODE_INVAL)
1160

1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
  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:
Iustin Pop's avatar
Iustin Pop committed
1173
        nlist = outils.ContainerToDicts(alist)
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
      else:
        nlist = []
      bo[attr] = nlist
    return bo

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

    """
1184
1185
1186
1187
1188
1189
1190
    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"]
1191
    obj = super(Instance, cls).FromDict(val)
Iustin Pop's avatar
Iustin Pop committed
1192
1193
    obj.nics = outils.ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = outils.ContainerFromDicts(obj.disks, list, Disk)
1194
1195
    return obj

1196
1197
1198
1199
1200
1201
1202
1203
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
1204
1205
1206
1207
1208
1209
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
1210
1211
    if self.osparams is None:
      self.osparams = {}
1212
    UpgradeBeParams(self.beparams)
1213

Iustin Pop's avatar
Iustin Pop committed
1214
1215

class OS(ConfigObject):
1216
1217
1218
1219
1220
1221
  """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

1222
1223
1224
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

1225
  """
Iustin Pop's avatar
Iustin Pop committed
1226
1227
1228
  __slots__ = [
    "name",
    "path",
1229
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
1230
1231
    "create_script",
    "export_script",
1232
1233
    "import_script",
    "rename_script",
1234
    "verify_script",
1235
    "supported_variants",
1236
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
1237
1238
    ]

1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
  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]

1274

1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
class ExtStorage(ConfigObject):
  """Config object representing an External Storage Provider.

  """
  __slots__ = [
    "name",
    "path",
    "create_script",
    "remove_script",
    "grow_script",
    "attach_script",
    "detach_script",
    "setinfo_script",
1288
1289
    "verify_script",
    "supported_parameters",
1290
1291