backend.py 86.5 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

Iustin Pop's avatar
Iustin Pop committed
29
30
31
32
33
34
# pylint: disable-msg=E1103

# E1103: %s %r has no %r member (but some types could not be
# inferred), because the _TryOSFromDisk returns either (True, os_obj)
# or (False, "string") which confuses pylint

Iustin Pop's avatar
Iustin Pop committed
35
36
37
38
39
40
41
42
43

import os
import os.path
import shutil
import time
import stat
import errno
import re
import subprocess
44
import random
45
import logging
46
import tempfile
47
48
import zlib
import base64
Iustin Pop's avatar
Iustin Pop committed
49
50
51
52
53
54
55
56

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
57
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
58
59


60
61
62
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"


63
64
65
66
67
68
69
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

70

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
86
87
88
89
90
  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)
91
92
93
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
94
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
95
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
96

Iustin Pop's avatar
Iustin Pop committed
97
98
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
99
100

  """
Iustin Pop's avatar
Iustin Pop committed
101
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
102
103


104
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
105
106
107
108
109
110
111
112
113
  """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

  """
114
  return ssh.SshRunner(cluster_name)
115
116


117
118
119
120
121
122
123
124
125
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

  """
126
  assert isinstance(data, (list, tuple))
127
128
129
130
131
132
133
134
135
136
  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")


137
def _CleanDirectory(path, exclude=None):
138
139
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
140
141
  @type path: str
  @param path: the directory to clean
142
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
143
144
  @param exclude: list of files to be excluded, defaults
      to the empty list
145
146

  """
147
148
  if not os.path.isdir(path):
    return
149
150
151
152
153
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
154

155
  for rel_name in utils.ListVisibleFiles(path):
156
157
158
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
159
160
161
162
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


163
164
165
166
167
168
def _BuildUploadFileList():
  """Build the list of allowed upload files.

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

  """
169
170
171
172
173
174
175
  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,
176
    constants.HMAC_CLUSTER_KEY,
177
178
179
    ])

  for hv_name in constants.HYPER_TYPES:
180
    hv_class = hypervisor.GetHypervisorClass(hv_name)
181
182
183
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
184
185
186
187
188


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


189
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
190
191
  """Removes job queue files and archived jobs.

192
193
  @rtype: tuple
  @return: True, None
194
195

  """
196
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
197
198
199
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


200
201
202
203
204
205
206
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
207
  @return: master_netdev, master_ip, master_name
208
  @raise RPCFail: in case of errors
209
210
211

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
212
213
214
215
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
216
  except errors.ConfigurationError, err:
Iustin Pop's avatar
Iustin Pop committed
217
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
218
  return (master_netdev, master_ip, master_node)
219
220


221
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
222
223
  """Activate local node as master node.

224
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
225
226
227
228
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
229
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
230
      daemons (ganeti-masterd and ganeti-rapi)
231
232
233
  @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
234
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
235
236

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

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

    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:
264
    if no_voting:
265
266
267
268
269
270
271
272
273
274
275
276
277
      masterd_args = "--no-voting --yes-do-it"
    else:
      masterd_args = ""

    env = {
      "EXTRA_MASTERD_ARGS": masterd_args,
      }

    result = utils.RunCmd([constants.DAEMON_UTIL, "start-master"], env=env)
    if result.failed:
      msg = "Can't start Ganeti master: %s" % result.output
      logging.error(msg)
      err_msgs.append(msg)
278

279
280
  if err_msgs:
    _Fail("; ".join(err_msgs))
281

Iustin Pop's avatar
Iustin Pop committed
282

283
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
284
285
  """Deactivate this node as master.

286
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
287
288
289
290
291
292
293
  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
294
295

  """
296
297
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
298
299

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

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

  if stop_daemons:
309
310
311
312
313
    result = utils.RunCmd([constants.DAEMON_UTIL, "stop-master"])
    if result.failed:
      logging.error("Could not stop Ganeti master, command %s had exitcode %s"
                    " and error %s",
                    result.cmd, result.exit_code, result.output)
Iustin Pop's avatar
Iustin Pop committed
314
315


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

319
320
321
322
  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
323

Iustin Pop's avatar
Iustin Pop committed
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
  @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

339
  """
340
341
342
343
  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)]
344
  for name, content, mode in sshd_keys:
345
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
346

347
348
349
350
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
351
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
352

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

356
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
357

358
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
359
360


361
def LeaveCluster(modify_ssh_setup):
Iustin Pop's avatar
Iustin Pop committed
362
363
364
365
366
367
  """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
368
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
369
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
370

371
372
  @param modify_ssh_setup: boolean

Iustin Pop's avatar
Iustin Pop committed
373
  """
374
  _CleanDirectory(constants.DATA_DIR)
375
  JobQueuePurge()
376

377
378
379
  if modify_ssh_setup:
    try:
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
380

381
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
Iustin Pop's avatar
Iustin Pop committed
382

383
384
385
386
      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
387

388
389
390
391
392
393
394
  try:
    utils.RemoveFile(constants.HMAC_CLUSTER_KEY)
    utils.RemoveFile(constants.RAPI_CERT_FILE)
    utils.RemoveFile(constants.SSL_CERT_FILE)
  except:
    logging.exception("Error while removing cluster secrets")

395
396
397
398
  result = utils.RunCmd([constants.DAEMON_UTIL, "stop", constants.CONFD])
  if result.failed:
    logging.error("Command %s failed with exitcode %s and error %s",
                  result.cmd, result.exit_code, result.output)
399

400
401
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
402

Iustin Pop's avatar
Iustin Pop committed
403

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

407
408
409
410
411
412
413
414
415
416
417
418
  @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
419

420
  """
Iustin Pop's avatar
Iustin Pop committed
421
422
423
424
425
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

426
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
427
428
429
430
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

431
  outputarray["bootid"] = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
432

433
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
434
435


436
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
437
438
  """Verify the status of the local node.

439
440
441
442
443
444
445
446
447
  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
448

449
450
451
452
453
454
455
456
457
458
459
  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
460
461
462
  @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
463
464
465
466

  """
  result = {}

467
468
469
470
471
472
473
474
475
476
477
478
479
  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]:
480
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
481
      if not success:
482
483
484
485
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
486
487
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
488
    for name, pip, sip in what[constants.NV_NODENETTEST]:
489
490
491
492
493
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
494
495
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
496
    else:
497
      port = utils.GetDaemonPort(constants.NODED)
498
      for name, pip, sip in what[constants.NV_NODENETTEST]:
499
500
501
502
503
504
505
        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:
506
507
508
509
510
511
512
513
514
515
516
          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:
517
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
518

519
520
521
522
523
  if constants.NV_PVLIST in what:
    result[constants.NV_PVLIST] = \
      bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
                                   filter_allocatable=False)

524
  if constants.NV_VERSION in what:
525
526
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
527
528
529
530

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

532
533
534
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
535
    except errors.BlockDeviceError, err:
536
      logging.warning("Can't get used minors list", exc_info=True)
537
      used_minors = str(err)
538
539
    result[constants.NV_DRBDLIST] = used_minors

540
541
542
543
544
545
546
547
548
549
550
  if constants.NV_NODESETUP in what:
    result[constants.NV_NODESETUP] = tmpr = []
    if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
      tmpr.append("The sysfs filesytem doesn't seem to be mounted"
                  " under /sys, missing required directories /sys/block"
                  " and /sys/class/net")
    if (not os.path.isdir("/proc/sys") or
        not os.path.isfile("/proc/sysrq-trigger")):
      tmpr.append("The procfs filesystem doesn't seem to be mounted"
                  " under /proc, missing required directory /proc/sys and"
                  " the file /proc/sysrq-trigger")
551
  return result
Iustin Pop's avatar
Iustin Pop committed
552
553
554
555
556


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

Iustin Pop's avatar
Iustin Pop committed
557
558
559
560
561
562
563
564
565
566
567
  @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
568
569

  """
570
571
572
573
574
  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
575
  if result.failed:
576
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
577

578
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
579
  for line in result.stdout.splitlines():
580
581
582
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
583
      logging.error("Invalid line returned from lvs output: '%s'", line)
584
585
      continue
    name, size, attr = match.groups()
586
587
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
Iustin Pop's avatar
Iustin Pop committed
588
589
590
591
592
    virtual = attr[0] == 'v'
    if virtual:
      # we don't want to report such volumes as existing, since they
      # don't really hold data
      continue
593
594
595
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
596
597
598


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

Iustin Pop's avatar
Iustin Pop committed
601
602
603
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
604
605

  """
606
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
607
608


609
610
611
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
  @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.

627
628
629
630
631
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
632
633
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648

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

649
650
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
651
652


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

Iustin Pop's avatar
Iustin Pop committed
656
657
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
658
659

  """
660
  missing = []
Iustin Pop's avatar
Iustin Pop committed
661
662
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
663
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
664

665
  if missing:
666
    _Fail("Missing bridges %s", ", ".join(missing))
667

Iustin Pop's avatar
Iustin Pop committed
668

669
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
670
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
671

672
673
674
675
676
  @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
677
678
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
679

680
  """
681
682
683
684
685
686
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
687
688
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
689

690
  return results
Iustin Pop's avatar
Iustin Pop committed
691
692


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

696
697
698
699
  @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
700

701
702
703
704
705
  @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
706

707
  """
Iustin Pop's avatar
Iustin Pop committed
708
709
  output = {}

710
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
711
712
713
714
715
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

716
  return output
Iustin Pop's avatar
Iustin Pop committed
717
718


719
720
721
722
723
724
725
726
727
728
729
730
731
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)
732
733
734
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
735
736

  for idx in range(len(instance.disks)):
737
    link_name = _GetBlockDevSymlinkPath(iname, idx)
738
    if not os.path.islink(link_name):
739
      _Fail("Instance %s was not restarted since ganeti 1.2.5", iname)
740
741


742
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
743
744
  """Gather data about all instances.

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

749
750
751
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

752
  @rtype: dict
753
754
755
756
  @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
757
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
758

759
  """
Iustin Pop's avatar
Iustin Pop committed
760
761
  output = {}

762
763
764
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
765
      for name, _, memory, vcpus, state, times in iinfo:
766
        value = {
767
768
769
770
771
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
772
773
774
775
776
777
        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]:
778
779
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
780
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
781

782
  return output
Iustin Pop's avatar
Iustin Pop committed
783
784


785
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
786
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
787

788
789
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
790
791
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
792
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
793
794

  """
795
796
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
797
  create_env = OSEnvironment(instance, inst_os)
798
799
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
800
801
802

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

804
805
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
806
  if result.failed:
807
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
808
                  " output: %s", result.cmd, result.fail_reason, logfile,
809
                  result.output)
810
    lines = [utils.SafeEncode(val)
811
             for val in utils.TailFile(logfile, lines=20)]
812
813
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
814
815


816
def RunRenameInstance(instance, old_name):
817
818
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
819
  @type instance: L{objects.Instance}
820
821
822
  @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
823
824
  @rtype: boolean
  @return: the success of the operation
825
826
827
828

  """
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
829
  rename_env = OSEnvironment(instance, inst_os)
830
  rename_env['OLD_INSTANCE_NAME'] = old_name
831
832
833
834

  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
835

836
837
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
838
839

  if result.failed:
840
    logging.error("os create command '%s' returned error: %s output: %s",
841
                  result.cmd, result.fail_reason, result.output)
842
    lines = [utils.SafeEncode(val)
843
             for val in utils.TailFile(logfile, lines=20)]
844
845
    _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
846
847
848


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

Iustin Pop's avatar
Iustin Pop committed
851
852
853
854
855
856
857
858
  @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
859

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

Iustin Pop's avatar
Iustin Pop committed
863
  """
864
865
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
866
867
868
869
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
870
    logging.error("volume group %s not present", vg_name)
871
    return retdic
Iustin Pop's avatar
Iustin Pop committed
872
  valarr = retval.stdout.strip().rstrip(':').split(':')
873
874
875
876
877
878
879
880
  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
881
      logging.exception("Fail to parse vgs output: %s", err)
882
  else:
883
884
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
885
886
887
  return retdic


