config.py 19.9 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
37
38
39
40
41
42
43
44

"""

import os
import tempfile
import random

from ganeti import errors
from ganeti import logger
from ganeti import utils
from ganeti import constants
from ganeti import rpc
from ganeti import objects

45

Iustin Pop's avatar
Iustin Pop committed
46
class ConfigWriter:
47
  """The interface to the cluster configuration.
Iustin Pop's avatar
Iustin Pop committed
48

49
  """
Iustin Pop's avatar
Iustin Pop committed
50
  def __init__(self, cfg_file=None, offline=False):
51
    self.write_count = 0
Iustin Pop's avatar
Iustin Pop committed
52
53
    self._config_data = None
    self._config_time = None
54
55
    self._config_size = None
    self._config_inode = None
Iustin Pop's avatar
Iustin Pop committed
56
57
58
59
60
    self._offline = offline
    if cfg_file is None:
      self._cfg_file = constants.CLUSTER_CONF_FILE
    else:
      self._cfg_file = cfg_file
61
    self._temporary_ids = set()
62
63
64
65
66
    # 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
Iustin Pop's avatar
Iustin Pop committed
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

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

  def GenerateMAC(self):
    """Generate a MAC for an instance.

    This should check the current instances for duplicates.

    """
    self._OpenConfig()
    self._ReleaseLock()
    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)
      if mac not in all_macs:
        break
      retries -= 1
    else:
96
      raise errors.ConfigurationError("Can't generate unique MAC")
Iustin Pop's avatar
Iustin Pop committed
97
98
    return mac

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
  def _ComputeAllLVs(self):
    """Compute the list of all LVs.

    """
    self._OpenConfig()
    self._ReleaseLock()
    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

  def GenerateUniqueID(self, exceptions=None):
    """Generate an unique disk name.

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

    Args:
      - 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

    Returns: the unique id as a string

    """
    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:
136
      unique_id = utils.NewUUID()
137
138
139
      if unique_id not in existing and unique_id is not None:
        break
    else:
140
141
      raise errors.ConfigurationError("Not able generate an unique ID"
                                      " (last tried ID: %s" % unique_id)
142
143
144
    self._temporary_ids.add(unique_id)
    return unique_id

Iustin Pop's avatar
Iustin Pop committed
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
  def _AllMACs(self):
    """Return all MACs present in the config.

    """
    self._OpenConfig()
    self._ReleaseLock()

    result = []
    for instance in self._config_data.instances.values():
      for nic in instance.nics:
        result.append(nic.mac)

    return result

  def VerifyConfig(self):
    """Stub verify function.
    """
    self._OpenConfig()
    self._ReleaseLock()

    result = []
    seen_macs = []
    data = self._config_data
    for instance_name in data.instances:
      instance = data.instances[instance_name]
      if instance.primary_node not in data.nodes:
171
        result.append("instance '%s' has invalid primary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
172
173
174
                      (instance_name, instance.primary_node))
      for snode in instance.secondary_nodes:
        if snode not in data.nodes:
175
          result.append("instance '%s' has invalid secondary node '%s'" %
Iustin Pop's avatar
Iustin Pop committed
176
177
178
                        (instance_name, snode))
      for idx, nic in enumerate(instance.nics):
        if nic.mac in seen_macs:
179
          result.append("instance '%s' has NIC %d mac %s duplicate" %
Iustin Pop's avatar
Iustin Pop committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
                        (instance_name, idx, nic.mac))
        else:
          seen_macs.append(nic.mac)
    return result

  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.

    """
    if disk.children:
      for child in disk.children:
        self.SetDiskID(child, node_name)

    if disk.logical_id is None and disk.physical_id is not None:
      return
201
    if disk.dev_type in constants.LDS_DRBD:
Iustin Pop's avatar
Iustin Pop committed
202
203
      pnode, snode, port = disk.logical_id
      if node_name not in (pnode, snode):
204
205
        raise errors.ConfigurationError("DRBD device not knowing node %s" %
                                        node_name)
Iustin Pop's avatar
Iustin Pop committed
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
      pnode_info = self.GetNodeInfo(pnode)
      snode_info = self.GetNodeInfo(snode)
      if pnode_info is None or snode_info is None:
        raise errors.ConfigurationError("Can't find primary or secondary node"
                                        " for %s" % str(disk))
      if pnode == node_name:
        disk.physical_id = (pnode_info.secondary_ip, port,
                            snode_info.secondary_ip, port)
      else: # it must be secondary, we tested above
        disk.physical_id = (snode_info.secondary_ip, port,
                            pnode_info.secondary_ip, port)
    else:
      disk.physical_id = disk.logical_id
    return

221
222
223
224
  def AddTcpUdpPort(self, port):
    """Adds a new port to the available port pool.

    """
225
    if not isinstance(port, int):
226
      raise errors.ProgrammerError("Invalid type passed for port")
227
228

    self._OpenConfig()
229
    self._config_data.cluster.tcpudp_port_pool.add(port)
230
231
    self._WriteConfig()

232
  def GetPortList(self):
233
234
235
236
237
    """Returns a copy of the current port list.

    """
    self._OpenConfig()
    self._ReleaseLock()
238
    return self._config_data.cluster.tcpudp_port_pool.copy()
239

Iustin Pop's avatar
Iustin Pop committed
240
241
242
  def AllocatePort(self):
    """Allocate a port.

243
244
245
    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
246
247
248
249

    """
    self._OpenConfig()

250
    # If there are TCP/IP ports configured, we use them first.
251
252
    if self._config_data.cluster.tcpudp_port_pool:
      port = self._config_data.cluster.tcpudp_port_pool.pop()
253
254
255
    else:
      port = self._config_data.cluster.highest_used_port + 1
      if port >= constants.LAST_DRBD_PORT:
256
257
258
        raise errors.ConfigurationError("The highest used port is greater"
                                        " than %s. Aborting." %
                                        constants.LAST_DRBD_PORT)
259
      self._config_data.cluster.highest_used_port = port
Iustin Pop's avatar
Iustin Pop committed
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285

    self._WriteConfig()
    return port

  def GetHostKey(self):
    """Return the rsa hostkey from the config.

    Args: None

    Returns: rsa hostkey
    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data.cluster.rsahostkeypub

  def AddInstance(self, instance):
    """Add an instance to the config.

    This should be used after creating a new instance.

    Args:
      instance: the instance object
    """
    if not isinstance(instance, objects.Instance):
      raise errors.ProgrammerError("Invalid type passed to AddInstance")

286
287
288
    if instance.disk_template != constants.DT_DISKLESS:
      all_lvs = instance.MapLVsByNode()
      logger.Info("Instance '%s' DISK_LAYOUT: %s" % (instance.name, all_lvs))
289

Iustin Pop's avatar
Iustin Pop committed
290
291
292
293
294
295
296
297
298
299
300
    self._OpenConfig()
    self._config_data.instances[instance.name] = instance
    self._WriteConfig()

  def MarkInstanceUp(self, instance_name):
    """Mark the instance status to up in the config.

    """
    self._OpenConfig()

    if instance_name not in self._config_data.instances:
301
302
      raise errors.ConfigurationError("Unknown instance '%s'" %
                                      instance_name)
Iustin Pop's avatar
Iustin Pop committed
303
304
305
306
307
308
309
310
311
312
313
    instance = self._config_data.instances[instance_name]
    instance.status = "up"
    self._WriteConfig()

  def RemoveInstance(self, instance_name):
    """Remove the instance from the configuration.

    """
    self._OpenConfig()

    if instance_name not in self._config_data.instances:
314
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
315
316
317
    del self._config_data.instances[instance_name]
    self._WriteConfig()

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
  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.

    """
    self._OpenConfig()
    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
    self._config_data.instances[inst.name] = inst
    self._WriteConfig()

Iustin Pop's avatar
Iustin Pop committed
335
336
337
338
339
340
341
  def MarkInstanceDown(self, instance_name):
    """Mark the status of an instance to down in the configuration.

    """
    self._OpenConfig()

    if instance_name not in self._config_data.instances:
342
      raise errors.ConfigurationError("Unknown instance '%s'" % instance_name)
Iustin Pop's avatar
Iustin Pop committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    instance = self._config_data.instances[instance_name]
    instance.status = "down"
    self._WriteConfig()

  def GetInstanceList(self):
    """Get the list of instances.

    Returns:
      array of instances, ex. ['instance2.example.com','instance1.example.com']
      these contains all the instances, also the ones in Admin_down state

    """
    self._OpenConfig()
    self._ReleaseLock()

    return self._config_data.instances.keys()

  def ExpandInstanceName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    self._OpenConfig()
    self._ReleaseLock()

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

  def GetInstanceInfo(self, instance_name):
    """Returns informations about an instance.

    It takes the information from the configuration file. Other informations of
    an instance are taken from the live systems.

    Args:
      instance: name of the instance, ex instance1.example.com

    Returns:
      the instance object

    """
    self._OpenConfig()
    self._ReleaseLock()

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

    return self._config_data.instances[instance_name]

  def AddNode(self, node):
    """Add a node to the configuration.

    Args:
      node: an object.Node instance

    """
    self._OpenConfig()
    self._config_data.nodes[node.name] = node
    self._WriteConfig()

  def RemoveNode(self, node_name):
    """Remove a node from the configuration.

    """
    self._OpenConfig()
    if node_name not in self._config_data.nodes:
408
      raise errors.ConfigurationError("Unknown node '%s'" % node_name)
Iustin Pop's avatar
Iustin Pop committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470

    del self._config_data.nodes[node_name]
    self._WriteConfig()

  def ExpandNodeName(self, short_name):
    """Attempt to expand an incomplete instance name.

    """
    self._OpenConfig()
    self._ReleaseLock()

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

  def GetNodeInfo(self, node_name):
    """Get the configuration of a node, as stored in the config.

    Args: node: nodename (tuple) of the node

    Returns: the node object

    """
    self._OpenConfig()
    self._ReleaseLock()

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

    return self._config_data.nodes[node_name]

  def GetNodeList(self):
    """Return the list of nodes which are in the configuration.

    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data.nodes.keys()

  def DumpConfig(self):
    """Return the entire configuration of the cluster.
    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data

  def _BumpSerialNo(self):
    """Bump up the serial number of the config.

    """
    self._config_data.cluster.serial_no += 1

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

    In case we already have configuration data and the config file has
    the same mtime as when we read it, we skip the parsing of the
    file, since de-serialisation could be slow.

    """
    try:
      st = os.stat(self._cfg_file)
    except OSError, err:
471
      raise errors.ConfigurationError("Can't stat config file: %s" % err)
Iustin Pop's avatar
Iustin Pop committed
472
473
    if (self._config_data is not None and
        self._config_time is not None and
474
475
476
        self._config_time == st.st_mtime and
        self._config_size == st.st_size and
        self._config_inode == st.st_ino):
Iustin Pop's avatar
Iustin Pop committed
477
478
479
480
481
      # data is current, so skip loading of config file
      return
    f = open(self._cfg_file, 'r')
    try:
      try:
482
        data = objects.ConfigData.Load(f)
Iustin Pop's avatar
Iustin Pop committed
483
      except Exception, err:
484
        raise errors.ConfigurationError(err)
Iustin Pop's avatar
Iustin Pop committed
485
486
487
488
    finally:
      f.close()
    if (not hasattr(data, 'cluster') or
        not hasattr(data.cluster, 'config_version')):
489
490
      raise errors.ConfigurationError("Incomplete configuration"
                                      " (missing cluster.config_version)")
Iustin Pop's avatar
Iustin Pop committed
491
    if data.cluster.config_version != constants.CONFIG_VERSION:
492
493
494
495
      raise errors.ConfigurationError("Cluster configuration version"
                                      " mismatch, got %s instead of %s" %
                                      (data.cluster.config_version,
                                       constants.CONFIG_VERSION))
Iustin Pop's avatar
Iustin Pop committed
496
497
    self._config_data = data
    self._config_time = st.st_mtime
498
499
    self._config_size = st.st_size
    self._config_inode = st.st_ino
Iustin Pop's avatar
Iustin Pop committed
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515

  def _ReleaseLock(self):
    """xxxx
    """

  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
    nodelist = self.GetNodeList()
516
    myhostname = self._my_hostname
Iustin Pop's avatar
Iustin Pop committed
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549

    tgt_list = []
    for node in nodelist:
      nodeinfo = self.GetNodeInfo(node)
      if nodeinfo.name == myhostname:
        continue
      tgt_list.append(node)

    result = rpc.call_upload_file(tgt_list, self._cfg_file)
    for node in tgt_list:
      if not result[node]:
        logger.Error("copy of file %s to node %s failed" %
                     (self._cfg_file, node))
        bad = True
    return not bad

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

    """
    if destination is None:
      destination = self._cfg_file
    self._BumpSerialNo()
    dir_name, file_name = os.path.split(destination)
    fd, name = tempfile.mkstemp('.newconfig', file_name, dir_name)
    f = os.fdopen(fd, 'w')
    try:
      self._config_data.Dump(f)
      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)
