backend.py 83 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
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"


57
58
59
60
61
62
63
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

64

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
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
80
81
82
83
84
  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)
85
86
87
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
88
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
89
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
90

Iustin Pop's avatar
Iustin Pop committed
91
92
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
93
94

  """
Iustin Pop's avatar
Iustin Pop committed
95
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
96
97


98
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
99
100
101
102
103
104
105
106
107
  """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

  """
108
  return ssh.SshRunner(cluster_name)
109
110


111
112
113
114
115
116
117
118
119
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

  """
120
  assert isinstance(data, (list, tuple))
121
122
123
124
125
126
127
128
129
130
  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")


131
def _CleanDirectory(path, exclude=None):
132
133
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
134
135
  @type path: str
  @param path: the directory to clean
136
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
137
138
  @param exclude: list of files to be excluded, defaults
      to the empty list
139
140

  """
141
142
  if not os.path.isdir(path):
    return
143
144
145
146
147
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
148

149
  for rel_name in utils.ListVisibleFiles(path):
150
151
152
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
153
154
155
156
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


157
158
159
160
161
162
def _BuildUploadFileList():
  """Build the list of allowed upload files.

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

  """
163
164
165
166
167
168
169
  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,
170
    constants.HMAC_CLUSTER_KEY,
171
172
173
    ])

  for hv_name in constants.HYPER_TYPES:
174
    hv_class = hypervisor.GetHypervisorClass(hv_name)
175
176
177
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
178
179
180
181
182


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


183
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
184
185
  """Removes job queue files and archived jobs.

186
187
  @rtype: tuple
  @return: True, None
188
189

  """
190
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
191
192
193
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


194
195
196
197
198
199
200
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
201
  @return: master_netdev, master_ip, master_name
202
  @raise RPCFail: in case of errors
203
204
205

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


215
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
216
217
  """Activate local node as master node.

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

  @type start_daemons: boolean
223
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
224
      daemons (ganeti-masterd and ganeti-rapi)
225
226
227
  @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
228
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
229
230

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

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

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

274
275
  if err_msgs:
    _Fail("; ".join(err_msgs))
276

Iustin Pop's avatar
Iustin Pop committed
277

278
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
279
280
  """Deactivate this node as master.

281
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
282
283
284
285
286
287
288
  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
289
290

  """
291
292
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
293
294

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

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

  if stop_daemons:
    # stop/kill the rapi and the master daemon
Guido Trotter's avatar
Guido Trotter committed
305
    for daemon in constants.RAPI, constants.MASTERD:
306
      utils.KillProcess(utils.ReadPidFile(utils.DaemonPidFileName(daemon)))
Iustin Pop's avatar
Iustin Pop committed
307
308


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

312
313
314
315
  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
316

Iustin Pop's avatar
Iustin Pop committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
  @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

332
  """
333
334
335
336
  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)]
337
  for name, content, mode in sshd_keys:
338
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
339

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

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

349
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
350

351
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
352
353
354


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

  """
365
  _CleanDirectory(constants.DATA_DIR)
366
  JobQueuePurge()
367

368
369
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
370

371
    utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
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
  outputarray["bootid"] = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
410

411
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
412
413


414
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
415
416
  """Verify the status of the local node.

417
418
419
420
421
422
423
424
425
  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
426

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

  """
  result = {}

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

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

  if constants.NV_VERSION in what:
498
499
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
500
501
502
503

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

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

513
  return result
Iustin Pop's avatar
Iustin Pop committed
514
515
516
517
518


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

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

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

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
553
554
555


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

Iustin Pop's avatar
Iustin Pop committed
558
559
560
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
561
562

  """
563
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
564
565


566
567
568
def NodeVolumes():
  """List all volumes on this node.

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

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

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

606
607
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
608
609


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

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

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

622
  if missing:
623
    _Fail("Missing bridges %s", ", ".join(missing))
624

Iustin Pop's avatar
Iustin Pop committed
625

626
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
627
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
628

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

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

647
  return results
Iustin Pop's avatar
Iustin Pop committed
648
649


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

653
654
655
656
  @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
657

658
659
660
661
662
  @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
663

664
  """
Iustin Pop's avatar
Iustin Pop committed
665
666
  output = {}

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

673
  return output
Iustin Pop's avatar
Iustin Pop committed
674
675


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

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


699
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
700
701
  """Gather data about all instances.

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

706
707
708
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

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

716
  """
Iustin Pop's avatar
Iustin Pop committed
717
718
  output = {}

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

739
  return output
Iustin Pop's avatar
Iustin Pop committed
740
741


742
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
743
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
744

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

  """
752
753
  inst_os = OSFromDisk(instance.os)

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

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

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


773
def RunRenameInstance(instance, old_name):
774
775
  """Run the OS rename script for an instance.

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

  """
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
786
  rename_env = OSEnvironment(instance, inst_os)
787
  rename_env['OLD_INSTANCE_NAME'] = old_name
788
789
790
791

  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
792

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

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


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

Iustin Pop's avatar
Iustin Pop committed
808
809
810
811
812
813
814
815
  @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
816

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

Iustin Pop's avatar
Iustin Pop committed
820
  """
821
822
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

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

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


845
846
847
848
849
850
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):
851
852
853
854
855
856
  """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).


857
858
859
860
  @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
861
862

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


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

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


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

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


921
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
922
923
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
924
  @type instance: L{objects.Instance}
925
  @param instance: the instance object
926
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
927

928
  """
929
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
930
931

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

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


946
def InstanceShutdown(instance):
Iustin Pop's avatar
Iustin Pop committed
947
948
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
949
950
951
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
952
  @param instance: the instance object
953
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
954

955
  """
956
957
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
958
  iname = instance.name
Iustin Pop's avatar
Iustin Pop committed
959

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

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

  # test every 10secs for 2min

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

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

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

990
  _RemoveBlockDevLinks(iname, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
991
992


993
def InstanceReboot(instance, reboot_type):
994
995
  """Reboot an instance.

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

  """
1012
  running_instances = GetInstanceList([instance.hypervisor])
1013
1014

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

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


1033
1034
1035
1036
1037
1038
1039
def MigrationInfo(instance):
  """Gather information about an instance to be migrated.

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

  """
1040
1041
1042
1043
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    info = hyper.MigrationInfo(instance)
  except errors.HypervisorError, err:
1044
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1045
  return info