config.py 41 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Configuration management for Ganeti

24
This module provides the interface to the Ganeti cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
25

26
27
The configuration data is stored on every node but is updated on the master
only. After each update, the master distributes the data to the other nodes.
Iustin Pop's avatar
Iustin Pop committed
28

29
30
Currently, the data storage format is JSON. YAML was slow and consuming too
much memory.
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
36

"""

import os
import tempfile
import random
37
import logging
38
import time
Iustin Pop's avatar
Iustin Pop committed
39
40

from ganeti import errors
41
from ganeti import locking
Iustin Pop's avatar
Iustin Pop committed
42
43
44
45
from ganeti import utils
from ganeti import constants
from ganeti import rpc
from ganeti import objects
46
from ganeti import serializer
47
48


49
50
51
_config_lock = locking.SharedLock()


Michael Hanselmann's avatar
Michael Hanselmann committed
52
def _ValidateConfig(data):
Iustin Pop's avatar
Iustin Pop committed
53
54
55
56
57
58
59
60
  """Verifies that a configuration objects looks valid.

  This only verifies the version of the configuration.

  @raise errors.ConfigurationError: if the version differs from what
      we expect

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
61
  if data.version != constants.CONFIG_VERSION:
62
63
    raise errors.ConfigurationError("Cluster configuration version"
                                    " mismatch, got %s instead of %s" %
Michael Hanselmann's avatar
Michael Hanselmann committed
64
                                    (data.version,
65
                                     constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
66

67

Iustin Pop's avatar
Iustin Pop committed
68
class ConfigWriter:
69
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
70

71
  """
Iustin Pop's avatar
Iustin Pop committed
72
  def __init__(self, cfg_file=None, offline=False):
73
    self.write_count = 0
74
    self._lock = _config_lock
Iustin Pop's avatar
Iustin Pop committed
75
76
77
78
79
80
    self._config_data = None
    self._offline = offline
    if cfg_file is None:
      self._cfg_file = constants.CLUSTER_CONF_FILE
    else:
      self._cfg_file = cfg_file
81
    self._temporary_ids = set()
82
    self._temporary_drbds = {}
83
    self._temporary_macs = set()
84
85
86
87
88
    # Note: in order to prevent errors when resolving our name in
    # _DistributeConfig, we compute it here once and reuse it; it's
    # better to raise an error before starting to modify the config
    # file than after it was modified
    self._my_hostname = utils.HostInfo().name
89
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
90
    self._OpenConfig()
Iustin Pop's avatar
Iustin Pop committed
91
92
93
94
95
96
97
98
99

  # this method needs to be static, so that we can call it on the class
  @staticmethod
  def IsCluster():
    """Check if the cluster is configured.

    """
    return os.path.exists(constants.CLUSTER_CONF_FILE)

100
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
101
102
103
104
105
106
107
108
109
110
111
112
113
114
  def GenerateMAC(self):
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
    prefix = self._config_data.cluster.mac_prefix
    all_macs = self._AllMACs()
    retries = 64
    while retries > 0:
      byte1 = random.randrange(0, 256)
      byte2 = random.randrange(0, 256)
      byte3 = random.randrange(0, 256)
      mac = "%s:%02x:%02x:%02x" % (prefix, byte1, byte2, byte3)
115
      if mac not in all_macs and mac not in self._temporary_macs:
Iustin Pop's avatar
Iustin Pop committed
116
117
118
        break
      retries -= 1
    else:
119
      raise errors.ConfigurationError("Can't generate unique MAC")
120
    self._temporary_macs.add(mac)
Iustin Pop's avatar
Iustin Pop committed
121
122
    return mac

123
  @locking.ssynchronized(_config_lock, shared=1)
124
125
126
127
128
129
130
131
  def IsMacInUse(self, mac):
    """Predicate: check if the specified MAC is in use in the Ganeti cluster.

    This only checks instances managed by this cluster, it does not
    check for potential collisions elsewhere.

    """
    all_macs = self._AllMACs()
132
    return mac in all_macs or mac in self._temporary_macs
133

134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
  @locking.ssynchronized(_config_lock, shared=1)
  def GenerateDRBDSecret(self):
    """Generate a DRBD secret.

    This checks the current disks for duplicates.

    """
    all_secrets = self._AllDRBDSecrets()
    retries = 64
    while retries > 0:
      secret = utils.GenerateSecret()
      if secret not in all_secrets:
        break
      retries -= 1
    else:
      raise errors.ConfigurationError("Can't generate unique DRBD secret")
    return secret

152
153
154
155
156
157
158
159
160
161
162
  def _ComputeAllLVs(self):
    """Compute the list of all LVs.

    """
    lvnames = set()
    for instance in self._config_data.instances.values():
      node_data = instance.MapLVsByNode()
      for lv_list in node_data.values():
        lvnames.update(lv_list)
    return lvnames

163
  @locking.ssynchronized(_config_lock, shared=1)
164
165
166
167
168
169
  def GenerateUniqueID(self, exceptions=None):
    """Generate an unique disk name.

    This checks the current node, instances and disk names for
    duplicates.

Iustin Pop's avatar
Iustin Pop committed
170
171
172
173
    @param exceptions: a list with some other names which should be checked
        for uniqueness (used for example when you want to get
        more than one id at one time without adding each one in
        turn to the config file)
174

Iustin Pop's avatar
Iustin Pop committed
175
176
    @rtype: string
    @return: the unique id
177
178
179
180
181
182
183
184
185
186
187

    """
    existing = set()
    existing.update(self._temporary_ids)
    existing.update(self._ComputeAllLVs())
    existing.update(self._config_data.instances.keys())
    existing.update(self._config_data.nodes.keys())
    if exceptions is not None:
      existing.update(exceptions)
    retries = 64
    while retries > 0:
188
      unique_id = utils.NewUUID()
189
190
191
      if unique_id not in existing and unique_id is not None:
        break
    else:
192
193
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
194
195
196
    self._temporary_ids.add(unique_id)
    return unique_id

Iustin Pop's avatar
Iustin Pop committed
197
198
199
  def _AllMACs(self):
    """Return all MACs present in the config.

Iustin Pop's avatar
Iustin Pop committed
200
201
202
    @rtype: list
    @return: the list of all MACs

Iustin Pop's avatar
Iustin Pop committed
203
204
205
206
207
208
209
210
    """
    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

211
212
213
  def _AllDRBDSecrets(self):
    """Return all DRBD secrets present in the config.

Iustin Pop's avatar
Iustin Pop committed
214
215
216
    @rtype: list
    @return: the list of all DRBD secrets

217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    """
    def helper(disk, result):
      """Recursively gather secrets from this disk."""
      if disk.dev_type == constants.DT_DRBD8:
        result.append(disk.logical_id[5])
      if disk.children:
        for child in disk.children:
          helper(child, result)

    result = []
    for instance in self._config_data.instances.values():
      for disk in instance.disks:
        helper(disk, result)

    return result

233
234
235
236
237
238
239
240
241
242
243
244
245
246
  def _CheckDiskIDs(self, disk, l_ids, p_ids):
    """Compute duplicate disk IDs

    @type disk: L{objects.Disk}
    @param disk: the disk at which to start searching
    @type l_ids: list
    @param l_ids: list of current logical ids
    @type p_ids: list
    @param p_ids: list of current physical ids
    @rtype: list
    @return: a list of error messages

    """
    result = []
247
248
249
250
251
252
253
254
255
256
    if disk.logical_id is not None:
      if disk.logical_id in l_ids:
        result.append("duplicate logical id %s" % str(disk.logical_id))
      else:
        l_ids.append(disk.logical_id)
    if disk.physical_id is not None:
      if disk.physical_id in p_ids:
        result.append("duplicate physical id %s" % str(disk.physical_id))
      else:
        p_ids.append(disk.physical_id)
257
258
259
260
261
262

    if disk.children:
      for child in disk.children:
        result.extend(self._CheckDiskIDs(child, l_ids, p_ids))
    return result

263
  def _UnlockedVerifyConfig(self):
264
265
    """Verify function.

266
267
268
269
    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

Iustin Pop's avatar
Iustin Pop committed
270
271
272
    """
    result = []
    seen_macs = []
273
    ports = {}
Iustin Pop's avatar
Iustin Pop committed
274
    data = self._config_data
275
276
    seen_lids = []
    seen_pids = []
277
278
279
280
281
282
283
284
285
286
287
288
289
290

    # global cluster checks
    if not data.cluster.enabled_hypervisors:
      result.append("enabled hypervisors list doesn't have any entries")
    invalid_hvs = set(data.cluster.enabled_hypervisors) - constants.HYPER_TYPES
    if invalid_hvs:
      result.append("enabled hypervisors contains invalid entries: %s" %
                    invalid_hvs)

    if data.cluster.master_node not in data.nodes:
      result.append("cluster has invalid primary node '%s'" %
                    data.cluster.master_node)

    # per-instance checks
Iustin Pop's avatar
Iustin Pop committed
291
292
293
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
294
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
295
296
297
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
298
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
299
300
301
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
302
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
303
304
305
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320

      # gather the drbd ports for duplicate checks
      for dsk in instance.disks:
        if dsk.dev_type in constants.LDS_DRBD:
          tcp_port = dsk.logical_id[2]
          if tcp_port not in ports:
            ports[tcp_port] = []
          ports[tcp_port].append((instance.name, "drbd disk %s" % dsk.iv_name))
      # gather network port reservation
      net_port = getattr(instance, "network_port", None)
      if net_port is not None:
        if net_port not in ports:
          ports[net_port] = []
        ports[net_port].append((instance.name, "network port"))

321
322
323
324
      # instance disk verify
      for idx, disk in enumerate(instance.disks):
        result.extend(["instance '%s' disk %d error: %s" %
                       (instance.name, idx, msg) for msg in disk.Verify()])
325
        result.extend(self._CheckDiskIDs(disk, seen_lids, seen_pids))
326

327
    # cluster-wide pool of free ports
328
    for free_port in data.cluster.tcpudp_port_pool:
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
      if free_port not in ports:
        ports[free_port] = []
      ports[free_port].append(("cluster", "port marked as free"))

    # compute tcp/udp duplicate ports
    keys = ports.keys()
    keys.sort()
    for pnum in keys:
      pdata = ports[pnum]
      if len(pdata) > 1:
        txt = ", ".join(["%s/%s" % val for val in pdata])
        result.append("tcp/udp port %s has duplicates: %s" % (pnum, txt))

    # highest used tcp port check
    if keys:
344
      if keys[-1] > data.cluster.highest_used_port:
345
        result.append("Highest used port mismatch, saved %s, computed %s" %
346
347
                      (data.cluster.highest_used_port, keys[-1]))

348
349
350
    if not data.nodes[data.cluster.master_node].master_candidate:
      result.append("Master node is not a master candidate")

351
    # master candidate checks
352
353
354
355
    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()
    if mc_now < mc_max:
      result.append("Not enough master candidates: actual %d, target %d" %
                    (mc_now, mc_max))
356

357
358
359
360
361
362
363
364
    # node checks
    for node in data.nodes.values():
      if [node.master_candidate, node.drained, node.offline].count(True) > 1:
        result.append("Node %s state is invalid: master_candidate=%s,"
                      " drain=%s, offline=%s" %
                      (node.name, node.master_candidate, node.drain,
                       node.offline))

365
366
367
368
369
370
    # drbd minors check
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    for node, minor, instance_a, instance_b in duplicates:
      result.append("DRBD minor %d on node %s is assigned twice to instances"
                    " %s and %s" % (minor, node, instance_a, instance_b))

Iustin Pop's avatar
Iustin Pop committed
371
372
    return result

373
374
375
376
377
378
379
380
381
382
383
384
385
  @locking.ssynchronized(_config_lock, shared=1)
  def VerifyConfig(self):
    """Verify function.

    This is just a wrapper over L{_UnlockedVerifyConfig}.

    @rtype: list
    @return: a list of error messages; a non-empty list signifies
        configuration errors

    """
    return self._UnlockedVerifyConfig()

386
  def _UnlockedSetDiskID(self, disk, node_name):
Iustin Pop's avatar
Iustin Pop committed
387
388
389
390
391
392
393
394
    """Convert the unique ID to the ID needed on the target nodes.

    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.

395
396
    This function is for internal use, when the config lock is already held.

Iustin Pop's avatar
Iustin Pop committed
397
398
399
    """
    if disk.children:
      for child in disk.children:
400
        self._UnlockedSetDiskID(child, node_name)
Iustin Pop's avatar
Iustin Pop committed
401
402
403

    if disk.logical_id is None and disk.physical_id is not None:
      return
404
    if disk.dev_type == constants.LD_DRBD8:
405
      pnode, snode, port, pminor, sminor, secret = disk.logical_id
Iustin Pop's avatar
Iustin Pop committed
406
      if node_name not in (pnode, snode):
407
408
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
409
410
      pnode_info = self._UnlockedGetNodeInfo(pnode)
      snode_info = self._UnlockedGetNodeInfo(snode)
Iustin Pop's avatar
Iustin Pop committed
411
412
413
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
414
415
      p_data = (pnode_info.secondary_ip, port)
      s_data = (snode_info.secondary_ip, port)
Iustin Pop's avatar
Iustin Pop committed
416
      if pnode == node_name:
417
        disk.physical_id = p_data + s_data + (pminor, secret)
Iustin Pop's avatar
Iustin Pop committed
418
      else: # it must be secondary, we tested above
419
        disk.physical_id = s_data + p_data + (sminor, secret)
Iustin Pop's avatar
Iustin Pop committed
420
421
422
423
    else:
      disk.physical_id = disk.logical_id
    return

424
425
426
427
428
429
430
431
432
433
434
435
436
437
  @locking.ssynchronized(_config_lock)
  def SetDiskID(self, disk, node_name):
    """Convert the unique ID to the ID needed on the target nodes.

    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.

    """
    return self._UnlockedSetDiskID(disk, node_name)

  @locking.ssynchronized(_config_lock)
438
439
440
441
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
442
    if not isinstance(port, int):
443
      raise errors.ProgrammerError("Invalid type passed for port")
444

445
    self._config_data.cluster.tcpudp_port_pool.add(port)
446
447
    self._WriteConfig()

448
  @locking.ssynchronized(_config_lock, shared=1)
449
  def GetPortList(self):
450
451
452
    """Returns a copy of the current port list.

    """
453
    return self._config_data.cluster.tcpudp_port_pool.copy()
454

455
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
456
457
458
  def AllocatePort(self):
    """Allocate a port.

459
460
461
    The port will be taken from the available port pool or from the
    default port range (and in this case we increase
    highest_used_port).
Iustin Pop's avatar
Iustin Pop committed
462
463

    """
464
    # If there are TCP/IP ports configured, we use them first.
465
466
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
467
468
469
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
470
471
472
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
473
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
474
475
476
477

    self._WriteConfig()
    return port

478
  def _UnlockedComputeDRBDMap(self):
479
480
    """Compute the used DRBD minor/nodes.

481
    @rtype: (dict, list)
Iustin Pop's avatar
Iustin Pop committed
482
483
    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
484
485
486
        an empty list), and a list of duplicates; if the duplicates
        list is not empty, the configuration is corrupted and its caller
        should raise an exception
487
488
489

    """
    def _AppendUsedPorts(instance_name, disk, used):
490
      duplicates = []
491
      if disk.dev_type == constants.LD_DRBD8 and len(disk.logical_id) >= 5:
Michael Hanselmann's avatar
Michael Hanselmann committed
492
493
        node_a, node_b, _, minor_a, minor_b = disk.logical_id[:5]
        for node, port in ((node_a, minor_a), (node_b, minor_b)):
494
495
          assert node in used, ("Node '%s' of instance '%s' not found"
                                " in node list" % (node, instance_name))
496
          if port in used[node]:
497
498
499
            duplicates.append((node, port, instance_name, used[node][port]))
          else:
            used[node][port] = instance_name
500
501
      if disk.children:
        for child in disk.children:
502
503
          duplicates.extend(_AppendUsedPorts(instance_name, child, used))
      return duplicates
504

505
    duplicates = []
506
    my_dict = dict((node, {}) for node in self._config_data.nodes)
507
508
509
    for instance in self._config_data.instances.itervalues():
      for disk in instance.disks:
        duplicates.extend(_AppendUsedPorts(instance.name, disk, my_dict))
510
    for (node, minor), instance in self._temporary_drbds.iteritems():
511
      if minor in my_dict[node] and my_dict[node][minor] != instance:
512
513
514
515
        duplicates.append((node, minor, instance, my_dict[node][minor]))
      else:
        my_dict[node][minor] = instance
    return my_dict, duplicates
516

517
518
519
520
521
522
523
524
525
526
527
  @locking.ssynchronized(_config_lock)
  def ComputeDRBDMap(self):
    """Compute the used DRBD minor/nodes.

    This is just a wrapper over L{_UnlockedComputeDRBDMap}.

    @return: dictionary of node_name: dict of minor: instance_name;
        the returned dict will have all the nodes in it (even if with
        an empty list).

    """
528
529
530
531
532
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
    return d_map
533

534
535
536
537
538
539
540
541
542
  @locking.ssynchronized(_config_lock)
  def AllocateDRBDMinor(self, nodes, instance):
    """Allocate a drbd minor.

    The free minor will be automatically computed from the existing
    devices. A node can be given multiple times in order to allocate
    multiple minors. The result is the list of minors, in the same
    order as the passed nodes.

543
544
545
    @type instance: string
    @param instance: the instance for which we allocate minors

546
    """
547
    assert isinstance(instance, basestring), \
548
           "Invalid argument '%s' passed to AllocateDRBDMinor" % instance
549

550
551
552
553
    d_map, duplicates = self._UnlockedComputeDRBDMap()
    if duplicates:
      raise errors.ConfigurationError("Duplicate DRBD ports detected: %s" %
                                      str(duplicates))
554
555
556
557
558
559
560
    result = []
    for nname in nodes:
      ndata = d_map[nname]
      if not ndata:
        # no minors used, we can start at 0
        result.append(0)
        ndata[0] = instance
561
        self._temporary_drbds[(nname, 0)] = instance
562
563
564
565
566
567
568
569
570
571
        continue
      keys = ndata.keys()
      keys.sort()
      ffree = utils.FirstFree(keys)
      if ffree is None:
        # return the next minor
        # TODO: implement high-limit check
        minor = keys[-1] + 1
      else:
        minor = ffree
572
573
574
575
576
      # double-check minor against current instances
      assert minor not in d_map[nname], \
             ("Attempt to reuse allocated DRBD minor %d on node %s,"
              " already allocated to instance %s" %
              (minor, nname, d_map[nname][minor]))
577
      ndata[minor] = instance
578
579
580
581
582
583
584
585
      # double-check minor against reservation
      r_key = (nname, minor)
      assert r_key not in self._temporary_drbds, \
             ("Attempt to reuse reserved DRBD minor %d on node %s,"
              " reserved for instance %s" %
              (minor, nname, self._temporary_drbds[r_key]))
      self._temporary_drbds[r_key] = instance
      result.append(minor)
586
587
588
589
    logging.debug("Request to allocate drbd minors, input: %s, returning %s",
                  nodes, result)
    return result

590
  def _UnlockedReleaseDRBDMinors(self, instance):
591
592
593
594
595
596
597
    """Release temporary drbd minors allocated for a given instance.

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
598
599
    assert isinstance(instance, basestring), \
           "Invalid argument passed to ReleaseDRBDMinors"
600
601
602
603
    for key, name in self._temporary_drbds.items():
      if name == instance:
        del self._temporary_drbds[key]

604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
  @locking.ssynchronized(_config_lock)
  def ReleaseDRBDMinors(self, instance):
    """Release temporary drbd minors allocated for a given instance.

    This should be called on the error paths, on the success paths
    it's automatically called by the ConfigWriter add and update
    functions.

    This function is just a wrapper over L{_UnlockedReleaseDRBDMinors}.

    @type instance: string
    @param instance: the instance for which temporary minors should be
                     released

    """
    self._UnlockedReleaseDRBDMinors(instance)

621
622
623
624
625
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
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
  @locking.ssynchronized(_config_lock, shared=1)
  def GetConfigVersion(self):
    """Get the configuration version.

    @return: Config version

    """
    return self._config_data.version

  @locking.ssynchronized(_config_lock, shared=1)
  def GetClusterName(self):
    """Get cluster name.

    @return: Cluster name

    """
    return self._config_data.cluster.cluster_name

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterNode(self):
    """Get the hostname of the master node for this cluster.

    @return: Master hostname

    """
    return self._config_data.cluster.master_node

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterIP(self):
    """Get the IP of the master node for this cluster.

    @return: Master IP

    """
    return self._config_data.cluster.master_ip

  @locking.ssynchronized(_config_lock, shared=1)
  def GetMasterNetdev(self):
    """Get the master network device for this cluster.

    """
    return self._config_data.cluster.master_netdev

  @locking.ssynchronized(_config_lock, shared=1)
  def GetFileStorageDir(self):
    """Get the file storage dir for this cluster.

    """
    return self._config_data.cluster.file_storage_dir

  @locking.ssynchronized(_config_lock, shared=1)
  def GetHypervisorType(self):
    """Get the hypervisor type for this cluster.

    """
676
    return self._config_data.cluster.enabled_hypervisors[0]
677

678
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
679
680
681
  def GetHostKey(self):
    """Return the rsa hostkey from the config.

Iustin Pop's avatar
Iustin Pop committed
682
683
    @rtype: string
    @return: the rsa hostkey
Iustin Pop's avatar
Iustin Pop committed
684
685
686
687

    """
    return self._config_data.cluster.rsahostkeypub

688
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
689
690
691
692
693
  def AddInstance(self, instance):
    """Add an instance to the config.

    This should be used after creating a new instance.

Iustin Pop's avatar
Iustin Pop committed
694
695
696
    @type instance: L{objects.Instance}
    @param instance: the instance object

Iustin Pop's avatar
Iustin Pop committed
697
698
699
700
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

701
702
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
Iustin Pop's avatar
Iustin Pop committed
703
      logging.info("Instance '%s' DISK_LAYOUT: %s", instance.name, all_lvs)
704

705
706
707
708
709
710
    all_macs = self._AllMACs()
    for nic in instance.nics:
      if nic.mac in all_macs:
        raise errors.ConfigurationError("Cannot add instance %s:"
          " MAC address '%s' already in use." % (instance.name, nic.mac))

711
    instance.serial_no = 1
712
    instance.ctime = instance.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
713
    self._config_data.instances[instance.name] = instance
714
    self._config_data.cluster.serial_no += 1
715
    self._UnlockedReleaseDRBDMinors(instance.name)
716
717
    for nic in instance.nics:
      self._temporary_macs.discard(nic.mac)
Iustin Pop's avatar
Iustin Pop committed
718
719
    self._WriteConfig()

720
721
  def _SetInstanceStatus(self, instance_name, status):
    """Set the instance's status to a given value.
Iustin Pop's avatar
Iustin Pop committed
722
723

    """
724
725
    assert isinstance(status, bool), \
           "Invalid status '%s' passed to SetInstanceStatus" % (status,)
Iustin Pop's avatar
Iustin Pop committed
726
727

    if instance_name not in self._config_data.instances:
728
729
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
730
    instance = self._config_data.instances[instance_name]
731
732
    if instance.admin_up != status:
      instance.admin_up = status
733
      instance.serial_no += 1
734
      instance.mtime = time.time()
735
      self._WriteConfig()
Iustin Pop's avatar
Iustin Pop committed
736

737
  @locking.ssynchronized(_config_lock)
738
739
740
741
  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
742
    self._SetInstanceStatus(instance_name, True)
743

744
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
745
746
747
748
749
  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    if instance_name not in self._config_data.instances:
750
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
751
    del self._config_data.instances[instance_name]
752
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
753
754
    self._WriteConfig()

755
  @locking.ssynchronized(_config_lock)
756
757
758
759
760
761
762
763
764
765
766
767
768
  def RenameInstance(self, old_name, new_name):
    """Rename an instance.

    This needs to be done in ConfigWriter and not by RemoveInstance
    combined with AddInstance as only we can guarantee an atomic
    rename.

    """
    if old_name not in self._config_data.instances:
      raise errors.ConfigurationError("Unknown instance '%s'" % old_name)
    inst = self._config_data.instances[old_name]
    del self._config_data.instances[old_name]
    inst.name = new_name
769
770
771
772
773
774
775
776
777
778

    for disk in inst.disks:
      if disk.dev_type == constants.LD_FILE:
        # rename the file paths in logical and physical id
        file_storage_dir = os.path.dirname(os.path.dirname(disk.logical_id[1]))
        disk.physical_id = disk.logical_id = (disk.logical_id[0],
                                              os.path.join(file_storage_dir,
                                                           inst.name,
                                                           disk.iv_name))

779
780
781
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

782
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
783
784
785
786
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
787
    self._SetInstanceStatus(instance_name, False)
Iustin Pop's avatar
Iustin Pop committed
788

789
790
791
792
793
794
795
796
  def _UnlockedGetInstanceList(self):
    """Get the list of instances.

    This function is for internal use, when the config lock is already held.

    """
    return self._config_data.instances.keys()

797
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
798
799
800
  def GetInstanceList(self):
    """Get the list of instances.

Iustin Pop's avatar
Iustin Pop committed
801
802
    @return: array of instances, ex. ['instance2.example.com',
        'instance1.example.com']
Iustin Pop's avatar
Iustin Pop committed
803
804

    """
805
    return self._UnlockedGetInstanceList()
Iustin Pop's avatar
Iustin Pop committed
806

807
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
808
809
810
811
812
813
814
  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
                                    self._config_data.instances.keys())

815
  def _UnlockedGetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
816
    """Returns information about an instance.
817
818
819
820
821
822
823
824
825

    This function is for internal use, when the config lock is already held.

    """
    if instance_name not in self._config_data.instances:
      return None

    return self._config_data.instances[instance_name]

826
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
827
  def GetInstanceInfo(self, instance_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
828
    """Returns information about an instance.
Iustin Pop's avatar
Iustin Pop committed
829

Michael Hanselmann's avatar
Michael Hanselmann committed
830
    It takes the information from the configuration file. Other information of
Iustin Pop's avatar
Iustin Pop committed
831
832
    an instance are taken from the live systems.

Iustin Pop's avatar
Iustin Pop committed
833
834
    @param instance_name: name of the instance, e.g.
        I{instance1.example.com}
Iustin Pop's avatar
Iustin Pop committed
835

Iustin Pop's avatar
Iustin Pop committed
836
837
    @rtype: L{objects.Instance}
    @return: the instance object
Iustin Pop's avatar
Iustin Pop committed
838
839

    """
840
    return self._UnlockedGetInstanceInfo(instance_name)
Iustin Pop's avatar
Iustin Pop committed
841

842
843
844
845
846
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllInstancesInfo(self):
    """Get the configuration of all instances.

    @rtype: dict
Iustin Pop's avatar
Iustin Pop committed
847
    @return: dict of (instance, instance_info), where instance_info is what
848
849
850
              would GetInstanceInfo return for the node

    """
851
852
    my_dict = dict([(instance, self._UnlockedGetInstanceInfo(instance))
                    for instance in self._UnlockedGetInstanceList()])
853
854
    return my_dict

855
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
856
857
858
  def AddNode(self, node):
    """Add a node to the configuration.

Iustin Pop's avatar
Iustin Pop committed
859
860
    @type node: L{objects.Node}
    @param node: a Node instance
Iustin Pop's avatar
Iustin Pop committed
861
862

    """
863
864
    logging.info("Adding node %s to configuration" % node.name)

865
    node.serial_no = 1
866
    node.ctime = node.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
867
    self._config_data.nodes[node.name] = node
868
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
869
870
    self._WriteConfig()

871
  @locking.ssynchronized(_config_lock)
Iustin Pop's avatar
Iustin Pop committed
872
873
874
875
  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
876
877
    logging.info("Removing node %s from configuration" % node_name)

Iustin Pop's avatar
Iustin Pop committed
878
    if node_name not in self._config_data.nodes:
879
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
880
881

    del self._config_data.nodes[node_name]
882
    self._config_data.cluster.serial_no += 1
Iustin Pop's avatar
Iustin Pop committed
883
884
    self._WriteConfig()

885
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
886
887
888
889
890
891
892
  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    return utils.MatchNameComponent(short_name,
                                    self._config_data.nodes.keys())

893
  def _UnlockedGetNodeInfo(self, node_name):
Iustin Pop's avatar
Iustin Pop committed
894
895
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
896
897
    This function is for internal use, when the config lock is already
    held.
898

Iustin Pop's avatar
Iustin Pop committed
899
    @param node_name: the node name, e.g. I{node1.example.com}
Iustin Pop's avatar
Iustin Pop committed
900

Iustin Pop's avatar
Iustin Pop committed
901
902
    @rtype: L{objects.Node}
    @return: the node object
Iustin Pop's avatar
Iustin Pop committed
903
904
905
906
907
908
909

    """
    if node_name not in self._config_data.nodes:
      return None

    return self._config_data.nodes[node_name]

910
911
912
913
914

  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeInfo(self, node_name):
    """Get the configuration of a node, as stored in the config.

Iustin Pop's avatar
Iustin Pop committed
915
    This is just a locked wrapper over L{_UnlockedGetNodeInfo}.
916

Iustin Pop's avatar
Iustin Pop committed
917
918
919
920
    @param node_name: the node name, e.g. I{node1.example.com}

    @rtype: L{objects.Node}
    @return: the node object
921
922
923
924
925

    """
    return self._UnlockedGetNodeInfo(node_name)

  def _UnlockedGetNodeList(self):
Iustin Pop's avatar
Iustin Pop committed
926
927
    """Return the list of nodes which are in the configuration.

Iustin Pop's avatar
Iustin Pop committed
928
929
930
931
    This function is for internal use, when the config lock is already
    held.

    @rtype: list
932

Iustin Pop's avatar
Iustin Pop committed
933
934
935
    """
    return self._config_data.nodes.keys()

936
937
938
939
940
941
942
943

  @locking.ssynchronized(_config_lock, shared=1)
  def GetNodeList(self):
    """Return the list of nodes which are in the configuration.

    """
    return self._UnlockedGetNodeList()

Iustin Pop's avatar
Iustin Pop committed
944
945
946
947
948
949
950
951
952
  @locking.ssynchronized(_config_lock, shared=1)
  def GetOnlineNodeList(self):
    """Return the list of nodes which are online.

    """
    all_nodes = [self._UnlockedGetNodeInfo(node)
                 for node in self._UnlockedGetNodeList()]
    return [node.name for node in all_nodes if not node.offline]

953
954
955
956
957
  @locking.ssynchronized(_config_lock, shared=1)
  def GetAllNodesInfo(self):
    """Get the configuration of all nodes.

    @rtype: dict
958
    @return: dict of (node, node_info), where node_info is what
959
960
961
962
963
964
965
              would GetNodeInfo return for the node

    """
    my_dict = dict([(node, self._UnlockedGetNodeInfo(node))
                    for node in self._UnlockedGetNodeList()])
    return my_dict

966
  def _UnlockedGetMasterCandidateStats(self, exceptions=None):
967
968
    """Get the number of current and maximum desired and possible candidates.

969
970
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
971
972
973
974
975
    @rtype: tuple
    @return: tuple of (current, desired and possible)

    """
    mc_now = mc_max = 0
976
977
978
    for node in self._config_data.nodes.values():
      if exceptions and node.name in exceptions:
        continue
979
      if not (node.offline or node.drained):
980
981
982
983
984
985
986
        mc_max += 1
      if node.master_candidate:
        mc_now += 1
    mc_max = min(mc_max, self._config_data.cluster.candidate_pool_size)
    return (mc_now, mc_max)

  @locking.ssynchronized(_config_lock, shared=1)
987
  def GetMasterCandidateStats(self, exceptions=None):
988
989
990
991
    """Get the number of current and maximum possible candidates.

    This is just a wrapper over L{_UnlockedGetMasterCandidateStats}.

992
993
    @type exceptions: list
    @param exceptions: if passed, list of nodes that should be ignored
994
995
996
997
    @rtype: tuple
    @return: tuple of (current, max)

    """
998
    return self._UnlockedGetMasterCandidateStats(exceptions)
999
1000
1001
1002
1003
1004

  @locking.ssynchronized(_config_lock)
  def MaintainCandidatePool(self):
    """Try to grow the candidate pool to the desired size.

    @rtype: list
Iustin Pop's avatar
Iustin Pop committed
1005
    @return: list with the adjusted nodes (L{objects.Node} instances)
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016

    """
    mc_now, mc_max = self._UnlockedGetMasterCandidateStats()
    mod_list = []
    if mc_now < mc_max:
      node_list = self._config_data.nodes.keys()
      random.shuffle(node_list)
      for name in node_list:
        if mc_now >= mc_max:
          break
        node = self._config_data.nodes[name]
1017
        if node.master_candidate or node.offline or node.drained:
1018
          continue
Iustin Pop's avatar
Iustin Pop committed
1019
        mod_list.append(node)
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
        node.master_candidate = True
        node.serial_no += 1
        mc_now += 1
      if mc_now != mc_max:
        # this should not happen
        logging.warning("Warning: MaintainCandidatePool didn't manage to"
                        " fill the candidate pool (%d/%d)", mc_now, mc_max)
      if mod_list:
        self._config_data.cluster.serial_no += 1
        self._WriteConfig()

    return mod_list

Iustin Pop's avatar
Iustin Pop committed
1033
1034
1035
1036
  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
1037
    self._config_data.serial_no += 1
1038
    self._config_data.mtime = time.time()
Iustin Pop's avatar
Iustin Pop committed
1039
1040
1041
1042
1043
1044
1045
1046

  def _OpenConfig(self):
    """Read the config data from disk.

    """
    f = open(self._cfg_file, 'r')
    try:
      try:
1047
        data = objects.ConfigData.FromDict(serializer.Load(f.read()))
Iustin Pop's avatar
Iustin Pop committed
1048
      except Exception, err:
1049
        raise errors.ConfigurationError(err)
Iustin Pop's avatar
Iustin Pop committed
1050
1051
    finally:
      f.close()
Michael Hanselmann's avatar
Michael Hanselmann committed
1052
1053
1054
1055

    # Make sure the configuration has the right version
    _ValidateConfig(data)

Iustin Pop's avatar
Iustin Pop committed
1056
    if (not hasattr(data, 'cluster') or
1057
        not hasattr(data.cluster, 'rsahostkeypub')):
1058
      raise errors.ConfigurationError("Incomplete configuration"
1059
                                      " (missing cluster.rsahostkeypub)")
Iustin Pop's avatar
Iustin Pop committed
1060
    self._config_data = data
1061
    # reset the last serial as -1 so that the next write will cause
1062
1063
    # ssconf update
    self._last_cluster_serial = -1
Iustin Pop's avatar
Iustin Pop committed
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075

  def _DistributeConfig(self):
    """Distribute the configuration to the other nodes.

    Currently, this only copies the configuration file. In the future,
    it could be used to encapsulate the 2/3-phase update mechanism.

    """
    if self._offline:
      return True
    bad = False

1076
1077
1078
    node_list = []
    addr_list = []
    myhostname = self._my_hostname
1079
1080
1081
1082
    # we can skip checking whether _UnlockedGetNodeInfo returns None
    # since the node list comes from _UnlocketGetNodeList, and we are
    # called with the lock held, so no modifications should take place
    # in between
1083
1084
1085
1086
1087
1088
1089
1090
    for node_name in self._UnlockedGetNodeList():
      if node_name == myhostname:
        continue
      node_info = self._UnlockedGetNodeInfo(node_name)
      if not node_info.master_candidate:
        continue
      node_list.append(node_info.name)
      addr_list.append(node_info.primary_ip)
1091

1092
1093
    result = rpc.RpcRunner.call_upload_file(node_list, self._cfg_file,
                                            address_list=addr_list)
1094
1095
1096
1097
    for to_node, to_result in result.items():
      msg = to_result.RemoteFailMsg()
      if msg:
        msg = ("Copy of file %s to node %s failed: %s" %
1098
               (self._cfg_file, to_node, msg))
1099
        logging.error(msg)
Iustin Pop's avatar
Iustin Pop committed
1100
1101
1102
1103
1104
1105
1106
        bad = True
    return not bad

  def _WriteConfig(self, destination=None):
    """Write the configuration data to persistent storage.

    """
1107
1108
1109
1110
1111
    config_errors = self._UnlockedVerifyConfig()
    if config_errors:
      raise errors.ConfigurationError("Configuration data is not"
                                      " consistent: %s" %
                                      (", ".join(config_errors)))
Iustin Pop's avatar
Iustin Pop committed
1112
1113
1114
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
1115
    txt = serializer.Dump(self._config_data.ToDict())
Iustin Pop's avatar
Iustin Pop committed
1116
1117
1118
1119
    dir_name, file_name = os.path.split(destination)
    fd, name = tempfile.mkstemp('.newconfig', file_name, dir_name)
    f = os.fdopen(fd, 'w')
    try:
1120
      f.write(txt)
Iustin Pop's avatar
Iustin Pop committed
1121
1122
1123
1124
1125
      os.fsync(f.fileno())
    finally:
      f.close()
    # we don't need to do os.close(fd) as f.close() did it
    os.rename(name, destination)
1126
    self.write_count += 1
Iustin Pop's avatar
Iustin Pop committed
1127

1128
    # and redistribute the config file to master candidates
Iustin Pop's avatar
Iustin Pop committed
1129
1130
    self._DistributeConfig()

1131
    # Write ssconf files on all nodes (including locally)
1132
    if self._last_cluster_serial < self._config_data.cluster.serial_no:
1133
      if not self._offline:
1134
1135
1136
1137
1138
1139
1140
1141
        result = rpc.RpcRunner.call_write_ssconf_files(\
          self._UnlockedGetNodeList(),
          self._UnlockedGetSsconfValues())
        for nname, nresu in result.items():
          msg = nresu.RemoteFailMsg()
          if msg:
            logging.warning("Error while uploading ssconf files to"
                            " node %s: %s", nname, msg)
1142
      self._last_cluster_serial = self._config_data.cluster.serial_no
1143

1144
  def _UnlockedGetSsconfValues(self):
Iustin Pop's avatar
Iustin Pop committed
1145
1146
1147
1148
1149
1150
1151
    """Return the values needed by ssconf.

    @rtype: dict
    @return: a dictionary with keys the ssconf names and values their
        associated value

    """
1152
    fn = "\n".join
1153
    instance_names = utils.NiceSort(self._UnlockedGetInstanceList())
1154
1155
    node_names = utils.NiceSort(self._UnlockedGetNodeList())
    node_info = [self._UnlockedGetNodeInfo(name) for name in node_names]
1156
    node_pri_ips = ["%s %s" % (ninfo.name, ninfo.primary_ip)
1157
                    for ninfo in node_info]
1158
    node_snd_ips = ["%s %s" % (ninfo.name, ninfo.secondary_ip)
1159
                    for ninfo in node_info]
1160

1161
    instance_data = fn(instance_names)
1162
    off_data = fn(node.name for node in node_info if node.offline)
1163
    on_data = fn(node.name for node in node_info if not node.offline)
1164
    mc_data = fn(node.name for node in node_info if node.master_candidate)
1165
1166
    mc_ips_data = fn(node.primary_ip for node in node_info
                     if node.master_candidate)
1167
    node_data = fn(node_names)
1168
1169
    node_pri_ips_data = fn(node_pri_ips)
    node_snd_ips_data = fn(node_snd_ips)
1170

Iustin Pop's avatar
Iustin Pop committed
1171
    cluster = self._config_data.cluster
1172
    cluster_tags = fn(cluster.GetTags())
1173
    return {
Iustin Pop's avatar
Iustin Pop committed
1174
      constants.SS_CLUSTER_NAME: cluster.cluster_name,
1175
      constants.SS_CLUSTER_TAGS: cluster_tags,
Iustin Pop's avatar
Iustin Pop committed
1176
      constants.SS_FILE_STORAGE_DIR: cluster.file_storage_dir,
1177
      constants.SS_MASTER_CANDIDATES: mc_data,
1178
      constants.SS_MASTER_CANDIDATES_IPS: mc_ips_data,
Iustin Pop's avatar
Iustin Pop committed
1179
1180
1181
      constants.SS_MASTER_IP: cluster.master_ip,
      constants.SS_MASTER_NETDEV: cluster.master_netdev,
      constants.SS_MASTER_NODE: cluster.master_node,
1182
      constants.SS_NODE_LIST: node_data,
1183
1184
      constants.SS_NODE_PRIMARY_IPS: node_pri_ips_data,
      constants.SS_NODE_SECONDARY_IPS: node_snd_ips_data,
1185
      constants.SS_OFFLINE_NODES: off_data,
1186
1187
      constants.SS_ONLINE_NODES: on_data,
      constants.SS_INSTANCE_LIST: instance_data,
1188
      constants.SS_RELEASE_VERSION: constants.RELEASE_VERSION,
1189
1190
      }

1191
  @locking.ssynchronized(_config_lock, shared=1)
Iustin Pop's avatar
Iustin Pop committed
1192
1193
1194
1195
1196
1197
  def GetVGName(self):
    """Return the volume group name.

    """
    return self._config_data.cluster.volume_group_name

1198
  @locking.ssynchronized(_config_lock)
1199
1200
1201
1202
  def SetVGName(self, vg_name):
    """Set the volume group name.

    """
1203
    self._config_data.cluster.volume_group_name = vg_name
1204
    self._config_data.cluster.serial_no += 1