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
166
167
168
169
170
171
172
  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,
    ])

  for hv_name in constants.HYPER_TYPES:
    hv_class = hypervisor.GetHypervisor(hv_name)
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
173
174
175
176
177


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


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

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

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


189
190
191
192
193
194
195
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
196
  @return: master_netdev, master_ip, master_name
197
  @raise RPCFail: in case of errors
198
199
200

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


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

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

  @type start_daemons: boolean
218
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
219
      daemons (ganeti-masterd and ganeti-rapi)
220
221
222
  @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
223
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
224
225

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

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

    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:
253
254
255
256
257
258
259
260
261
262
263
    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)
264
      if result.failed:
265
266
        msg = "Can't start daemon %s: %s" % (daemon, result.output)
        logging.error(msg)
267
        err_msgs.append(msg)
268

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

Iustin Pop's avatar
Iustin Pop committed
272

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

276
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
277
278
279
280
281
282
283
  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
284
285

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

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

292
293
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
294
  if result.failed:
295
    logging.error("Can't remove the master IP, error: %s", result.output)
296
297
298
299
300
301
    # 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
302
303


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

307
308
309
310
  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
311

Iustin Pop's avatar
Iustin Pop committed
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
  @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

327
  """
328
329
330
331
  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)]
332
  for name, content, mode in sshd_keys:
333
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
334

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

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

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

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


def LeaveCluster():
Iustin Pop's avatar
Iustin Pop committed
350
351
352
353
354
355
  """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
356
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
357
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
358
359

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

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

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

372
373
374
375
    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
376

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

Iustin Pop's avatar
Iustin Pop committed
380

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

384
385
386
387
388
389
390
391
392
393
394
395
  @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
396

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

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

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

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


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

420
421
422
423
424
425
426
427
428
  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
429

430
431
432
433
434
435
436
437
438
439
440
  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
441
442
443
  @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
444
445
446
447

  """
  result = {}

448
449
450
451
452
453
454
455
456
457
458
459
460
  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]:
461
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
462
      if not success:
463
464
465
466
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
467
468
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
469
    for name, pip, sip in what[constants.NV_NODENETTEST]:
470
471
472
473
474
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
475
476
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
477
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
478
      port = utils.GetNodeDaemonPort()
479
      for name, pip, sip in what[constants.NV_NODENETTEST]:
480
481
482
483
484
485
486
        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:
487
488
489
490
491
492
493
494
495
496
497
          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:
498
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
499
500

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

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

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

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


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

Iustin Pop's avatar
Iustin Pop committed
522
523
524
525
526
527
528
529
530
531
532
  @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
533
534

  """
535
536
537
538
539
  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
540
  if result.failed:
541
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
542

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

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


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

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

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


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

Iustin Pop's avatar
Iustin Pop committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
  @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.

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

  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(),
    }

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


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

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

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

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

Iustin Pop's avatar
Iustin Pop committed
628

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

632
633
634
635
636
  @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
637
638
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
639

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

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


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

656
657
658
659
  @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
660

661
662
663
664
665
  @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
666

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

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

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


679
680
681
682
683
684
685
686
687
688
689
690
691
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)
692
693
694
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
695
696

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


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

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

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

712
  @rtype: dict
713
714
715
716
  @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
717
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
718

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

722
723
724
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
725
      for name, _, memory, vcpus, state, times in iinfo:
726
        value = {
727
728
729
730
731
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
732
733
734
735
736
737
        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]:
738
739
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
740
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
741

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


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

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

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

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

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

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


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

Iustin Pop's avatar
Iustin Pop committed
779
  @type instance: L{objects.Instance}
780
781
782
  @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
783
784
  @rtype: boolean
  @return: the success of the operation
785
786
787
788

  """
  inst_os = OSFromDisk(instance.os)

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

  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
795

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

  if result.failed:
800
    logging.error("os create command '%s' returned error: %s output: %s",
801
                  result.cmd, result.fail_reason, result.output)
802
    lines = [utils.SafeEncode(val)
803
             for val in utils.TailFile(logfile, lines=20)]
804
805
    _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
806
807
808


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

Iustin Pop's avatar
Iustin Pop committed
811
812
813
814
815
816
817
818
  @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
819

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

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

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

  if retval.failed:
830
    logging.error("volume group %s not present", vg_name)
831
    return retdic
Iustin Pop's avatar
Iustin Pop committed
832
  valarr = retval.stdout.strip().rstrip(':').split(':')
833
834
835
836
837
838
839
840
  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
841
      logging.exception("Fail to parse vgs output: %s", err)
842
  else:
843
844
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
845
846
847
  return retdic


848
849
850
851
852
853
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):
854
855
856
857
858
859
  """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).


860
861
862
863
  @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
864
865

  """
866
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
867
868
  try:
    os.symlink(device_path, link_name)
869
870
  except OSError, err:
    if err.errno == errno.EEXIST:
871
872
873
874
875
876
877
878
879
880
      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


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

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


894
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
895
896
897
898
899
  """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
900
901
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
902
903
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
904

Iustin Pop's avatar
Iustin Pop committed
905
906
  """
  block_devices = []
907
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
908
909
910
911
912
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
913
    try:
914
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
915
916
917
918
919
920
    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
921
922
923
  return block_devices


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

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

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

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

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


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

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

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

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

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

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

  # test every 10secs for 2min

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

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

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

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


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

Iustin Pop's avatar
Iustin Pop committed
999
1000
1001
1002
1003
1004
1005
1006
1007
  @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)
1008
1009
1010
1011
      - 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)
1012
  @rtype: None
1013
1014

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

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

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


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

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

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


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

  """
1062
1063
1064
1065
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
1066
    _Fail("Failed to accept instance: %s", err, exc=True)
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079


def FinalizeMigration(instance, info, success):
  """Finalize any preparation 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 success: boolean
  @param success: whether the migration was a success or a failure