backend.py 80.6 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
#

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


22
23
24
25
26
27
"""Functions used by the node daemon

@var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in
     the L{UploadFile} function

"""
Iustin Pop's avatar
Iustin Pop committed
28
29
30
31
32
33
34
35
36
37


import os
import os.path
import shutil
import time
import stat
import errno
import re
import subprocess
38
import random
39
import logging
40
import tempfile
41
42
import zlib
import base64
Iustin Pop's avatar
Iustin Pop committed
43
44
45
46
47
48
49
50

from ganeti import errors
from ganeti import utils
from ganeti import ssh
from ganeti import hypervisor
from ganeti import constants
from ganeti import bdev
from ganeti import objects
51
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
52
53


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

def _Fail(msg, *args, **kwargs):
  """Log an error and the raise an RPCFail exception.

  This exception is then handled specially in the ganeti daemon and
  turned into a 'failed' return type. As such, this function is a
  useful shortcut for logging the error and returning it to the master
  daemon.

  @type msg: string
  @param msg: the text of the exception
  @raise RPCFail

  """
  if args:
    msg = msg % args
76
77
78
79
80
  if "log" not in kwargs or kwargs["log"]: # if we should log this error
    if "exc" in kwargs and kwargs["exc"]:
      logging.exception(msg)
    else:
      logging.error(msg)
81
82
83
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
84
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
85
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
86

Iustin Pop's avatar
Iustin Pop committed
87
88
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
89
90

  """
Iustin Pop's avatar
Iustin Pop committed
91
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
92
93


94
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
95
96
97
98
99
100
101
102
103
  """Simple wrapper to return an SshRunner.

  @type cluster_name: str
  @param cluster_name: the cluster name, which is needed
      by the SshRunner constructor
  @rtype: L{ssh.SshRunner}
  @return: an SshRunner instance

  """
104
  return ssh.SshRunner(cluster_name)
105
106


107
108
109
110
111
112
113
114
115
def _Decompress(data):
  """Unpacks data compressed by the RPC client.

  @type data: list or tuple
  @param data: Data sent by RPC client
  @rtype: str
  @return: Decompressed data

  """
116
  assert isinstance(data, (list, tuple))
117
118
119
120
121
122
123
124
125
126
  assert len(data) == 2
  (encoding, content) = data
  if encoding == constants.RPC_ENCODING_NONE:
    return content
  elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
    return zlib.decompress(base64.b64decode(content))
  else:
    raise AssertionError("Unknown data encoding")


127
def _CleanDirectory(path, exclude=None):
128
129
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
130
131
  @type path: str
  @param path: the directory to clean
132
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
133
134
  @param exclude: list of files to be excluded, defaults
      to the empty list
135
136

  """
137
138
  if not os.path.isdir(path):
    return
139
140
141
142
143
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
144

145
  for rel_name in utils.ListVisibleFiles(path):
146
147
148
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
149
150
151
152
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


153
154
155
156
157
158
def _BuildUploadFileList():
  """Build the list of allowed upload files.

  This is abstracted so that it's built only once at module import time.

  """
159
160
161
162
163
164
165
  allowed_files = set([
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
    constants.VNC_PASSWORD_FILE,
    constants.RAPI_CERT_FILE,
    constants.RAPI_USERS_FILE,
166
    constants.HMAC_CLUSTER_KEY,
167
168
169
    ])

  for hv_name in constants.HYPER_TYPES:
170
    hv_class = hypervisor.GetHypervisorClass(hv_name)
171
172
173
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
174
175
176
177
178


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


179
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
180
181
  """Removes job queue files and archived jobs.

182
183
  @rtype: tuple
  @return: True, None
184
185

  """
186
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
187
188
189
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


190
191
192
193
194
195
196
def GetMasterInfo():
  """Returns master information.

  This is an utility function to compute master information, either
  for consumption here or from the node daemon.

  @rtype: tuple
197
  @return: master_netdev, master_ip, master_name
198
  @raise RPCFail: in case of errors
199
200
201

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
202
203
204
205
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
206
  except errors.ConfigurationError, err:
Iustin Pop's avatar
Iustin Pop committed
207
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
208
  return (master_netdev, master_ip, master_node)
209
210


211
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
212
213
  """Activate local node as master node.

214
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
215
216
217
218
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
219
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
220
      daemons (ganeti-masterd and ganeti-rapi)
221
222
223
  @type no_voting: boolean
  @param no_voting: whether to start ganeti-masterd without a node vote
      (if start_daemons is True), but still non-interactively
Iustin Pop's avatar
Iustin Pop committed
224
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
225
226

  """
227
  # GetMasterInfo will raise an exception if not able to return data
Guido Trotter's avatar
Guido Trotter committed
228
  master_netdev, master_ip, _ = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
229

230
  err_msgs = []
231
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
232
    if utils.OwnIpAddress(master_ip):
233
      # we already have the ip:
234
      logging.debug("Master IP already configured, doing nothing")
235
    else:
236
237
      msg = "Someone else has the master ip, not activating"
      logging.error(msg)
238
      err_msgs.append(msg)
239
240
241
242
243
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
244
245
      msg = "Can't activate master IP: %s" % result.output
      logging.error(msg)
246
      err_msgs.append(msg)
247
248
249
250
251
252
253

    result = utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev,
                           "-s", master_ip, master_ip])
    # we'll ignore the exit code of arping

  # and now start the master and rapi daemons
  if start_daemons:
254
255
256
257
258
259
260
261
262
263
264
    daemons_params = {
        'ganeti-masterd': [],
        'ganeti-rapi': [],
        }
    if no_voting:
      daemons_params['ganeti-masterd'].append('--no-voting')
      daemons_params['ganeti-masterd'].append('--yes-do-it')
    for daemon in daemons_params:
      cmd = [daemon]
      cmd.extend(daemons_params[daemon])
      result = utils.RunCmd(cmd)
265
      if result.failed:
266
267
        msg = "Can't start daemon %s: %s" % (daemon, result.output)
        logging.error(msg)
268
        err_msgs.append(msg)
269

270
271
  if err_msgs:
    _Fail("; ".join(err_msgs))
272

Iustin Pop's avatar
Iustin Pop committed
273

274
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
275
276
  """Deactivate this node as master.

277
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
278
279
280
281
282
283
284
  master. It will also stop the master daemons depending on the
  stop_daemons parameter.

  @type stop_daemons: boolean
  @param stop_daemons: whether to also stop the master daemons
      (ganeti-masterd and ganeti-rapi)
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
285
286

  """
287
288
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
289
290

  # GetMasterInfo will raise an exception if not able to return data
Guido Trotter's avatar
Guido Trotter committed
291
  master_netdev, master_ip, _ = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
292

293
294
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
295
  if result.failed:
296
    logging.error("Can't remove the master IP, error: %s", result.output)
297
298
299
300
301
302
    # but otherwise ignore the failure

  if stop_daemons:
    # stop/kill the rapi and the master daemon
    for daemon in constants.RAPI_PID, constants.MASTERD_PID:
      utils.KillProcess(utils.ReadPidFile(utils.DaemonPidFileName(daemon)))
Iustin Pop's avatar
Iustin Pop committed
303
304


Iustin Pop's avatar
Iustin Pop committed
305
def AddNode(dsa, dsapub, rsa, rsapub, sshkey, sshpub):
306
  """Joins this node to the cluster.
Iustin Pop's avatar
Iustin Pop committed
307

308
309
310
311
  This does the following:
      - updates the hostkeys of the machine (rsa and dsa)
      - adds the ssh private key to the user
      - adds the ssh public key to the users' authorized_keys file
Iustin Pop's avatar
Iustin Pop committed
312

Iustin Pop's avatar
Iustin Pop committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
  @type dsa: str
  @param dsa: the DSA private key to write
  @type dsapub: str
  @param dsapub: the DSA public key to write
  @type rsa: str
  @param rsa: the RSA private key to write
  @type rsapub: str
  @param rsapub: the RSA public key to write
  @type sshkey: str
  @param sshkey: the SSH private key to write
  @type sshpub: str
  @param sshpub: the SSH public key to write
  @rtype: boolean
  @return: the success of the operation

328
  """
329
330
331
332
  sshd_keys =  [(constants.SSH_HOST_RSA_PRIV, rsa, 0600),
                (constants.SSH_HOST_RSA_PUB, rsapub, 0644),
                (constants.SSH_HOST_DSA_PRIV, dsa, 0600),
                (constants.SSH_HOST_DSA_PUB, dsapub, 0644)]
333
  for name, content, mode in sshd_keys:
334
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
335

336
337
338
339
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
340
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
341

342
343
  for name, content in [(priv_key, sshkey), (pub_key, sshpub)]:
    utils.WriteFile(name, data=content, mode=0600)
Iustin Pop's avatar
Iustin Pop committed
344

345
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
346

347
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
348
349
350


def LeaveCluster():
Iustin Pop's avatar
Iustin Pop committed
351
352
353
354
355
356
  """Cleans up and remove the current node.

  This function cleans up and prepares the current node to be removed
  from the cluster.

  If processing is successful, then it raises an
Iustin Pop's avatar
Iustin Pop committed
357
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
358
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
359
360

  """
361
  _CleanDirectory(constants.DATA_DIR)
362
  JobQueuePurge()
363

364
365
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
366

367
368
369
370
371
    f = open(pub_key, 'r')
    try:
      utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
    finally:
      f.close()
Iustin Pop's avatar
Iustin Pop committed
372

373
374
375
376
    utils.RemoveFile(priv_key)
    utils.RemoveFile(pub_key)
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
Iustin Pop's avatar
Iustin Pop committed
377

378
379
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
380

Iustin Pop's avatar
Iustin Pop committed
381

382
def GetNodeInfo(vgname, hypervisor_type):
Michael Hanselmann's avatar
Michael Hanselmann committed
383
  """Gives back a hash with different information about the node.
Iustin Pop's avatar
Iustin Pop committed
384

385
386
387
388
389
390
391
392
393
394
395
396
  @type vgname: C{string}
  @param vgname: the name of the volume group to ask for disk space information
  @type hypervisor_type: C{str}
  @param hypervisor_type: the name of the hypervisor to ask for
      memory information
  @rtype: C{dict}
  @return: dictionary with the following keys:
      - vg_size is the size of the configured volume group in MiB
      - vg_free is the free size of the volume group in MiB
      - memory_dom0 is the memory allocated for domain0 in MiB
      - memory_free is the currently available (free) ram in MiB
      - memory_total is the total number of ram in MiB
Iustin Pop's avatar
Iustin Pop committed
397

398
  """
Iustin Pop's avatar
Iustin Pop committed
399
400
401
402
403
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

404
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
405
406
407
408
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

409
410
411
412
413
414
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

415
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
416
417


418
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
419
420
  """Verify the status of the local node.

421
422
423
424
425
426
427
428
429
  Based on the input L{what} parameter, various checks are done on the
  local node.

  If the I{filelist} key is present, this list of
  files is checksummed and the file/checksum pairs are returned.

  If the I{nodelist} key is present, we check that we have
  connectivity via ssh with the target nodes (and check the hostname
  report).
Iustin Pop's avatar
Iustin Pop committed
430

431
432
433
434
435
436
437
438
439
440
441
  If the I{node-net-test} key is present, we check that we have
  connectivity to the given nodes via both primary IP and, if
  applicable, secondary IPs.

  @type what: C{dict}
  @param what: a dictionary of things to check:
      - filelist: list of files for which to compute checksums
      - nodelist: list of nodes we should check ssh communication with
      - node-net-test: list of nodes we should check node daemon port
        connectivity with
      - hypervisor: list with hypervisors to run the verify for
Iustin Pop's avatar
Iustin Pop committed
442
443
444
  @rtype: dict
  @return: a dictionary with the same keys as the input dict, and
      values representing the result of the checks
Iustin Pop's avatar
Iustin Pop committed
445
446
447
448

  """
  result = {}

449
450
451
452
453
454
455
456
457
458
459
460
461
  if constants.NV_HYPERVISOR in what:
    result[constants.NV_HYPERVISOR] = tmp = {}
    for hv_name in what[constants.NV_HYPERVISOR]:
      tmp[hv_name] = hypervisor.GetHypervisor(hv_name).Verify()

  if constants.NV_FILELIST in what:
    result[constants.NV_FILELIST] = utils.FingerprintFiles(
      what[constants.NV_FILELIST])

  if constants.NV_NODELIST in what:
    result[constants.NV_NODELIST] = tmp = {}
    random.shuffle(what[constants.NV_NODELIST])
    for node in what[constants.NV_NODELIST]:
462
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
463
      if not success:
464
465
466
467
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
468
469
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
470
    for name, pip, sip in what[constants.NV_NODENETTEST]:
471
472
473
474
475
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
476
477
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
478
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
479
      port = utils.GetNodeDaemonPort()
480
      for name, pip, sip in what[constants.NV_NODENETTEST]:
481
482
483
484
485
486
487
        fail = []
        if not utils.TcpPing(pip, port, source=my_pip):
          fail.append("primary")
        if sip != pip:
          if not utils.TcpPing(sip, port, source=my_sip):
            fail.append("secondary")
        if fail:
488
489
490
491
492
493
494
495
496
497
498
          tmp[name] = ("failure using the %s interface(s)" %
                       " and ".join(fail))

  if constants.NV_LVLIST in what:
    result[constants.NV_LVLIST] = GetVolumeList(what[constants.NV_LVLIST])

  if constants.NV_INSTANCELIST in what:
    result[constants.NV_INSTANCELIST] = GetInstanceList(
      what[constants.NV_INSTANCELIST])

  if constants.NV_VGLIST in what:
499
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
500
501

  if constants.NV_VERSION in what:
502
503
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
504
505
506
507

  if constants.NV_HVINFO in what:
    hyper = hypervisor.GetHypervisor(what[constants.NV_HVINFO])
    result[constants.NV_HVINFO] = hyper.GetNodeInfo()
508

509
510
511
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
512
    except errors.BlockDeviceError, err:
513
      logging.warning("Can't get used minors list", exc_info=True)
514
      used_minors = str(err)
515
516
    result[constants.NV_DRBDLIST] = used_minors

517
  return result
Iustin Pop's avatar
Iustin Pop committed
518
519
520
521
522


def GetVolumeList(vg_name):
  """Compute list of logical volumes and their size.

Iustin Pop's avatar
Iustin Pop committed
523
524
525
526
527
528
529
530
531
532
533
  @type vg_name: str
  @param vg_name: the volume group whose LVs we should list
  @rtype: dict
  @return:
      dictionary of all partions (key) with value being a tuple of
      their size (in MiB), inactive and online status::

        {'test1': ('20.06', True, True)}

      in case of errors, a string is returned with the error
      details.
Iustin Pop's avatar
Iustin Pop committed
534
535

  """
536
537
538
539
540
  lvs = {}
  sep = '|'
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=%s" % sep,
                         "-olv_name,lv_size,lv_attr", vg_name])
Iustin Pop's avatar
Iustin Pop committed
541
  if result.failed:
542
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
543

544
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
545
  for line in result.stdout.splitlines():
546
547
548
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
549
      logging.error("Invalid line returned from lvs output: '%s'", line)
550
551
      continue
    name, size, attr = match.groups()
552
553
554
555
556
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
557
558
559


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
560
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
561

Iustin Pop's avatar
Iustin Pop committed
562
563
564
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
565
566

  """
567
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
568
569


570
571
572
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
  @rtype: list
  @return:
    A list of dictionaries, each having four keys:
      - name: the logical volume name,
      - size: the size of the logical volume
      - dev: the physical device on which the LV lives
      - vg: the volume group to which it belongs

    In case of errors, we return an empty list and log the
    error.

    Note that since a logical volume can live on multiple physical
    volumes, the resulting list might include a logical volume
    multiple times.

588
589
590
591
592
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
593
594
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609

  def parse_dev(dev):
    if '(' in dev:
      return dev.split('(')[0]
    else:
      return dev

  def map_line(line):
    return {
      'name': line[0].strip(),
      'size': line[1].strip(),
      'dev': parse_dev(line[2].strip()),
      'vg': line[3].strip(),
    }

610
611
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
612
613


Iustin Pop's avatar
Iustin Pop committed
614
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
615
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
616

Iustin Pop's avatar
Iustin Pop committed
617
618
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
619
620

  """
621
  missing = []
Iustin Pop's avatar
Iustin Pop committed
622
623
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
624
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
625

626
  if missing:
627
    _Fail("Missing bridges %s", ", ".join(missing))
628

Iustin Pop's avatar
Iustin Pop committed
629

630
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
631
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
632

633
634
635
636
637
  @type hypervisor_list: list
  @param hypervisor_list: the list of hypervisors to query information

  @rtype: list
  @return: a list of all running instances on the current node
Iustin Pop's avatar
Iustin Pop committed
638
639
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
640

641
  """
642
643
644
645
646
647
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
648
649
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
650

651
  return results
Iustin Pop's avatar
Iustin Pop committed
652
653


654
def GetInstanceInfo(instance, hname):
Michael Hanselmann's avatar
Michael Hanselmann committed
655
  """Gives back the information about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
656

657
658
659
660
  @type instance: string
  @param instance: the instance name
  @type hname: string
  @param hname: the hypervisor type of the instance
Iustin Pop's avatar
Iustin Pop committed
661

662
663
664
665
666
  @rtype: dict
  @return: dictionary with the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
667

668
  """
Iustin Pop's avatar
Iustin Pop committed
669
670
  output = {}

671
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
672
673
674
675
676
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

677
  return output
Iustin Pop's avatar
Iustin Pop committed
678
679


680
681
682
683
684
685
686
687
688
689
690
691
692
def GetInstanceMigratable(instance):
  """Gives whether an instance can be migrated.

  @type instance: L{objects.Instance}
  @param instance: object representing the instance to be checked.

  @rtype: tuple
  @return: tuple of (result, description) where:
      - result: whether the instance can be migrated or not
      - description: a description of the issue, if relevant

  """
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
693
694
695
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
696
697

  for idx in range(len(instance.disks)):
698
    link_name = _GetBlockDevSymlinkPath(iname, idx)
699
    if not os.path.islink(link_name):
700
      _Fail("Instance %s was not restarted since ganeti 1.2.5", iname)
701
702


703
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
704
705
  """Gather data about all instances.

Iustin Pop's avatar
Iustin Pop committed
706
  This is the equivalent of L{GetInstanceInfo}, except that it
Iustin Pop's avatar
Iustin Pop committed
707
708
709
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

710
711
712
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

713
  @rtype: dict
714
715
716
717
  @return: dictionary of instance: data, with data having the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
718
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
719

720
  """
Iustin Pop's avatar
Iustin Pop committed
721
722
  output = {}

723
724
725
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
726
      for name, _, memory, vcpus, state, times in iinfo:
727
        value = {
728
729
730
731
732
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
733
734
735
736
737
738
        if name in output:
          # we only check static parameters, like memory and vcpus,
          # and not state and time which can change between the
          # invocations of the different hypervisors
          for key in 'memory', 'vcpus':
            if value[key] != output[name][key]:
739
740
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
741
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
742

743
  return output
Iustin Pop's avatar
Iustin Pop committed
744
745


746
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
747
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
748

749
750
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
751
752
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
753
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
754
755

  """
756
757
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
758
  create_env = OSEnvironment(instance, inst_os)
759
760
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
761
762
763

  logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                     instance.name, int(time.time()))
764

765
766
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
767
  if result.failed:
768
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
769
                  " output: %s", result.cmd, result.fail_reason, logfile,
770
                  result.output)
771
    lines = [utils.SafeEncode(val)
772
             for val in utils.TailFile(logfile, lines=20)]
773
774
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
775
776


777
def RunRenameInstance(instance, old_name):
778
779
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
780
  @type instance: L{objects.Instance}
781
782
783
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
Iustin Pop's avatar
Iustin Pop committed
784
785
  @rtype: boolean
  @return: the success of the operation
786
787
788
789

  """
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
790
  rename_env = OSEnvironment(instance, inst_os)
791
  rename_env['OLD_INSTANCE_NAME'] = old_name
792
793
794
795

  logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                           old_name,
                                           instance.name, int(time.time()))
Iustin Pop's avatar
Iustin Pop committed
796

797
798
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
799
800

  if result.failed:
801
    logging.error("os create command '%s' returned error: %s output: %s",
802
                  result.cmd, result.fail_reason, result.output)
803
    lines = [utils.SafeEncode(val)
804
             for val in utils.TailFile(logfile, lines=20)]
805
806
    _Fail("OS rename script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
Iustin Pop's avatar
Iustin Pop committed
807
808
809


def _GetVGInfo(vg_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
810
  """Get information about the volume group.
Iustin Pop's avatar
Iustin Pop committed
811

Iustin Pop's avatar
Iustin Pop committed
812
813
814
815
816
817
818
819
  @type vg_name: str
  @param vg_name: the volume group which we query
  @rtype: dict
  @return:
    A dictionary with the following keys:
      - C{vg_size} is the total size of the volume group in MiB
      - C{vg_free} is the free size of the volume group in MiB
      - C{pv_count} are the number of physical disks in that VG
Iustin Pop's avatar
Iustin Pop committed
820

Iustin Pop's avatar
Iustin Pop committed
821
822
    If an error occurs during gathering of data, we return the same dict
    with keys all set to None.
823

Iustin Pop's avatar
Iustin Pop committed
824
  """
825
826
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
827
828
829
830
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
831
    logging.error("volume group %s not present", vg_name)
832
    return retdic
Iustin Pop's avatar
Iustin Pop committed
833
  valarr = retval.stdout.strip().rstrip(':').split(':')
834
835
836
837
838
839
840
841
  if len(valarr) == 3:
    try:
      retdic = {
        "vg_size": int(round(float(valarr[0]), 0)),
        "vg_free": int(round(float(valarr[1]), 0)),
        "pv_count": int(valarr[2]),
        }
    except ValueError, err:
Iustin Pop's avatar
Iustin Pop committed
842
      logging.exception("Fail to parse vgs output: %s", err)
843
  else:
844
845
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
846
847
848
  return retdic


849
850
851
852
853
854
def _GetBlockDevSymlinkPath(instance_name, idx):
  return os.path.join(constants.DISK_LINKS_DIR,
                      "%s:%d" % (instance_name, idx))


def _SymlinkBlockDev(instance_name, device_path, idx):
855
856
857
858
859
860
  """Set up symlinks to a instance's block device.

  This is an auxiliary function run when an instance is start (on the primary
  node) or when an instance is migrated (on the target node).


861
862
863
864
  @param instance_name: the name of the target instance
  @param device_path: path of the physical block device, on the node
  @param idx: the disk index
  @return: absolute path to the disk's symlink
865
866

  """
867
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
868
869
  try:
    os.symlink(device_path, link_name)
870
871
  except OSError, err:
    if err.errno == errno.EEXIST:
872
873
874
875
876
877
878
879
880
881
      if (not os.path.islink(link_name) or
          os.readlink(link_name) != device_path):
        os.remove(link_name)
        os.symlink(device_path, link_name)
    else:
      raise

  return link_name


882
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
883
884
885
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
886
  for idx, _ in enumerate(disks):
887
888
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
889
      try:
890
891
892
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
893
894


895
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
896
897
898
899
900
  """Set up an instance's block device(s).

  This is run on the primary node at instance startup. The block
  devices must be already assembled.

Iustin Pop's avatar
Iustin Pop committed
901
902
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
903
904
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
905

Iustin Pop's avatar
Iustin Pop committed
906
907
  """
  block_devices = []
908
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
909
910
911
912
913
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
914
    try:
915
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
916
917
918
919
920
921
    except OSError, e:
      raise errors.BlockDeviceError("Cannot create block device symlink: %s" %
                                    e.strerror)

    block_devices.append((disk, link_name))

Iustin Pop's avatar
Iustin Pop committed
922
923
924
  return block_devices


925
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
926
927
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
928
  @type instance: L{objects.Instance}
929
  @param instance: the instance object
930
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
931

932
  """
933
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
934
935

  if instance.name in running_instances:
936
937
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
938
939

  try:
940
941
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
942
    hyper.StartInstance(instance, block_devices)
943
  except errors.BlockDeviceError, err:
944
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
945
  except errors.HypervisorError, err:
946
    _RemoveBlockDevLinks(instance.name, instance.disks)
947
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
948
949


950
def InstanceShutdown(instance):
Iustin Pop's avatar
Iustin Pop committed
951
952
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
953
954
955
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
956
  @param instance: the instance object
957
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
958

959
  """
960
961
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
962
  iname = instance.name
Iustin Pop's avatar
Iustin Pop committed
963

964
965
966
  if iname not in running_instances:
    logging.info("Instance %s not running, doing nothing", iname)
    return
Iustin Pop's avatar
Iustin Pop committed
967

968
  hyper = hypervisor.GetHypervisor(hv_name)
Iustin Pop's avatar
Iustin Pop committed
969
970
971
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
972
    _Fail("Failed to stop instance %s: %s", iname, err)
Iustin Pop's avatar
Iustin Pop committed
973
974
975
976

  # test every 10secs for 2min

  time.sleep(1)
Michael Hanselmann's avatar
Michael Hanselmann committed
977
  for _ in range(11):
978
    if instance.name not in GetInstanceList([hv_name]):
Iustin Pop's avatar
Iustin Pop committed
979
980
981
982
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
983
    logging.error("Shutdown of '%s' unsuccessful, using destroy", iname)
Iustin Pop's avatar
Iustin Pop committed
984
985
986
987

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
988
      _Fail("Failed to force stop instance %s: %s", iname, err)
Iustin Pop's avatar
Iustin Pop committed
989
990

    time.sleep(1)
991
    if instance.name in GetInstanceList([hv_name]):
992
      _Fail("Could not shutdown instance %s even by destroy", iname)
Iustin Pop's avatar
Iustin Pop committed
993

994
  _RemoveBlockDevLinks(iname, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
995
996


997
def InstanceReboot(instance, reboot_type):
998
999
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
1000
1001
1002
1003
1004
1005
1006
1007
1008
  @type instance: L{objects.Instance}
  @param instance: the instance object to reboot
  @type reboot_type: str
  @param reboot_type: the type of reboot, one the following
    constants:
      - L{constants.INSTANCE_REBOOT_SOFT}: only reboot the
        instance OS, do not recreate the VM
      - L{constants.INSTANCE_REBOOT_HARD}: tear down and
        restart the VM (at the hypervisor level)
1009
1010
1011
1012
      - the other reboot type (L{constants.INSTANCE_REBOOT_FULL}) is
        not accepted here, since that mode is handled differently, in
        cmdlib, and translates into full stop and start of the
        instance (instead of a call_instance_reboot RPC)
1013
  @rtype: None
1014
1015

  """
1016
  running_instances = GetInstanceList([instance.hypervisor])
1017
1018

  if instance.name not in running_instances:
1019
    _Fail("Cannot reboot instance %s that is not running", instance.name)
1020

1021
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1022
1023
1024
1025
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
1026
      _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
1027
1028
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
1029
      InstanceShutdown(instance)
1030
      return StartInstance(instance)
1031
    except errors.HypervisorError, err:
1032
      _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1033
  else:
1034
    _Fail("Invalid reboot_type received: %s", reboot_type)
1035
1036


1037
1038
1039
1040
1041
1042
1043
def MigrationInfo(instance):
  """Gather information about an instance to be migrated.

  @type instance: L{objects.Instance}
  @param instance: the instance definition

  """
1044
1045
1046
1047
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    info = hyper.MigrationInfo(instance)
  except errors.HypervisorError, err:
1048
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1049
  return info
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062


def AcceptInstance(instance, info, target):
  """Prepare the node to accept an instance.

  @type instance: L{objects.Instance}
  @param instance: the instance definition
  @type info: string/data (opaque)
  @param info: migration information, from the source node
  @type target: string
  @param target: target host (usually ip), on this node

  """
1063
1064
1065
1066
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
Iustin Pop's avatar