backend.py 98.3 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
    constants.CLUSTER_DOMAIN_SECRET_FILE,
197
198
199
    ])

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

  return frozenset(allowed_files)
204
205
206
207
208


_ALLOWED_UPLOAD_FILES = _BuildUploadFileList()


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

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

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


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

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


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

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

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

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

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

    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:
284
    if no_voting:
285
286
287
288
289
290
291
292
293
294
295
296
297
      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)
298

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

Iustin Pop's avatar
Iustin Pop committed
302

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

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

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

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

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

  if stop_daemons:
329
330
331
332
333
    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
334
335


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

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

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

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

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

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

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

378
379
380
381
  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
382
383


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

394
395
  @param modify_ssh_setup: boolean

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

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

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

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

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

419
420
421
422
  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)
423

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

Iustin Pop's avatar
Iustin Pop committed
427

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

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

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

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

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

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


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

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

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

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

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

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

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

537
538
539
540
541
542
543
544
545
546
547
  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)

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

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

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

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

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

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

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

587
588
589
590
591
592
593
594
595
596
597
  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")
598
599
600
601

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

602
603
604
  if constants.NV_OSLIST in what:
    result[constants.NV_OSLIST] = DiagnoseOS()

605
  return result
Iustin Pop's avatar
Iustin Pop committed
606
607
608
609
610


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

Iustin Pop's avatar
Iustin Pop committed
611
612
613
614
615
616
617
618
619
620
621
  @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
622
623

  """
624
625
626
627
628
  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
629
  if result.failed:
630
    _Fail("Failed to list logical volumes, lvs output: %s", result.output)
631

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

  return lvs
Iustin Pop's avatar
Iustin Pop committed
650
651
652


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

Iustin Pop's avatar
Iustin Pop committed
655
656
657
  @rtype: dict
  @return: dictionary with keys volume name and values the
      size of the volume
Iustin Pop's avatar
Iustin Pop committed
658
659

  """
660
  return utils.ListVolumeGroups()
Iustin Pop's avatar
Iustin Pop committed
661
662


663
664
665
def NodeVolumes():
  """List all volumes on this node.

Iustin Pop's avatar
Iustin Pop committed
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
  @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.

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

  def parse_dev(dev):
690
691
692
693
    return dev.split('(')[0]

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

  def map_line(line):
696
697
698
699
700
701
702
703
704
705
706
    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
707
708


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

Iustin Pop's avatar
Iustin Pop committed
712
713
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
714
715

  """
716
  missing = []
Iustin Pop's avatar
Iustin Pop committed
717
718
  for bridge in bridges_list:
    if not utils.BridgeExists(bridge):
719
      missing.append(bridge)
Iustin Pop's avatar
Iustin Pop committed
720

721
  if missing:
722
    _Fail("Missing bridges %s", utils.CommaJoin(missing))
723

Iustin Pop's avatar
Iustin Pop committed
724

725
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
726
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
727

728
729
730
731
732
  @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
733
734
    - instance1.example.com
    - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
735

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

746
  return results
Iustin Pop's avatar
Iustin Pop committed
747
748


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

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

757
758
759
760
761
  @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
762

763
  """
Iustin Pop's avatar
Iustin Pop committed
764
765
  output = {}

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

772
  return output
Iustin Pop's avatar
Iustin Pop committed
773
774


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

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


798
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
799
800
  """Gather data about all instances.

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

805
806
807
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

808
  @rtype: dict
809
810
811
812
  @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
813
      - vcpus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
814

815
  """
Iustin Pop's avatar
Iustin Pop committed
816
817
  output = {}

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

838
  return output
Iustin Pop's avatar
Iustin Pop committed
839
840


Iustin Pop's avatar
Iustin Pop committed
841
842
843
844
845
846
847
848
849
850
851
852
853
854
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.

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


861
def InstanceOsAdd(instance, reinstall, debug):
Alexander Schreiber's avatar
Alexander Schreiber committed
862
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
863

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

  """
873
874
  inst_os = OSFromDisk(instance.os)

875
  create_env = OSEnvironment(instance, inst_os, debug)
876
877
  if reinstall:
    create_env['INSTANCE_REINSTALL'] = "1"
Iustin Pop's avatar
Iustin Pop committed
878

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

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


893
def RunRenameInstance(instance, old_name, debug):
894
895
  """Run the OS rename script for an instance.

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

  """
  inst_os = OSFromDisk(instance.os)

908
  rename_env = OSEnvironment(instance, inst_os, debug)
909
  rename_env['OLD_INSTANCE_NAME'] = old_name
910

Iustin Pop's avatar
Iustin Pop committed
911
912
  logfile = _InstanceLogName("rename", instance.os,
                             "%s-%s" % (old_name, instance.name))
Iustin Pop's avatar
Iustin Pop committed
913

914
915
  result = utils.RunCmd([inst_os.rename_script], env=rename_env,
                        cwd=inst_os.path, output=logfile)
Iustin Pop's avatar
Iustin Pop committed
916
917

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


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

Iustin Pop's avatar
Iustin Pop committed
929
930
931
932
933
934
935
936
  @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
937

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

Iustin Pop's avatar
Iustin Pop committed
941
  """
942
943
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
944
945
946
947
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

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


966
def _GetBlockDevSymlinkPath(instance_name, idx):
967
968
  return utils.PathJoin(constants.DISK_LINKS_DIR,
                        "%s:%d" % (instance_name, idx))
969
970
971


def _SymlinkBlockDev(instance_name, device_path, idx):
972
973
974
975
976
977
  """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).


978
979
980
981
  @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
982
983

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


999
def _RemoveBlockDevLinks(instance_name, disks):
Iustin Pop's avatar
Iustin Pop committed
1000
1001
1002
  """Remove the block device symlinks belonging to the given instance.

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


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

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


1042
def StartInstance(instance):
Iustin Pop's avatar
Iustin Pop committed
1043
1044
  """Start an instance.

Iustin Pop's avatar
Iustin Pop committed
1045
  @type instance: L{objects.Instance}
1046
  @param instance: the instance object
1047
  @rtype: None
Iustin Pop's avatar
Iustin Pop committed
1048

1049
  """
1050
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
1051
1052

  if instance.name in running_instances:
1053
1054
    logging.info("Instance %s already running, not starting", instance.name)
    return
Iustin Pop's avatar
Iustin Pop committed
1055
1056

  try:
1057
1058
    block_devices = _GatherAndLinkBlockDevs(instance)
    hyper = hypervisor.GetHypervisor(instance.hypervisor)
1059
    hyper.StartInstance(instance, block_devices)
1060
  except errors.BlockDeviceError, err: