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
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
244
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
245
  master_netdev, master_ip, _ = GetMasterInfo()
246
  if not master_netdev:
247
    return False, "Cluster configuration incomplete, cannot read ssconf files"
Iustin Pop's avatar
Iustin Pop committed
248

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

260
  return True, None
Iustin Pop's avatar
Iustin Pop committed
261
262


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

266
267
268
269
  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
270

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

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

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

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

303
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
304

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

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


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

  """
321
  _CleanDirectory(constants.DATA_DIR)
322
  JobQueuePurge()
323

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

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

336
337
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
338

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

Iustin Pop's avatar
Iustin Pop committed
342

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

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

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

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

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

376
  return True, outputarray
Iustin Pop's avatar
Iustin Pop committed
377
378


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

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

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

  """
  result = {}

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

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

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

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

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

478
  return True, result
Iustin Pop's avatar
Iustin Pop committed
479
480
481
482
483


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

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

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

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
518
519
520


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

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

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


531
532
533
def NodeVolumes():
  """List all volumes on this node.

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

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

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

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


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

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

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

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

  return True, None
Iustin Pop's avatar
Iustin Pop committed
592
593


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

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

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

615
  return results
Iustin Pop's avatar
Iustin Pop committed
616
617


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

621
622
623
624
  @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
625

626
627
628
629
630
  @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
631

632
  """
Iustin Pop's avatar
Iustin Pop committed
633
634
  output = {}

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

641
  return True, output
Iustin Pop's avatar
Iustin Pop committed
642
643


644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
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, '')


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

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

675
676
677
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

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

685
  """
Iustin Pop's avatar
Iustin Pop committed
686
687
  output = {}

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

708
  return True, output
Iustin Pop's avatar
Iustin Pop committed
709
710


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

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

  """
722
723
724
725
726
727
728
729
730
  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
731

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

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

739
740
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
741
  if result.failed:
742
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
743
                  " output: %s", result.cmd, result.fail_reason, logfile,
744
                  result.output)
745
    lines = [utils.SafeEncode(val)
746
747
748
             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)))
749

750
  return (True, "Successfully installed")
751
752


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

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

  """
  inst_os = OSFromDisk(instance.os)

766
767
  rename_env = OSEnvironment(instance)
  rename_env['OLD_INSTANCE_NAME'] = old_name
768
769
770
771

  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
772

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

  if result.failed:
777
    logging.error("os create command '%s' returned error: %s output: %s",
778
                  result.cmd, result.fail_reason, result.output)
779
    lines = [utils.SafeEncode(val)
780
781
782
             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
783

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


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

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

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

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

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

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


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


839
840
841
842
  @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
843
844

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


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

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


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

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


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

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

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

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

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

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


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

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

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

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

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

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

  # test every 10secs for 2min

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

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

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

974
  _RemoveBlockDevLinks(instance.name, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
975

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


979
def InstanceReboot(instance, reboot_type):
980
981
  """Reboot an instance.

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

  """
998
  running_instances = GetInstanceList([instance.hypervisor])
999
1000

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

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

1020
  return (True, "Reboot successful")
1021
1022


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

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

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


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

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

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


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

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

1091
  """
1092
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1093
1094

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


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