backend.py 55.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 22 23 24 25 26 27 28 29 30 31 32
#

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


"""Functions used by the node daemon"""


import os
import os.path
import shutil
import time
import stat
import errno
import re
import subprocess
33
import random
34
import logging
35
import tempfile
Iustin Pop's avatar
Iustin Pop committed
36 37 38 39 40 41 42 43

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
44
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
45 46


Michael Hanselmann's avatar
Michael Hanselmann committed
47 48 49 50
def _GetConfig():
  return ssconf.SimpleConfigReader()


51
def _GetSshRunner():
Michael Hanselmann's avatar
Michael Hanselmann committed
52
  return ssh.SshRunner(_GetConfig())
53 54


55 56 57 58 59 60 61
def _CleanDirectory(path, exclude=[]):
  """Removes all regular files in a directory.

  @param exclude: List of files to be excluded.
  @type exclude: list

  """
62 63
  if not os.path.isdir(path):
    return
64 65 66 67

  # Normalize excluded paths
  exclude = [os.path.normpath(i) for i in exclude]

68
  for rel_name in utils.ListVisibleFiles(path):
69 70 71
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
72 73 74 75
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


76
def JobQueuePurge():
77 78 79
  """Removes job queue files and archived jobs

  """
80
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
81 82 83
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


84 85 86 87 88 89 90 91
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
  @return: (master_netdev, master_ip, master_name)
92 93 94

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
95 96 97 98
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
99 100 101
  except errors.ConfigurationError, err:
    logging.exception("Cluster configuration incomplete")
    return (None, None)
102
  return (master_netdev, master_ip, master_node)
103 104


105
def StartMaster(start_daemons):
Iustin Pop's avatar
Iustin Pop committed
106 107
  """Activate local node as master node.

108 109 110 111
  The function will always try activate the IP address of the master
  (if someone else has it, then it won't). Then, if the start_daemons
  parameter is True, it will also start the master daemons
  (ganet-masterd and ganeti-rapi).
Iustin Pop's avatar
Iustin Pop committed
112 113

  """
114
  ok = True
115
  master_netdev, master_ip, _ = GetMasterInfo()
116
  if not master_netdev:
Iustin Pop's avatar
Iustin Pop committed
117 118
    return False

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
    if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT,
                     source=constants.LOCALHOST_IP_ADDRESS):
      # we already have the ip:
      logging.debug("Already started")
    else:
      logging.error("Someone else has the master ip, not activating")
      ok = False
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
      logging.error("Can't activate master IP: %s", result.output)
      ok = False

    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:
    for daemon in 'ganeti-masterd', 'ganeti-rapi':
      result = utils.RunCmd([daemon])
      if result.failed:
        logging.error("Can't start daemon %s: %s", daemon, result.output)
        ok = False
  return ok
Iustin Pop's avatar
Iustin Pop committed
147 148


149
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
150 151
  """Deactivate this node as master.

152 153 154
  The function will always try to deactivate the IP address of the
  master. Then, if the stop_daemons parameter is True, it will also
  stop the master daemons (ganet-masterd and ganeti-rapi).
Iustin Pop's avatar
Iustin Pop committed
155 156

  """
157
  master_netdev, master_ip, _ = GetMasterInfo()
158 159
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
160

161 162
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
163
  if result.failed:
164
    logging.error("Can't remove the master IP, error: %s", result.output)
165 166 167 168 169 170
    # but otherwise ignore the failure

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

  return True


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

178 179 180 181
  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
182

183
  """
184 185 186 187
  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)]
188
  for name, content, mode in sshd_keys:
189
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
190

191 192 193 194
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
195
    logging.exception("Error while processing user ssh files")
196
    return False
Iustin Pop's avatar
Iustin Pop committed
197

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

201
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
202

203
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
204 205 206 207 208 209 210 211

  return True


def LeaveCluster():
  """Cleans up the current node and prepares it to be removed from the cluster.

  """
212
  _CleanDirectory(constants.DATA_DIR)
213
  JobQueuePurge()
214

215 216
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
217 218
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
219 220
    return

221
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
222
  try:
223
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
224 225 226
  finally:
    f.close()

227 228
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
229

230 231 232
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
233 234

def GetNodeInfo(vgname):
Alexander Schreiber's avatar
Alexander Schreiber committed
235
  """Gives back a hash with different informations about the node.
Iustin Pop's avatar
Iustin Pop committed
236 237 238 239 240 241 242 243 244 245 246

  Returns:
    { 'vg_size' : xxx,  'vg_free' : xxx, 'memory_domain0': xxx,
      'memory_free' : xxx, 'memory_total' : xxx }
    where
    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

247
  """
Iustin Pop's avatar
Iustin Pop committed
248 249 250 251 252
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

Michael Hanselmann's avatar
Michael Hanselmann committed
253
  hyper = hypervisor.GetHypervisor(_GetConfig())
Iustin Pop's avatar
Iustin Pop committed
254 255 256 257
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

258 259 260 261 262 263
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

Iustin Pop's avatar
Iustin Pop committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
  return outputarray


def VerifyNode(what):
  """Verify the status of the local node.

  Args:
    what - a dictionary of things to check:
      'filelist' : list of files for which to compute checksums
      'nodelist' : list of nodes we should check communication with
      'hypervisor': run the hypervisor-specific verify

  Requested files on local node are checksummed and the result returned.

  The nodelist is traversed, with the following checks being made
  for each node:
  - known_hosts key correct
  - correct resolving of node name (target node returns its own hostname
    by ssh-execution of 'hostname', result compared against name in list.

  """
  result = {}

  if 'hypervisor' in what:
Michael Hanselmann's avatar
Michael Hanselmann committed
288
    result['hypervisor'] = hypervisor.GetHypervisor(_GetConfig()).Verify()
Iustin Pop's avatar
Iustin Pop committed
289 290 291 292 293 294

  if 'filelist' in what:
    result['filelist'] = utils.FingerprintFiles(what['filelist'])

  if 'nodelist' in what:
    result['nodelist'] = {}
295
    random.shuffle(what['nodelist'])
Iustin Pop's avatar
Iustin Pop committed
296
    for node in what['nodelist']:
297
      success, message = _GetSshRunner().VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
298 299
      if not success:
        result['nodelist'][node] = message
300 301 302 303 304 305 306 307 308 309 310 311 312 313
  if 'node-net-test' in what:
    result['node-net-test'] = {}
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
    for name, pip, sip in what['node-net-test']:
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
      result['node-net-test'][my_name] = ("Can't find my own"
                                          " primary/secondary IP"
                                          " in the node list")
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
314
      port = utils.GetNodeDaemonPort()
315 316 317 318 319 320 321 322 323 324 325 326
      for name, pip, sip in what['node-net-test']:
        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:
          result['node-net-test'][name] = ("failure using the %s"
                                           " interface(s)" %
                                           " and ".join(fail))

Iustin Pop's avatar
Iustin Pop committed
327 328 329 330 331 332 333
  return result


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

  Returns:
334 335 336
    dictionary of all partions (key) with their size (in MiB), inactive
    and online status:
    {'test1': ('20.06', True, True)}
Iustin Pop's avatar
Iustin Pop committed
337 338

  """
339 340 341 342 343
  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
344
  if result.failed:
345 346
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
347
    return result.output
348

349
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
350
  for line in result.stdout.splitlines():
351 352 353
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
354
      logging.error("Invalid line returned from lvs output: '%s'", line)
355 356
      continue
    name, size, attr = match.groups()
357 358 359 360 361
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
362 363 364


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
365
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
366 367 368 369 370 371 372 373

  Returns:
    Dictionary with keys volume name and values the size of the volume

  """
  return utils.ListVolumeGroups()


374 375 376 377 378 379 380 381
def NodeVolumes():
  """List all volumes on this node.

  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
382 383
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
    return {}

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

400 401
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
402 403


Iustin Pop's avatar
Iustin Pop committed
404
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
405
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
406 407 408 409 410 411 412 413 414 415 416 417 418

  Returns:
    True if all of them exist, false otherwise

  """
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
      return False

  return True


def GetInstanceList():
Alexander Schreiber's avatar
Alexander Schreiber committed
419
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
420 421 422 423 424 425

  Returns:
    A list of all running instances on the current node
    - instance1.example.com
    - instance2.example.com

426
  """
Iustin Pop's avatar
Iustin Pop committed
427
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
428
    names = hypervisor.GetHypervisor(_GetConfig()).ListInstances()
Iustin Pop's avatar
Iustin Pop committed
429
  except errors.HypervisorError, err:
430
    logging.exception("Error enumerating instances")
Iustin Pop's avatar
Iustin Pop committed
431 432 433 434 435 436
    raise

  return names


def GetInstanceInfo(instance):
Alexander Schreiber's avatar
Alexander Schreiber committed
437
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
438 439 440 441 442 443 444 445 446 447 448

  Args:
    instance: name of the instance (ex. instance1.example.com)

  Returns:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)

449
  """
Iustin Pop's avatar
Iustin Pop committed
450 451
  output = {}

Michael Hanselmann's avatar
Michael Hanselmann committed
452
  iinfo = hypervisor.GetHypervisor(_GetConfig()).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


def GetAllInstancesInfo():
  """Gather data about all instances.

  This is the equivalent of `GetInstanceInfo()`, except that it
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

  Returns: a dictionary of dictionaries, keys being the instance name,
    and with values:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)
    vcpus: the number of cpus

477
  """
Iustin Pop's avatar
Iustin Pop committed
478 479
  output = {}

Michael Hanselmann's avatar
Michael Hanselmann committed
480
  iinfo = hypervisor.GetHypervisor(_GetConfig()).GetAllInstancesInfo()
Iustin Pop's avatar
Iustin Pop committed
481
  if iinfo:
482
    for name, inst_id, memory, vcpus, state, times in iinfo:
Iustin Pop's avatar
Iustin Pop committed
483 484 485 486 487 488 489 490 491 492 493
      output[name] = {
        'memory': memory,
        'vcpus': vcpus,
        'state': state,
        'time': times,
        }

  return output


def AddOSToInstance(instance, os_disk, swap_disk):
Alexander Schreiber's avatar
Alexander Schreiber committed
494
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
495 496 497 498 499 500 501

  Args:
    instance: the instance object
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
502
  cfg = _GetConfig()
Iustin Pop's avatar
Iustin Pop committed
503 504 505 506
  inst_os = OSFromDisk(instance.os)

  create_script = inst_os.create_script

Iustin Pop's avatar
Iustin Pop committed
507 508
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
509
    logging.error("Can't find this device-visible name '%s'", os_disk)
Iustin Pop's avatar
Iustin Pop committed
510 511
    return False

Iustin Pop's avatar
Iustin Pop committed
512 513
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
514
    logging.error("Can't find this device-visible name '%s'", swap_disk)
Iustin Pop's avatar
Iustin Pop committed
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                     instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

534
  command = utils.BuildShellCmd("cd %s && %s -i %s -b %s -s %s &>%s",
Iustin Pop's avatar
Iustin Pop committed
535 536 537
                                inst_os.path, create_script, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
Michael Hanselmann's avatar
Michael Hanselmann committed
538
  env = {'HYPERVISOR': cfg.GetHypervisorType()}
539

540
  result = utils.RunCmd(command, env=env)
541
  if result.failed:
542 543 544
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
                  " output: %s", command, result.fail_reason, logfile,
                  result.output)
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    return False

  return True


def RunRenameInstance(instance, old_name, os_disk, swap_disk):
  """Run the OS rename script for an instance.

  Args:
    instance: the instance object
    old_name: the old name of the instance
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
  inst_os = OSFromDisk(instance.os)

  script = inst_os.rename_script

  os_device = instance.FindDisk(os_disk)
  if os_device is None:
566
    logging.error("Can't find this device-visible name '%s'", os_disk)
567 568 569 570
    return False

  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
571
    logging.error("Can't find this device-visible name '%s'", swap_disk)
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                           old_name,
                                           instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

  command = utils.BuildShellCmd("cd %s && %s -o %s -n %s -b %s -s %s &>%s",
                                inst_os.path, script, old_name, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
Iustin Pop's avatar
Iustin Pop committed
596 597 598 599

  result = utils.RunCmd(command)

  if result.failed:
600 601
    logging.error("os create command '%s' returned error: %s output: %s",
                  command, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    return False

  return True


def _GetVGInfo(vg_name):
  """Get informations about the volume group.

  Args:
    vg_name: the volume group

  Returns:
    { 'vg_size' : xxx, 'vg_free' : xxx, 'pv_count' : xxx }
    where
    vg_size is the total size of the volume group in MiB
    vg_free is the free size of the volume group in MiB
    pv_count are the number of physical disks in that vg

620 621 622
  If an error occurs during gathering of data, we return the same dict
  with keys all set to None.

Iustin Pop's avatar
Iustin Pop committed
623
  """
624 625
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
626 627 628 629
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
630
    logging.error("volume group %s not present", vg_name)
631
    return retdic
Iustin Pop's avatar
Iustin Pop committed
632
  valarr = retval.stdout.strip().rstrip(':').split(':')
633 634 635 636 637 638 639 640
  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:
641
      logging.exception("Fail to parse vgs output")
642
  else:
643 644
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
  return retdic


def _GatherBlockDevs(instance):
  """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.

  """
  block_devices = []
  for disk in instance.disks:
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
    block_devices.append((disk, device))
  return block_devices


def StartInstance(instance, extra_args):
  """Start an instance.

  Args:
    instance - name of instance to start.

672
  """
Iustin Pop's avatar
Iustin Pop committed
673 674 675 676 677 678
  running_instances = GetInstanceList()

  if instance.name in running_instances:
    return True

  block_devices = _GatherBlockDevs(instance)
Michael Hanselmann's avatar
Michael Hanselmann committed
679
  hyper = hypervisor.GetHypervisor(_GetConfig())
Iustin Pop's avatar
Iustin Pop committed
680 681 682 683

  try:
    hyper.StartInstance(instance, block_devices, extra_args)
  except errors.HypervisorError, err:
684
    logging.exception("Failed to start instance")
Iustin Pop's avatar
Iustin Pop committed
685 686 687 688 689 690 691 692 693 694 695
    return False

  return True


def ShutdownInstance(instance):
  """Shut an instance down.

  Args:
    instance - name of instance to shutdown.

696
  """
Iustin Pop's avatar
Iustin Pop committed
697 698 699 700 701
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
    return True

Michael Hanselmann's avatar
Michael Hanselmann committed
702
  hyper = hypervisor.GetHypervisor(_GetConfig())
Iustin Pop's avatar
Iustin Pop committed
703 704 705
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
706
    logging.error("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
707 708 709 710 711 712 713 714 715 716 717 718
    return False

  # test every 10secs for 2min
  shutdown_ok = False

  time.sleep(1)
  for dummy in range(11):
    if instance.name not in GetInstanceList():
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
719
    logging.error("shutdown of '%s' unsuccessful, using destroy", instance)
Iustin Pop's avatar
Iustin Pop committed
720 721 722 723

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
724
      logging.exception("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
725 726 727 728
      return False

    time.sleep(1)
    if instance.name in GetInstanceList():
729 730
      logging.error("could not shutdown instance '%s' even by destroy",
                    instance.name)
Iustin Pop's avatar
Iustin Pop committed
731 732 733 734 735
      return False

  return True


736 737 738 739 740 741 742 743 744 745 746
def RebootInstance(instance, reboot_type, extra_args):
  """Reboot an instance.

  Args:
    instance    - name of instance to reboot
    reboot_type - how to reboot [soft,hard,full]

  """
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
747
    logging.error("Cannot reboot instance that is not running")
748 749
    return False

Michael Hanselmann's avatar
Michael Hanselmann committed
750
  hyper = hypervisor.GetHypervisor(_GetConfig())
751 752 753 754
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
755
      logging.exception("Failed to soft reboot instance")
756 757 758 759 760 761
      return False
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
      ShutdownInstance(instance)
      StartInstance(instance, extra_args)
    except errors.HypervisorError, err:
762
      logging.exception("Failed to hard reboot instance")
763 764 765 766 767 768 769 770
      return False
  else:
    raise errors.ParameterError("reboot_type invalid")


  return True


771 772 773 774
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

  """
Michael Hanselmann's avatar
Michael Hanselmann committed
775
  hyper = hypervisor.GetHypervisor(_GetConfig())
776 777 778 779 780

  try:
    hyper.MigrateInstance(instance, target, live)
  except errors.HypervisorError, err:
    msg = "Failed to migrate instance: %s" % str(err)
781
    logging.error(msg)
782 783 784 785
    return (False, msg)
  return (True, "Migration successfull")


786
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
787 788 789
  """Creates a block device for an instance.

  Args:
790 791 792
   disk: a ganeti.objects.Disk object
   size: the size of the physical underlying device
   owner: a string with the name of the instance
Manuel Franceschini's avatar
Manuel Franceschini committed
793 794
   on_primary: a boolean indicating if it is the primary node or not
   info: string that will be sent to the physical device creation
Iustin Pop's avatar
Iustin Pop committed
795 796 797 798 799 800 801 802 803 804

  Returns:
    the new unique_id of the device (this can sometime be
    computed only after creation), or None. On secondary nodes,
    it's not required to return anything.

  """
  clist = []
  if disk.children:
    for child in disk.children:
805
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
806 807 808 809 810 811 812 813
      if on_primary or disk.AssembleOnSecondary():
        # we need the children open in case the device itself has to
        # be assembled
        crdev.Open()
      clist.append(crdev)
  try:
    device = bdev.FindDevice(disk.dev_type, disk.physical_id, clist)
    if device is not None:
814
      logging.info("removing existing device %s", disk)
Iustin Pop's avatar
Iustin Pop committed
815 816 817 818 819 820 821 822 823 824
      device.Remove()
  except errors.BlockDeviceError, err:
    pass

  device = bdev.Create(disk.dev_type, disk.physical_id,
                       clist, size)
  if device is None:
    raise ValueError("Can't create child device for %s, %s" %
                     (disk, size))
  if on_primary or disk.AssembleOnSecondary():
825
    if not device.Assemble():
826
      errorstring = "Can't assemble device after creation"
827
      logging.error(errorstring)
828 829
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
830
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
831 832
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
833 834
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
835 836 837

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
  physical_id = device.unique_id
  return physical_id


def RemoveBlockDevice(disk):
  """Remove a block device.

  This is intended to be called recursively.

  """
  try:
    # since we are removing the device, allow a partial match
    # this allows removal of broken mirrors
    rdev = _RecursiveFindBD(disk, allow_partial=True)
  except errors.BlockDeviceError, err:
    # probably can't attach
854
    logging.info("Can't attach to device %s in remove", disk)
Iustin Pop's avatar
Iustin Pop committed
855 856
    rdev = None
  if rdev is not None:
857
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
858
    result = rdev.Remove()
859 860
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
861 862 863 864 865 866 867 868
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


869
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
  """Activate a block device for an instance.

  This is run on the primary and secondary nodes for an instance.

  This function is called recursively.

  Args:
    disk: a objects.Disk object
    as_primary: if we should make the block device read/write

  Returns:
    the assembled device or None (in case no device was assembled)

  If the assembly is not successful, an exception is raised.

  """
  children = []
  if disk.children:
888 889 890 891 892
    mcn = disk.ChildrenNeeded()
    if mcn == -1:
      mcn = 0 # max number of Nones allowed
    else:
      mcn = len(disk.children) - mcn # max number of Nones
Iustin Pop's avatar
Iustin Pop committed
893
    for chld_disk in disk.children:
894 895 896
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
897
        if children.count(None) >= mcn:
898 899
          raise
        cdev = None
900
        logging.debug("Error in child activation: %s", str(err))
901
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
902 903 904

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
905
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
906 907 908
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
909 910 911
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
912 913 914 915 916
  else:
    result = True
  return result


917
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
918 919 920 921 922 923 924 925 926
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

  Returns:
    a /dev path for primary nodes
    True for secondary nodes

  """
927
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
  if isinstance(result, bdev.BlockDev):
    result = result.dev_path
  return result


def ShutdownBlockDevice(disk):
  """Shut down a block device.

  First, if the device is assembled (can `Attach()`), then the device
  is shutdown. Then the children of the device are shutdown.

  This function is called recursively. Note that we don't cache the
  children or such, as oppossed to assemble, shutdown of different
  devices doesn't require that the upper device was active.

  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is not None:
946
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
947
    result = r_dev.Shutdown()
948 949
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
950 951 952 953 954 955 956 957
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


958 959
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
960 961

  """
962 963
  parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
  if parent_bdev is None:
964
    logging.error("Can't find parent device")
Iustin Pop's avatar
Iustin Pop committed
965
    return False
966 967
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
968 969
    logging.error("Can't find new device(s) to add: %s:%s",
                  new_bdevs, new_cdevs)
Iustin Pop's avatar
Iustin Pop committed
970
    return False
971
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
972 973 974
  return True


975 976
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
977 978

  """
979 980
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
981
    logging.error("Can't find parent in remove children: %s", parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
982
    return False
983 984 985 986 987 988
  devs = []
  for disk in new_cdevs:
    rpath = disk.StaticDevPath()
    if rpath is None:
      bd = _RecursiveFindBD(disk)
      if bd is None:
989 990
        logging.error("Can't find dynamic device %s while removing children",
                      disk)
991 992 993 994 995 996
        return False
      else:
        devs.append(bd.dev_path)
    else:
      devs.append(rpath)
  parent_bdev.RemoveChildren(devs)
Iustin Pop's avatar
Iustin Pop committed
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  return True


def GetMirrorStatus(disks):
  """Get the mirroring status of a list of devices.

  Args:
    disks: list of `objects.Disk`

  Returns:
    list of (mirror_done, estimated_time) tuples, which
    are the result of bdev.BlockDevice.CombinedSyncStatus()

  """
  stats = []
  for dsk in disks:
    rbd = _RecursiveFindBD(dsk)
    if rbd is None:
1015
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
    stats.append(rbd.CombinedSyncStatus())
  return stats


def _RecursiveFindBD(disk, allow_partial=False):
  """Check if a device is activated.

  If so, return informations about the real device.

  Args:
    disk: the objects.Disk instance
    allow_partial: don't abort the find if a child of the
                   device can't be found; this is intended to be
                   used when repairing mirrors

  Returns:
    None if the device can't be found
    otherwise the device instance

  """
  children = []
  if disk.children:
    for chdisk in disk.children:
      children.append(_RecursiveFindBD(chdisk))

  return bdev.FindDevice(disk.dev_type, disk.physical_id, children)


def FindBlockDevice(disk):
  """Check if a device is activated.

  If so, return informations about the real device.

  Args:
    disk: the objects.Disk instance
  Returns:
    None if the device can't be found
    (device_path, major, minor, sync_percent, estimated_time, is_degraded)

  """
  rbd = _RecursiveFindBD(disk)
  if rbd is None:
    return rbd
1059
  return (rbd.dev_path, rbd.major, rbd.minor) + rbd.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069


def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
  """Write a file to the filesystem.

  This allows the master to overwrite(!) a file. It will only perform
  the operation if the file belongs to a list of configuration files.

  """
  if not os.path.isabs(file_name):
1070 1071
    logging.error("Filename passed to UploadFile is not absolute: '%s'",
                  file_name)
Iustin Pop's avatar
Iustin Pop committed
1072 1073
    return False

1074 1075 1076 1077
  allowed_files = [
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
1078
    constants.VNC_PASSWORD_FILE,
1079
    ]
1080

1081
  if file_name not in allowed_files:
1082 1083
    logging.error("Filename passed to UploadFile not in allowed"
                 " upload targets: '%s'", file_name)
Iustin Pop's avatar
Iustin Pop committed
1084 1085
    return False

1086 1087
  utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
                  atime=atime, mtime=mtime)
Iustin Pop's avatar
Iustin Pop committed
1088 1089
  return True

1090

Iustin Pop's avatar
Iustin Pop committed
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
def _ErrnoOrStr(err):
  """Format an EnvironmentError exception.

  If the `err` argument has an errno attribute, it will be looked up
  and converted into a textual EXXXX description. Otherwise the string
  representation of the error will be returned.

  """
  if hasattr(err, 'errno'):
    detail = errno.errorcode[err.errno]
  else:
    detail = str(err)
  return detail

Iustin Pop's avatar
Iustin Pop committed
1105

1106
def _OSOndiskVersion(name, os_dir):
Alexander Schreiber's avatar
Alexander Schreiber committed
1107
  """Compute and return the API version of a given OS.
Iustin Pop's avatar
Iustin Pop committed
1108

Alexander Schreiber's avatar
Alexander Schreiber committed
1109
  This function will try to read the API version of the os given by
1110 1111 1112 1113
  the 'name' parameter and residing in the 'os_dir' directory.

  Return value will be either an integer denoting the version or None in the
  case when this is not a valid OS name.
Iustin Pop's avatar
Iustin Pop committed
1114 1115 1116 1117 1118 1119 1120

  """
  api_file = os.path.sep.join([os_dir, "ganeti_api_version"])

  try:
    st = os.stat(api_file)
  except EnvironmentError, err:
1121
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file not"
1122
                           " found (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1123 1124

  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1125
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file is not"
1126
                           " a regular file")
Iustin Pop's avatar
Iustin Pop committed
1127 1128 1129 1130 1131 1132 1133 1134

  try:
    f = open(api_file)
    try:
      api_version = f.read(256)
    finally:
      f.close()
  except EnvironmentError, err:
1135
    raise errors.InvalidOS(name, os_dir, "error while reading the"
1136
                           " API version (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1137 1138 1139 1140 1141

  api_version = api_version.strip()
  try:
    api_version = int(api_version)
  except (TypeError, ValueError), err:
1142 1143
    raise errors.InvalidOS(name, os_dir,
                           "API version is not integer (%s)" % str(err))
Iustin Pop's avatar
Iustin Pop committed
1144 1145 1146

  return api_version

1147

1148
def DiagnoseOS(top_dirs=None):
Iustin Pop's avatar
Iustin Pop committed
1149 1150
  """Compute the validity for all OSes.

1151 1152
  Returns an OS object for each name in all the given top directories
  (if not given defaults to constants.OS_SEARCH_PATH)
Iustin Pop's avatar
Iustin Pop committed