888
889
890
891
892
893
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):
894
895
896
897
898
899
  """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).


900
901
902
903
  @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
904
905

  """
906
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
907
908
  try:
    os.symlink(device_path, link_name)
909
910
  except OSError, err:
    if err.errno == errno.EEXIST:
911
912
913
914
915
916
917
918
919
920
      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


921
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
922
923
924
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
925
  for idx, _ in enumerate(disks):
926
927
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
928
      try:
929
930
931
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
932
933


934
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
935
936
937
938
939
  """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
940
941
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
942
943
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
944

Iustin Pop's avatar
Iustin Pop committed
945
946
  """
  block_devices = []
947
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
948
949
950
951
952
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
953
    try:
954
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
955
956
957
958
959
960
    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
961
962
963
  return block_devices


964
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
965
966
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
967
  @type instance: L{objects.Instance}
968
  @param instance: the instance object
969
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
970

971
  """
972
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
973
974

  if instance.name in running_instances:
975
976
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
977
978

  try:
979
980
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
981
    hyper.StartInstance(instance, block_devices)
982
  except errors.BlockDeviceError, err:
983
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
984
  except errors.HypervisorError, err:
985
    _RemoveBlockDevLinks(instance.name, instance.disks)
986
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
987
988


989
def InstanceShutdown(instance, timeout):
Iustin Pop's avatar
Iustin Pop committed
990
991
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
992
993
994
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
995
  @param instance: the instance object
996
997
  @type timeout: integer
  @param timeout: maximum timeout for soft shutdown
998
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
999

1000
  """
1001
  hv_name = instance.hypervisor
1002
  hyper = hypervisor.GetHypervisor(hv_name)
1003
  iname = instance.name
Iustin Pop's avatar
Iustin Pop committed
1004

1005
  if instance.name not in hyper.ListInstances():
1006
1007
    logging.info("Instance %s not running, doing nothing", iname)
    return
Iustin Pop's avatar
Iustin Pop committed
1008

1009
1010
1011
  class _TryShutdown:
    def __init__(self):
      self.tried_once = False
Iustin Pop's avatar
Iustin Pop committed
1012

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
    def __call__(self):
      if iname not in hyper.ListInstances():
        return

      try:
        hyper.StopInstance(instance, retry=self.tried_once)
      except errors.HypervisorError, err:
        if iname not in hyper.ListInstances():
          # if the instance is no longer existing, consider this a
          # success and go to cleanup
          return

        _Fail("Failed to stop instance %s: %s", iname, err)

      self.tried_once = True

      raise utils.RetryAgain()

  try:
    utils.Retry(_TryShutdown(), 5, timeout)
  except utils.RetryTimeout:
Iustin Pop's avatar
Iustin Pop committed
1034
    # the shutdown did not succeed
1035
    logging.error("Shutdown of '%s' unsuccessful, forcing", iname)
Iustin Pop's avatar
Iustin Pop committed
1036
1037
1038
1039

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
1040
      if iname in hyper.ListInstances():
1041
1042
1043
        # only raise an error if the instance still exists, otherwise
        # the error could simply be "instance ... unknown"!
        _Fail("Failed to force stop instance %s: %s", iname, err)
Iustin Pop's avatar
Iustin Pop committed
1044
1045

    time.sleep(1)
1046
1047

    if iname in hyper.ListInstances():
1048
      _Fail("Could not shutdown instance %s even by destroy", iname)
Iustin Pop's avatar
Iustin Pop committed
1049

1050
  _RemoveBlockDevLinks(iname, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
1051
1052


1053
def InstanceReboot(instance, reboot_type, shutdown_timeout):
1054
1055
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
1056
1057
1058
1059
1060
1061
1062
1063
1064
  @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)
1065
1066
1067
1068
      - 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)
Michael Hanselmann's avatar
Michael Hanselmann committed
1069
1070
  @type shutdown_timeout: integer
  @param shutdown_timeout: maximum timeout for soft shutdown
1071
  @rtype: None
1072
1073

  """
1074
  running_instances = GetInstanceList([instance.hypervisor])
Alexander Schreiber's avatar