backend.py 59 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
Iustin Pop's avatar
Iustin Pop committed
36
37
38
39
40
41
42
43

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
44
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
45
46


Michael Hanselmann's avatar
Michael Hanselmann committed
47
48
49
50
def _GetConfig():
  return ssconf.SimpleConfigReader()


51
52
def _GetSshRunner(cluster_name):
  return ssh.SshRunner(cluster_name)
53
54


55
56
57
58
59
60
61
def _CleanDirectory(path, exclude=[]):
  """Removes all regular files in a directory.

  @param exclude: List of files to be excluded.
  @type exclude: list

  """
62
63
  if not os.path.isdir(path):
    return
64
65
66
67

  # Normalize excluded paths
  exclude = [os.path.normpath(i) for i in exclude]

68
  for rel_name in utils.ListVisibleFiles(path):
69
70
71
    full_name = os.path.normpath(os.path.join(path, rel_name))
    if full_name in exclude:
      continue
72
73
74
75
    if os.path.isfile(full_name) and not os.path.islink(full_name):
      utils.RemoveFile(full_name)


76
def JobQueuePurge():
77
78
79
  """Removes job queue files and archived jobs

  """
80
  _CleanDirectory(constants.QUEUE_DIR, exclude=[constants.JOB_QUEUE_LOCK_FILE])
81
82
83
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)


84
85
86
87
88
89
90
91
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
  @return: (master_netdev, master_ip, master_name)
92
93
94

  """
  try:
Michael Hanselmann's avatar
Michael Hanselmann committed
95
96
97
98
    cfg = _GetConfig()
    master_netdev = cfg.GetMasterNetdev()
    master_ip = cfg.GetMasterIP()
    master_node = cfg.GetMasterNode()
99
100
101
  except errors.ConfigurationError, err:
    logging.exception("Cluster configuration incomplete")
    return (None, None)
102
  return (master_netdev, master_ip, master_node)
103
104


105
def StartMaster(start_daemons):
Iustin Pop's avatar
Iustin Pop committed
106
107
  """Activate local node as master node.

108
109
110
111
  The function will always try activate the IP address of the master
  (if someone else has it, then it won't). Then, if the start_daemons
  parameter is True, it will also start the master daemons
  (ganet-masterd and ganeti-rapi).
Iustin Pop's avatar
Iustin Pop committed
112
113

  """
114
  ok = True
115
  master_netdev, master_ip, _ = GetMasterInfo()
116
  if not master_netdev:
Iustin Pop's avatar
Iustin Pop committed
117
118
    return False

119
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
120
    if utils.OwnIpAddress(master_ip):
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
      # we already have the ip:
      logging.debug("Already started")
    else:
      logging.error("Someone else has the master ip, not activating")
      ok = False
  else:
    result = utils.RunCmd(["ip", "address", "add", "%s/32" % master_ip,
                           "dev", master_netdev, "label",
                           "%s:0" % master_netdev])
    if result.failed:
      logging.error("Can't activate master IP: %s", result.output)
      ok = False

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

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


148
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
149
150
  """Deactivate this node as master.

151
152
153
  The function will always try to deactivate the IP address of the
  master. Then, if the stop_daemons parameter is True, it will also
  stop the master daemons (ganet-masterd and ganeti-rapi).
Iustin Pop's avatar
Iustin Pop committed
154
155

  """
156
  master_netdev, master_ip, _ = GetMasterInfo()
157
158
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
159

160
161
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
162
  if result.failed:
163
    logging.error("Can't remove the master IP, error: %s", result.output)
164
165
166
167
168
169
    # 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
170
171
172
173

  return True


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

177
178
179
180
  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
181

182
  """
183
184
185
186
  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)]
187
  for name, content, mode in sshd_keys:
188
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
189

190
191
192
193
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
194
    logging.exception("Error while processing user ssh files")
195
    return False
Iustin Pop's avatar
Iustin Pop committed
196

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

200
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
201

202
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
203
204
205
206
207
208
209
210

  return True


def LeaveCluster():
  """Cleans up the current node and prepares it to be removed from the cluster.

  """
211
  _CleanDirectory(constants.DATA_DIR)
212
  JobQueuePurge()
213

214
215
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
216
217
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
218
219
    return

220
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
221
  try:
222
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
223
224
225
  finally:
    f.close()

226
227
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
228

229
230
231
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
232

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

236
237
238
239
240
241
242
243
244
245
246
247
  @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
248

249
  """
Iustin Pop's avatar
Iustin Pop committed
250
251
252
253
254
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

255
  hyper = hypervisor.GetHypervisor(hypervisor_type)
Iustin Pop's avatar
Iustin Pop committed
256
257
258
259
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

260
261
262
263
264
265
  f = open("/proc/sys/kernel/random/boot_id", 'r')
  try:
    outputarray["bootid"] = f.read(128).rstrip("\n")
  finally:
    f.close()

Iustin Pop's avatar
Iustin Pop committed
266
267
268
  return outputarray


269
def VerifyNode(what, cluster_name):
Iustin Pop's avatar
Iustin Pop committed
270
271
  """Verify the status of the local node.

272
273
274
275
276
277
278
279
280
  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
281

282
283
284
285
286
287
288
289
290
291
292
  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
293
294
295
296
297

  """
  result = {}

  if 'hypervisor' in what:
298
299
300
    result['hypervisor'] = my_dict = {}
    for hv_name in what['hypervisor']:
      my_dict[hv_name] = hypervisor.GetHypervisor(hv_name).Verify()
Iustin Pop's avatar
Iustin Pop committed
301
302
303
304
305
306

  if 'filelist' in what:
    result['filelist'] = utils.FingerprintFiles(what['filelist'])

  if 'nodelist' in what:
    result['nodelist'] = {}
307
    random.shuffle(what['nodelist'])
Iustin Pop's avatar
Iustin Pop committed
308
    for node in what['nodelist']:
309
      success, message = _GetSshRunner(cluster_name).VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
310
311
      if not success:
        result['nodelist'][node] = message
312
313
314
315
316
317
318
319
320
321
322
323
324
325
  if 'node-net-test' in what:
    result['node-net-test'] = {}
    my_name = utils.HostInfo().name
    my_pip = my_sip = None
    for name, pip, sip in what['node-net-test']:
      if name == my_name:
        my_pip = pip
        my_sip = sip
        break
    if not my_pip:
      result['node-net-test'][my_name] = ("Can't find my own"
                                          " primary/secondary IP"
                                          " in the node list")
    else:
Michael Hanselmann's avatar
Michael Hanselmann committed
326
      port = utils.GetNodeDaemonPort()
327
328
329
330
331
332
333
334
335
336
337
338
      for name, pip, sip in what['node-net-test']:
        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:
          result['node-net-test'][name] = ("failure using the %s"
                                           " interface(s)" %
                                           " and ".join(fail))

Iustin Pop's avatar
Iustin Pop committed
339
340
341
342
343
344
345
  return result


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

  Returns:
346
347
348
    dictionary of all partions (key) with their size (in MiB), inactive
    and online status:
    {'test1': ('20.06', True, True)}
Iustin Pop's avatar
Iustin Pop committed
349
350

  """
351
352
353
354
355
  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
356
  if result.failed:
357
358
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
359
    return result.output
360

361
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
362
  for line in result.stdout.splitlines():
363
364
365
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
366
      logging.error("Invalid line returned from lvs output: '%s'", line)
367
368
      continue
    name, size, attr = match.groups()
369
370
371
372
373
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
374
375
376


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
377
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
378
379
380
381
382
383
384
385

  Returns:
    Dictionary with keys volume name and values the size of the volume

  """
  return utils.ListVolumeGroups()


386
387
388
389
390
391
392
393
def NodeVolumes():
  """List all volumes on this node.

  """
  result = utils.RunCmd(["lvs", "--noheadings", "--units=m", "--nosuffix",
                         "--separator=|",
                         "--options=lv_name,lv_size,devices,vg_name"])
  if result.failed:
394
395
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
    return {}

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

412
413
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
414
415


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

Iustin Pop's avatar
Iustin Pop committed
419
420
  @rtype: boolean
  @return: C{True} if all of them exist, C{False} otherwise
Iustin Pop's avatar
Iustin Pop committed
421
422
423
424
425
426
427
428
429

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

  return True


430
def GetInstanceList(hypervisor_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
431
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
432

433
434
435
436
437
438
439
  @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
             - instance1.example.com
             - instance2.example.com
Iustin Pop's avatar
Iustin Pop committed
440

441
  """
442
443
444
445
446
447
448
449
450
  results = []
  for hname in hypervisor_list:
    try:
      names = hypervisor.GetHypervisor(hname).ListInstances()
      results.extend(names)
    except errors.HypervisorError, err:
      logging.exception("Error enumerating instances for hypevisor %s", hname)
      # FIXME: should we somehow not propagate this to the master?
      raise
Iustin Pop's avatar
Iustin Pop committed
451

452
  return results
Iustin Pop's avatar
Iustin Pop committed
453
454


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

458
459
460
461
  @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
462

463
464
465
466
467
  @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
468

469
  """
Iustin Pop's avatar
Iustin Pop committed
470
471
  output = {}

472
  iinfo = hypervisor.GetHypervisor(hname).GetInstanceInfo(instance)
Iustin Pop's avatar
Iustin Pop committed
473
474
475
476
477
478
479
480
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


481
def GetAllInstancesInfo(hypervisor_list):
Iustin Pop's avatar
Iustin Pop committed
482
483
484
485
486
487
  """Gather data about all instances.

  This is the equivalent of `GetInstanceInfo()`, except that it
  computes data for all instances at once, thus being faster if one
  needs data about more than one instance.

488
489
490
491
492
493
494
495
496
  @type hypervisor_list: list
  @param hypervisor_list: list of hypervisors to query for instance data

  @rtype: dict of dicts
  @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)
      - vcpuus: the number of vcpus
Iustin Pop's avatar
Iustin Pop committed
497

498
  """
Iustin Pop's avatar
Iustin Pop committed
499
500
  output = {}

501
502
503
504
  for hname in hypervisor_list:
    iinfo = hypervisor.GetHypervisor(hname).GetAllInstancesInfo()
    if iinfo:
      for name, inst_id, memory, vcpus, state, times in iinfo:
505
        value = {
506
507
508
509
510
          'memory': memory,
          'vcpus': vcpus,
          'state': state,
          'time': times,
          }
511
512
513
514
        if name in output and output[name] != value:
          raise errors.HypervisorError("Instance %s running duplicate"
                                       " with different parameters" % name)
        output[name] = value
Iustin Pop's avatar
Iustin Pop committed
515
516
517
518

  return output


519
def AddOSToInstance(instance):
Alexander Schreiber's avatar
Alexander Schreiber committed
520
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
521

522
523
  @type instance: L{objects.Instance}
  @param instance: Instance whose OS is to be installed
Iustin Pop's avatar
Iustin Pop committed
524
525
526
527
528

  """
  inst_os = OSFromDisk(instance.os)

  create_script = inst_os.create_script
529
  create_env = OSEnvironment(instance)
Iustin Pop's avatar
Iustin Pop committed
530
531
532
533
534
535

  logfile = "%s/add-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                     instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

536
537
  command = utils.BuildShellCmd("cd %s && %s &>%s",
                                inst_os.path, create_script, logfile)
538

539
  result = utils.RunCmd(command, env=create_env)
540
  if result.failed:
541
542
543
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
                  " output: %s", command, result.fail_reason, logfile,
                  result.output)
544
545
546
547
548
    return False

  return True


549
def RunRenameInstance(instance, old_name):
550
551
  """Run the OS rename script for an instance.

Iustin Pop's avatar
Iustin Pop committed
552
  @type instance: L{objects.Instance}
553
554
555
  @param instance: Instance whose OS is to be installed
  @type old_name: string
  @param old_name: previous instance name
556
557
558
559
560

  """
  inst_os = OSFromDisk(instance.os)

  script = inst_os.rename_script
561
562
  rename_env = OSEnvironment(instance)
  rename_env['OLD_INSTANCE_NAME'] = old_name
563
564
565
566
567
568
569

  logfile = "%s/rename-%s-%s-%s-%d.log" % (constants.LOG_OS_DIR, instance.os,
                                           old_name,
                                           instance.name, int(time.time()))
  if not os.path.exists(constants.LOG_OS_DIR):
    os.mkdir(constants.LOG_OS_DIR, 0750)

570
571
  command = utils.BuildShellCmd("cd %s && %s &>%s",
                                inst_os.path, script, logfile)
Iustin Pop's avatar
Iustin Pop committed
572

573
  result = utils.RunCmd(command, env=rename_env)
Iustin Pop's avatar
Iustin Pop committed
574
575

  if result.failed:
576
577
    logging.error("os create command '%s' returned error: %s output: %s",
                  command, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
    return False

  return True


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

  Args:
    vg_name: the volume group

  Returns:
    { 'vg_size' : xxx, 'vg_free' : xxx, 'pv_count' : xxx }
    where
    vg_size is the total size of the volume group in MiB
    vg_free is the free size of the volume group in MiB
    pv_count are the number of physical disks in that vg

596
597
598
  If an error occurs during gathering of data, we return the same dict
  with keys all set to None.

Iustin Pop's avatar
Iustin Pop committed
599
  """
600
601
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
602
603
604
605
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

  if retval.failed:
606
    logging.error("volume group %s not present", vg_name)
607
    return retdic
Iustin Pop's avatar
Iustin Pop committed
608
  valarr = retval.stdout.strip().rstrip(':').split(':')
609
610
611
612
613
614
615
616
  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:
617
      logging.exception("Fail to parse vgs output")
618
  else:
619
620
    logging.error("vgs output has the wrong number of fields (expected"
                  " three): %s", str(valarr))
Iustin Pop's avatar
Iustin Pop committed
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
  return retdic


def _GatherBlockDevs(instance):
  """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.

  """
  block_devices = []
  for disk in instance.disks:
    device = _RecursiveFindBD(disk)
    if device is None:
      raise errors.BlockDeviceError("Block device '%s' is not set up." %
                                    str(disk))
    device.Open()
    block_devices.append((disk, device))
  return block_devices


def StartInstance(instance, extra_args):
  """Start an instance.

645
646
647
648
  @type instance: instance object
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
649

650
  """
651
  running_instances = GetInstanceList([instance.hypervisor])
Iustin Pop's avatar
Iustin Pop committed
652
653
654
655
656

  if instance.name in running_instances:
    return True

  block_devices = _GatherBlockDevs(instance)
657
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
Iustin Pop's avatar
Iustin Pop committed
658
659
660
661

  try:
    hyper.StartInstance(instance, block_devices, extra_args)
  except errors.HypervisorError, err:
662
    logging.exception("Failed to start instance")
Iustin Pop's avatar
Iustin Pop committed
663
664
665
666
667
668
669
670
    return False

  return True


def ShutdownInstance(instance):
  """Shut an instance down.

671
672
673
674
  @type instance: instance object
  @param instance: the instance object
  @rtype: boolean
  @return: whether the startup was successful or not
Iustin Pop's avatar
Iustin Pop committed
675

676
  """
677
678
  hv_name = instance.hypervisor
  running_instances = GetInstanceList([hv_name])
Iustin Pop's avatar
Iustin Pop committed
679
680
681
682

  if instance.name not in running_instances:
    return True

683
  hyper = hypervisor.GetHypervisor(hv_name)
Iustin Pop's avatar
Iustin Pop committed
684
685
686
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
687
    logging.error("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
688
689
690
691
692
693
694
    return False

  # test every 10secs for 2min
  shutdown_ok = False

  time.sleep(1)
  for dummy in range(11):
695
    if instance.name not in GetInstanceList([hv_name]):
Iustin Pop's avatar
Iustin Pop committed
696
697
698
699
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
700
    logging.error("shutdown of '%s' unsuccessful, using destroy", instance)
Iustin Pop's avatar
Iustin Pop committed
701
702
703
704

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
705
      logging.exception("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
706
707
708
      return False

    time.sleep(1)
709
    if instance.name in GetInstanceList([hv_name]):
710
711
      logging.error("could not shutdown instance '%s' even by destroy",
                    instance.name)
Iustin Pop's avatar
Iustin Pop committed
712
713
714
715
716
      return False

  return True


717
718
719
720
721
722
723
724
def RebootInstance(instance, reboot_type, extra_args):
  """Reboot an instance.

  Args:
    instance    - name of instance to reboot
    reboot_type - how to reboot [soft,hard,full]

  """
725
  running_instances = GetInstanceList([instance.hypervisor])
726
727

  if instance.name not in running_instances:
728
    logging.error("Cannot reboot instance that is not running")
729
730
    return False

731
  hyper = hypervisor.GetHypervisor(instance.hypervisor)
732
733
734
735
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
736
      logging.exception("Failed to soft reboot instance")
737
738
739
740
741
742
      return False
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
      ShutdownInstance(instance)
      StartInstance(instance, extra_args)
    except errors.HypervisorError, err:
743
      logging.exception("Failed to hard reboot instance")
744
745
746
747
748
749
750
      return False
  else:
    raise errors.ParameterError("reboot_type invalid")

  return True


751
752
753
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

Iustin Pop's avatar
Iustin Pop committed
754
  @type instance: L{objects.Instance}
755
756
757
758
759
760
761
762
763
764
765
  @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

766
  """
767
  hyper = hypervisor.GetHypervisor(instance.hypervisor_name)
768
769

  try:
770
    hyper.MigrateInstance(instance.name, target, live)
771
772
  except errors.HypervisorError, err:
    msg = "Failed to migrate instance: %s" % str(err)
773
    logging.error(msg)
774
775
776
777
    return (False, msg)
  return (True, "Migration successfull")


778
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
779
780
  """Creates a block device for an instance.

Iustin Pop's avatar
Iustin Pop committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
  @type disk: L{objects.Disk}
  @param disk: the object describing the disk we should create
  @type size: int
  @param size: the size of the physical underlying device, in MiB
  @type owner: str
  @param owner: the name of the instance for which disk is created,
      used for device cache data
  @type on_primary: boolean
  @param on_primary:  indicates if it is the primary node or not
  @type info: string
  @param info: string that will be sent to the physical device
      creation, used for example to set (LVM) tags on LVs

  @return: the new unique_id of the device (this can sometime be
      computed only after creation), or None. On secondary nodes,
      it's not required to return anything.
Iustin Pop's avatar
Iustin Pop committed
797
798
799
800
801

  """
  clist = []
  if disk.children:
    for child in disk.children:
802
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
803
804
805
806
807
808
809
810
      if on_primary or disk.AssembleOnSecondary():
        # we need the children open in case the device itself has to
        # be assembled
        crdev.Open()
      clist.append(crdev)
  try:
    device = bdev.FindDevice(disk.dev_type, disk.physical_id, clist)
    if device is not None:
811
      logging.info("removing existing device %s", disk)
Iustin Pop's avatar
Iustin Pop committed
812
813
814
815
816
817
818
819
820
821
      device.Remove()
  except errors.BlockDeviceError, err:
    pass

  device = bdev.Create(disk.dev_type, disk.physical_id,
                       clist, size)
  if device is None:
    raise ValueError("Can't create child device for %s, %s" %
                     (disk, size))
  if on_primary or disk.AssembleOnSecondary():
822
    if not device.Assemble():
823
      errorstring = "Can't assemble device after creation"
824
      logging.error(errorstring)
825
826
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
827
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
828
829
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
830
831
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
832
833
834

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
  physical_id = device.unique_id
  return physical_id


def RemoveBlockDevice(disk):
  """Remove a block device.

  This is intended to be called recursively.

  """
  try:
    # since we are removing the device, allow a partial match
    # this allows removal of broken mirrors
    rdev = _RecursiveFindBD(disk, allow_partial=True)
  except errors.BlockDeviceError, err:
    # probably can't attach
851
    logging.info("Can't attach to device %s in remove", disk)
Iustin Pop's avatar
Iustin Pop committed
852
853
    rdev = None
  if rdev is not None:
854
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
855
    result = rdev.Remove()
856
857
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
858
859
860
861
862
863
864
865
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


866
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
  """Activate a block device for an instance.

  This is run on the primary and secondary nodes for an instance.

  This function is called recursively.

  Args:
    disk: a objects.Disk object
    as_primary: if we should make the block device read/write

  Returns:
    the assembled device or None (in case no device was assembled)

  If the assembly is not successful, an exception is raised.

  """
  children = []
  if disk.children:
885
886
887
888
889
    mcn = disk.ChildrenNeeded()
    if mcn == -1:
      mcn = 0 # max number of Nones allowed
    else:
      mcn = len(disk.children) - mcn # max number of Nones
Iustin Pop's avatar
Iustin Pop committed
890
    for chld_disk in disk.children:
891
892
893
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
894
        if children.count(None) >= mcn:
895
896
          raise
        cdev = None
897
        logging.debug("Error in child activation: %s", str(err))
898
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
899
900
901

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
902
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
903
904
905
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
906
907
908
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
909
910
911
912
913
  else:
    result = True
  return result


914
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
915
916
917
918
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

Iustin Pop's avatar
Iustin Pop committed
919
920
921
  @rtype: str or boolean
  @return: a C{/dev/...} path for primary nodes, and
      C{True} for secondary nodes
Iustin Pop's avatar
Iustin Pop committed
922
923

  """
924
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
  if isinstance(result, bdev.BlockDev):
    result = result.dev_path
  return result


def ShutdownBlockDevice(disk):
  """Shut down a block device.

  First, if the device is assembled (can `Attach()`), then the device
  is shutdown. Then the children of the device are shutdown.

  This function is called recursively. Note that we don't cache the
  children or such, as oppossed to assemble, shutdown of different
  devices doesn't require that the upper device was active.

  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is not None:
943
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
944
    result = r_dev.Shutdown()
945
946
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
947
948
949
950
951
952
953
954
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


955
956
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
957
958

  """
959
960
  parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
  if parent_bdev is None:
961
    logging.error("Can't find parent device")
Iustin Pop's avatar
Iustin Pop committed
962
    return False
963
964
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
965
966
    logging.error("Can't find new device(s) to add: %s:%s",
                  new_bdevs, new_cdevs)
Iustin Pop's avatar
Iustin Pop committed
967
    return False
968
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
969
970
971
  return True


972
973
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
974
975

  """
976
977
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
978
    logging.error("Can't find parent in remove children: %s", parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
979
    return False
980
981
982
983
984
985
  devs = []
  for disk in new_cdevs:
    rpath = disk.StaticDevPath()
    if rpath is None:
      bd = _RecursiveFindBD(disk)
      if bd is None:
986
987
        logging.error("Can't find dynamic device %s while removing children",
                      disk)
988
989
990
991
992
993
        return False
      else:
        devs.append(bd.dev_path)
    else:
      devs.append(rpath)
  parent_bdev.RemoveChildren(devs)
Iustin Pop's avatar
Iustin Pop committed
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
  return True


def GetMirrorStatus(disks):
  """Get the mirroring status of a list of devices.

  Args:
    disks: list of `objects.Disk`

  Returns:
    list of (mirror_done, estimated_time) tuples, which
    are the result of bdev.BlockDevice.CombinedSyncStatus()

  """
  stats = []
  for dsk in disks:
    rbd = _RecursiveFindBD(dsk)
    if rbd is None:
1012
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
    stats.append(rbd.CombinedSyncStatus())
  return stats


def _RecursiveFindBD(disk, allow_partial=False):
  """Check if a device is activated.

  If so, return informations about the real device.

  Args:
    disk: the objects.Disk instance
    allow_partial: don't abort the find if a child of the
                   device can't be found; this is intended to be
                   used when repairing mirrors

  Returns:
    None if the device can't be found
    otherwise the device instance

  """
  children = []
  if disk.children:
    for chdisk in disk.children:
      children.append(_RecursiveFindBD(chdisk))

  return bdev.FindDevice(disk.dev_type, disk.physical_id, children)


def FindBlockDevice(disk):
  """Check if a device is activated.

  If so, return informations about the real device.

  Args:
    disk: the objects.Disk instance
  Returns:
    None if the device can't be found
    (device_path, major, minor, sync_percent, estimated_time, is_degraded)

  """
  rbd = _RecursiveFindBD(disk)
  if rbd is None:
    return rbd
1056
  return (rbd.dev_path, rbd.major, rbd.minor) + rbd.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066


def UploadFile(file_name, data, mode, uid, gid, atime, mtime):
  """Write a file to the filesystem.

  This allows the master to overwrite(!) a file. It will only perform
  the operation if the file belongs to a list of configuration files.

  """
  if not os.path.isabs(file_name):
1067
1068
    logging.error("Filename passed to UploadFile is not absolute: '%s'",
                  file_name)
Iustin Pop's avatar
Iustin Pop committed
1069
1070
    return False

1071
1072
1073
1074
  allowed_files = [
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
1075
    constants.VNC_PASSWORD_FILE,
1076
    ]
1077

1078
  if file_name not in allowed_files:
1079
1080
    logging.error("Filename passed to UploadFile not in allowed"
                 " upload targets: '%s'", file_name)
Iustin Pop's avatar
Iustin Pop committed
1081
1082
    return False

1083
1084
  utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
                  atime=atime, mtime=mtime)
Iustin Pop's avatar
Iustin Pop committed
1085
1086
  return True

1087

Iustin Pop's avatar
Iustin Pop committed
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
def _ErrnoOrStr(err):
  """Format an EnvironmentError exception.

  If the `err` argument has an errno attribute, it will be looked up
  and converted into a textual EXXXX description. Otherwise the string
  representation of the error will be returned.

  """
  if hasattr(err, 'errno'):
    detail = errno.errorcode[err.errno]
  else:
    detail = str(err)
  return detail

Iustin Pop's avatar
Iustin Pop committed
1102

1103
def _OSOndiskVersion(name, os_dir):
Alexander Schreiber's avatar
Alexander Schreiber committed
1104
  """Compute and return the API version of a given OS.
Iustin Pop's avatar
Iustin Pop committed
1105

Alexander Schreiber's avatar
Alexander Schreiber committed
1106
  This function will try to read the API version of the os given by
1107
1108
1109
1110
  the 'name' parameter and residing in the 'os_dir' directory.

  Return value will be either an integer denoting the version or None in the
  case when this is not a valid OS name.
Iustin Pop's avatar
Iustin Pop committed
1111
1112
1113
1114
1115
1116
1117

  """
  api_file = os.path.sep.join([os_dir, "ganeti_api_version"])

  try:
    st = os.stat(api_file)
  except EnvironmentError, err:
1118
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file not"
1119
                           " found (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1120
1121

  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1122
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file is not"
1123
                           " a regular file")
Iustin Pop's avatar
Iustin Pop committed
1124
1125
1126
1127

  try:
    f = open(api_file)
    try:
1128
      api_versions = f.readlines()
Iustin Pop's avatar
Iustin Pop committed
1129
1130
1131
    finally:
      f.close()
  except EnvironmentError, err:
1132
    raise errors.InvalidOS(name, os_dir, "error while reading the"
1133
                           " API version (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1134

1135
  api_versions = [version.strip() for version in api_versions]
Iustin Pop's avatar
Iustin Pop committed
1136
  try:
1137
    api_versions = [int(version) for version in api_versions]
Iustin Pop's avatar
Iustin Pop committed
1138
  except (TypeError, ValueError), err:
1139
1140
    raise errors.InvalidOS(name, os_dir,
                           "API version is not integer (%s)" % str(err))
Iustin Pop's avatar
Iustin Pop committed
1141

1142
  return api_versions
Iustin Pop's avatar
Iustin Pop committed
1143

1144

1145
def DiagnoseOS(top_dirs=None):
Iustin Pop's avatar
Iustin Pop committed
1146
1147
  """Compute the validity for all OSes.

1148
1149
  Returns an OS object for each name in all the given top directories
  (if not given defaults to constants.OS_SEARCH_PATH)
Iustin Pop's avatar
Iustin Pop committed
1150
1151

  Returns:
1152
    list of OS objects
Iustin Pop's avatar
Iustin Pop committed
1153
1154

  """
1155
1156
  if top_dirs is None:
    top_dirs = constants.OS_SEARCH_PATH
Iustin Pop's avatar
Iustin Pop committed
1157
1158

  result = []
Iustin Pop's avatar
Iustin Pop committed
1159
1160
  for dir_name in top_dirs:
    if os.path.isdir(dir_name):
1161
      try:
Iustin Pop's avatar
Iustin Pop committed
1162
        f_names = utils.ListVisibleFiles(dir_name)
1163
      except EnvironmentError, err:
1164
        logging.exception("Can't list the OS directory %s", dir_name)
1165
1166
1167
        break
      for name in f_names:
        try:
Iustin Pop's avatar
Iustin Pop committed
1168
          os_inst = OSFromDisk(name, base_dir=dir_name)
1169
1170
          result.append(os_inst)
        except errors.InvalidOS, err:
1171
          result.append(objects.OS.FromInvalidOS(err))
Iustin Pop's avatar
Iustin Pop committed
1172
1173
1174
1175

  return result


1176
def OSFromDisk(name, base_dir=None):
Iustin Pop's avatar
Iustin Pop committed
1177
1178
1179
1180
1181
1182
1183
  """Create an OS instance from disk.

  This function will return an OS instance if the given name is a
  valid OS name. Otherwise, it will raise an appropriate
  `errors.InvalidOS` exception, detailing why this is not a valid
  OS.

1184
1185
1186
  @type base_dir: string
  @keyword base_dir: Base directory containing OS installations.
                     Defaults to a search in all the OS_SEARCH_PATH dirs.
1187

Iustin Pop's avatar
Iustin Pop committed
1188
  """
1189

1190
  if base_dir is None:
1191
    os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
1192
1193
1194
1195
    if os_dir is None:
      raise errors.InvalidOS(name, None, "OS dir not found in search path")
  else:
    os_dir = os.path.sep.join([base_dir, name])
Iustin Pop's avatar
Iustin Pop committed
1196

1197
  api_versions = _OSOndiskVersion(name, os_dir)
Iustin Pop's avatar
Iustin Pop committed
1198

1199
  if constants.OS_API_VERSION not in api_versions:
1200
1201
    raise errors.InvalidOS(name, os_dir, "API version mismatch"
                           " (found %s want %s)"
1202
                           % (api_versions, constants.OS_API_VERSION))
Iustin Pop's avatar
Iustin Pop committed
1203
1204

  # OS Scripts dictionary, we will populate it with the actual script names
1205
  os_scripts = dict.fromkeys(constants.OS_SCRIPTS)
Iustin Pop's avatar
Iustin Pop committed
1206
1207
1208
1209
1210
1211
1212

  for script in os_scripts:
    os_scripts[script] = os.path.sep.join([os_dir, script])

    try:
      st = os.stat(os_scripts[script])
    except EnvironmentError, err:
1213
      raise errors.InvalidOS(name, os_dir, "'%s' script missing (%s)" %
1214
                             (script, _ErrnoOrStr(err)))