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

4
# Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011, 2012 Google Inc.
Iustin Pop's avatar
Iustin Pop committed
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Transportable objects for Ganeti.

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

"""

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

# 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 objectutils
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
def FillIPolicy(default_ipolicy, custom_ipolicy, skip_keys=None):
  """Fills an instance policy with defaults.
87
88

  """
89
  assert frozenset(default_ipolicy.keys()) == constants.IPOLICY_ALL_KEYS
90
  ret_dict = {}
91
  for key in constants.IPOLICY_ISPECS:
92
93
    ret_dict[key] = FillDict(default_ipolicy[key],
                             custom_ipolicy.get(key, {}),
94
                             skip_keys=skip_keys)
95
  # list items
96
  for key in [constants.IPOLICY_DTS]:
97
    ret_dict[key] = list(custom_ipolicy.get(key, default_ipolicy[key]))
98
99
100
  # 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])
101

102
103
104
  return ret_dict


105
106
107
def FillDiskParams(default_dparams, custom_dparams, skip_keys=None):
  """Fills the disk parameter defaults.

108
  @see: L{FillDict} for parameters and return value
109
110
111
112
113
114
115
116
117

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


118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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


135
136
137
138
139
140
141
142
143
144
145
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
146
    del target[constants.BE_MEMORY]
147
148


149
150
151
152
153
154
def UpgradeDiskParams(diskparams):
  """Upgrade the disk parameters.

  @type diskparams: dict
  @param diskparams: disk parameters to upgrade
  @rtype: dict
155
  @return: the upgraded disk parameters dict
156
157

  """
158
159
  if not diskparams:
    result = {}
160
  else:
161
    result = FillDiskParams(constants.DISK_DT_DEFAULTS, diskparams)
162
163
164
165

  return result


Iustin Pop's avatar
Iustin Pop committed
166
167
168
169
170
171
172
173
174
175
176
177
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 = {}

178
179
180
181
  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
182
183
184
  return FillDict(constants.NDC_DEFAULTS, ndparams)


185
186
187
188
189
def MakeEmptyIPolicy():
  """Create empty IPolicy dictionary.

  """
  return dict([
190
191
192
    (constants.ISPECS_MIN, {}),
    (constants.ISPECS_MAX, {}),
    (constants.ISPECS_STD, {}),
193
194
195
    ])


196
class ConfigObject(objectutils.ValidatedSlots):
Iustin Pop's avatar
Iustin Pop committed
197
198
199
200
201
202
203
204
205
  """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
206
  config objects and the memory reduction is useful)
Iustin Pop's avatar
Iustin Pop committed
207
208
209
210
211

  """
  __slots__ = []

  def __getattr__(self, name):
212
    if name not in self.GetAllSlots():
213
214
      raise AttributeError("Invalid object attribute %s.%s" %
                           (type(self).__name__, name))
Iustin Pop's avatar
Iustin Pop committed
215
216
217
    return None

  def __setstate__(self, state):
218
    slots = self.GetAllSlots()
Iustin Pop's avatar
Iustin Pop committed
219
    for name in state:
220
      if name in slots:
Iustin Pop's avatar
Iustin Pop committed
221
222
        setattr(self, name, state[name])

223
224
  def Validate(self):
    """Validates the slots.
225
226

    """
227

228
229
230
231
232
233
234
235
236
237
  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.

    """
238
    result = {}
239
    for name in self.GetAllSlots():
240
241
242
243
244
245
      value = getattr(self, name, None)
      if value is not None:
        result[name] = value
    return result

  __getstate__ = ToDict
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262

  @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))
263
    val_str = dict([(str(k), v) for k, v in val.iteritems()])
264
    obj = cls(**val_str) # pylint: disable=W0142
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
    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))
297
298
    if source is None:
      source = c_type()
299
300
301
302
303
304
305
306
307
    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

308
309
310
311
312
313
314
315
  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

316
317
318
319
  def __repr__(self):
    """Implement __repr__ for ConfigObjects."""
    return repr(self.ToDict())

320
321
322
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

323
324
    This method will be called at configuration load time, and its
    implementation will be object dependent.
325
326
327
328

    """
    pass

Iustin Pop's avatar
Iustin Pop committed
329

330
class TaggableObject(ConfigObject):
331
332
333
  """An generic class supporting tags.

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

Iustin Pop's avatar
Iustin Pop committed
337
338
  @classmethod
  def ValidateTag(cls, tag):
339
340
341
342
343
344
345
    """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):
346
      raise errors.TagError("Invalid tag type (not a string)")
347
    if len(tag) > constants.MAX_TAG_LEN:
348
349
      raise errors.TagError("Tag too long (>%d characters)" %
                            constants.MAX_TAG_LEN)
350
    if not tag:
351
      raise errors.TagError("Tags cannot be empty")
Iustin Pop's avatar
Iustin Pop committed
352
    if not cls.VALID_TAG_RE.match(tag):
353
      raise errors.TagError("Tag contains invalid characters")
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370

  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:
371
      raise errors.TagError("Too many tags")
372
373
374
375
376
377
378
379
380
381
382
    self.GetTags().add(tag)

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

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

385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
  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

408

409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
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",
424
    "ip_family",
425
426
427
    ]


Iustin Pop's avatar
Iustin Pop committed
428
429
class ConfigData(ConfigObject):
  """Top-level config object."""
430
431
432
433
434
435
  __slots__ = [
    "version",
    "cluster",
    "nodes",
    "nodegroups",
    "instances",
436
    "networks",
437
438
    "serial_no",
    ] + _TIMESTAMPS
Iustin Pop's avatar
Iustin Pop committed
439

440
441
442
443
444
445
446
447
448
  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()
449
    for key in "nodes", "instances", "nodegroups", "networks":
450
451
452
453
454
455
456
457
458
459
460
461
462
      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)
463
    obj.nodegroups = cls._ContainerFromDicts(obj.nodegroups, dict, NodeGroup)
464
    obj.networks = cls._ContainerFromDicts(obj.networks, dict, Network)
465
466
    return obj

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

482
483
484
485
486
487
488
489
490
  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()
491
492
493
494
    if self.nodegroups is None:
      self.nodegroups = {}
    for nodegroup in self.nodegroups.values():
      nodegroup.UpgradeConfig()
495
496
497
498
499
500
    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
501
502
    if self.networks is None:
      self.networks = {}
503
504
    for network in self.networks.values():
      network.UpgradeConfig()
505

Iustin Pop's avatar
Iustin Pop committed
506
507
508

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

Guido Trotter's avatar
Guido Trotter committed
511
512
513
514
515
516
517
518
519
  @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

    """
520
521
522
523
    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
524

525
    if (mode == constants.NIC_MODE_BRIDGED and
Guido Trotter's avatar
Guido Trotter committed
526
        not nicparams[constants.NIC_LINK]):
527
      raise errors.ConfigurationError("Missing bridged NIC link")
Guido Trotter's avatar
Guido Trotter committed
528

Iustin Pop's avatar
Iustin Pop committed
529
530
531
532

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

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

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

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

547
548
549
550
551
552
553
  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.

554
555
556
    @warning: The path returned is not a normalized pathname; callers
        should check that it is a valid path.

557
558
559
    """
    if self.dev_type == constants.LD_LV:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
560
561
    elif self.dev_type == constants.LD_BLOCKDEV:
      return self.logical_id[1]
562
563
    elif self.dev_type == constants.LD_RBD:
      return "/dev/%s/%s" % (self.logical_id[0], self.logical_id[1])
564
565
    return None

566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
  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

582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
  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
597
598
599
600
601
602
603
604
605
  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.

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

    """
    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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
  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 {}

675
676
677
678
679
680
681
682
  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.

    """
683
    if self.dev_type in (constants.LD_LV, constants.LD_FILE,
684
                         constants.LD_RBD, constants.LD_EXT):
685
686
687
688
689
690
691
692
693
      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)

694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
  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

709
710
711
712
713
714
715
716
717
  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

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

762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
  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)
789
790
791
792
    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))
793
794
    return obj

795
796
797
798
799
  def __str__(self):
    """Custom str() formatter for disks.

    """
    if self.dev_type == constants.LD_LV:
Michael Hanselmann's avatar
Michael Hanselmann committed
800
      val = "<LogicalVolume(/dev/%s/%s" % self.logical_id
801
    elif self.dev_type in constants.LDS_DRBD:
802
      node_a, node_b, port, minor_a, minor_b = self.logical_id[:5]
803
      val = "<DRBD8("
804
805
806
807
      if self.physical_id is None:
        phy = "unconfigured"
      else:
        phy = ("configured as %s:%s %s:%s" %
808
809
               (self.physical_id[0], self.physical_id[1],
                self.physical_id[2], self.physical_id[3]))
810

811
812
      val += ("hosts=%s/%d-%s/%d, port=%s, %s, " %
              (node_a, minor_a, node_b, minor_b, port, phy))
813
814
815
816
817
818
819
820
821
822
823
      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
824
825
826
827
    if isinstance(self.size, int):
      val += ", size=%dm)>" % self.size
    else:
      val += ", size='%s')>" % (self.size,)
828
829
    return val

830
831
832
833
  def Verify(self):
    """Checks that this disk is correctly configured.

    """
Michael Hanselmann's avatar
Michael Hanselmann committed
834
    all_errors = []
835
    if self.mode not in constants.DISK_ACCESS_SET:
Michael Hanselmann's avatar
Michael Hanselmann committed
836
837
      all_errors.append("Disk access mode '%s' is invalid" % (self.mode, ))
    return all_errors
838

839
840
841
842
843
844
845
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

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

847
    # FIXME: Make this configurable in Ganeti 2.7
848
    self.params = {}
849
850
    # add here config upgrade for this disk

851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
  @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:
873
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_DRBD8], {
874
875
876
877
878
879
880
881
882
883
884
885
        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],
886
        }))
887
888

      # data LV
889
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
890
        constants.LDP_STRIPES: dt_params[constants.DRBD_DATA_STRIPES],
891
        }))
892
893

      # metadata LV
894
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
895
        constants.LDP_STRIPES: dt_params[constants.DRBD_META_STRIPES],
896
897
898
        }))

    elif disk_template in (constants.DT_FILE, constants.DT_SHARED_FILE):
899
900
901
      result.append(constants.DISK_LD_DEFAULTS[constants.LD_FILE])

    elif disk_template == constants.DT_PLAIN:
902
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_LV], {
903
        constants.LDP_STRIPES: dt_params[constants.LV_STRIPES],
904
        }))
905
906
907
908
909

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

    elif disk_template == constants.DT_RBD:
910
      result.append(FillDict(constants.DISK_LD_DEFAULTS[constants.LD_RBD], {
911
        constants.LDP_POOL: dt_params[constants.RBD_POOL],
912
        }))
913

914
915
916
    elif disk_template == constants.DT_EXT:
      result.append(constants.DISK_LD_DEFAULTS[constants.LD_EXT])

917
918
    return result

Iustin Pop's avatar
Iustin Pop committed
919

920
class InstancePolicy(ConfigObject):
921
  """Config object representing instance policy limits dictionary.
922

923
924
925
926
927

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

  """
928
  @classmethod
929
  def CheckParameterSyntax(cls, ipolicy, check_std):
930
931
932
933
    """ Check the instance policy for validity.

    """
    for param in constants.ISPECS_PARAMETERS:
934
      InstancePolicy.CheckISpecSyntax(ipolicy, param, check_std)
935
936
    if constants.IPOLICY_DTS in ipolicy:
      InstancePolicy.CheckDiskTemplates(ipolicy[constants.IPOLICY_DTS])
937
938
939
    for key in constants.IPOLICY_PARAMETERS:
      if key in ipolicy:
        InstancePolicy.CheckParameter(key, ipolicy[key])
940
941
942
943
    wrong_keys = frozenset(ipolicy.keys()) - constants.IPOLICY_ALL_KEYS
    if wrong_keys:
      raise errors.ConfigurationError("Invalid keys in ipolicy: %s" %
                                      utils.CommaJoin(wrong_keys))
944
945

  @classmethod
946
  def CheckISpecSyntax(cls, ipolicy, name, check_std):
947
948
949
950
951
952
953
954
955
    """Check the instance policy for validity on a given key.

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

    @type ipolicy: dict
    @param ipolicy: dictionary with min, max, std specs
    @type name: string
    @param name: what are the limits for
956
957
    @type check_std: bool
    @param check_std: Whether to check std value or just assume compliance
958
959
960
    @raise errors.ConfigureError: when specs for given name are not valid

    """
961
    min_v = ipolicy[constants.ISPECS_MIN].get(name, 0)
962
963
964
965
966
967
968
969

    if check_std:
      std_v = ipolicy[constants.ISPECS_STD].get(name, min_v)
      std_msg = std_v
    else:
      std_v = min_v
      std_msg = "-"

970
    max_v = ipolicy[constants.ISPECS_MAX].get(name, std_v)
971
972
    err = ("Invalid specification of min/max/std values for %s: %s/%s/%s" %
           (name,
973
974
            ipolicy[constants.ISPECS_MIN].get(name, "-"),
            ipolicy[constants.ISPECS_MAX].get(name, "-"),
975
            std_msg))
976
977
978
    if min_v > std_v or std_v > max_v:
      raise errors.ConfigurationError(err)

979
980
981
982
983
984
985
986
987
988
  @classmethod
  def CheckDiskTemplates(cls, disk_templates):
    """Checks the disk templates for validity.

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

989
990
991
992
993
994
995
996
997
998
999
1000
1001
  @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))

1002

1003
class Instance(TaggableObject):
Iustin Pop's avatar
Iustin Pop committed
1004
  """Config object representing an instance."""
Balazs Lecz's avatar
Balazs Lecz committed
1005
  __slots__ = [
Iustin Pop's avatar
Iustin Pop committed
1006
1007
1008
    "name",
    "primary_node",
    "os",
1009
    "hypervisor",
1010
1011
    "hvparams",
    "beparams",
1012
    "osparams",
1013
    "admin_state",
Iustin Pop's avatar
Iustin Pop committed
1014
1015
1016
    "nics",
    "disks",
    "disk_template",
1017
    "network_port",
1018
    "serial_no",
1019
    ] + _TIMESTAMPS + _UUID
Iustin Pop's avatar
Iustin Pop committed
1020
1021
1022
1023

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

1024
1025
1026
1027
1028
1029
1030
1031
    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,
1032
                             "List of names of secondary nodes")
1033
1034
1035
1036

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

Iustin Pop's avatar
Iustin Pop committed
1037
1038
1039
1040
1041
1042
    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.

    """
1043
1044
    def _Helper(nodes, device):
      """Recursively computes nodes given a top device."""
1045
      if device.dev_type in constants.LDS_DRBD:
1046
1047
1048
        nodea, nodeb = device.logical_id[:2]
        nodes.add(nodea)
        nodes.add(nodeb)
Iustin Pop's avatar
Iustin Pop committed
1049
1050
      if device.children:
        for child in device.children:
1051
          _Helper(nodes, child)
Iustin Pop's avatar
Iustin Pop committed
1052

1053
    all_nodes = set()
Iustin Pop's avatar
Iustin Pop committed
1054
    all_nodes.add(self.primary_node)
Iustin Pop's avatar
Iustin Pop committed
1055
    for device in self.disks:
1056
1057
      _Helper(all_nodes, device)
    return tuple(all_nodes)
Iustin Pop's avatar
Iustin Pop committed
1058

1059
  all_nodes = property(_ComputeAllNodes, None, None,
1060
                       "List of names of all the nodes of the instance")
Iustin Pop's avatar
Iustin Pop committed
1061
1062
1063
1064

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

Iustin Pop's avatar
Iustin Pop committed
1068
1069
    @param lvmap: optional dictionary to receive the
        'node' : ['lv', ...] data.
Iustin Pop's avatar
Iustin Pop committed
1070

1071
1072
1073
1074
    @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
1075
1076

    """
Iustin Pop's avatar
Iustin Pop committed
1077
    if node is None:
Iustin Pop's avatar
Iustin Pop committed
1078
1079
1080
      node = self.primary_node

    if lvmap is None:
Michael Hanselmann's avatar
Michael Hanselmann committed
1081
1082
1083
      lvmap = {
        node: [],
        }
Iustin Pop's avatar
Iustin Pop committed
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
      ret = lvmap
    else:
      if not node in lvmap:
        lvmap[node] = []
      ret = None

    if not devs:
      devs = self.disks

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

1097
      elif dev.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
1098
1099
1100
1101
1102
1103
1104
1105
1106
        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

1107
1108
  def FindDisk(self, idx):
    """Find a disk given having a specified index.
1109

1110
    This is just a wrapper that does validation of the index.
1111

1112
1113
1114
1115
1116
    @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
1117

1118
1119
1120
1121
    """
    try:
      idx = int(idx)
      return self.disks[idx]
1122
    except (TypeError, ValueError), err:
1123
1124
      raise errors.OpPrereqError("Invalid disk index: '%s'" % str(err),
                                 errors.ECODE_INVAL)
1125
1126
    except IndexError:
      raise errors.OpPrereqError("Invalid disk index: %d (instace has disks"
1127
                                 " 0 to %d" % (idx, len(self.disks) - 1),
1128
                                 errors.ECODE_INVAL)
1129

1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
  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.

    """
1153
1154
1155
1156
1157
1158
1159
    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"]
1160
1161
1162
1163
1164
    obj = super(Instance, cls).FromDict(val)
    obj.nics = cls._ContainerFromDicts(obj.nics, list, NIC)
    obj.disks = cls._ContainerFromDicts(obj.disks, list, Disk)
    return obj

1165
1166
1167
1168
1169
1170
1171
1172
  def UpgradeConfig(self):
    """Fill defaults for missing configuration values.

    """
    for nic in self.nics:
      nic.UpgradeConfig()
    for disk in self.disks:
      disk.UpgradeConfig()
1173
1174
1175
1176
1177
1178
    if self.hvparams:
      for key in constants.HVC_GLOBALS:
        try:
          del self.hvparams[key]
        except KeyError:
          pass
1179
1180
    if self.osparams is None:
      self.osparams = {}
1181
    UpgradeBeParams(self.beparams)
1182

Iustin Pop's avatar
Iustin Pop committed
1183
1184

class OS(ConfigObject):
1185
1186
1187
1188
1189
1190
  """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

1191
1192
1193
  @type VARIANT_DELIM: string
  @cvar VARIANT_DELIM: the variant delimiter

1194
  """
Iustin Pop's avatar
Iustin Pop committed
1195
1196
1197
  __slots__ = [
    "name",
    "path",
1198
    "api_versions",
Iustin Pop's avatar
Iustin Pop committed
1199
1200
    "create_script",
    "export_script",
1201
1202
    "import_script",
    "rename_script",
1203
    "verify_script",
1204
    "supported_variants",
1205
    "supported_parameters",
Iustin Pop's avatar
Iustin Pop committed
1206
1207
    ]

1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
  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]

1243

1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
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",
1257
1258
    "verify_script",
    "supported_parameters",
1259
1260
1261
    ]


1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
class NodeHvState(ConfigObject):
  """Hypvervisor state on a node.

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

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


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

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


1296
class Node(TaggableObject):
1297
1298
1299
1300
1301
1302
1303
1304
  """Config object representing a node.

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

  """
Balazs Lecz's avatar
Balazs Lecz committed
1305
  __slots__ = [
1306
1307
1308
    "name",
    "primary_ip",
    "secondary_ip",
1309
    "serial_no",
1310
    "master_candidate",
1311
    "offline",
1312
    "drained",
1313
    "group",
1314
1315
    "master_capable",
    "vm_capable",
1316
    "ndparams",
1317
    "powered",