550
    self.write_count += 1
551
552
553
554
    # re-set our cache as not to re-read the config file
    try:
      st = os.stat(destination)
    except OSError, err:
555
      raise errors.ConfigurationError("Can't stat config file: %s" % err)
556
557
558
559
    self._config_time = st.st_mtime
    self._config_size = st.st_size
    self._config_inode = st.st_ino
    # and redistribute the config file
Iustin Pop's avatar
Iustin Pop committed
560
561
562
    self._DistributeConfig()

  def InitConfig(self, node, primary_ip, secondary_ip,
563
                 hostkeypub, mac_prefix, vg_name, def_bridge):
Iustin Pop's avatar
Iustin Pop committed
564
565
566
567
568
569
570
571
572
573
574
    """Create the initial cluster configuration.

    It will contain the current node, which will also be the master
    node, and no instances or operating systmes.

    Args:
      node: the nodename of the initial node
      primary_ip: the IP address of the current host
      secondary_ip: the secondary IP of the current host or None
      hostkeypub: the public hostkey of this host

575
    """
Iustin Pop's avatar
Iustin Pop committed
576
577
    hu_port = constants.FIRST_DRBD_PORT - 1
    globalconfig = objects.Cluster(config_version=constants.CONFIG_VERSION,
Michael Hanselmann's avatar
Michael Hanselmann committed
578
                                   serial_no=1,
Iustin Pop's avatar
Iustin Pop committed
579
580
581
582
                                   rsahostkeypub=hostkeypub,
                                   highest_used_port=hu_port,
                                   mac_prefix=mac_prefix,
                                   volume_group_name=vg_name,
583
584
                                   default_bridge=def_bridge,
                                   tcpudp_port_pool=set())
Iustin Pop's avatar
Iustin Pop committed
585
586
587
588
589
590
591
    if secondary_ip is None:
      secondary_ip = primary_ip
    nodeconfig = objects.Node(name=node, primary_ip=primary_ip,
                              secondary_ip=secondary_ip)

    self._config_data = objects.ConfigData(nodes={node: nodeconfig},
                                           instances={},
592
                                           cluster=globalconfig)
Iustin Pop's avatar
Iustin Pop committed
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    self._WriteConfig()

  def GetVGName(self):
    """Return the volume group name.

    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data.cluster.volume_group_name

  def GetDefBridge(self):
    """Return the default bridge.

    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data.cluster.default_bridge

  def GetMACPrefix(self):
    """Return the mac prefix.

    """
    self._OpenConfig()
    self._ReleaseLock()
    return self._config_data.cluster.mac_prefix
618
619
620
621
622
623
624
625
626
627
628
629

  def GetClusterInfo(self):
    """Returns informations about the cluster

    Returns:
      the cluster object

    """
    self._OpenConfig()
    self._ReleaseLock()

    return self._config_data.cluster
630
631
632
633
634
635
636
637
638
639
640
641

  def Update(self, target):
    """Notify function to be called after updates.

    This function must be called when an object (as returned by
    GetInstanceInfo, GetNodeInfo, GetCluster) has been updated and the
    caller wants the modifications saved to the backing store. Note
    that all modified objects will be saved, but the target argument
    is the one the caller wants to ensure that it's saved.

    """
    if self._config_data is None:
642
643
      raise errors.ProgrammerError("Configuration file not read,"
                                   " cannot save.")
644
645
646
647
648
649
650
    if isinstance(target, objects.Cluster):
      test = target == self._config_data.cluster
    elif isinstance(target, objects.Node):
      test = target in self._config_data.nodes.values()
    elif isinstance(target, objects.Instance):
      test = target in self._config_data.instances.values()
    else:
651
652
      raise errors.ProgrammerError("Invalid object type (%s) passed to"
                                   " ConfigWriter.Update" % type(target))
653
    if not test:
654
655
      raise errors.ConfigurationError("Configuration updated since object"
                                      " has been read or unknown object")
656
    self._WriteConfig()