backend.py 80.2 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


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


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

from ganeti import errors
from ganeti import utils
from ganeti import ssh
from ganeti import hypervisor
from ganeti import constants
from ganeti import bdev
from ganeti import objects
46
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
47
48


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

  Its argument is the error message.

  """

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

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

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

  """
  if args:
    msg = msg % args
71
72
73
74
75
  if "log" not in kwargs or kwargs["log"]: # if we should log this error
    if "exc" in kwargs and kwargs["exc"]:
      logging.exception(msg)
    else:
      logging.error(msg)
76
77
78
  raise RPCFail(msg)


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

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

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


89
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
90
91
92
93
94
95
96
97
98
  """Simple wrapper to return an SshRunner.

  @type cluster_name: str
  @param cluster_name: the cluster name, which is needed
      by the SshRunner constructor
  @rtype: L{ssh.SshRunner}
  @return: an SshRunner instance

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


102
103
104
105
106
107
108
109
110
def _Decompress(data):
  """Unpacks data compressed by the RPC client.

  @type data: list or tuple
  @param data: Data sent by RPC client
  @rtype: str
  @return: Decompressed data

  """
111
  assert isinstance(data, (list, tuple))
112
113
114
115
116
117
118
119
120
121
  assert len(data) == 2
  (encoding, content) = data
  if encoding == constants.RPC_ENCODING_NONE:
    return content
  elif encoding == constants.RPC_ENCODING_ZLIB_BASE64:
    return zlib.decompress(base64.b64decode(content))
  else:
    raise AssertionError("Unknown data encoding")


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

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

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

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


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

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

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


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

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


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

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

  @type start_daemons: boolean
188
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
189
      daemons (ganeti-masterd and ganeti-rapi)
190
191
192
  @type no_voting: boolean
  @param no_voting: whether to start ganeti-masterd without a node vote
      (if start_daemons is True), but still non-interactively
Iustin Pop's avatar
Iustin Pop committed
193
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
194
195

  """
196
  # GetMasterInfo will raise an exception if not able to return data
Guido Trotter's avatar
Guido Trotter committed
197
  master_netdev, master_ip, _ = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
198

199
  err_msgs = []
200
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
201
    if utils.OwnIpAddress(master_ip):
202
      # we already have the ip:
203
      logging.debug("Master IP already configured, doing nothing")
204
    else:
205
206
      msg = "Someone else has the master ip, not activating"
      logging.error(msg)
207
      err_msgs.append(msg)
208
209
210
211
212
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
213
214
      msg = "Can't activate master IP: %s" % result.output
      logging.error(msg)
215
      err_msgs.append(msg)
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:
223
224
225
226
227
228
229
230
231
232
233
    daemons_params = {
        'ganeti-masterd': [],
        'ganeti-rapi': [],
        }
    if no_voting:
      daemons_params['ganeti-masterd'].append('--no-voting')
      daemons_params['ganeti-masterd'].append('--yes-do-it')
    for daemon in daemons_params:
      cmd = [daemon]
      cmd.extend(daemons_params[daemon])
      result = utils.RunCmd(cmd)
234
      if result.failed:
235
236
        msg = "Can't start daemon %s: %s" % (daemon, result.output)
        logging.error(msg)
237
        err_msgs.append(msg)
238

239
240
  if err_msgs:
    _Fail("; ".join(err_msgs))
241

Iustin Pop's avatar
Iustin Pop committed
242

243
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
244
245
  """Deactivate this node as master.

246
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
247
248
249
250
251
252
253
  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
254
255

  """
256
257
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
258
259

  # GetMasterInfo will raise an exception if not able to return data
Guido Trotter's avatar
Guido Trotter committed
260
  master_netdev, master_ip, _ = GetMasterInfo()
Iustin Pop's avatar
Iustin Pop committed
261

262
263
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
264
  if result.failed:
265
    logging.error("Can't remove the master IP, error: %s", result.output)
266
267
268
269
270
271
    # 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
272
273


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

277
278
279
280
  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
281

Iustin Pop's avatar
Iustin Pop committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
  @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

297
  """
298
299
300
301
  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)]
302
  for name, content, mode in sshd_keys:
303
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
304

305
306
307
308
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
309
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
310

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

314
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
315

316
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
317
318
319


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

  """
330
  _CleanDirectory(constants.DATA_DIR)
331
  JobQueuePurge()
332

333
334
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
335

336
337
338
339
340
    f = open(pub_key, 'r')
    try:
      utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
    finally:
      f.close()
Iustin Pop's avatar
Iustin Pop committed
341

342
343
344
345
    utils.RemoveFile(priv_key)
    utils.RemoveFile(pub_key)
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
Iustin Pop's avatar
Iustin Pop committed
346

347
348
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
349

Iustin Pop's avatar
Iustin Pop committed
350

351
def GetNodeInfo(vgname, hypervisor_type):
Michael Hanselmann's avatar
Michael Hanselmann committed
352
  """Gives back a hash with different information about the node.
Iustin Pop's avatar
Iustin Pop committed
353

354
355
356
357
358
359
360
361
362
363
364
365
  @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
366

367
  """
Iustin Pop's avatar
Iustin Pop committed
368
369
370
371
372
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

373
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
374
375
376
377
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

378
379
380
381
382
383
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

384
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
385
386


387
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
388
389
  """Verify the status of the local node.

390
391
392
393
394
395
396
397
398
  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
399

400
401
402
403
404
405
406
407
408
409
410
  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
411
412
413
  @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
414
415
416
417

  """
  result = {}

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

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

  if constants.NV_VERSION in what:
471
472
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
473
474
475
476

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

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

486
  return result
Iustin Pop's avatar
Iustin Pop committed
487
488
489
490
491


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

Iustin Pop's avatar
Iustin Pop committed
492
493
494
495
496
497
498
499
500
501
502
  @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
503
504

  """
505
506
507
508
509
  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
510
  if result.failed:
511
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
512

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
526
527
528


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

Iustin Pop's avatar
Iustin Pop committed
531
532
533
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
534
535

  """
536
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
537
538


539
540
541
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
  @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.

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

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

579
580
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
581
582


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

Iustin Pop's avatar
Iustin Pop committed
586
587
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
588
589

  """
590
  missing = []
Iustin Pop's avatar
Iustin Pop committed
591
592
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
593
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
594

595
  if missing:
596
    _Fail("Missing bridges %s", ", ".join(missing))
597

Iustin Pop's avatar
Iustin Pop committed
598

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

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

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

620
  return results
Iustin Pop's avatar
Iustin Pop committed
621
622


623
def GetInstanceInfo(instance, hname):
Michael Hanselmann's avatar
Michael Hanselmann committed
624
  """Gives back the information about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
625

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

631
632
633
634
635
  @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
636

637
  """
Iustin Pop's avatar
Iustin Pop committed
638
639
  output = {}

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

646
  return output
Iustin Pop's avatar
Iustin Pop committed
647
648


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

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


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

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

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

682
  @rtype: dict
683
684
685
686
  @return: dictionary of instance: data, with data having the following keys:
      - memory: memory size of instance (int)
      - state: xen state of instance (string)
      - time: cpu time of instance (float)
Iustin Pop's avatar
Iustin Pop committed
687
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
688

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

692
693
694
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
695
      for name, _, memory, vcpus, state, times in iinfo:
696
        value = {
697
698
699
700
701
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
702
703
704
705
706
707
        if name in output:
          # we only check static parameters, like memory and vcpus,
          # and not state and time which can change between the
          # invocations of the different hypervisors
          for key in 'memory', 'vcpus':
            if value[key] != output[name][key]:
708
709
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
710
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
711

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


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

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

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

Guido Trotter's avatar
Guido Trotter committed
727
  create_env = OSEnvironment(instance, inst_os)
728
729
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
730
731
732

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

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


746
def RunRenameInstance(instance, old_name):
747
748
  """Run the OS rename script for an instance.

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

  """
  inst_os = OSFromDisk(instance.os)

Guido Trotter's avatar
Guido Trotter committed
759
  rename_env = OSEnvironment(instance, inst_os)
760
  rename_env['OLD_INSTANCE_NAME'] = old_name
761
762
763
764

  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
765

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

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


def _GetVGInfo(vg_name):
Michael Hanselmann's avatar
Michael Hanselmann committed
779
  """Get information about the volume group.
Iustin Pop's avatar
Iustin Pop committed
780

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

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

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

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

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


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


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

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


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

  """
Iustin Pop's avatar
Iustin Pop committed
855
  for idx, _ in enumerate(disks):
856
857
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
858
      try:
859
860
861
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
862
863


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

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


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

Iustin Pop's avatar
Iustin Pop committed
897
  @type instance: L{objects.Instance}
898
  @param instance: the instance object
899
  @rtype: None
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
906
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
907
908

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


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

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

  @type instance: L{objects.Instance}
925
  @param instance: the instance object
926
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
927

928
  """
929
930
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
931
  iname = instance.name
Iustin Pop's avatar
Iustin Pop committed
932

933
934
935
  if iname not in running_instances:
    logging.info("Instance %s not running, doing nothing", iname)
    return
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", iname, err)
Iustin Pop's avatar
Iustin Pop committed
942
943
944
945

  # test every 10secs for 2min

  time.sleep(1)
Michael Hanselmann's avatar
Michael Hanselmann committed
946
  for _ 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
    logging.error("Shutdown of '%s' unsuccessful, using destroy", iname)
Iustin Pop's avatar
Iustin Pop committed
953
954
955
956

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

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

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


966
def InstanceReboot(instance, reboot_type):
967
968
  """Reboot an instance.

Iustin Pop's avatar
Iustin Pop committed
969
970
971
972
973
974
975
976
977
  @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)
978
979
980
981
      - the other reboot type (L{constants.INSTANCE_REBOOT_FULL}) is
        not accepted here, since that mode is handled differently, in
        cmdlib, and translates into full stop and start of the
        instance (instead of a call_instance_reboot RPC)
982
  @rtype: None
983
984

  """
985
  running_instances = GetInstanceList([instance.hypervisor])
986
987

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

990
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
991
992
993
994
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
995
      _Fail("Failed to soft reboot instance %s: %s", instance.name, err)
996
997
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
998
      InstanceShutdown(instance)
999
      return StartInstance(instance)
1000
    except errors.HypervisorError, err:
1001
      _Fail("Failed to hard reboot instance %s: %s", instance.name, err)
1002
  else:
1003
    _Fail("Invalid reboot_type received: %s", reboot_type)
1004
1005


1006
1007
1008
1009
1010
1011
1012
def MigrationInfo(instance):
  """Gather information about an instance to be migrated.

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

  """
1013
1014
1015
1016
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    info = hyper.MigrationInfo(instance)
  except errors.HypervisorError, err:
1017
    _Fail("Failed to fetch migration information: %s", err, exc=True)
1018
  return info
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031


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

  """
1032
1033
1034
1035
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.AcceptInstance(instance, info, target)
  except errors.HypervisorError, err:
1036
    _Fail("Failed to accept instance: %s", err, exc=True)
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049


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

  """
1050
1051
1052
1053
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
  try:
    hyper.FinalizeMigration(instance, info, success)
  except errors.HypervisorError, err:
1054
    _Fail("Failed to finalize migration: %s", err, exc=True)
1055
1056


1057
1058
1059
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

Iustin Pop's avatar
Iustin Pop committed
1060
  @type instance: L{objects.Instance}
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
  @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