backend.py 86.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
"""Functions used by the node daemon

@var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in
     the L{UploadFile} function
26
27
@var _ALLOWED_CLEAN_DIRS: denotes which directories are accepted
     in the L{_CleanDirectory} function
28
29

"""
Iustin Pop's avatar
Iustin Pop committed
30

Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
36
# 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
37
38
39
40
41
42
43
44

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

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


61
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"
62
63
64
65
66
_ALLOWED_CLEAN_DIRS = frozenset([
  constants.DATA_DIR,
  constants.JOB_QUEUE_ARCHIVE_DIR,
  constants.QUEUE_DIR,
  ])
67
68


69
70
71
72
73
74
75
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

76

77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
92
93
94
95
96
  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)
97
98
99
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
100
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
101
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
102

Iustin Pop's avatar
Iustin Pop committed
103
104
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
105
106

  """
Iustin Pop's avatar
Iustin Pop committed
107
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
108
109


110
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
111
112
113
114
115
116
117
118
119
  """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

  """
120
  return ssh.SshRunner(cluster_name)
121
122


123
124
125
126
127
128
129
130
131
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

  """
132
  assert isinstance(data, (list, tuple))
133
134
135
136
137
138
139
140
141
142
  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")


143
def _CleanDirectory(path, exclude=None):
144
145
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
146
147
  @type path: str
  @param path: the directory to clean
148
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
149
150
  @param exclude: list of files to be excluded, defaults
      to the empty list
151
152

  """
153
154
155
156
  if path not in _ALLOWED_CLEAN_DIRS:
    _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
          path)

157
158
  if not os.path.isdir(path):
    return
159
160
161
162
163
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
164

165
  for rel_name in utils.ListVisibleFiles(path):
166
    full_name = utils.PathJoin(path, rel_name)
167
168
    if full_name in exclude:
      continue
169
170
171
172
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


173
174
175
176
177
178
def _BuildUploadFileList():
  """Build the list of allowed upload files.

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

  """
179
180
181
182
183
184
185
  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,
186
    constants.HMAC_CLUSTER_KEY,
187
188
189
    ])

  for hv_name in constants.HYPER_TYPES:
190
    hv_class = hypervisor.GetHypervisorClass(hv_name)
191
192
193
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
194
195
196
197
198


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


199
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
200
201
  """Removes job queue files and archived jobs.

202
203
  @rtype: tuple
  @return: True, None
204
205

  """
206
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
207
208
209
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


210
211
212
213
214
215
216
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
217
  @return: master_netdev, master_ip, master_name
218
  @raise RPCFail: in case of errors
219
220
221

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
222
223
224
225
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
226
  except errors.ConfigurationError, err:
Iustin Pop's avatar
Iustin Pop committed
227
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
228
  return (master_netdev, master_ip, master_node)
229
230


231
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
232
233
  """Activate local node as master node.

234
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
235
236
237
238
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
239
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
240
      daemons (ganeti-masterd and ganeti-rapi)
241
242
243
  @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
244
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
245
246

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

250
  err_msgs = []
251
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
252
    if utils.OwnIpAddress(master_ip):
253
      # we already have the ip:
254
      logging.debug("Master IP already configured, doing nothing")
255
    else:
256
257
      msg = "Someone else has the master ip, not activating"
      logging.error(msg)
258
      err_msgs.append(msg)
259
260
261
262
263
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
264
265
      msg = "Can't activate master IP: %s" % result.output
      logging.error(msg)
266
      err_msgs.append(msg)
267
268
269
270
271
272
273

    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:
274
    if no_voting:
275
276
277
278
279
280
281
282
283
284
285
286
287
      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)
288

289
290
  if err_msgs:
    _Fail("; ".join(err_msgs))
291

Iustin Pop's avatar
Iustin Pop committed
292

293
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
294
295
  """Deactivate this node as master.

296
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
297
298
299
300
301
302
303
  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
304
305

  """
306
307
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
308
309

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

312
313
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
314
  if result.failed:
315
    logging.error("Can't remove the master IP, error: %s", result.output)
316
317
318
    # but otherwise ignore the failure

  if stop_daemons:
319
320
321
322
323
    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
324
325


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

329
330
331
332
  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
333

Iustin Pop's avatar
Iustin Pop committed
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
  @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

349
  """
350
351
352
353
  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)]
354
  for name, content, mode in sshd_keys:
355
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
356

357
358
359
360
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
361
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
362

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

366
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
367

368
369
370
371
  result = utils.RunCmd([constants.DAEMON_UTIL, "reload-ssh-keys"])
  if result.failed:
    _Fail("Unable to reload SSH keys (command %r, exit code %s, output %r)",
          result.cmd, result.exit_code, result.output)
Iustin Pop's avatar
Iustin Pop committed
372
373


374
def LeaveCluster(modify_ssh_setup):
Iustin Pop's avatar
Iustin Pop committed
375
376
377
378
379
380
  """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
381
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
382
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
383

384
385
  @param modify_ssh_setup: boolean

Iustin Pop's avatar
Iustin Pop committed
386
  """
387
  _CleanDirectory(constants.DATA_DIR)
388
  JobQueuePurge()
389

390
391
392
  if modify_ssh_setup:
    try:
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
393

394
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
Iustin Pop's avatar
Iustin Pop committed
395

396
397
398
399
      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
400

401
402
403
404
  try:
    utils.RemoveFile(constants.HMAC_CLUSTER_KEY)
    utils.RemoveFile(constants.RAPI_CERT_FILE)
    utils.RemoveFile(constants.SSL_CERT_FILE)
Iustin Pop's avatar
Iustin Pop committed
405
  except: # pylint: disable-msg=W0702
406
407
    logging.exception("Error while removing cluster secrets")

408
409
410
411
  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)
412

413
414
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
415

Iustin Pop's avatar
Iustin Pop committed
416

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

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

433
  """
Iustin Pop's avatar
Iustin Pop committed
434
435
436
437
438
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

439
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
440
441
442
443
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

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

446
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
447
448


449
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
450
451
  """Verify the status of the local node.

452
453
454
455
456
457
458
459
460
  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
461

462
463
464
465
466
467
468
469
470
471
472
  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
473
474
475
  @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
476
477
478
479

  """
  result = {}

480
481
482
483
484
485
486
487
488
489
490
491
492
  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]:
493
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
494
      if not success:
495
496
497
498
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
499
500
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
501
    for name, pip, sip in what[constants.NV_NODENETTEST]:
502
503
504
505
506
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
507
508
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
509
    else:
510
      port = utils.GetDaemonPort(constants.NODED)
511
      for name, pip, sip in what[constants.NV_NODENETTEST]:
512
513
514
515
516
517
518
        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:
519
520
521
522
523
524
525
526
527
528
529
          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:
530
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
531

532
533
534
535
536
  if constants.NV_PVLIST in what:
    result[constants.NV_PVLIST] = \
      bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
                                   filter_allocatable=False)

537
  if constants.NV_VERSION in what:
538
539
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
540
541
542
543

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

545
546
547
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
548
    except errors.BlockDeviceError, err:
549
      logging.warning("Can't get used minors list", exc_info=True)
550
      used_minors = str(err)
551
552
    result[constants.NV_DRBDLIST] = used_minors

553
554
555
556
557
558
559
560
561
562
563
  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")
564
565
566
567

  if constants.NV_TIME in what:
    result[constants.NV_TIME] = utils.SplitTime(time.time())

568
  return result
Iustin Pop's avatar
Iustin Pop committed
569
570
571
572
573


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

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

  """
587
588
589
590
591
  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
592
  if result.failed:
593
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
594

595
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
596
  for line in result.stdout.splitlines():
597
598
599
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
600
      logging.error("Invalid line returned from lvs output: '%s'", line)
601
602
      continue
    name, size, attr = match.groups()
603
604
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
Iustin Pop's avatar
Iustin Pop committed
605
606
607
608
609
    virtual = attr[0] == 'v'
    if virtual:
      # we don't want to report such volumes as existing, since they
      # don't really hold data
      continue
610
611
612
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
613
614
615


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

Iustin Pop's avatar
Iustin Pop committed
618
619
620
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
621
622

  """
623
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
624
625


626
627
628
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
  @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.

644
645
646
647
648
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
649
650
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665

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

666
667
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
668
669


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

Iustin Pop's avatar
Iustin Pop committed
673
674
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
675
676

  """
677
  missing = []
Iustin Pop's avatar
Iustin Pop committed
678
679
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
680
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
681

682
  if missing:
683
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
684

Iustin Pop's avatar
Iustin Pop committed
685

686
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
687
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
688

689
690
691
692
693
  @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
694
695
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
696

697
  """
698
699
700
701
702
703
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
704
705
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
706

707
  return results
Iustin Pop's avatar
Iustin Pop committed
708
709


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

713
714
715
716
  @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
717

718
719
720
721
722
  @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
723

724
  """
Iustin Pop's avatar
Iustin Pop committed
725
726
  output = {}

727
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
728
729
730
731
732
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

733
  return output
Iustin Pop's avatar
Iustin Pop committed
734
735


736
737
738
739
740
741
742
743
744
745
746
747
748
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)
749
750
751
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
752
753

  for idx in range(len(instance.disks)):
754
    link_name = _GetBlockDevSymlinkPath(iname, idx)
755
    if not os.path.islink(link_name):
756
      _Fail("Instance %s was not restarted since ganeti 1.2.5", iname)
757
758


759
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
760
761
  """Gather data about all instances.

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

766
767
768
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

769
  @rtype: dict
770
771
772
773
  @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
774
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
775

776
  """
Iustin Pop's avatar
Iustin Pop committed
777
778
  output = {}

779
780
781
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
782
      for name, _, memory, vcpus, state, times in iinfo:
783
        value = {
784
785
786
787
788
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
789
790
791
792
793
794
        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]:
795
796
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
797
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
798

799
  return output
Iustin Pop's avatar
Iustin Pop committed
800
801


Iustin Pop's avatar
Iustin Pop committed
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
def _InstanceLogName(kind, os_name, instance):
  """Compute the OS log filename for a given instance and operation.

  The instance name and os name are passed in as strings since not all
  operations have these as part of an instance object.

  @type kind: string
  @param kind: the operation type (e.g. add, import, etc.)
  @type os_name: string
  @param os_name: the os name
  @type instance: string
  @param instance: the name of the instance being imported/added/etc.

  """
  base = "%s-%s-%s-%d.log" % (kind, os_name, instance, int(time.time()))
  return utils.PathJoin(constants.LOG_OS_DIR, base)


820
def InstanceOsAdd(instance, reinstall, debug):
Alexander Schreiber's avatar
Alexander Schreiber committed
821
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
822

823
824
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
825
826
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
827
828
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
829
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
830
831

  """
832
833
  inst_os = OSFromDisk(instance.os)

834
  create_env = OSEnvironment(instance, inst_os, debug)
835
836
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
837

Iustin Pop's avatar
Iustin Pop committed
838
  logfile = _InstanceLogName("add", instance.os, instance.name)
839

840
841
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
842
  if result.failed:
843
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
844
                  " output: %s", result.cmd, result.fail_reason, logfile,
845
                  result.output)
846
    lines = [utils.SafeEncode(val)
847
             for val in utils.TailFile(logfile, lines=20)]
848
849
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
850
851


852
def RunRenameInstance(instance, old_name, debug):
853
854
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
855
  @type instance: L{objects.Instance}
856
857
858
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
859
860
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
Iustin Pop's avatar
Iustin Pop committed
861
862
  @rtype: boolean
  @return: the success of the operation
863
864
865
866

  """
  inst_os = OSFromDisk(instance.os)

867
  rename_env = OSEnvironment(instance, inst_os, debug)
868
  rename_env['OLD_INSTANCE_NAME'] = old_name
869

Iustin Pop's avatar
Iustin Pop committed
870
871
  logfile = _InstanceLogName("rename", instance.os,
                             "%s-%s" % (old_name, instance.name))
Iustin Pop's avatar
Iustin Pop committed
872

873
874
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
875
876

  if result.failed:
877
    logging.error("os create command '%s' returned error: %s output: %s",
878
                  result.cmd, result.fail_reason, result.output)
879
    lines = [utils.SafeEncode(val)
880
             for val in utils.TailFile(logfile, lines=20)]
881
882
    _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
883
884
885


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

Iustin Pop's avatar
Iustin Pop committed
888
889
890
891
892
893
894
895
  @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
896

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

Iustin Pop's avatar
Iustin Pop committed
900
  """
901
902
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
903
904
905
906
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
907
    logging.error("volume group %s not present", vg_name)
908
    return retdic
Iustin Pop's avatar
Iustin Pop committed
909
  valarr = retval.stdout.strip().rstrip(':').split(':')
910
911
912
913
914
915
916
  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]),
        }
917
    except (TypeError, ValueError), err:
Iustin Pop's avatar
Iustin Pop committed
918
      logging.exception("Fail to parse vgs output: %s", err)
919
  else:
920
921
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
922
923
924
  return retdic


925
def _GetBlockDevSymlinkPath(instance_name, idx):
926
927
  return utils.PathJoin(constants.DISK_LINKS_DIR,
                        "%s:%d" % (instance_name, idx))
928
929
930


def _SymlinkBlockDev(instance_name, device_path, idx):
931
932
933
934
935
936
  """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).


937
938
939
940
  @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
941
942

  """
943
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
944
945
  try:
    os.symlink(device_path, link_name)
946
947
  except OSError, err:
    if err.errno == errno.EEXIST:
948
949
950
951
952
953
954
955
956
957
      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


958
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
959
960
961
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
962
  for idx, _ in enumerate(disks):
963
964
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
965
      try:
966
967
968
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
969
970


971
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
972
973
974
975
976
  """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
977
978
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
979
980
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
981

Iustin Pop's avatar
Iustin Pop committed
982
983
  """
  block_devices = []
984
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
985
986
987
988
989
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
990
    try:
991
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
992
993
994
995
996
997
    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
998
999
1000
  return block_devices


1001
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
1002
1003
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
1004
  @type instance: L{objects.Instance}
1005
  @param instance: the instance object
1006
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1007

1008
  """
1009
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
1010
1011

  if instance.name in running_instances:
1012
1013
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
1014
1015

  try:
1016
1017
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1018
    hyper.StartInstance(instance, block_devices)
1019
  except errors.BlockDeviceError, err:
1020
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
1021
  except errors.HypervisorError, err:
1022
    _RemoveBlockDevLinks(instance.name, instance.disks)
1023
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
1024
1025


1026
def InstanceShutdown(instance, timeout):
Iustin Pop's avatar
Iustin Pop committed
1027
1028
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
1029
1030
1031
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
1032
  @param instance: the instance object
1033
1034
  @type timeout: integer
  @param timeout: maximum timeout for soft shutdown
1035
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1036

1037
  """
1038
  hv_name = instance.hypervisor
1039
  hyper = hypervisor.GetHypervisor(hv_name)
1040
  iname = instance.name
Iustin Pop's avatar
Iustin Pop committed
1041

1042
  if instance.name not in hyper.ListInstances():
1043
1044
    logging.info("Instance %s not running, doing nothing", iname)
    return
Iustin Pop's avatar
Iustin Pop committed
1045

1046
1047
1048
  class _TryShutdown:
    def __init__(self):
      self.tried_once = False
Iustin Pop's avatar
Iustin Pop committed
1049

1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
    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
1071
    # the shutdown did not succeed
1072
    logging.error("Shutdown of '%s' unsuccessful, forcing", iname)
Iustin Pop's avatar