ganeti-noded 16.3 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#!/usr/bin/python
#

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


"""Ganeti node daemon"""

24
25
26
# functions in this module need to have a given name structure, so:
# pylint: disable-msg=C0103

Iustin Pop's avatar
Iustin Pop committed
27
28
29
30
31
32
33
34
35
36
37
38
39
40
import os
import sys
import resource
import traceback

from optparse import OptionParser


from ganeti import backend
from ganeti import logger
from ganeti import constants
from ganeti import objects
from ganeti import errors
from ganeti import ssconf
41
from ganeti import utils
Iustin Pop's avatar
Iustin Pop committed
42
43
44
45
46
47
48
49

from twisted.spread import pb
from twisted.internet import reactor
from twisted.cred import checkers, portal
from OpenSSL import SSL


class ServerContextFactory:
50
51
52
53
54
55
56
57
58
59
  """SSL context factory class that uses a given certificate.

  """
  @staticmethod
  def getContext():
    """Return a customized context.

    The context will be set to use our certificate.

    """
Iustin Pop's avatar
Iustin Pop committed
60
61
62
63
64
65
    ctx = SSL.Context(SSL.TLSv1_METHOD)
    ctx.use_certificate_file(constants.SSL_CERT_FILE)
    ctx.use_privatekey_file(constants.SSL_CERT_FILE)
    return ctx

class ServerObject(pb.Avatar):
66
67
68
69
70
  """The server implementation.

  This class holds all methods exposed over the RPC interface.

  """
Iustin Pop's avatar
Iustin Pop committed
71
72
73
74
  def __init__(self, name):
    self.name = name

  def perspectiveMessageReceived(self, broker, message, args, kw):
75
    """Custom message dispatching function.
Iustin Pop's avatar
Iustin Pop committed
76

77
78
    This function overrides the pb.Avatar function in order to provide
    a simple form of exception passing (as text only).
Iustin Pop's avatar
Iustin Pop committed
79

80
    """
Iustin Pop's avatar
Iustin Pop committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94
    args = broker.unserialize(args, self)
    kw = broker.unserialize(kw, self)
    method = getattr(self, "perspective_%s" % message)
    tb = None
    state = None
    try:
      state = method(*args, **kw)
    except:
      tb = traceback.format_exc()

    return broker.serialize((tb, state), self, method, args, kw)

  # the new block devices  --------------------------

95
96
97
98
99
  @staticmethod
  def perspective_blockdev_create(params):
    """Create a block device.

    """
100
    bdev_s, size, on_primary, info = params
101
    bdev = objects.Disk.FromDict(bdev_s)
Iustin Pop's avatar
Iustin Pop committed
102
103
    if bdev is None:
      raise ValueError("can't unserialize data!")
104
    return backend.CreateBlockDevice(bdev, size, on_primary, info)
Iustin Pop's avatar
Iustin Pop committed
105

106
107
108
109
110
  @staticmethod
  def perspective_blockdev_remove(params):
    """Remove a block device.

    """
Iustin Pop's avatar
Iustin Pop committed
111
    bdev_s = params[0]
112
    bdev = objects.Disk.FromDict(bdev_s)
Iustin Pop's avatar
Iustin Pop committed
113
114
    return backend.RemoveBlockDevice(bdev)

Iustin Pop's avatar
Iustin Pop committed
115
116
117
118
119
120
121
122
  @staticmethod
  def perspective_blockdev_rename(params):
    """Remove a block device.

    """
    devlist = [(objects.Disk.FromDict(ds), uid) for ds, uid in params]
    return backend.RenameBlockDevices(devlist)

123
124
125
126
127
  @staticmethod
  def perspective_blockdev_assemble(params):
    """Assemble a block device.

    """
Iustin Pop's avatar
Iustin Pop committed
128
    bdev_s, on_primary = params
129
    bdev = objects.Disk.FromDict(bdev_s)
Iustin Pop's avatar
Iustin Pop committed
130
131
132
133
    if bdev is None:
      raise ValueError("can't unserialize data!")
    return backend.AssembleBlockDevice(bdev, on_primary)

134
135
136
137
138
  @staticmethod
  def perspective_blockdev_shutdown(params):
    """Shutdown a block device.

    """
Iustin Pop's avatar
Iustin Pop committed
139
    bdev_s = params[0]
140
    bdev = objects.Disk.FromDict(bdev_s)
Iustin Pop's avatar
Iustin Pop committed
141
142
143
144
    if bdev is None:
      raise ValueError("can't unserialize data!")
    return backend.ShutdownBlockDevice(bdev)

145
  @staticmethod
146
  def perspective_blockdev_addchildren(params):
147
148
149
150
151
152
    """Add a child to a mirror device.

    Note: this is only valid for mirror devices. It's the caller's duty
    to send a correct disk, otherwise we raise an error.

    """
Iustin Pop's avatar
Iustin Pop committed
153
    bdev_s, ndev_s = params
154
    bdev = objects.Disk.FromDict(bdev_s)
155
156
    ndevs = [objects.Disk.FromDict(disk_s) for disk_s in ndev_s]
    if bdev is None or ndevs.count(None) > 0:
Iustin Pop's avatar
Iustin Pop committed
157
      raise ValueError("can't unserialize data!")
158
    return backend.MirrorAddChildren(bdev, ndevs)
Iustin Pop's avatar
Iustin Pop committed
159

160
  @staticmethod
161
  def perspective_blockdev_removechildren(params):
162
163
164
165
166
167
    """Remove a child from a mirror device.

    This is only valid for mirror devices, of course. It's the callers
    duty to send a correct disk, otherwise we raise an error.

    """
Iustin Pop's avatar
Iustin Pop committed
168
    bdev_s, ndev_s = params
169
    bdev = objects.Disk.FromDict(bdev_s)
170
171
    ndevs = [objects.Disk.FromDict(disk_s) for disk_s in ndev_s]
    if bdev is None or ndevs.count(None) > 0:
Iustin Pop's avatar
Iustin Pop committed
172
      raise ValueError("can't unserialize data!")
173
    return backend.MirrorRemoveChildren(bdev, ndevs)
Iustin Pop's avatar
Iustin Pop committed
174

175
176
177
178
179
  @staticmethod
  def perspective_blockdev_getmirrorstatus(params):
    """Return the mirror status for a list of disks.

    """
180
    disks = [objects.Disk.FromDict(dsk_s)
Iustin Pop's avatar
Iustin Pop committed
181
182
183
            for dsk_s in params]
    return backend.GetMirrorStatus(disks)

184
185
186
187
188
189
190
  @staticmethod
  def perspective_blockdev_find(params):
    """Expose the FindBlockDevice functionality for a disk.

    This will try to find but not activate a disk.

    """
191
    disk = objects.Disk.FromDict(params[0])
Iustin Pop's avatar
Iustin Pop committed
192
193
    return backend.FindBlockDevice(disk)

194
195
196
197
198
199
200
201
202
  @staticmethod
  def perspective_blockdev_snapshot(params):
    """Create a snapshot device.

    Note that this is only valid for LVM disks, if we get passed
    something else we raise an exception. The snapshot device can be
    remove by calling the generic block device remove call.

    """
203
    cfbd = objects.Disk.FromDict(params[0])
Iustin Pop's avatar
Iustin Pop committed
204
205
206
207
    return backend.SnapshotBlockDevice(cfbd)

  # export/import  --------------------------

208
209
210
211
212
  @staticmethod
  def perspective_snapshot_export(params):
    """Export a given snapshot.

    """
213
    disk = objects.Disk.FromDict(params[0])
Iustin Pop's avatar
Iustin Pop committed
214
    dest_node = params[1]
215
    instance = objects.Instance.FromDict(params[2])
216
217
218
219
220
    return backend.ExportSnapshot(disk, dest_node, instance)

  @staticmethod
  def perspective_finalize_export(params):
    """Expose the finalize export functionality.
Iustin Pop's avatar
Iustin Pop committed
221

222
    """
223
224
    instance = objects.Instance.FromDict(params[0])
    snap_disks = [objects.Disk.FromDict(str_data)
Iustin Pop's avatar
Iustin Pop committed
225
226
227
                  for str_data in params[1]]
    return backend.FinalizeExport(instance, snap_disks)

228
229
230
231
232
233
234
235
236
237
  @staticmethod
  def perspective_export_info(params):
    """Query information about an existing export on this node.

    The given path may not contain an export, in which case we return
    None.

    """
    path = params[0]
    einfo = backend.ExportInfo(path)
Iustin Pop's avatar
Iustin Pop committed
238
239
240
241
    if einfo is None:
      return einfo
    return einfo.Dumps()

242
243
244
245
246
247
248
249
250
  @staticmethod
  def perspective_export_list(params):
    """List the available exports on this node.

    Note that as opposed to export_info, which may query data about an
    export in any path, this only queries the standard Ganeti path
    (constants.EXPORT_DIR).

    """
Iustin Pop's avatar
Iustin Pop committed
251
252
    return backend.ListExports()

253
254
255
256
257
  @staticmethod
  def perspective_export_remove(params):
    """Remove an export.

    """
Iustin Pop's avatar
Iustin Pop committed
258
259
260
261
262
    export = params[0]
    return backend.RemoveExport(export)

  # volume  --------------------------

263
264
265
266
267
  @staticmethod
  def perspective_volume_list(params):
    """Query the list of logical volumes in a given volume group.

    """
Iustin Pop's avatar
Iustin Pop committed
268
269
270
    vgname = params[0]
    return backend.GetVolumeList(vgname)

271
272
273
274
275
  @staticmethod
  def perspective_vg_list(params):
    """Query the list of volume groups.

    """
Iustin Pop's avatar
Iustin Pop committed
276
277
278
279
    return backend.ListVolumeGroups()

  # bridge  --------------------------

280
281
282
283
284
  @staticmethod
  def perspective_bridges_exist(params):
    """Check if all bridges given exist on this node.

    """
Iustin Pop's avatar
Iustin Pop committed
285
286
287
288
289
    bridges_list = params[0]
    return backend.BridgesExist(bridges_list)

  # instance  --------------------------

290
291
292
293
294
  @staticmethod
  def perspective_instance_os_add(params):
    """Install an OS on a given instance.

    """
Iustin Pop's avatar
Iustin Pop committed
295
    inst_s, os_disk, swap_disk = params
296
    inst = objects.Instance.FromDict(inst_s)
Iustin Pop's avatar
Iustin Pop committed
297
298
    return backend.AddOSToInstance(inst, os_disk, swap_disk)

299
300
301
302
303
304
  @staticmethod
  def perspective_instance_run_rename(params):
    """Runs the OS rename script for an instance.

    """
    inst_s, old_name, os_disk, swap_disk = params
305
    inst = objects.Instance.FromDict(inst_s)
306
307
    return backend.RunRenameInstance(inst, old_name, os_disk, swap_disk)

308
309
310
311
312
  @staticmethod
  def perspective_instance_os_import(params):
    """Run the import function of an OS onto a given instance.

    """
Iustin Pop's avatar
Iustin Pop committed
313
    inst_s, os_disk, swap_disk, src_node, src_image = params
314
    inst = objects.Instance.FromDict(inst_s)
Iustin Pop's avatar
Iustin Pop committed
315
316
317
    return backend.ImportOSIntoInstance(inst, os_disk, swap_disk,
                                        src_node, src_image)

318
319
320
321
322
  @staticmethod
  def perspective_instance_shutdown(params):
    """Shutdown an instance.

    """
323
    instance = objects.Instance.FromDict(params[0])
Iustin Pop's avatar
Iustin Pop committed
324
325
    return backend.ShutdownInstance(instance)

326
327
328
329
330
  @staticmethod
  def perspective_instance_start(params):
    """Start an instance.

    """
331
    instance = objects.Instance.FromDict(params[0])
Iustin Pop's avatar
Iustin Pop committed
332
333
334
    extra_args = params[1]
    return backend.StartInstance(instance, extra_args)

335
336
337
338
339
340
341
342
343
344
  @staticmethod
  def perspective_instance_reboot(params):
    """Reboot an instance.

    """
    instance = objects.Instance.FromDict(params[0])
    reboot_type = params[1]
    extra_args = params[2]
    return backend.RebootInstance(instance, reboot_type, extra_args)

345
346
347
348
349
  @staticmethod
  def perspective_instance_info(params):
    """Query instance information.

    """
Iustin Pop's avatar
Iustin Pop committed
350
351
    return backend.GetInstanceInfo(params[0])

352
353
354
355
356
  @staticmethod
  def perspective_all_instances_info(params):
    """Query information about all instances.

    """
Iustin Pop's avatar
Iustin Pop committed
357
358
    return backend.GetAllInstancesInfo()

359
360
361
362
363
  @staticmethod
  def perspective_instance_list(params):
    """Query the list of running instances.

    """
Iustin Pop's avatar
Iustin Pop committed
364
365
366
367
    return backend.GetInstanceList()

  # node --------------------------

368
369
370
371
372
373
374
375
  @staticmethod
  def perspective_node_tcp_ping(params):
    """Do a TcpPing on the remote node.

    """
    return utils.TcpPing(params[0], params[1], params[2],
                         timeout=params[3], live_port_needed=params[4])

376
377
378
379
380
  @staticmethod
  def perspective_node_info(params):
    """Query node information.

    """
Iustin Pop's avatar
Iustin Pop committed
381
382
383
    vgname = params[0]
    return backend.GetNodeInfo(vgname)

384
385
386
387
388
  @staticmethod
  def perspective_node_add(params):
    """Complete the registration of this node in the cluster.

    """
Iustin Pop's avatar
Iustin Pop committed
389
390
391
    return backend.AddNode(params[0], params[1], params[2],
                           params[3], params[4], params[5])

392
393
394
395
396
  @staticmethod
  def perspective_node_verify(params):
    """Run a verify sequence on this node.

    """
Iustin Pop's avatar
Iustin Pop committed
397
398
    return backend.VerifyNode(params[0])

399
400
401
402
403
  @staticmethod
  def perspective_node_start_master(params):
    """Promote this node to master status.

    """
Iustin Pop's avatar
Iustin Pop committed
404
405
    return backend.StartMaster()

406
407
408
409
410
  @staticmethod
  def perspective_node_stop_master(params):
    """Demote this node from master status.

    """
Iustin Pop's avatar
Iustin Pop committed
411
412
    return backend.StopMaster()

413
414
415
416
417
  @staticmethod
  def perspective_node_leave_cluster(params):
    """Cleanup after leaving a cluster.

    """
Iustin Pop's avatar
Iustin Pop committed
418
419
    return backend.LeaveCluster()

420
421
422
423
424
  @staticmethod
  def perspective_node_volumes(params):
    """Query the list of all logical volume groups.

    """
425
426
    return backend.NodeVolumes()

Iustin Pop's avatar
Iustin Pop committed
427
428
  # cluster --------------------------

429
430
431
432
433
  @staticmethod
  def perspective_version(params):
    """Query version information.

    """
Iustin Pop's avatar
Iustin Pop committed
434
435
    return constants.PROTOCOL_VERSION

436
437
438
439
440
441
442
443
  @staticmethod
  def perspective_upload_file(params):
    """Upload a file.

    Note that the backend implementation imposes strict rules on which
    files are accepted.

    """
Iustin Pop's avatar
Iustin Pop committed
444
445
446
447
448
    return backend.UploadFile(*params)


  # os -----------------------

449
450
451
452
453
  @staticmethod
  def perspective_os_diagnose(params):
    """Query detailed information about existing OSes.

    """
Iustin Pop's avatar
Iustin Pop committed
454
455
456
457
458
459
460
461
    os_list = backend.DiagnoseOS()
    if not os_list:
      # this catches also return values of 'False',
      # for which we can't iterate over
      return os_list
    result = []
    for data in os_list:
      if isinstance(data, objects.OS):
462
        result.append(data.ToDict())
Iustin Pop's avatar
Iustin Pop committed
463
464
465
      elif isinstance(data, errors.InvalidOS):
        result.append(data.args)
      else:
466
467
468
        raise errors.ProgrammerError("Invalid result from backend.DiagnoseOS"
                                     " (class %s, %s)" %
                                     (str(data.__class__), data))
Iustin Pop's avatar
Iustin Pop committed
469
470
471

    return result

472
473
474
475
476
  @staticmethod
  def perspective_os_get(params):
    """Query information about a given OS.

    """
Iustin Pop's avatar
Iustin Pop committed
477
478
    name = params[0]
    try:
479
      os_obj = backend.OSFromDisk(name).ToDict()
Iustin Pop's avatar
Iustin Pop committed
480
    except errors.InvalidOS, err:
481
482
      os_obj = err.args
    return os_obj
Iustin Pop's avatar
Iustin Pop committed
483
484
485

  # hooks -----------------------

486
487
488
489
490
  @staticmethod
  def perspective_hooks_runner(params):
    """Run hook scripts.

    """
Iustin Pop's avatar
Iustin Pop committed
491
492
493
494
495
496
    hpath, phase, env = params
    hr = backend.HooksRunner()
    return hr.RunHooks(hpath, phase, env)


class MyRealm:
497
498
499
  """Simple realm that forwards all requests to a ServerObject.

  """
Iustin Pop's avatar
Iustin Pop committed
500
  __implements__ = portal.IRealm
501

Iustin Pop's avatar
Iustin Pop committed
502
  def requestAvatar(self, avatarId, mind, *interfaces):
503
504
505
    """Return an avatar based on our ServerObject class.

    """
Iustin Pop's avatar
Iustin Pop committed
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
    if pb.IPerspective not in interfaces:
      raise NotImplementedError
    return pb.IPerspective, ServerObject(avatarId), lambda:None


def ParseOptions():
  """Parse the command line options.

  Returns:
    (options, args) as from OptionParser.parse_args()

  """
  parser = OptionParser(description="Ganeti node daemon",
                        usage="%prog [-f] [-d]",
                        version="%%prog (ganeti) %s" %
                        constants.RELEASE_VERSION)

  parser.add_option("-f", "--foreground", dest="fork",
                    help="Don't detach from the current terminal",
                    default=True, action="store_false")
  parser.add_option("-d", "--debug", dest="debug",
                    help="Enable some debug messages",
                    default=False, action="store_true")
  options, args = parser.parse_args()
  return options, args


def main():
534
535
536
  """Main function for the node daemon.

  """
Iustin Pop's avatar
Iustin Pop committed
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
  options, args = ParseOptions()
  for fname in (constants.SSL_CERT_FILE,):
    if not os.path.isfile(fname):
      print "config %s not there, will not run." % fname
      sys.exit(5)

  try:
    ss = ssconf.SimpleStore()
    port = ss.GetNodeDaemonPort()
    pwdata = ss.GetNodeDaemonPassword()
  except errors.ConfigurationError, err:
    print "Cluster configuration incomplete: '%s'" % str(err)
    sys.exit(5)

  # become a daemon
  if options.fork:
    createDaemon()

  logger.SetupLogging(twisted_workaround=True, debug=options.debug,
                      program="ganeti-noded")

  p = portal.Portal(MyRealm())
  p.registerChecker(
    checkers.InMemoryUsernamePasswordDatabaseDontUse(master_node=pwdata))
  reactor.listenSSL(port, pb.PBServerFactory(p), ServerContextFactory())
  reactor.run()


def createDaemon():
  """Detach a process from the controlling terminal and run it in the
  background as a daemon.
568

Iustin Pop's avatar
Iustin Pop committed
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
  """
  UMASK = 077
  WORKDIR = "/"
  # Default maximum for the number of available file descriptors.
  if 'SC_OPEN_MAX' in os.sysconf_names:
    try:
      MAXFD = os.sysconf('SC_OPEN_MAX')
      if MAXFD < 0:
        MAXFD = 1024
    except OSError:
      MAXFD = 1024
  else:
    MAXFD = 1024
  # The standard I/O file descriptors are redirected to /dev/null by default.
  #REDIRECT_TO = getattr(os, "devnull", "/dev/null")
  REDIRECT_TO = constants.LOG_NODESERVER
  try:
    pid = os.fork()
  except OSError, e:
588
    raise Exception("%s [%d]" % (e.strerror, e.errno))
Michael Hanselmann's avatar
Michael Hanselmann committed
589
  if (pid == 0):  # The first child.
Iustin Pop's avatar
Iustin Pop committed
590
591
    os.setsid()
    try:
Michael Hanselmann's avatar
Michael Hanselmann committed
592
      pid = os.fork() # Fork a second child.
Iustin Pop's avatar
Iustin Pop committed
593
    except OSError, e:
594
      raise Exception("%s [%d]" % (e.strerror, e.errno))
Michael Hanselmann's avatar
Michael Hanselmann committed
595
    if (pid == 0):  # The second child.
Iustin Pop's avatar
Iustin Pop committed
596
597
598
599
      os.chdir(WORKDIR)
      os.umask(UMASK)
    else:
      # exit() or _exit()?  See below.
Michael Hanselmann's avatar
Michael Hanselmann committed
600
      os._exit(0) # Exit parent (the first child) of the second child.
Iustin Pop's avatar
Iustin Pop committed
601
  else:
Michael Hanselmann's avatar
Michael Hanselmann committed
602
    os._exit(0) # Exit parent of the first child.
Iustin Pop's avatar
Iustin Pop committed
603
604
605
606
607
608
609
610
  maxfd = resource.getrlimit(resource.RLIMIT_NOFILE)[1]
  if (maxfd == resource.RLIM_INFINITY):
    maxfd = MAXFD

  # Iterate through and close all file descriptors.
  for fd in range(0, maxfd):
    try:
      os.close(fd)
Michael Hanselmann's avatar
Michael Hanselmann committed
611
    except OSError: # ERROR, fd wasn't open to begin with (ignored)
Iustin Pop's avatar
Iustin Pop committed
612
      pass
613
  os.open(REDIRECT_TO, os.O_RDWR|os.O_CREAT|os.O_APPEND, 0600)
Iustin Pop's avatar
Iustin Pop committed
614
  # Duplicate standard input to standard output and standard error.
Michael Hanselmann's avatar
Michael Hanselmann committed
615
616
  os.dup2(0, 1)     # standard output (1)
  os.dup2(0, 2)     # standard error (2)
Iustin Pop's avatar
Iustin Pop committed
617
618
619
  return(0)


620
if __name__ == '__main__':
Iustin Pop's avatar
Iustin Pop committed
621
  main()