backend.py 81 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
  ok = True
193
  master_netdev, master_ip, _ = GetMasterInfo()
194
  if not master_netdev:
Iustin Pop's avatar
Iustin Pop committed
195
196
    return False

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

    result = utils.RunCmd(["arping", "-q", "-U", "-c 3", "-I", master_netdev,
                           "-s", master_ip, master_ip])
    # we'll ignore the exit code of arping

  # and now start the master and rapi daemons
  if start_daemons:
    for daemon in 'ganeti-masterd', 'ganeti-rapi':
      result = utils.RunCmd([daemon])
      if result.failed:
        logging.error("Can't start daemon %s: %s", daemon, result.output)
        ok = False
  return ok
Iustin Pop's avatar
Iustin Pop committed
224
225


226
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
227
228
  """Deactivate this node as master.

229
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
230
231
232
233
234
235
236
  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
237
238

  """
239
  master_netdev, master_ip, _ = GetMasterInfo()
240
241
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
242

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

  return True


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

260
261
262
263
  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
264

Iustin Pop's avatar
Iustin Pop committed
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
  @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

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

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

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

297
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
298

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

301
  return (True, "Node added successfully")
Iustin Pop's avatar
Iustin Pop committed
302
303
304


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

  """
315
  _CleanDirectory(constants.DATA_DIR)
316
  JobQueuePurge()
317

318
319
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
320
321
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
322
323
    return

324
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
325
  try:
326
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
327
328
329
  finally:
    f.close()

330
331
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
332

333
334
335
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
336

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

340
341
342
343
344
345
346
347
348
349
350
351
  @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
352

353
  """
Iustin Pop's avatar
Iustin Pop committed
354
355
356
357
358
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

359
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
360
361
362
363
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

364
365
366
367
368
369
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

Iustin Pop's avatar
Iustin Pop committed
370
371
372
  return outputarray


373
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
374
375
  """Verify the status of the local node.

376
377
378
379
380
381
382
383
384
  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
385

386
387
388
389
390
391
392
393
394
395
396
  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
397
398
399
  @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
400
401
402
403

  """
  result = {}

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

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

  if constants.NV_VERSION in what:
457
458
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
459
460
461
462

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

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

Iustin Pop's avatar
Iustin Pop committed
472
473
474
475
476
477
  return result


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

Iustin Pop's avatar
Iustin Pop committed
478
479
480
481
482
483
484
485
486
487
488
  @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
489
490

  """
491
492
493
494
495
  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
496
  if result.failed:
497
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
498

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
512
513
514


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

Iustin Pop's avatar
Iustin Pop committed
517
518
519
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
520
521

  """
522
  return True, utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
523
524


525
526
527
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
  @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.

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

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

566
567
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
568
569


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

Iustin Pop's avatar
Iustin Pop committed
573
574
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
575
576
577
578
579
580
581
582
583

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

  return True


584
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
585
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
586

587
588
589
590
591
  @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
592
593
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
594

595
  """
596
597
598
599
600
601
602
603
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
      logging.exception("Error enumerating instances for hypevisor %s", hname)
      raise
Iustin Pop's avatar
Iustin Pop committed
604

605
  return results
Iustin Pop's avatar
Iustin Pop committed
606
607


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

611
612
613
614
  @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
615

616
617
618
619
620
  @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
621

622
  """
Iustin Pop's avatar
Iustin Pop committed
623
624
  output = {}

625
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
626
627
628
629
630
631
632
633
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
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, '')


658
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
659
660
  """Gather data about all instances.

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

665
666
667
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

668
  @rtype: dict
669
670
671
672
  @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
673
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
674

675
  """
Iustin Pop's avatar
Iustin Pop committed
676
677
  output = {}

678
679
680
681
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
      for name, inst_id, memory, vcpus, state, times in iinfo:
682
        value = {
683
684
685
686
687
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
688
689
690
691
692
693
694
695
        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]:
              raise errors.HypervisorError("Instance %s is running twice"
                                           " with different parameters" % name)
696
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
697
698
699
700

  return output


701
def InstanceOsAdd(instance, reinstall):
Alexander Schreiber's avatar
Alexander Schreiber committed
702
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
703

704
705
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
706
707
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
Iustin Pop's avatar
Iustin Pop committed
708
709
  @rtype: boolean
  @return: the success of the operation
Iustin Pop's avatar
Iustin Pop committed
710
711

  """
712
713
714
715
716
717
718
719
720
  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
721

722
  create_env = OSEnvironment(instance)
723
724
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
725
726
727

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

729
730
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
731
  if result.failed:
732
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
733
                  " output: %s", result.cmd, result.fail_reason, logfile,
734
                  result.output)
735
    lines = [utils.SafeEncode(val)
736
737
738
             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)))
739

740
  return (True, "Successfully installed")
741
742


743
def RunRenameInstance(instance, old_name):
744
745
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
746
  @type instance: L{objects.Instance}
747
748
749
  @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
750
751
  @rtype: boolean
  @return: the success of the operation
752
753
754
755

  """
  inst_os = OSFromDisk(instance.os)

756
757
  rename_env = OSEnvironment(instance)
  rename_env['OLD_INSTANCE_NAME'] = old_name
758
759
760
761

  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
762

763
764
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
765
766

  if result.failed:
767
    logging.error("os create command '%s' returned error: %s output: %s",
768
                  result.cmd, result.fail_reason, result.output)
769
    lines = [utils.SafeEncode(val)
770
771
772
             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
773

774
  return (True, "Rename successful")
Iustin Pop's avatar
Iustin Pop committed
775
776
777
778
779


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

Iustin Pop's avatar
Iustin Pop committed
780
781
782
783
784
785
786
787
  @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
788

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

Iustin Pop's avatar
Iustin Pop committed
792
  """
793
794
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
795
796
797
798
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

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


817
818
819
820
821
822
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):
823
824
825
826
827
828
  """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).


829
830
831
832
  @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
833
834

  """
835
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
836
837
  try:
    os.symlink(device_path, link_name)
838
839
  except OSError, err:
    if err.errno == errno.EEXIST:
840
841
842
843
844
845
846
847
848
849
      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


850
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
851
852
853
  """Remove the block device symlinks belonging to the given instance.

  """
854
855
856
  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
857
      try:
858
859
860
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
861
862


863
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
864
865
866
867
868
  """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
869
870
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
871
872
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
873

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


893
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
894
895
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
896
  @type instance: L{objects.Instance}
897
898
899
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
900

901
  """
902
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
903
904

  if instance.name in running_instances:
905
    return (True, "Already running")
Iustin Pop's avatar
Iustin Pop committed
906
907

  try:
908
909
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
910
    hyper.StartInstance(instance, block_devices)
911
  except errors.BlockDeviceError, err:
912
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
913
  except errors.HypervisorError, err:
914
    _RemoveBlockDevLinks(instance.name, instance.disks)
915
    _Fail("Hypervisor error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
916

917
  return (True, "Instance started successfully")
Iustin Pop's avatar
Iustin Pop committed
918
919


920
def InstanceShutdown(instance):
Iustin Pop's avatar
Iustin Pop committed
921
922
  """Shut an instance down.

Iustin Pop's avatar
Iustin Pop committed
923
924
925
  @note: this functions uses polling with a hardcoded timeout.

  @type instance: L{objects.Instance}
926
927
928
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
929

930
  """
931
932
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
Iustin Pop's avatar
Iustin Pop committed
933
934

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

937
  hyper = hypervisor.GetHypervisor(hv_name)
Iustin Pop's avatar
Iustin Pop committed
938
939
940
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
941
    _Fail("Failed to stop instance %s: %s", instance.name, err)
Iustin Pop's avatar
Iustin Pop committed
942
943
944
945
946

  # test every 10secs for 2min

  time.sleep(1)
  for dummy in range(11):
947
    if instance.name not in GetInstanceList([hv_name]):
Iustin Pop's avatar
Iustin Pop committed
948
949
950
951
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
952
953
    logging.error("Shutdown of '%s' unsuccessful, using destroy",
                  instance.name)
Iustin Pop's avatar
Iustin Pop committed
954
955
956
957

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

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

964
  _RemoveBlockDevLinks(instance.name, instance.disks)
Iustin Pop's avatar
Iustin Pop committed
965

966
  return (True, "Instance has been shutdown successfully")
Iustin Pop's avatar
Iustin Pop committed
967
968


969
def InstanceReboot(instance, reboot_type):
970
971
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
972
973
974
975
976
977
978
979
980
981
982
983
984
985
  @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
986
987

  """
988
  running_instances = GetInstanceList([instance.hypervisor])
989
990

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

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

1010
  return (True, "Reboot successful")
1011
1012


1013
1014
1015
1016
1017
1018
1019
def MigrationInfo(instance):
  """Gather information about an instance to be migrated.

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

  """
1020
1021
1022
1023
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    info = hyper.MigrationInfo(instance)
  except errors.HypervisorError, err:
1024
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1025
  return (True, info)
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038


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

  """
1039
1040
1041
1042
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
1043
    _Fail("Failed to accept instance: %s", err, exc=True)
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
  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

  """
1058
1059
1060
1061
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.FinalizeMigration(instance, info, success)
  except errors.HypervisorError, err:
1062
    _Fail("Failed to finalize migration: %s", err, exc=True)
1063
1064
1065
  return (True, "Migration Finalized")


1066
1067
1068
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

Iustin Pop's avatar
Iustin Pop committed
1069
  @type instance: L{objects.Instance}
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
  @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

1081
  """
1082
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
1083
1084

  try:
1085
    hyper.MigrateInstance(instance.name, target, live)
1086
  except errors.HypervisorError, err:
1087
    _Fail("Failed to migrate instance: %s", err, exc=True)
1088
1089
1090
  return (True, "Migration successfull")


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

Iustin Pop's avatar
Iustin Pop committed
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
  @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
1110
1111
1112
1113
1114

  """
  clist = []
  if disk.children:
    for child in disk.children:
1115
1116
1117
      try:
        crdev = _RecursiveAssembleBD(child, owner, on_primary)
      except errors.BlockDeviceError, err:
1118
        _Fail("Can't assemble device %s: %s", child, err)
Iustin Pop's avatar
Iustin Pop committed
1119
1120
1121
      if on_primary or disk.AssembleOnSecondary():
        # we need the children open in case the device itself has to
        # be assembled
1122
1123
1124
        try:
          crdev.Open()
        except errors.BlockDeviceError, err:
1125
          _Fail("Can't make child '%s' read-write: %s", child, err)
Iustin Pop's avatar
Iustin Pop committed
1126
1127
      clist.append(crdev)

1128
1129
  try:
    device = bdev.Create(disk.dev_type, disk.physical_id, clist, size)
1130
  except errors.BlockDeviceError, err:
1131
    _Fail("Can't create block device: %s", err)
Iustin Pop's avatar
Iustin Pop committed
1132

Iustin Pop's avatar
Iustin Pop committed
1133
  if on_primary or disk.AssembleOnSecondary():
1134
1135
1136
    try:
      device.Assemble()
    except errors.BlockDeviceError, err:
1137
      _Fail("Can't assemble device after creation, unusual event: %s", err)
1138
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
1139
    if on_primary or disk.OpenOnSecondary():
1140
1141
1142
      try:
        device.Open(force=True)
      except errors.BlockDeviceError, err: