backend.py 81.4 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
71
72
73
74
75
76
77
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
  if "exc" in kwargs and kwargs["exc"]:
    logging.exception(msg)
  else:
    logging.error(msg)
  raise RPCFail(msg)


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

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

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


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

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


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

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


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

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

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

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


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

  @rtype: None
151
152

  """
153
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
154
155
156
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


157
158
159
160
161
162
163
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
Iustin Pop's avatar
Iustin Pop committed
164
165
  @return: (master_netdev, master_ip, master_name) if we have a good
      configuration, otherwise (None, None, None)
166
167
168

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
169
170
171
172
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
173
174
  except errors.ConfigurationError, err:
    logging.exception("Cluster configuration incomplete")
Iustin Pop's avatar
Iustin Pop committed
175
    return (None, None, None)
176
  return (master_netdev, master_ip, master_node)
177
178


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

182
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
183
184
185
186
187
188
189
  (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
190
191

  """
192
  master_netdev, master_ip, _ = GetMasterInfo()
193
  if not master_netdev:
194
    return False, "Cluster configuration incomplete, cannot read ssconf files"
Iustin Pop's avatar
Iustin Pop committed
195

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

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

  return not payload, "; ".join(payload)
Iustin Pop's avatar
Iustin Pop committed
228
229


230
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
231
232
  """Deactivate this node as master.

233
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
234
235
236
237
238
239
240
  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
241
242

  """
243
  master_netdev, master_ip, _ = GetMasterInfo()
244
245
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
246

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

  return True


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

264
265
266
267
  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
268

Iustin Pop's avatar
Iustin Pop committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
  @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

284
  """
285
286
287
288
  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)]
289
  for name, content, mode in sshd_keys:
290
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
291

292
293
294
295
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
296
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
297

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

301
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
302

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

305
  return (True, "Node added successfully")
Iustin Pop's avatar
Iustin Pop committed
306
307
308


def LeaveCluster():
Iustin Pop's avatar
Iustin Pop committed
309
310
311
312
313
314
  """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
315
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
316
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
317
318

  """
319
  _CleanDirectory(constants.DATA_DIR)
320
  JobQueuePurge()
321

322
323
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
324
325
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
326
327
    return

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

334
335
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
336

337
338
339
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
340

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

344
345
346
347
348
349
350
351
352
353
354
355
  @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
356

357
  """
Iustin Pop's avatar
Iustin Pop committed
358
359
360
361
362
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

363
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
364
365
366
367
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

368
369
370
371
372
373
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

374
  return True, outputarray
Iustin Pop's avatar
Iustin Pop committed
375
376


377
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
378
379
  """Verify the status of the local node.

380
381
382
383
384
385
386
387
388
  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
389

390
391
392
393
394
395
396
397
398
399
400
  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
401
402
403
  @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
404
405
406
407

  """
  result = {}

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

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

  if constants.NV_VERSION in what:
461
462
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
463
464
465
466

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

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

476
  return True, result
Iustin Pop's avatar
Iustin Pop committed
477
478
479
480
481


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

Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486
487
488
489
490
491
492
  @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
493
494

  """
495
496
497
498
499
  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
500
  if result.failed:
501
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
502

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
516
517
518


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

Iustin Pop's avatar
Iustin Pop committed
521
522
523
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
524
525

  """
526
  return True, utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
527
528


529
530
531
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
  @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.

547
548
549
550
551
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
552
553
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
Iustin Pop's avatar
Iustin Pop committed
554
    return []
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569

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

570
571
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
572
573


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

Iustin Pop's avatar
Iustin Pop committed
577
578
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
579
580

  """
581
  missing = []
Iustin Pop's avatar
Iustin Pop committed
582
583
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
584
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
585

586
587
588
589
  if missing:
    return False, "Missing bridges %s" % (", ".join(missing),)

  return True, None
Iustin Pop's avatar
Iustin Pop committed
590
591


592
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
593
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
594

595
596
597
598
599
  @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
600
601
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
602

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

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


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

619
620
621
622
  @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
623

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

630
  """
Iustin Pop's avatar
Iustin Pop committed
631
632
  output = {}

633
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
634
635
636
637
638
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

639
  return True, output
Iustin Pop's avatar
Iustin Pop committed
640
641


642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
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)
  if instance.name not in hyper.ListInstances():
    return (False, 'not running')

  for idx in range(len(instance.disks)):
    link_name = _GetBlockDevSymlinkPath(instance.name, idx)
    if not os.path.islink(link_name):
      return (False, 'not restarted since ganeti 1.2.5')

  return (True, '')


666
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
667
668
  """Gather data about all instances.

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

673
674
675
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

676
  @rtype: dict
677
678
679
680
  @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
681
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
682

683
  """
Iustin Pop's avatar
Iustin Pop committed
684
685
  output = {}

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

706
  return True, output
Iustin Pop's avatar
Iustin Pop committed
707
708


709
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
710
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
711

712
713
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
714
715
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
Iustin Pop's avatar
Iustin Pop committed
716
717
  @rtype: boolean
  @return: the success of the operation
Iustin Pop's avatar
Iustin Pop committed
718
719

  """
720
721
722
723
724
725
726
727
728
  try:
    inst_os = OSFromDisk(instance.os)
  except errors.InvalidOS, err:
    os_name, os_dir, os_err = err.args
    if os_dir is None:
      return (False, "Can't find OS '%s': %s" % (os_name, os_err))
    else:
      return (False, "Error parsing OS '%s' in directory %s: %s" %
              (os_name, os_dir, os_err))
Iustin Pop's avatar
Iustin Pop committed
729

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

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

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

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


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

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

  """
  inst_os = OSFromDisk(instance.os)

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

  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
770

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

  if result.failed:
775
    logging.error("os create command '%s' returned error: %s output: %s",
776
                  result.cmd, result.fail_reason, result.output)
777
    lines = [utils.SafeEncode(val)
778
779
780
             for val in utils.TailFile(logfile, lines=20)]
    return (False, "OS rename script failed (%s), last lines in the"
            " log file:\n%s" % (result.fail_reason, "\n".join(lines)))
Iustin Pop's avatar
Iustin Pop committed
781

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


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

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

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

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

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

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


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


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

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


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

  """
862
863
864
  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
865
      try:
866
867
868
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
869
870


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

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


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

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

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

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

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

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


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

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

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

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

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

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

  # test every 10secs for 2min

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

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

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

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

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


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

Iustin Pop's avatar
Iustin Pop committed
980
981
982
983
984
985
986
987
988
989
990
991
992
993
  @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
994
995

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

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

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

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


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

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

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


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

  """
1047
1048
1049
1050
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
1051
    _Fail("Failed to accept instance: %s", err, exc=True)
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
  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

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


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

Iustin Pop's avatar
Iustin Pop committed
1077
  @type instance: L{objects.Instance}
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
  @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

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

  try:
1093
    hyper.MigrateInstance(instance.name, target, live)
1094
  except errors.HypervisorError, err:
1095
    _Fail("Failed to migrate instance: %s", err, exc=True)
1096
1097
1098
  return (True, "Migration successfull")


1099
def BlockdevCreate(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
1100
1101
  """Creates a block device for an instance.

Iustin Pop's avatar
Iustin Pop committed
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
  @type disk: L{objects.Disk}
  @param disk: the object describing the disk we should create
  @type size: int
  @param size: the size of the physical underlying device, in MiB
  @type owner: str
  @param owner: the name of the instance for which disk is created,
      used for device cache data
  @type on_primary: boolean
  @param on_primary:  indicates if it is the primary node or not
  @type info: string
  @param info: string that will be sent to the physical device
      creation, used for example to set (LVM) tags on LVs

  @return: 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.
Iustin Pop's avatar
Iustin Pop committed
1118
1119