backend.py 94.1 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
#

# 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.


22
23
24
25
"""Functions used by the node daemon

@var _ALLOWED_UPLOAD_FILES: denotes which files are accepted in
     the L{UploadFile} function
26
27
@var _ALLOWED_CLEAN_DIRS: denotes which directories are accepted
     in the L{_CleanDirectory} function
28
29

"""
Iustin Pop's avatar
Iustin Pop committed
30

Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35
36
# pylint: disable-msg=E1103

# E1103: %s %r has no %r member (but some types could not be
# inferred), because the _TryOSFromDisk returns either (True, os_obj)
# or (False, "string") which confuses pylint

Iustin Pop's avatar
Iustin Pop committed
37
38
39
40
41
42
43
44

import os
import os.path
import shutil
import time
import stat
import errno
import re
45
import random
46
import logging
47
import tempfile
48
49
import zlib
import base64
50
import signal
Iustin Pop's avatar
Iustin Pop committed
51
52
53
54
55
56
57
58

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
59
from ganeti import ssconf
60
from ganeti import serializer
Iustin Pop's avatar
Iustin Pop committed
61
62


63
_BOOT_ID_PATH = "/proc/sys/kernel/random/boot_id"
64
65
66
67
_ALLOWED_CLEAN_DIRS = frozenset([
  constants.DATA_DIR,
  constants.JOB_QUEUE_ARCHIVE_DIR,
  constants.QUEUE_DIR,
68
  constants.CRYPTO_KEYS_DIR,
69
  ])
70
71
72
_MAX_SSL_CERT_VALIDITY = 7 * 24 * 60 * 60
_X509_KEY_FILE = "key"
_X509_CERT_FILE = "cert"
73
74
75
_IES_STATUS_FILE = "status"
_IES_PID_FILE = "pid"
_IES_CA_FILE = "ca"
76
77


78
79
80
81
82
83
84
class RPCFail(Exception):
  """Class denoting RPC failure.

  Its argument is the error message.

  """

85

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
101
102
103
104
105
  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)
106
107
108
  raise RPCFail(msg)


Michael Hanselmann's avatar
Michael Hanselmann committed
109
def _GetConfig():
Iustin Pop's avatar
Iustin Pop committed
110
  """Simple wrapper to return a SimpleStore.
Iustin Pop's avatar
Iustin Pop committed
111

Iustin Pop's avatar
Iustin Pop committed
112
113
  @rtype: L{ssconf.SimpleStore}
  @return: a SimpleStore instance
Iustin Pop's avatar
Iustin Pop committed
114
115

  """
Iustin Pop's avatar
Iustin Pop committed
116
  return ssconf.SimpleStore()
Michael Hanselmann's avatar
Michael Hanselmann committed
117
118


119
def _GetSshRunner(cluster_name):
Iustin Pop's avatar
Iustin Pop committed
120
121
122
123
124
125
126
127
128
  """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

  """
129
  return ssh.SshRunner(cluster_name)
130
131


132
133
134
135
136
137
138
139
140
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

  """
141
  assert isinstance(data, (list, tuple))
142
143
144
145
146
147
148
149
150
151
  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")


152
def _CleanDirectory(path, exclude=None):
153
154
  """Removes all regular files in a directory.

Iustin Pop's avatar
Iustin Pop committed
155
156
  @type path: str
  @param path: the directory to clean
157
  @type exclude: list
Iustin Pop's avatar
Iustin Pop committed
158
159
  @param exclude: list of files to be excluded, defaults
      to the empty list
160
161

  """
162
163
164
165
  if path not in _ALLOWED_CLEAN_DIRS:
    _Fail("Path passed to _CleanDirectory not in allowed clean targets: '%s'",
          path)

166
167
  if not os.path.isdir(path):
    return
168
169
170
171
172
  if exclude is None:
    exclude = []
  else:
    # Normalize excluded paths
    exclude = [os.path.normpath(i) for i in exclude]
173

174
  for rel_name in utils.ListVisibleFiles(path):
175
    full_name = utils.PathJoin(path, rel_name)
176
177
    if full_name in exclude:
      continue
178
179
180
181
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


182
183
184
185
186
187
def _BuildUploadFileList():
  """Build the list of allowed upload files.

  This is abstracted so that it's built only once at module import time.

  """
188
189
190
191
192
193
194
  allowed_files = set([
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
    constants.VNC_PASSWORD_FILE,
    constants.RAPI_CERT_FILE,
    constants.RAPI_USERS_FILE,
195
    constants.CONFD_HMAC_KEY,
196
197
198
    ])

  for hv_name in constants.HYPER_TYPES:
199
    hv_class = hypervisor.GetHypervisorClass(hv_name)
200
201
202
    allowed_files.update(hv_class.GetAncillaryFiles())

  return frozenset(allowed_files)
203
204
205
206
207


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


208
def JobQueuePurge():
Iustin Pop's avatar
Iustin Pop committed
209
210
  """Removes job queue files and archived jobs.

211
212
  @rtype: tuple
  @return: True, None
213
214

  """
215
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
216
217
218
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


219
220
221
222
223
224
225
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
226
  @return: master_netdev, master_ip, master_name
227
  @raise RPCFail: in case of errors
228
229
230

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
231
232
233
234
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
235
  except errors.ConfigurationError, err:
Iustin Pop's avatar
Iustin Pop committed
236
    _Fail("Cluster configuration incomplete: %s", err, exc=True)
237
  return (master_netdev, master_ip, master_node)
238
239


240
def StartMaster(start_daemons, no_voting):
Iustin Pop's avatar
Iustin Pop committed
241
242
  """Activate local node as master node.

243
  The function will always try activate the IP address of the master
Iustin Pop's avatar
Iustin Pop committed
244
245
246
247
  (unless someone else has it). It will also start the master daemons,
  based on the start_daemons parameter.

  @type start_daemons: boolean
248
  @param start_daemons: whether to also start the master
Iustin Pop's avatar
Iustin Pop committed
249
      daemons (ganeti-masterd and ganeti-rapi)
250
251
252
  @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
253
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
254
255

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

259
  err_msgs = []
260
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
261
    if utils.OwnIpAddress(master_ip):
262
      # we already have the ip:
263
      logging.debug("Master IP already configured, doing nothing")
264
    else:
265
266
      msg = "Someone else has the master ip, not activating"
      logging.error(msg)
267
      err_msgs.append(msg)
268
269
270
271
272
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
273
274
      msg = "Can't activate master IP: %s" % result.output
      logging.error(msg)
275
      err_msgs.append(msg)
276
277
278
279
280
281
282

    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:
283
    if no_voting:
284
285
286
287
288
289
290
291
292
293
294
295
296
      masterd_args = "--no-voting --yes-do-it"
    else:
      masterd_args = ""

    env = {
      "EXTRA_MASTERD_ARGS": masterd_args,
      }

    result = utils.RunCmd([constants.DAEMON_UTIL, "start-master"], env=env)
    if result.failed:
      msg = "Can't start Ganeti master: %s" % result.output
      logging.error(msg)
      err_msgs.append(msg)
297

298
299
  if err_msgs:
    _Fail("; ".join(err_msgs))
300

Iustin Pop's avatar
Iustin Pop committed
301

302
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
303
304
  """Deactivate this node as master.

305
  The function will always try to deactivate the IP address of the
Iustin Pop's avatar
Iustin Pop committed
306
307
308
309
310
311
312
  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
313
314

  """
315
316
  # TODO: log and report back to the caller the error failures; we
  # need to decide in which case we fail the RPC for this
317
318

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

321
322
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
323
  if result.failed:
324
    logging.error("Can't remove the master IP, error: %s", result.output)
325
326
327
    # but otherwise ignore the failure

  if stop_daemons:
328
329
330
331
332
    result = utils.RunCmd([constants.DAEMON_UTIL, "stop-master"])
    if result.failed:
      logging.error("Could not stop Ganeti master, command %s had exitcode %s"
                    " and error %s",
                    result.cmd, result.exit_code, result.output)
Iustin Pop's avatar
Iustin Pop committed
333
334


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

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

Iustin Pop's avatar
Iustin Pop committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
  @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

358
  """
359
360
361
362
  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)]
363
  for name, content, mode in sshd_keys:
364
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
365

366
367
368
369
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
370
    _Fail("Error while processing user ssh files: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
371

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

375
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
376

377
378
379
380
  result = utils.RunCmd([constants.DAEMON_UTIL, "reload-ssh-keys"])
  if result.failed:
    _Fail("Unable to reload SSH keys (command %r, exit code %s, output %r)",
          result.cmd, result.exit_code, result.output)
Iustin Pop's avatar
Iustin Pop committed
381
382


383
def LeaveCluster(modify_ssh_setup):
Iustin Pop's avatar
Iustin Pop committed
384
385
386
387
388
389
  """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
390
  L{errors.QuitGanetiException} which is used as a special case to
Iustin Pop's avatar
Iustin Pop committed
391
  shutdown the node daemon.
Iustin Pop's avatar
Iustin Pop committed
392

393
394
  @param modify_ssh_setup: boolean

Iustin Pop's avatar
Iustin Pop committed
395
  """
396
  _CleanDirectory(constants.DATA_DIR)
397
  _CleanDirectory(constants.CRYPTO_KEYS_DIR)
398
  JobQueuePurge()
399

400
401
402
  if modify_ssh_setup:
    try:
      priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
403

404
      utils.RemoveAuthorizedKey(auth_keys, utils.ReadFile(pub_key))
Iustin Pop's avatar
Iustin Pop committed
405

406
407
408
409
      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
410

411
  try:
412
    utils.RemoveFile(constants.CONFD_HMAC_KEY)
413
    utils.RemoveFile(constants.RAPI_CERT_FILE)
414
    utils.RemoveFile(constants.NODED_CERT_FILE)
Iustin Pop's avatar
Iustin Pop committed
415
  except: # pylint: disable-msg=W0702
416
417
    logging.exception("Error while removing cluster secrets")

418
419
420
421
  result = utils.RunCmd([constants.DAEMON_UTIL, "stop", constants.CONFD])
  if result.failed:
    logging.error("Command %s failed with exitcode %s and error %s",
                  result.cmd, result.exit_code, result.output)
422

423
424
  # Raise a custom exception (handled in ganeti-noded)
  raise errors.QuitGanetiException(True, 'Shutdown scheduled')
425

Iustin Pop's avatar
Iustin Pop committed
426

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

430
431
432
433
434
435
436
437
438
439
440
441
  @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
442

443
  """
Iustin Pop's avatar
Iustin Pop committed
444
445
446
447
448
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

449
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
450
451
452
453
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

454
  outputarray["bootid"] = utils.ReadFile(_BOOT_ID_PATH, size=128).rstrip("\n")
455

456
  return outputarray
Iustin Pop's avatar
Iustin Pop committed
457
458


459
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
460
461
  """Verify the status of the local node.

462
463
464
465
466
467
468
469
470
  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
471

472
473
474
475
476
477
478
479
480
481
482
  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
483
484
485
  @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
486
487
488

  """
  result = {}
489
490
  my_name = utils.HostInfo().name
  port = utils.GetDaemonPort(constants.NODED)
Iustin Pop's avatar
Iustin Pop committed
491

492
493
494
  if constants.NV_HYPERVISOR in what:
    result[constants.NV_HYPERVISOR] = tmp = {}
    for hv_name in what[constants.NV_HYPERVISOR]:
495
496
497
498
499
      try:
        val = hypervisor.GetHypervisor(hv_name).Verify()
      except errors.HypervisorError, err:
        val = "Error while checking hypervisor: %s" % str(err)
      tmp[hv_name] = val
500
501
502
503
504
505
506
507
508

  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]:
509
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
510
      if not success:
511
512
513
514
        tmp[node] = message

  if constants.NV_NODENETTEST in what:
    result[constants.NV_NODENETTEST] = tmp = {}
515
    my_pip = my_sip = None
516
    for name, pip, sip in what[constants.NV_NODENETTEST]:
517
518
519
520
521
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
522
523
      tmp[my_name] = ("Can't find my own primary/secondary IP"
                      " in the node list")
524
    else:
525
      for name, pip, sip in what[constants.NV_NODENETTEST]:
526
527
528
529
530
531
532
        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:
533
534
535
          tmp[name] = ("failure using the %s interface(s)" %
                       " and ".join(fail))

536
537
538
539
540
541
542
543
544
545
546
  if constants.NV_MASTERIP in what:
    # FIXME: add checks on incoming data structures (here and in the
    # rest of the function)
    master_name, master_ip = what[constants.NV_MASTERIP]
    if master_name == my_name:
      source = constants.LOCALHOST_IP_ADDRESS
    else:
      source = None
    result[constants.NV_MASTERIP] = utils.TcpPing(master_ip, port,
                                                  source=source)

547
  if constants.NV_LVLIST in what:
548
549
550
551
552
    try:
      val = GetVolumeList(what[constants.NV_LVLIST])
    except RPCFail, err:
      val = str(err)
    result[constants.NV_LVLIST] = val
553
554

  if constants.NV_INSTANCELIST in what:
555
556
557
558
559
560
    # GetInstanceList can fail
    try:
      val = GetInstanceList(what[constants.NV_INSTANCELIST])
    except RPCFail, err:
      val = str(err)
    result[constants.NV_INSTANCELIST] = val
561
562

  if constants.NV_VGLIST in what:
563
    result[constants.NV_VGLIST] = utils.ListVolumeGroups()
564

565
566
567
568
569
  if constants.NV_PVLIST in what:
    result[constants.NV_PVLIST] = \
      bdev.LogicalVolume.GetPVInfo(what[constants.NV_PVLIST],
                                   filter_allocatable=False)

570
  if constants.NV_VERSION in what:
571
572
    result[constants.NV_VERSION] = (constants.PROTOCOL_VERSION,
                                    constants.RELEASE_VERSION)
573
574
575
576

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

578
579
580
  if constants.NV_DRBDLIST in what:
    try:
      used_minors = bdev.DRBD8.GetUsedDevs().keys()
581
    except errors.BlockDeviceError, err:
582
      logging.warning("Can't get used minors list", exc_info=True)
583
      used_minors = str(err)
584
585
    result[constants.NV_DRBDLIST] = used_minors

586
587
588
589
590
591
592
593
594
595
596
  if constants.NV_NODESETUP in what:
    result[constants.NV_NODESETUP] = tmpr = []
    if not os.path.isdir("/sys/block") or not os.path.isdir("/sys/class/net"):
      tmpr.append("The sysfs filesytem doesn't seem to be mounted"
                  " under /sys, missing required directories /sys/block"
                  " and /sys/class/net")
    if (not os.path.isdir("/proc/sys") or
        not os.path.isfile("/proc/sysrq-trigger")):
      tmpr.append("The procfs filesystem doesn't seem to be mounted"
                  " under /proc, missing required directory /proc/sys and"
                  " the file /proc/sysrq-trigger")
597
598
599
600

  if constants.NV_TIME in what:
    result[constants.NV_TIME] = utils.SplitTime(time.time())

601
  return result
Iustin Pop's avatar
Iustin Pop committed
602
603
604
605
606


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

Iustin Pop's avatar
Iustin Pop committed
607
608
609
610
611
612
613
614
615
616
617
  @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
618
619

  """
620
621
622
623
624
  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
625
  if result.failed:
626
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
627

628
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
629
  for line in result.stdout.splitlines():
630
631
632
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
633
      logging.error("Invalid line returned from lvs output: '%s'", line)
634
635
      continue
    name, size, attr = match.groups()
636
637
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
Iustin Pop's avatar
Iustin Pop committed
638
639
640
641
642
    virtual = attr[0] == 'v'
    if virtual:
      # we don't want to report such volumes as existing, since they
      # don't really hold data
      continue
643
644
645
    lvs[name] = (size, inactive, online)

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


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

Iustin Pop's avatar
Iustin Pop committed
651
652
653
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
654
655

  """
656
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
657
658


659
660
661
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
  @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.

677
678
679
680
681
  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
682
683
    _Fail("Failed to list logical volumes, lvs output: %s",
          result.output)
684
685

  def parse_dev(dev):
686
687
688
689
    return dev.split('(')[0]

  def handle_dev(dev):
    return [parse_dev(x) for x in dev.split(",")]
690
691

  def map_line(line):
692
693
694
695
696
697
698
699
700
701
702
    line = [v.strip() for v in line]
    return [{'name': line[0], 'size': line[1],
             'dev': dev, 'vg': line[3]} for dev in handle_dev(line[2])]

  all_devs = []
  for line in result.stdout.splitlines():
    if line.count('|') >= 3:
      all_devs.extend(map_line(line.split('|')))
    else:
      logging.warning("Strange line in the output from lvs: '%s'", line)
  return all_devs
703
704


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

Iustin Pop's avatar
Iustin Pop committed
708
709
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
710
711

  """
712
  missing = []
Iustin Pop's avatar
Iustin Pop committed
713
714
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
715
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
716

717
  if missing:
718
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
719

Iustin Pop's avatar
Iustin Pop committed
720

721
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
722
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
723

724
725
726
727
728
  @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
729
730
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
731

732
  """
733
734
735
736
737
738
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
739
740
      _Fail("Error enumerating instances (hypervisor %s): %s",
            hname, err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
741

742
  return results
Iustin Pop's avatar
Iustin Pop committed
743
744


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

748
749
750
751
  @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
752

753
754
755
756
757
  @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
758

759
  """
Iustin Pop's avatar
Iustin Pop committed
760
761
  output = {}

762
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
763
764
765
766
767
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

768
  return output
Iustin Pop's avatar
Iustin Pop committed
769
770


771
772
773
774
775
776
777
778
779
780
781
782
783
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)
784
785
786
  iname = instance.name
  if iname not in hyper.ListInstances():
    _Fail("Instance %s is not running", iname)
787
788

  for idx in range(len(instance.disks)):
789
    link_name = _GetBlockDevSymlinkPath(iname, idx)
790
    if not os.path.islink(link_name):
791
      _Fail("Instance %s was not restarted since ganeti 1.2.5", iname)
792
793


794
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
795
796
  """Gather data about all instances.

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

801
802
803
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

804
  @rtype: dict
805
806
807
808
  @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
809
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
810

811
  """
Iustin Pop's avatar
Iustin Pop committed
812
813
  output = {}

814
815
816
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
Iustin Pop's avatar
Iustin Pop committed
817
      for name, _, memory, vcpus, state, times in iinfo:
818
        value = {
819
820
821
822
823
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
824
825
826
827
828
829
        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]:
830
831
              _Fail("Instance %s is running twice"
                    " with different parameters", name)
832
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
833

834
  return output
Iustin Pop's avatar
Iustin Pop committed
835
836


Iustin Pop's avatar
Iustin Pop committed
837
838
839
840
841
842
843
844
845
846
847
848
849
850
def _InstanceLogName(kind, os_name, instance):
  """Compute the OS log filename for a given instance and operation.

  The instance name and os name are passed in as strings since not all
  operations have these as part of an instance object.

  @type kind: string
  @param kind: the operation type (e.g. add, import, etc.)
  @type os_name: string
  @param os_name: the os name
  @type instance: string
  @param instance: the name of the instance being imported/added/etc.

  """
851
  # TODO: Use tempfile.mkstemp to create unique filename
852
853
  base = ("%s-%s-%s-%s.log" %
          (kind, os_name, instance, utils.TimestampForFilename()))
Iustin Pop's avatar
Iustin Pop committed
854
855
856
  return utils.PathJoin(constants.LOG_OS_DIR, base)


857
def InstanceOsAdd(instance, reinstall, debug):
Alexander Schreiber's avatar
Alexander Schreiber committed
858
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
859

860
861
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
862
863
  @type reinstall: boolean
  @param reinstall: whether this is an instance reinstall
864
865
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
866
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
867
868

  """
869
870
  inst_os = OSFromDisk(instance.os)

871
  create_env = OSEnvironment(instance, inst_os, debug)
872
873
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
874

Iustin Pop's avatar
Iustin Pop committed
875
  logfile = _InstanceLogName("add", instance.os, instance.name)
876

877
878
  result = utils.RunCmd([inst_os.create_script], env=create_env,
                        cwd=inst_os.path, output=logfile,)
879
  if result.failed:
880
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
881
                  " output: %s", result.cmd, result.fail_reason, logfile,
882
                  result.output)
883
    lines = [utils.SafeEncode(val)
884
             for val in utils.TailFile(logfile, lines=20)]
885
886
    _Fail("OS create script failed (%s), last lines in the"
          " log file:\n%s", result.fail_reason, "\n".join(lines), log=False)
887
888


889
def RunRenameInstance(instance, old_name, debug):
890
891
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
892
  @type instance: L{objects.Instance}
893
894
895
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
896
897
  @type debug: integer
  @param debug: debug level, passed to the OS scripts
Iustin Pop's avatar
Iustin Pop committed
898
899
  @rtype: boolean
  @return: the success of the operation
900
901
902
903

  """
  inst_os = OSFromDisk(instance.os)

904
  rename_env = OSEnvironment(instance, inst_os, debug)
905
  rename_env['OLD_INSTANCE_NAME'] = old_name
906

Iustin Pop's avatar
Iustin Pop committed
907
908
  logfile = _InstanceLogName("rename", instance.os,
                             "%s-%s" % (old_name, instance.name))
Iustin Pop's avatar
Iustin Pop committed
909

910
911
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
912
913

  if result.failed:
914
    logging.error("os create command '%s' returned error: %s output: %s",
915
                  result.cmd, result.fail_reason, result.output)
916
    lines = [utils.SafeEncode(val)
917
             for val in utils.TailFile(logfile, lines=20)]
918
919
    _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
920
921
922


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

Iustin Pop's avatar
Iustin Pop committed
925
926
927
928
929
930
931
932
  @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
933

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

Iustin Pop's avatar
Iustin Pop committed
937
  """
938
939
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
940
941
942
943
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
944
    logging.error("volume group %s not present", vg_name)
945
    return retdic
Iustin Pop's avatar
Iustin Pop committed
946
  valarr = retval.stdout.strip().rstrip(':').split(':')
947
948
949
950
951
952
953
  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]),
        }
954
    except (TypeError, ValueError), err:
Iustin Pop's avatar
Iustin Pop committed
955
      logging.exception("Fail to parse vgs output: %s", err)
956
  else:
957
958
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
959
960
961
  return retdic


962
def _GetBlockDevSymlinkPath(instance_name, idx):
963
964
  return utils.PathJoin(constants.DISK_LINKS_DIR,
                        "%s:%d" % (instance_name, idx))
965
966
967


def _SymlinkBlockDev(instance_name, device_path, idx):
968
969
970
971
972
973
  """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).


974
975
976
977
  @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
978
979

  """
980
  link_name = _GetBlockDevSymlinkPath(instance_name, idx)
981
982
  try:
    os.symlink(device_path, link_name)
983
984
  except OSError, err:
    if err.errno == errno.EEXIST:
985
986
987
988
989
990
991
992
993
994
      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


995
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
996
997
998
  """Remove the block device symlinks belonging to the given instance.

  """
Iustin Pop's avatar
Iustin Pop committed
999
  for idx, _ in enumerate(disks):
1000
1001
    link_name = _GetBlockDevSymlinkPath(instance_name, idx)
    if os.path.islink(link_name):
Iustin Pop's avatar
Iustin Pop committed
1002
      try:
1003
1004
1005
        os.remove(link_name)
      except OSError:
        logging.exception("Can't remove symlink '%s'", link_name)
Iustin Pop's avatar
Iustin Pop committed
1006
1007


1008
def _GatherAndLinkBlockDevs(instance):
Iustin Pop's avatar
Iustin Pop committed
1009
1010
1011
1012
1013
  """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
1014
1015
  @type instance: L{objects.Instance}
  @param instance: the instance whose disks we shoul assemble
1016
1017
  @rtype: list
  @return: list of (disk_object, device_path)
Iustin Pop's avatar
Iustin Pop committed
1018

Iustin Pop's avatar
Iustin Pop committed
1019
1020
  """
  block_devices = []
1021
  for idx, disk in enumerate(instance.disks):
Iustin Pop's avatar
Iustin Pop committed
1022
1023
1024
1025
1026
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
1027
    try:
1028
      link_name = _SymlinkBlockDev(instance.name, device.dev_path, idx)
1029
1030
1031
1032
1033
1034
    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
1035
1036
1037
  return block_devices


1038
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
1039
1040
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
1041
  @type instance: L{objects.Instance}
1042
  @param instance: the instance object
1043
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1044

1045
  """
1046
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
1047
1048

  if instance.name in running_instances:
1049
1050
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
1051
1052

  try:
1053
1054
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1055
    hyper.StartInstance(instance, block_devices)
1056
  except errors.BlockDeviceError, err:
1057
    _Fail("Block device error: %s", err, exc=True)
Iustin Pop's avatar
Iustin Pop committed
1058
  except errors.HypervisorError, err:
1059
</