backend.py 81.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
36
37
import zlib
import base64
Iustin Pop's avatar
Iustin Pop committed
38
39
40
41
42
43
44
45

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


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

def _Fail(msg, *args, **kwargs):
  """Log an error and the raise an RPCFail exception.

  This exception is then handled specially in the ganeti daemon and
  turned into a 'failed' return type. As such, this function is a
  useful shortcut for logging the error and returning it to the master
  daemon.

  @type msg: string
  @param msg: the text of the exception
  @raise RPCFail

  """
  if args:
    msg = msg % args
71
72
73
74
75
  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)
76
77
78
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
79
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
80
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
81

Iustin Pop's avatar
Iustin Pop committed
82
83
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
84
85

  """
Iustin Pop's avatar
Iustin Pop committed
86
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
87
88


89
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
90
91
92
93
94
95
96
97
98
  """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

  """
99
  return ssh.SshRunner(cluster_name)
100
101


102
103
104
105
106
107
108
109
110
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

  """
111
  assert isinstance(data, (list, tuple))
112
113
114
115
116
117
118
119
120
121
  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")


122
def _CleanDirectory(path, exclude=None):
123
124
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
125
126
  @type path: str
  @param path: the directory to clean
127
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
128
129
  @param exclude: list of files to be excluded, defaults
      to the empty list
130
131

  """
132
133
  if not os.path.isdir(path):
    return
134
135
136
137
138
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
139

140
  for rel_name in utils.ListVisibleFiles(path):
141
142
143
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
144
145
146
147
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


148
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
149
150
  """Removes job queue files and archived jobs.

151
152
  @rtype: tuple
  @return: True, None
153
154

  """
155
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
156
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)
157
  return True, None
158
159


160
161
162
163
164
165
166
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
167
168
  @return: True, (master_netdev, master_ip, master_name) in case of success
  @raise RPCFail: in case of errors
169
170
171

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
172
173
174
175
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
176
  except errors.ConfigurationError, err:
177
178
    _Fail("Cluster configuration incomplete", exc=True)
  return True, (master_netdev, master_ip, master_node)
179
180


181
def StartMaster(start_daemons):
Iustin Pop's avatar
Iustin Pop committed
182
183
  """Activate local node as master node.

184
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
185
186
187
188
189
190
191
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
  @param start_daemons: whther to also start the master
      daemons (ganeti-masterd and ganeti-rapi)
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
192
193

  """
194
195
  # GetMasterInfo will raise an exception if not able to return data
  master_netdev, master_ip, _ = GetMasterInfo()[1]
Iustin Pop's avatar
Iustin Pop committed
196

197
  payload = []
198
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
199
    if utils.OwnIpAddress(master_ip):
200
      # we already have the ip:
201
      logging.debug("Master IP already configured, doing nothing")
202
    else:
203
204
205
      msg = "Someone else has the master ip, not activating"
      logging.error(msg)
      payload.append(msg)
206
207
208
209
210
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
211
212
213
      msg = "Can't activate master IP: %s" % result.output
      logging.error(msg)
      payload.append(msg)
214
215
216
217
218
219
220
221
222
223

    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:
224
225
226
227
        msg = "Can't start daemon %s: %s" % (daemon, result.output)
        logging.error(msg)
        payload.append(msg)

228
229
230
231
  if payload:
    _Fail("; ".join(payload))

  return True, None
Iustin Pop's avatar
Iustin Pop committed
232
233


234
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
235
236
  """Deactivate this node as master.

237
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
238
239
240
241
242
243
244
  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
245
246

  """
247
248
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
249
250
251

  # GetMasterInfo will raise an exception if not able to return data
  master_netdev, master_ip, _ = GetMasterInfo()[1]
Iustin Pop's avatar
Iustin Pop committed
252

253
254
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
255
  if result.failed:
256
    logging.error("Can't remove the master IP, error: %s", result.output)
257
258
259
260
261
262
    # 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
263

264
  return True, None
Iustin Pop's avatar
Iustin Pop committed
265
266


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

270
271
272
273
  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
274

Iustin Pop's avatar
Iustin Pop committed
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
  @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

290
  """
291
292
293
294
  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)]
295
  for name, content, mode in sshd_keys:
296
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
297

298
299
300
301
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
302
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
303

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

307
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
308

309
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
310

311
  return (True, "Node added successfully")
Iustin Pop's avatar
Iustin Pop committed
312
313
314


def LeaveCluster():
Iustin Pop's avatar
Iustin Pop committed
315
316
317
318
319
320
  """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
321
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
322
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
323
324

  """
325
  _CleanDirectory(constants.DATA_DIR)
326
  JobQueuePurge()
327

328
329
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
330

331
332
333
334
335
    f = open(pub_key, 'r')
    try:
      utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
    finally:
      f.close()
Iustin Pop's avatar
Iustin Pop committed
336

337
338
339
340
    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
341

342
343
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
344

Iustin Pop's avatar
Iustin Pop committed
345

346
def GetNodeInfo(vgname, hypervisor_type):
Alexander Schreiber's avatar
Alexander Schreiber committed
347
  """Gives back a hash with different informations about the node.
Iustin Pop's avatar
Iustin Pop committed
348

349
350
351
352
353
354
355
356
357
358
359
360
  @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
361

362
  """
Iustin Pop's avatar
Iustin Pop committed
363
364
365
366
367
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

368
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
369
370
371
372
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

373
374
375
376
377
378
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

379
  return True, outputarray
Iustin Pop's avatar
Iustin Pop committed
380
381


382
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
383
384
  """Verify the status of the local node.

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

395
396
397
398
399
400
401
402
403
404
405
  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
406
407
408
  @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
409
410
411
412

  """
  result = {}

413
414
415
416
417
418
419
420
421
422
423
424
425
  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]:
426
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
427
      if not success:
428
429
430
431
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
432
433
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
434
    for name, pip, sip in what[constants.NV_NODENETTEST]:
435
436
437
438
439
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
440
441
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
442
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
443
      port = utils.GetNodeDaemonPort()
444
      for name, pip, sip in what[constants.NV_NODENETTEST]:
445
446
447
448
449
450
451
        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:
452
453
454
455
456
457
458
459
460
461
462
          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:
463
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
464
465

  if constants.NV_VERSION in what:
466
467
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
468
469
470
471

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

473
474
475
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
476
    except errors.BlockDeviceError, err:
477
      logging.warning("Can't get used minors list", exc_info=True)
478
      used_minors = str(err)
479
480
    result[constants.NV_DRBDLIST] = used_minors

481
  return True, result
Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486


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

Iustin Pop's avatar
Iustin Pop committed
487
488
489
490
491
492
493
494
495
496
497
  @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
498
499

  """
500
501
502
503
504
  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
505
  if result.failed:
506
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
507

508
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
509
  for line in result.stdout.splitlines():
510
511
512
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
513
      logging.error("Invalid line returned from lvs output: '%s'", line)
514
515
      continue
    name, size, attr = match.groups()
516
517
518
519
520
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
521
522
523


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

Iustin Pop's avatar
Iustin Pop committed
526
527
528
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
529
530

  """
531
  return True, utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
532
533


534
535
536
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
  @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.

552
553
554
555
556
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
557
558
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573

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

574
575
576
  return True, [map_line(line.split('|'))
                for line in result.stdout.splitlines()
                if line.count('|') >= 3]
577
578


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

Iustin Pop's avatar
Iustin Pop committed
582
583
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
584
585

  """
586
  missing = []
Iustin Pop's avatar
Iustin Pop committed
587
588
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
589
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
590

591
  if missing:
592
    _Fail("Missing bridges %s", ", ".join(missing))
593
594

  return True, None
Iustin Pop's avatar
Iustin Pop committed
595
596


597
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
598
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
599

600
601
602
603
604
  @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
605
606
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
607

608
  """
609
610
611
612
613
614
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
615
616
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
617

618
  return results
Iustin Pop's avatar
Iustin Pop committed
619
620


621
def GetInstanceInfo(instance, hname):
Alexander Schreiber's avatar
Alexander Schreiber committed
622
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
623

624
625
626
627
  @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
628

629
630
631
632
633
  @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
634

635
  """
Iustin Pop's avatar
Iustin Pop committed
636
637
  output = {}

638
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
639
640
641
642
643
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

644
  return True, output
Iustin Pop's avatar
Iustin Pop committed
645
646


647
648
649
650
651
652
653
654
655
656
657
658
659
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)
660
661
662
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
663
664

  for idx in range(len(instance.disks)):
665
    link_name = _GetBlockDevSymlinkPath(iname, idx)
666
    if not os.path.islink(link_name):
667
      _Fail("Instance %s was not restarted since ganeti 1.2.5", iname)
668

669
  return True, None
670
671


672
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
673
674
  """Gather data about all instances.

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

679
680
681
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

682
  @rtype: dict
683
684
685
686
  @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
687
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
688

689
  """
Iustin Pop's avatar
Iustin Pop committed
690
691
  output = {}

692
693
694
695
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
      for name, inst_id, memory, vcpus, state, times in iinfo:
696
        value = {
697
698
699
700
701
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
702
703
704
705
706
707
        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]:
708
709
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
710
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
711

712
  return True, output
Iustin Pop's avatar
Iustin Pop committed
713
714


715
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
716
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
717

718
719
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
720
721
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
Iustin Pop's avatar
Iustin Pop committed
722
723
  @rtype: boolean
  @return: the success of the operation
Iustin Pop's avatar
Iustin Pop committed
724
725

  """
726
727
  inst_os = OSFromDisk(instance.os)

Iustin Pop's avatar
Iustin Pop committed
728

729
  create_env = OSEnvironment(instance)
730
731
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
732
733
734

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

736
737
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
738
  if result.failed:
739
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
740
                  " output: %s", result.cmd, result.fail_reason, logfile,
741
                  result.output)
742
    lines = [utils.SafeEncode(val)
743
             for val in utils.TailFile(logfile, lines=20)]
744
745
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
746

747
  return (True, "Successfully installed")
748
749


750
def RunRenameInstance(instance, old_name):
751
752
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
753
  @type instance: L{objects.Instance}
754
755
756
  @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
757
758
  @rtype: boolean
  @return: the success of the operation
759
760
761
762

  """
  inst_os = OSFromDisk(instance.os)

763
764
  rename_env = OSEnvironment(instance)
  rename_env['OLD_INSTANCE_NAME'] = old_name
765
766
767
768

  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
769

770
771
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
772
773

  if result.failed:
774
    logging.error("os create command '%s' returned error: %s output: %s",
775
                  result.cmd, result.fail_reason, result.output)
776
    lines = [utils.SafeEncode(val)
777
             for val in utils.TailFile(logfile, lines=20)]
778
779
    _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
780

781
  return (True, "Rename successful")
Iustin Pop's avatar
Iustin Pop committed
782
783
784
785
786


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

Iustin Pop's avatar
Iustin Pop committed
787
788
789
790
791
792
793
794
  @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
795

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

Iustin Pop's avatar
Iustin Pop committed
799
  """
800
801
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
802
803
804
805
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
806
    logging.error("volume group %s not present", vg_name)
807
    return retdic
Iustin Pop's avatar
Iustin Pop committed
808
  valarr = retval.stdout.strip().rstrip(':').split(':')
809
810
811
812
813
814
815
816
  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:
817
      logging.exception("Fail to parse vgs output")
818
  else:
819
820
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
821
822
823
  return retdic


824
825
826
827
828
829
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):
830
831
832
833
834
835
  """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).


836
837
838
839
  @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
840
841

  """
842
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
843
844
  try:
    os.symlink(device_path, link_name)
845
846
  except OSError, err:
    if err.errno == errno.EEXIST:
847
848
849
850
851
852
853
854
855
856
      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


857
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
858
859
860
  """Remove the block device symlinks belonging to the given instance.

  """
861
862
863
  for idx, disk in enumerate(disks):
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
864
      try:
865
866
867
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
868
869


870
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
871
872
873
874
875
  """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
876
877
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
878
879
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
880

Iustin Pop's avatar
Iustin Pop committed
881
882
  """
  block_devices = []
883
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
884
885
886
887
888
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
889
    try:
890
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
891
892
893
894
895
896
    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
897
898
899
  return block_devices


900
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
901
902
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
903
  @type instance: L{objects.Instance}
904
905
906
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
907

908
  """
909
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
910
911

  if instance.name in running_instances:
912
    return (True, "Already running")
Iustin Pop's avatar
Iustin Pop committed
913
914

  try:
915
916
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
917
    hyper.StartInstance(instance, block_devices)
918
  except errors.BlockDeviceError, err:
919
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
920
  except errors.HypervisorError, err:
921
    _RemoveBlockDevLinks(instance.name, instance.disks)
922
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
923

924
  return (True, "Instance started successfully")
Iustin Pop's avatar
Iustin Pop committed
925
926


927
def InstanceShutdown(instance):
Iustin Pop's avatar
Iustin Pop committed
928
929
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
930
931
932
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
933
934
935
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
936

937
  """
938
939
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
Iustin Pop's avatar
Iustin Pop committed
940
941

  if instance.name not in running_instances:
942
    return (True, "Instance already stopped")
Iustin Pop's avatar
Iustin Pop committed
943

944
  hyper = hypervisor.GetHypervisor(hv_name)
Iustin Pop's avatar
Iustin Pop committed
945
946
947
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
948
    _Fail("Failed to stop instance %s: %s", instance.name, err)
Iustin Pop's avatar
Iustin Pop committed
949
950
951
952
953

  # test every 10secs for 2min

  time.sleep(1)
  for dummy in range(11):
954
    if instance.name not in GetInstanceList([hv_name]):
Iustin Pop's avatar
Iustin Pop committed
955
956
957
958
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
959
960
    logging.error("Shutdown of '%s' unsuccessful, using destroy",
                  instance.name)
Iustin Pop's avatar
Iustin Pop committed
961
962
963
964

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
965
      _Fail("Failed to force stop instance %s: %s", instance.name, err)
Iustin Pop's avatar
Iustin Pop committed
966
967

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

971
  _RemoveBlockDevLinks(instance.name, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
972

973
  return (True, "Instance has been shutdown successfully")
Iustin Pop's avatar
Iustin Pop committed
974
975


976
def InstanceReboot(instance, reboot_type):
977
978
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
979
980
981
982
983
984
985
986
987
988
989
990
991
992
  @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)
      - the other reboot type (L{constants.INSTANCE_REBOOT_HARD})
        is not accepted here, since that mode is handled
        differently
  @rtype: boolean
  @return: the success of the operation
993
994

  """
995
  running_instances = GetInstanceList([instance.hypervisor])
996
997

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

1000
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1001
1002
1003
1004
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
1005
      _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
1006
1007
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
Iustin Pop's avatar
Iustin Pop committed
1008
1009
1010
      stop_result = InstanceShutdown(instance)
      if not stop_result[0]:
        return stop_result
1011
      return StartInstance(instance)
1012
    except errors.HypervisorError, err:
1013
      _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1014
  else:
1015
    _Fail("Invalid reboot_type received: %s", reboot_type)
1016

1017
  return (True, "Reboot successful")
1018
1019


1020
1021
1022
1023
1024
1025
1026
def MigrationInfo(instance):
  """Gather information about an instance to be migrated.

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

  """
1027
1028
1029
1030
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    info = hyper.MigrationInfo(instance)
  except errors.HypervisorError, err:
1031
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1032
  return (True, info)
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045


def AcceptInstance(instance, info, target):
  """Prepare the node to accept an instance.

  @type instance: L{objects.Instance}
  @param instance: the instance definition
  @type info: string/data (opaque)
  @param info: migration information, from the source node
  @type target: string
  @param target: target host (usually ip), on this node

  """
1046
1047
1048
1049
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
1050
    _Fail("Failed to accept instance: %s", err, exc=True)
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
  return (True, "Accept successfull")


def FinalizeMigration(instance, info, success):
  """Finalize any preparation to accept an instance.

  @type instance: L{objects.Instance}
  @param instance: the instance definition
  @type info: string/data (opaque)
  @param info: migration information, from the source node
  @type success: boolean
  @param success: whether the migration was a success or a failure

  """
1065
1066
1067
1068
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.FinalizeMigration(instance, info, success)
  except errors.HypervisorError, err:
1069
    _Fail("Failed to finalize migration: %s", err, exc=True)
1070
1071
1072
  return (True, "Migration Finalized")


1073
1074
1075
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

Iustin Pop's avatar
Iustin Pop committed
1076
  @type instance: L{objects.Instance}
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
  @param instance: the instance definition
  @type target: string
  @param target: the target node name
  @type live: boolean
  @param live: whether the migration should be done live or not (the
      interpretation of this parameter is left to the hypervisor)
  @rtype: tuple
  @return: a tuple of (success, msg) where:
      - succes is a boolean denoting the success/failure of the operation
      - msg is a string with details in case of failure

1088
  """
1089
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1090
1091

  try: