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

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


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


import os
import os.path
import shutil
import time
import stat
import errno
import re
import subprocess
33
import random
34
import logging
35
import tempfile
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


47
48
49
50
def _GetSshRunner():
  return ssh.SshRunner()


51
52
53
54
55
56
57
58
59
60
61
62
63
64
def _GetMasterInfo():
  """Return the master ip and netdev.

  """
  try:
    ss = ssconf.SimpleStore()
    master_netdev = ss.GetMasterNetdev()
    master_ip = ss.GetMasterIP()
  except errors.ConfigurationError, err:
    logging.exception("Cluster configuration incomplete")
    return (None, None)
  return (master_netdev, master_ip)


65
def StartMaster(start_daemons):
Iustin Pop's avatar
Iustin Pop committed
66
67
  """Activate local node as master node.

68
69
70
71
  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
72
73

  """
74
75
76
  ok = True
  master_netdev, master_ip = _GetMasterInfo()
  if not master_netdev:
Iustin Pop's avatar
Iustin Pop committed
77
78
    return False

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
  if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT):
    if utils.TcpPing(master_ip, constants.DEFAULT_NODED_PORT,
                     source=constants.LOCALHOST_IP_ADDRESS):
      # 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
107
108


109
def StopMaster(stop_daemons):
Iustin Pop's avatar
Iustin Pop committed
110
111
  """Deactivate this node as master.

112
113
114
  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
115
116

  """
117
118
119
  master_netdev, master_ip = _GetMasterInfo()
  if not master_netdev:
    return False
Iustin Pop's avatar
Iustin Pop committed
120

121
122
  result = utils.RunCmd(["ip", "address", "del", "%s/32" % master_ip,
                         "dev", master_netdev])
Iustin Pop's avatar
Iustin Pop committed
123
  if result.failed:
124
    logging.error("Can't remove the master IP, error: %s", result.output)
125
126
127
128
129
130
    # 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
131
132
133
134

  return True


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

138
139
140
141
  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
142

143
  """
144
145
146
147
  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)]
148
  for name, content, mode in sshd_keys:
149
    utils.WriteFile(name, data=content, mode=mode)
Iustin Pop's avatar
Iustin Pop committed
150

151
152
153
154
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS,
                                                    mkdir=True)
  except errors.OpExecError, err:
155
    logging.exception("Error while processing user ssh files")
156
    return False
Iustin Pop's avatar
Iustin Pop committed
157

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

161
  utils.AddAuthorizedKey(auth_keys, sshpub)
Iustin Pop's avatar
Iustin Pop committed
162

163
  utils.RunCmd([constants.SSH_INITD_SCRIPT, "restart"])
Iustin Pop's avatar
Iustin Pop committed
164
165
166
167
168
169
170
171

  return True


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

  """
172
173
174
175
176
  def _CleanDirectory(path):
    if not os.path.isdir(path):
      return
    for rel_name in utils.ListVisibleFiles(path):
      full_name = os.path.join(path, rel_name)
177
178
      if os.path.isfile(full_name) and not os.path.islink(full_name):
        utils.RemoveFile(full_name)
Iustin Pop's avatar
Iustin Pop committed
179

180
181
182
183
184
185
  _CleanDirectory(constants.DATA_DIR)

  # Remove job queue files and archived jobs
  _CleanDirectory(constants.QUEUE_DIR)
  _CleanDirectory(constants.JOB_QUEUE_ARCHIVE_DIR)

186
187
  try:
    priv_key, pub_key, auth_keys = ssh.GetUserFiles(constants.GANETI_RUNAS)
188
189
  except errors.OpExecError:
    logging.exception("Error while processing ssh files")
190
191
    return

192
  f = open(pub_key, 'r')
Iustin Pop's avatar
Iustin Pop committed
193
  try:
194
    utils.RemoveAuthorizedKey(auth_keys, f.read(8192))
Iustin Pop's avatar
Iustin Pop committed
195
196
197
  finally:
    f.close()

198
199
  utils.RemoveFile(priv_key)
  utils.RemoveFile(pub_key)
Iustin Pop's avatar
Iustin Pop committed
200

201
202
203
  # Return a reassuring string to the caller, and quit
  raise errors.QuitGanetiException(False, 'Shutdown scheduled')

Iustin Pop's avatar
Iustin Pop committed
204
205

def GetNodeInfo(vgname):
Alexander Schreiber's avatar
Alexander Schreiber committed
206
  """Gives back a hash with different informations about the node.
Iustin Pop's avatar
Iustin Pop committed
207
208
209
210
211
212
213
214
215
216
217

  Returns:
    { 'vg_size' : xxx,  'vg_free' : xxx, 'memory_domain0': xxx,
      'memory_free' : xxx, 'memory_total' : xxx }
    where
    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

218
  """
Iustin Pop's avatar
Iustin Pop committed
219
220
221
222
223
224
225
226
227
228
  outputarray = {}
  vginfo = _GetVGInfo(vgname)
  outputarray['vg_size'] = vginfo['vg_size']
  outputarray['vg_free'] = vginfo['vg_free']

  hyper = hypervisor.GetHypervisor()
  hyp_info = hyper.GetNodeInfo()
  if hyp_info is not None:
    outputarray.update(hyp_info)

229
230
231
232
233
234
  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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
  return outputarray


def VerifyNode(what):
  """Verify the status of the local node.

  Args:
    what - a dictionary of things to check:
      'filelist' : list of files for which to compute checksums
      'nodelist' : list of nodes we should check communication with
      'hypervisor': run the hypervisor-specific verify

  Requested files on local node are checksummed and the result returned.

  The nodelist is traversed, with the following checks being made
  for each node:
  - known_hosts key correct
  - correct resolving of node name (target node returns its own hostname
    by ssh-execution of 'hostname', result compared against name in list.

  """
  result = {}

  if 'hypervisor' in what:
    result['hypervisor'] = hypervisor.GetHypervisor().Verify()

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

  if 'nodelist' in what:
    result['nodelist'] = {}
266
    random.shuffle(what['nodelist'])
Iustin Pop's avatar
Iustin Pop committed
267
    for node in what['nodelist']:
268
      success, message = _GetSshRunner().VerifyNodeHostname(node)
Iustin Pop's avatar
Iustin Pop committed
269
270
      if not success:
        result['nodelist'][node] = message
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
  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:
      port = ssconf.SimpleStore().GetNodeDaemonPort()
      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
298
299
300
301
302
303
304
  return result


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

  Returns:
305
306
307
    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
308
309

  """
310
311
312
313
314
  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
315
  if result.failed:
316
317
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
318
    return result.output
319

320
  valid_line_re = re.compile("^ *([^|]+)\|([0-9.]+)\|([^|]{6})\|?$")
321
  for line in result.stdout.splitlines():
322
323
324
    line = line.strip()
    match = valid_line_re.match(line)
    if not match:
325
      logging.error("Invalid line returned from lvs output: '%s'", line)
326
327
      continue
    name, size, attr = match.groups()
328
329
330
331
332
    inactive = attr[4] == '-'
    online = attr[5] == 'o'
    lvs[name] = (size, inactive, online)

  return lvs
Iustin Pop's avatar
Iustin Pop committed
333
334
335


def ListVolumeGroups():
Alexander Schreiber's avatar
Alexander Schreiber committed
336
  """List the volume groups and their size.
Iustin Pop's avatar
Iustin Pop committed
337
338
339
340
341
342
343
344

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

  """
  return utils.ListVolumeGroups()


345
346
347
348
349
350
351
352
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:
353
354
    logging.error("Failed to list logical volumes, lvs output: %s",
                  result.output)
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
    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(),
    }

371
372
  return [map_line(line.split('|')) for line in result.stdout.splitlines()
          if line.count('|') >= 3]
373
374


Iustin Pop's avatar
Iustin Pop committed
375
def BridgesExist(bridges_list):
Alexander Schreiber's avatar
Alexander Schreiber committed
376
  """Check if a list of bridges exist on the current node.
Iustin Pop's avatar
Iustin Pop committed
377
378
379
380
381
382
383
384
385
386
387
388
389

  Returns:
    True if all of them exist, false otherwise

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

  return True


def GetInstanceList():
Alexander Schreiber's avatar
Alexander Schreiber committed
390
  """Provides a list of instances.
Iustin Pop's avatar
Iustin Pop committed
391
392
393
394
395
396

  Returns:
    A list of all running instances on the current node
    - instance1.example.com
    - instance2.example.com

397
  """
Iustin Pop's avatar
Iustin Pop committed
398
399
400
  try:
    names = hypervisor.GetHypervisor().ListInstances()
  except errors.HypervisorError, err:
401
    logging.exception("Error enumerating instances")
Iustin Pop's avatar
Iustin Pop committed
402
403
404
405
406
407
    raise

  return names


def GetInstanceInfo(instance):
Alexander Schreiber's avatar
Alexander Schreiber committed
408
  """Gives back the informations about an instance as a dictionary.
Iustin Pop's avatar
Iustin Pop committed
409
410
411
412
413
414
415
416
417
418
419

  Args:
    instance: name of the instance (ex. instance1.example.com)

  Returns:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)

420
  """
Iustin Pop's avatar
Iustin Pop committed
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
  output = {}

  iinfo = hypervisor.GetHypervisor().GetInstanceInfo(instance)
  if iinfo is not None:
    output['memory'] = iinfo[2]
    output['state'] = iinfo[4]
    output['time'] = iinfo[5]

  return output


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

  Returns: a dictionary of dictionaries, keys being the instance name,
    and with values:
    { 'memory' : 511, 'state' : '-b---', 'time' : 3188.8, }
    where
    memory: memory size of instance (int)
    state: xen state of instance (string)
    time: cpu time of instance (float)
    vcpus: the number of cpus

448
  """
Iustin Pop's avatar
Iustin Pop committed
449
450
451
452
  output = {}

  iinfo = hypervisor.GetHypervisor().GetAllInstancesInfo()
  if iinfo:
453
    for name, inst_id, memory, vcpus, state, times in iinfo:
Iustin Pop's avatar
Iustin Pop committed
454
455
456
457
458
459
460
461
462
463
464
      output[name] = {
        'memory': memory,
        'vcpus': vcpus,
        'state': state,
        'time': times,
        }

  return output


def AddOSToInstance(instance, os_disk, swap_disk):
Alexander Schreiber's avatar
Alexander Schreiber committed
465
  """Add an OS to an instance.
Iustin Pop's avatar
Iustin Pop committed
466
467
468
469
470
471
472
473
474
475
476

  Args:
    instance: the instance object
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
  inst_os = OSFromDisk(instance.os)

  create_script = inst_os.create_script

Iustin Pop's avatar
Iustin Pop committed
477
478
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
479
    logging.error("Can't find this device-visible name '%s'", os_disk)
Iustin Pop's avatar
Iustin Pop committed
480
481
    return False

Iustin Pop's avatar
Iustin Pop committed
482
483
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
484
    logging.error("Can't find this device-visible name '%s'", swap_disk)
Iustin Pop's avatar
Iustin Pop committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  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)

504
  command = utils.BuildShellCmd("cd %s && %s -i %s -b %s -s %s &>%s",
Iustin Pop's avatar
Iustin Pop committed
505
506
507
                                inst_os.path, create_script, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
508
509
510

  result = utils.RunCmd(command)
  if result.failed:
511
512
513
    logging.error("os create command '%s' returned error: %s, logfile: %s,"
                  " output: %s", command, result.fail_reason, logfile,
                  result.output)
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
    return False

  return True


def RunRenameInstance(instance, old_name, os_disk, swap_disk):
  """Run the OS rename script for an instance.

  Args:
    instance: the instance object
    old_name: the old name of the instance
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device

  """
  inst_os = OSFromDisk(instance.os)

  script = inst_os.rename_script

  os_device = instance.FindDisk(os_disk)
  if os_device is None:
535
    logging.error("Can't find this device-visible name '%s'", os_disk)
536
537
538
539
    return False

  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None:
540
    logging.error("Can't find this device-visible name '%s'", swap_disk)
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
    return False

  real_os_dev = _RecursiveFindBD(os_device)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(os_device))
  real_os_dev.Open()

  real_swap_dev = _RecursiveFindBD(swap_device)
  if real_swap_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(swap_device))
  real_swap_dev.Open()

  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)

  command = utils.BuildShellCmd("cd %s && %s -o %s -n %s -b %s -s %s &>%s",
                                inst_os.path, script, old_name, instance.name,
                                real_os_dev.dev_path, real_swap_dev.dev_path,
                                logfile)
Iustin Pop's avatar
Iustin Pop committed
565
566
567
568

  result = utils.RunCmd(command)

  if result.failed:
569
570
    logging.error("os create command '%s' returned error: %s output: %s",
                  command, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
    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

589
590
591
  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
592
  """
593
594
  retdic = dict.fromkeys(["vg_size", "vg_free", "pv_count"])

Iustin Pop's avatar
Iustin Pop committed
595
596
597
598
  retval = utils.RunCmd(["vgs", "-ovg_size,vg_free,pv_count", "--noheadings",
                         "--nosuffix", "--units=m", "--separator=:", vg_name])

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

  Args:
    instance - name of instance to start.

641
  """
Iustin Pop's avatar
Iustin Pop committed
642
643
644
645
646
647
648
649
650
651
652
  running_instances = GetInstanceList()

  if instance.name in running_instances:
    return True

  block_devices = _GatherBlockDevs(instance)
  hyper = hypervisor.GetHypervisor()

  try:
    hyper.StartInstance(instance, block_devices, extra_args)
  except errors.HypervisorError, err:
653
    logging.exception("Failed to start instance")
Iustin Pop's avatar
Iustin Pop committed
654
655
656
657
658
659
660
661
662
663
664
    return False

  return True


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

  Args:
    instance - name of instance to shutdown.

665
  """
Iustin Pop's avatar
Iustin Pop committed
666
667
668
669
670
671
672
673
674
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
    return True

  hyper = hypervisor.GetHypervisor()
  try:
    hyper.StopInstance(instance)
  except errors.HypervisorError, err:
675
    logging.error("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
676
677
678
679
680
681
682
683
684
685
686
687
    return False

  # test every 10secs for 2min
  shutdown_ok = False

  time.sleep(1)
  for dummy in range(11):
    if instance.name not in GetInstanceList():
      break
    time.sleep(10)
  else:
    # the shutdown did not succeed
688
    logging.error("shutdown of '%s' unsuccessful, using destroy", instance)
Iustin Pop's avatar
Iustin Pop committed
689
690
691
692

    try:
      hyper.StopInstance(instance, force=True)
    except errors.HypervisorError, err:
693
      logging.exception("Failed to stop instance")
Iustin Pop's avatar
Iustin Pop committed
694
695
696
697
      return False

    time.sleep(1)
    if instance.name in GetInstanceList():
698
699
      logging.error("could not shutdown instance '%s' even by destroy",
                    instance.name)
Iustin Pop's avatar
Iustin Pop committed
700
701
702
703
704
      return False

  return True


705
706
707
708
709
710
711
712
713
714
715
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]

  """
  running_instances = GetInstanceList()

  if instance.name not in running_instances:
716
    logging.error("Cannot reboot instance that is not running")
717
718
719
720
721
722
723
    return False

  hyper = hypervisor.GetHypervisor()
  if reboot_type == constants.INSTANCE_REBOOT_SOFT:
    try:
      hyper.RebootInstance(instance)
    except errors.HypervisorError, err:
724
      logging.exception("Failed to soft reboot instance")
725
726
727
728
729
730
      return False
  elif reboot_type == constants.INSTANCE_REBOOT_HARD:
    try:
      ShutdownInstance(instance)
      StartInstance(instance, extra_args)
    except errors.HypervisorError, err:
731
      logging.exception("Failed to hard reboot instance")
732
733
734
735
736
737
738
739
      return False
  else:
    raise errors.ParameterError("reboot_type invalid")


  return True


740
741
742
743
744
745
746
747
748
749
def MigrateInstance(instance, target, live):
  """Migrates an instance to another node.

  """
  hyper = hypervisor.GetHypervisor()

  try:
    hyper.MigrateInstance(instance, target, live)
  except errors.HypervisorError, err:
    msg = "Failed to migrate instance: %s" % str(err)
750
    logging.error(msg)
751
752
753
754
    return (False, msg)
  return (True, "Migration successfull")


755
def CreateBlockDevice(disk, size, owner, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
756
757
758
  """Creates a block device for an instance.

  Args:
759
760
761
   disk: a ganeti.objects.Disk object
   size: the size of the physical underlying device
   owner: a string with the name of the instance
Manuel Franceschini's avatar
Manuel Franceschini committed
762
763
   on_primary: a boolean indicating if it is the primary node or not
   info: string that will be sent to the physical device creation
Iustin Pop's avatar
Iustin Pop committed
764
765
766
767
768
769
770
771
772
773

  Returns:
    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.

  """
  clist = []
  if disk.children:
    for child in disk.children:
774
      crdev = _RecursiveAssembleBD(child, owner, on_primary)
Iustin Pop's avatar
Iustin Pop committed
775
776
777
778
779
780
781
782
      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:
783
      logging.info("removing existing device %s", disk)
Iustin Pop's avatar
Iustin Pop committed
784
785
786
787
788
789
790
791
792
793
      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():
794
    if not device.Assemble():
795
      errorstring = "Can't assemble device after creation"
796
      logging.error(errorstring)
797
798
      raise errors.BlockDeviceError("%s, very unusual event - check the node"
                                    " daemon logs" % errorstring)
799
    device.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
800
801
    if on_primary or disk.OpenOnSecondary():
      device.Open(force=True)
802
803
    DevCacheManager.UpdateCache(device.dev_path, owner,
                                on_primary, disk.iv_name)
804
805
806

  device.SetInfo(info)

Iustin Pop's avatar
Iustin Pop committed
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
  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
823
    logging.info("Can't attach to device %s in remove", disk)
Iustin Pop's avatar
Iustin Pop committed
824
825
    rdev = None
  if rdev is not None:
826
    r_path = rdev.dev_path
Iustin Pop's avatar
Iustin Pop committed
827
    result = rdev.Remove()
828
829
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
830
831
832
833
834
835
836
837
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and RemoveBlockDevice(child)
  return result


838
def _RecursiveAssembleBD(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
  """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:
857
858
859
860
861
    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
862
    for chld_disk in disk.children:
863
864
865
      try:
        cdev = _RecursiveAssembleBD(chld_disk, owner, as_primary)
      except errors.BlockDeviceError, err:
866
        if children.count(None) >= mcn:
867
868
          raise
        cdev = None
869
        logging.debug("Error in child activation: %s", str(err))
870
      children.append(cdev)
Iustin Pop's avatar
Iustin Pop committed
871
872
873

  if as_primary or disk.AssembleOnSecondary():
    r_dev = bdev.AttachOrAssemble(disk.dev_type, disk.physical_id, children)
874
    r_dev.SetSyncSpeed(constants.SYNC_SPEED)
Iustin Pop's avatar
Iustin Pop committed
875
876
877
    result = r_dev
    if as_primary or disk.OpenOnSecondary():
      r_dev.Open()
878
879
880
    DevCacheManager.UpdateCache(r_dev.dev_path, owner,
                                as_primary, disk.iv_name)

Iustin Pop's avatar
Iustin Pop committed
881
882
883
884
885
  else:
    result = True
  return result


886
def AssembleBlockDevice(disk, owner, as_primary):
Iustin Pop's avatar
Iustin Pop committed
887
888
889
890
891
892
893
894
895
  """Activate a block device for an instance.

  This is a wrapper over _RecursiveAssembleBD.

  Returns:
    a /dev path for primary nodes
    True for secondary nodes

  """
896
  result = _RecursiveAssembleBD(disk, owner, as_primary)
Iustin Pop's avatar
Iustin Pop committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
  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:
915
    r_path = r_dev.dev_path
Iustin Pop's avatar
Iustin Pop committed
916
    result = r_dev.Shutdown()
917
918
    if result:
      DevCacheManager.RemoveCache(r_path)
Iustin Pop's avatar
Iustin Pop committed
919
920
921
922
923
924
925
926
  else:
    result = True
  if disk.children:
    for child in disk.children:
      result = result and ShutdownBlockDevice(child)
  return result


927
928
def MirrorAddChildren(parent_cdev, new_cdevs):
  """Extend a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
929
930

  """
931
932
  parent_bdev = _RecursiveFindBD(parent_cdev, allow_partial=True)
  if parent_bdev is None:
933
    logging.error("Can't find parent device")
Iustin Pop's avatar
Iustin Pop committed
934
    return False
935
936
  new_bdevs = [_RecursiveFindBD(disk) for disk in new_cdevs]
  if new_bdevs.count(None) > 0:
937
938
    logging.error("Can't find new device(s) to add: %s:%s",
                  new_bdevs, new_cdevs)
Iustin Pop's avatar
Iustin Pop committed
939
    return False
940
  parent_bdev.AddChildren(new_bdevs)
Iustin Pop's avatar
Iustin Pop committed
941
942
943
  return True


944
945
def MirrorRemoveChildren(parent_cdev, new_cdevs):
  """Shrink a mirrored block device.
Iustin Pop's avatar
Iustin Pop committed
946
947

  """
948
949
  parent_bdev = _RecursiveFindBD(parent_cdev)
  if parent_bdev is None:
950
    logging.error("Can't find parent in remove children: %s", parent_cdev)
Iustin Pop's avatar
Iustin Pop committed
951
    return False
952
953
954
955
956
957
  devs = []
  for disk in new_cdevs:
    rpath = disk.StaticDevPath()
    if rpath is None:
      bd = _RecursiveFindBD(disk)
      if bd is None:
958
959
        logging.error("Can't find dynamic device %s while removing children",
                      disk)
960
961
962
963
964
965
        return False
      else:
        devs.append(bd.dev_path)
    else:
      devs.append(rpath)
  parent_bdev.RemoveChildren(devs)
Iustin Pop's avatar
Iustin Pop committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
  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:
984
      raise errors.BlockDeviceError("Can't find device %s" % str(dsk))
Iustin Pop's avatar
Iustin Pop committed
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
    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
1028
  return (rbd.dev_path, rbd.major, rbd.minor) + rbd.GetSyncStatus()
Iustin Pop's avatar
Iustin Pop committed
1029

1030
1031
1032
def _IsJobQueueFile(file_name):
  queue_dir = os.path.normpath(constants.QUEUE_DIR)
  return os.path.commonprefix([queue_dir, file_name]) == queue_dir
Iustin Pop's avatar
Iustin Pop committed
1033
1034
1035
1036
1037
1038
1039
1040
1041

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):
1042
1043
    logging.error("Filename passed to UploadFile is not absolute: '%s'",
                  file_name)
Iustin Pop's avatar
Iustin Pop committed
1044
1045
    return False

1046
1047
1048
1049
  allowed_files = [
    constants.CLUSTER_CONF_FILE,
    constants.ETC_HOSTS,
    constants.SSH_KNOWN_HOSTS_FILE,
1050
    constants.VNC_PASSWORD_FILE,
1051
    ]
1052
  allowed_files.extend(ssconf.SimpleStore().GetFileList())
1053
1054

  if not (file_name in allowed_files or _IsJobQueueFile(file_name)):
1055
1056
    logging.error("Filename passed to UploadFile not in allowed"
                 " upload targets: '%s'", file_name)
Iustin Pop's avatar
Iustin Pop committed
1057
1058
    return False

1059
1060
  utils.WriteFile(file_name, data=data, mode=mode, uid=uid, gid=gid,
                  atime=atime, mtime=mtime)
Iustin Pop's avatar
Iustin Pop committed
1061
1062
  return True

1063

Iustin Pop's avatar
Iustin Pop committed
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
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
1078

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

Alexander Schreiber's avatar
Alexander Schreiber committed
1082
  This function will try to read the API version of the os given by
1083
1084
1085
1086
  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
1087
1088
1089
1090
1091
1092
1093

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

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

  if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1098
    raise errors.InvalidOS(name, os_dir, "'ganeti_api_version' file is not"
1099
                           " a regular file")
Iustin Pop's avatar
Iustin Pop committed
1100
1101
1102
1103
1104
1105
1106
1107

  try:
    f = open(api_file)
    try:
      api_version = f.read(256)
    finally:
      f.close()
  except EnvironmentError, err:
1108
    raise errors.InvalidOS(name, os_dir, "error while reading the"
1109
                           " API version (%s)" % _ErrnoOrStr(err))
Iustin Pop's avatar
Iustin Pop committed
1110
1111
1112
1113
1114

  api_version = api_version.strip()
  try:
    api_version = int(api_version)
  except (TypeError, ValueError), err:
1115
1116
    raise errors.InvalidOS(name, os_dir,
                           "API version is not integer (%s)" % str(err))
Iustin Pop's avatar
Iustin Pop committed
1117
1118
1119

  return api_version

1120

1121
def DiagnoseOS(top_dirs=None):
Iustin Pop's avatar
Iustin Pop committed
1122
1123
  """Compute the validity for all OSes.

1124
1125
  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
1126
1127

  Returns:
1128
    list of OS objects
Iustin Pop's avatar
Iustin Pop committed
1129
1130

  """
1131
1132
  if top_dirs is None:
    top_dirs = constants.OS_SEARCH_PATH
Iustin Pop's avatar
Iustin Pop committed
1133
1134

  result = []
Iustin Pop's avatar
Iustin Pop committed
1135
1136
  for dir_name in top_dirs:
    if os.path.isdir(dir_name):
1137
      try:
Iustin Pop's avatar
Iustin Pop committed
1138
        f_names = utils.ListVisibleFiles(dir_name)
1139
      except EnvironmentError, err:
1140
        logging.exception("Can't list the OS directory %s", dir_name)
1141
1142
1143
        break
      for name in f_names:
        try:
Iustin Pop's avatar
Iustin Pop committed
1144
          os_inst = OSFromDisk(name, base_dir=dir_name)
1145
1146
          result.append(os_inst)
        except errors.InvalidOS, err:
1147
          result.append(objects.OS.FromInvalidOS(err))
Iustin Pop's avatar
Iustin Pop committed
1148
1149
1150
1151

  return result


1152
def OSFromDisk(name, base_dir=None):
Iustin Pop's avatar
Iustin Pop committed
1153
1154
1155
1156
1157
1158
1159
  """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.

1160
1161
1162
1163
  Args:
    os_dir: Directory containing the OS scripts. Defaults to a search
            in all the OS_SEARCH_PATH directories.

Iustin Pop's avatar
Iustin Pop committed
1164
  """
1165

1166
  if base_dir is None:
1167
    os_dir = utils.FindFile(name, constants.OS_SEARCH_PATH, os.path.isdir)
1168
1169
1170
1171
    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
1172

1173
  api_version = _OSOndiskVersion(name, os_dir)
Iustin Pop's avatar
Iustin Pop committed
1174
1175

  if api_version != constants.OS_API_VERSION:
1176
1177
    raise errors.InvalidOS(name, os_dir, "API version mismatch"
                           " (found %s want %s)"
1178
                           % (api_version, constants.OS_API_VERSION))
Iustin Pop's avatar
Iustin Pop committed
1179
1180

  # OS Scripts dictionary, we will populate it with the actual script names
1181
  os_scripts = {'create': '', 'export': '', 'import': '', 'rename': ''}
Iustin Pop's avatar
Iustin Pop committed
1182
1183
1184
1185
1186
1187
1188

  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:
1189
      raise errors.InvalidOS(name, os_dir, "'%s' script missing (%s)" %
1190
                             (script, _ErrnoOrStr(err)))
Iustin Pop's avatar
Iustin Pop committed
1191
1192

    if stat.S_IMODE(st.st_mode) & stat.S_IXUSR != stat.S_IXUSR:
1193
1194
      raise errors.InvalidOS(name, os_dir, "'%s' script not executable" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1195
1196

    if not stat.S_ISREG(stat.S_IFMT(st.st_mode)):
1197
1198
      raise errors.InvalidOS(name, os_dir, "'%s' is not a regular file" %
                             script)
Iustin Pop's avatar
Iustin Pop committed
1199
1200


1201
  return objects.OS(name=name, path=os_dir, status=constants.OS_VALID_STATUS,
Iustin Pop's avatar
Iustin Pop committed
1202
1203
1204
                    create_script=os_scripts['create'],
                    export_script=os_scripts['export'],
                    import_script=os_scripts['import'],
1205
                    rename_script=os_scripts['rename'],
Iustin Pop's avatar
Iustin Pop committed
1206
1207
1208
                    api_version=api_version)


1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
def GrowBlockDevice(disk, amount):
  """Grow a stack of block devices.

  This function is called recursively, with the childrens being the
  first one resize.

  Args:
    disk: the disk to be grown

  Returns: a tuple of (status, result), with:
    status: the result (true/false) of the operation
    result: the error message if the operation failed, otherwise not used

  """
  r_dev = _RecursiveFindBD(disk)
  if r_dev is None:
    return False, "Cannot find block device %s" % (disk,)

  try:
    r_dev.Grow(amount)
  except errors.BlockDeviceError, err:
    return False, str(err)

  return True, None


Iustin Pop's avatar
Iustin Pop committed
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
def SnapshotBlockDevice(disk):
  """Create a snapshot copy of a block device.

  This function is called recursively, and the snapshot is actually created
  just for the leaf lvm backend device.

  Args:
    disk: the disk to be snapshotted

  Returns:
    a config entry for the actual lvm device snapshotted.

1247
  """
Iustin Pop's avatar
Iustin Pop committed
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
  if disk.children:
    if len(disk.children) == 1:
      # only one child, let's recurse on it
      return SnapshotBlockDevice(disk.children[0])
    else:
      # more than one child, choose one that matches
      for child in disk.children:
        if child.size == disk.size:
          # return implies breaking the loop
          return SnapshotBlockDevice(child)
1258
  elif disk.dev_type == constants.LD_LV:
Iustin Pop's avatar
Iustin Pop committed
1259
1260
1261
1262
1263
1264
1265
    r_dev = _RecursiveFindBD(disk)
    if r_dev is not None:
      # let's stay on the safe side and ask for the full size, for now
      return r_dev.Snapshot(disk.size)
    else:
      return None
  else:
1266
    raise errors.ProgrammerError("Cannot snapshot non-lvm block device"
1267
                                 " '%s' of type '%s'" %
1268
                                 (disk.unique_id, disk.dev_type))
Iustin Pop's avatar
Iustin Pop committed
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281


def ExportSnapshot(disk, dest_node, instance):
  """Export a block device snapshot to a remote node.

  Args:
    disk: the snapshot block device
    dest_node: the node to send the image to
    instance: instance being exported

  Returns:
    True if successful, False otherwise.

1282
  """
Iustin Pop's avatar
Iustin Pop committed
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
  inst_os = OSFromDisk(instance.os)
  export_script = inst_os.export_script

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

  real_os_dev = _RecursiveFindBD(disk)
  if real_os_dev is None:
    raise errors.BlockDeviceError("Block device '%s' is not set up" %
                                  str(disk))
  real_os_dev.Open()

  destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
  destfile = disk.physical_id[1]

  # the target command is built out of three individual commands,
  # which are joined by pipes; we check each individual command for
  # valid parameters

  expcmd = utils.BuildShellCmd("cd %s; %s -i %s -b %s 2>%s", inst_os.path,
                               export_script, instance.name,
                               real_os_dev.dev_path, logfile)

  comprcmd = "gzip"

1310
  destcmd = utils.BuildShellCmd("mkdir -p %s && cat > %s/%s",
1311
                                destdir, destdir, destfile)
1312
1313
  remotecmd = _GetSshRunner().BuildCmd(dest_node, constants.GANETI_RUNAS,
                                       destcmd)
Iustin Pop's avatar
Iustin Pop committed
1314
1315

  # all commands have been checked, so we're safe to combine them
1316
  command = '|'.join([expcmd, comprcmd, utils.ShellQuoteArgs(remotecmd)])
Iustin Pop's avatar
Iustin Pop committed
1317
1318
1319
1320

  result = utils.RunCmd(command)

  if result.failed:
1321
1322
    logging.error("os snapshot export command '%s' returned error: %s"
                  " output: %s", command, result.fail_reason, result.output)
Iustin Pop's avatar
Iustin Pop committed
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
    return False

  return True


def FinalizeExport(instance, snap_disks):
  """Write out the export configuration information.

  Args:
    instance: instance configuration
    snap_disks: snapshot block devices

  Returns:
    False in case of error, True otherwise.

1338
  """
Iustin Pop's avatar
Iustin Pop committed
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
  destdir = os.path.join(constants.EXPORT_DIR, instance.name + ".new")
  finaldestdir = os.path.join(constants.EXPORT_DIR, instance.name)

  config = objects.SerializableConfigParser()

  config.add_section(constants.INISECT_EXP)
  config.set(constants.INISECT_EXP, 'version', '0')
  config.set(constants.INISECT_EXP, 'timestamp', '%d' % int(time.time()))
  config.set(constants.INISECT_EXP, 'source', instance.primary_node)
  config.set(constants.INISECT_EXP, 'os', instance.os)
  config.set(constants.INISECT_EXP, 'compression', 'gzip')

  config.add_section(constants.INISECT_INS)
  config.set(constants.INISECT_INS, 'name', instance.name)
  config.set(constants.INISECT_INS, 'memory', '%d' % instance.memory)
  config.set(constants.INISECT_INS, 'vcpus', '%d' % instance.vcpus)
  config.set(constants.INISECT_INS, 'disk_template', instance.disk_template)
1356
1357

  nic_count = 0
Iustin Pop's avatar
Iustin Pop committed
1358
1359
1360
1361
  for nic_count, nic in enumerate(instance.nics):
    config.set(constants.INISECT_INS, 'nic%d_mac' %
               nic_count, '%s' % nic.mac)
    config.set(constants.INISECT_INS, 'nic%d_ip' % nic_count, '%s' % nic.ip)
Iustin Pop's avatar
Iustin Pop committed
1362
1363
    config.set(constants.INISECT_INS, 'nic%d_bridge' % nic_count,
               '%s' % nic.bridge)
Iustin Pop's avatar
Iustin Pop committed
1364
1365
1366
  # TODO: redundant: on load can read nics until it doesn't exist
  config.set(constants.INISECT_INS, 'nic_count' , '%d' % nic_count)

1367
  disk_count = 0
Iustin Pop's avatar
Iustin Pop committed
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
  for disk_count, disk in enumerate(snap_disks):
    config.set(constants.INISECT_INS, 'disk%d_ivname' % disk_count,
               ('%s' % disk.iv_name))
    config.set(constants.INISECT_INS, 'disk%d_dump' % disk_count,
               ('%s' % disk.physical_id[1]))
    config.set(constants.INISECT_INS, 'disk%d_size' % disk_count,
               ('%d' % disk.size))
  config.set(constants.INISECT_INS, 'disk_count' , '%d' % disk_count)

  cff = os.path.join(destdir, constants.EXPORT_CONF_FILE)
  cfo = open(cff, 'w')
  try:
    config.write(cfo)
  finally:
    cfo.close()

  shutil.rmtree(finaldestdir, True)
  shutil.move(destdir, finaldestdir)

  return True


def ExportInfo(dest):
  """Get export configuration information.

  Args:
    dest: directory containing the export

  Returns:
    A serializable config file containing the export info.

  """
  cff = os.path.join(dest, constants.EXPORT_CONF_FILE)

  config = objects.SerializableConfigParser()
  config.read(cff)

  if (not config.has_section(constants.INISECT_EXP) or
      not config.has_section(constants.INISECT_INS)):
    return None

  return config


def ImportOSIntoInstance(instance, os_disk, swap_disk, src_node, src_image):
  """Import an os image into an instance.

  Args:
    instance: the instance object
    os_disk: the instance-visible name of the os device
    swap_disk: the instance-visible name of the swap device
    src_node: node holding the source image
    src_image: path to the source image on src_node

  Returns:
    False in case of error, True otherwise.

  """
  inst_os = OSFromDisk(instance.os)
  import_script = inst_os.import_script

Iustin Pop's avatar
Iustin Pop committed
1429
1430
  os_device = instance.FindDisk(os_disk)
  if os_device is None:
1431
    logging.error("Can't find this device-visible name '%s'", os_disk)
Iustin Pop's avatar
Iustin Pop committed
1432
1433
    return False

Iustin Pop's avatar
Iustin Pop committed
1434
1435
  swap_device = instance.FindDisk(swap_disk)
  if swap_device is None: