rpc.py 18.4 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.


"""Script to show add a new node to the cluster

"""

# pylint: disable-msg=C0103

import os

from twisted.internet.pollreactor import PollReactor

class ReReactor(PollReactor):
33
  """A re-startable Reactor implementation.
Iustin Pop's avatar
Iustin Pop committed
34

35
  """
Iustin Pop's avatar
Iustin Pop committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
  def run(self, installSignalHandlers=1):
    """Custom run method.

    This is customized run that, before calling Reactor.run, will
    reinstall the shutdown events and re-create the threadpool in case
    these are not present (as will happen on the second run of the
    reactor).

    """
    if not 'shutdown' in self._eventTriggers:
      # the shutdown queue has been killed, we are most probably
      # at the second run, thus recreate the queue
      self.addSystemEventTrigger('during', 'shutdown', self.crash)
      self.addSystemEventTrigger('during', 'shutdown', self.disconnectAll)
    if self.threadpool is not None and self.threadpool.joined == 1:
      # in case the threadpool has been stopped, re-start it
      # and add a trigger to stop it at reactor shutdown
      self.threadpool.start()
      self.addSystemEventTrigger('during', 'shutdown', self.threadpool.stop)

    return PollReactor.run(self, installSignalHandlers)


import twisted.internet.main
twisted.internet.main.installReactor(ReReactor())

from twisted.spread import pb
from twisted.internet import reactor
from twisted.cred import credentials
from OpenSSL import SSL, crypto

from ganeti import logger
from ganeti import utils
from ganeti import errors
from ganeti import constants
from ganeti import objects
from ganeti import ssconf

class NodeController:
  """Node-handling class.

  For each node that we speak with, we create an instance of this
  class, so that we have a safe place to store the details of this
  individual call.

  """
  def __init__(self, parent, node):
    self.parent = parent
    self.node = node

  def _check_end(self):
    """Stop the reactor if we got all the results.

    """
    if len(self.parent.results) == len(self.parent.nc):
      reactor.stop()

  def cb_call(self, obj):
Michael Hanselmann's avatar
Michael Hanselmann committed
94
    """Callback for successful connect.
Iustin Pop's avatar
Iustin Pop committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162

    If the connect and login sequence succeeded, we proceed with
    making the actual call.

    """
    deferred = obj.callRemote(self.parent.procedure, self.parent.args)
    deferred.addCallbacks(self.cb_done, self.cb_err2)

  def cb_done(self, result):
    """Callback for successful call.

    When we receive the result from a call, we check if it was an
    error and if so we raise a generic RemoteError (we can't pass yet
    the actual exception over). If there was no error, we store the
    result.

    """
    tb, self.parent.results[self.node] = result
    self._check_end()
    if tb:
      raise errors.RemoteError("Remote procedure error calling %s on %s:"
                               "\n%s" % (self.parent.procedure,
                                         self.node,
                                         tb))

  def cb_err1(self, reason):
    """Error callback for unsuccessful connect.

    """
    logger.Error("caller_connect: could not connect to remote host %s,"
                 " reason %s" % (self.node, reason))
    self.parent.results[self.node] = False
    self._check_end()

  def cb_err2(self, reason):
    """Error callback for unsuccessful call.

    This is when the call didn't return anything, not even an error,
    or when it time out, etc.

    """
    logger.Error("caller_call: could not call %s on node %s,"
                 " reason %s" % (self.parent.procedure, self.node, reason))
    self.parent.results[self.node] = False
    self._check_end()


class MirrorContextFactory:
  """Certificate verifier factory.

  This factory creates contexts that verify if the remote end has a
  specific certificate (i.e. our own certificate).

  The checks we do are that the PEM dump of the certificate is the
  same as our own and (somewhat redundantly) that the SHA checksum is
  the same.

  """
  isClient = 1

  def __init__(self):
    try:
      fd = open(constants.SSL_CERT_FILE, 'r')
      try:
        data = fd.read(16384)
      finally:
        fd.close()
    except EnvironmentError, err:
163 164
      raise errors.ConfigurationError("missing SSL certificate: %s" %
                                      str(err))
Iustin Pop's avatar
Iustin Pop committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 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 266 267 268 269 270 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
    self.mycert = crypto.load_certificate(crypto.FILETYPE_PEM, data)
    self.mypem = crypto.dump_certificate(crypto.FILETYPE_PEM, self.mycert)
    self.mydigest = self.mycert.digest('SHA')

  def verifier(self, conn, x509, errno, err_depth, retcode):
    """Certificate verify method.

    """
    if self.mydigest != x509.digest('SHA'):
      return False
    if crypto.dump_certificate(crypto.FILETYPE_PEM, x509) != self.mypem:
      return False
    return True

  def getContext(self):
    """Context generator.

    """
    context = SSL.Context(SSL.TLSv1_METHOD)
    context.set_verify(SSL.VERIFY_PEER, self.verifier)
    return context

class Client:
  """RPC Client class.

  This class, given a (remote) ethod name, a list of parameters and a
  list of nodes, will contact (in parallel) all nodes, and return a
  dict of results (key: node name, value: result).

  One current bug is that generic failure is still signalled by
  'False' result, which is not good. This overloading of values can
  cause bugs.

  """
  result_set = False
  result = False
  allresult = []

  def __init__(self, procedure, args):
    ss = ssconf.SimpleStore()
    self.port = ss.GetNodeDaemonPort()
    self.nodepw = ss.GetNodeDaemonPassword()
    self.nc = {}
    self.results = {}
    self.procedure = procedure
    self.args = args

  #--- generic connector -------------

  def connect_list(self, node_list):
    """Add a list of nodes to the target nodes.

    """
    for node in node_list:
      self.connect(node)

  def connect(self, connect_node):
    """Add a node to the target list.

    """
    factory = pb.PBClientFactory()
    self.nc[connect_node] = nc = NodeController(self, connect_node)
    reactor.connectSSL(connect_node, self.port, factory,
                       MirrorContextFactory())
    #d = factory.getRootObject()
    d = factory.login(credentials.UsernamePassword("master_node", self.nodepw))
    d.addCallbacks(nc.cb_call, nc.cb_err1)

  def getresult(self):
    """Return the results of the call.

    """
    return self.results

  def run(self):
    """Wrapper over reactor.run().

    This function simply calls reactor.run() if we have any requests
    queued, otherwise it does nothing.

    """
    if self.nc:
      reactor.run()


def call_volume_list(node_list, vg_name):
  """Gets the logical volumes present in a given volume group.

  This is a multi-node call.

  """
  c = Client("volume_list", [vg_name])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_vg_list(node_list):
  """Gets the volume group list.

  This is a multi-node call.

  """
  c = Client("vg_list", [])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_bridges_exist(node, bridges_list):
  """Checks if a node has all the bridges given.

  This method checks if all bridges given in the bridges_list are
  present on the remote node, so that an instance that uses interfaces
  on those bridges can be started.

  This is a single-node call.

  """
  c = Client("bridges_exist", [bridges_list])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_instance_start(node, instance, extra_args):
  """Stars an instance.

  This is a single-node call.

  """
296
  c = Client("instance_start", [instance.ToDict(), extra_args])
Iustin Pop's avatar
Iustin Pop committed
297 298 299 300 301 302 303 304 305 306 307
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_instance_shutdown(node, instance):
  """Stops an instance.

  This is a single-node call.

  """
308
  c = Client("instance_shutdown", [instance.ToDict()])
Iustin Pop's avatar
Iustin Pop committed
309 310 311 312 313 314 315 316 317 318 319
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_instance_os_add(node, inst, osdev, swapdev):
  """Installs an OS on the given instance.

  This is a single-node call.

  """
320
  params = [inst.ToDict(), osdev, swapdev]
Iustin Pop's avatar
Iustin Pop committed
321 322 323 324 325 326
  c = Client("instance_os_add", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


327 328 329 330 331 332
def call_instance_run_rename(node, inst, old_name, osdev, swapdev):
  """Run the OS rename script for an instance.

  This is a single-node call.

  """
333
  params = [inst.ToDict(), old_name, osdev, swapdev]
334 335 336 337 338 339
  c = Client("instance_run_rename", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


Iustin Pop's avatar
Iustin Pop committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
def call_instance_info(node, instance):
  """Returns information about a single instance.

  This is a single-node call.

  """
  c = Client("instance_info", [instance])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_all_instances_info(node_list):
  """Returns information about all instances on a given node.

  This is a single-node call.

  """
  c = Client("all_instances_info", [])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_instance_list(node_list):
  """Returns the list of running instances on a given node.

  This is a single-node call.

  """
  c = Client("instance_list", [])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_node_info(node_list, vg_name):
  """Return node information.

  This will return memory information and volume group size and free
  space.

  This is a multi-node call.

  """
  c = Client("node_info", [vg_name])
  c.connect_list(node_list)
  c.run()
  retux = c.getresult()

  for node_name in retux:
    ret = retux.get(node_name, False)
    if type(ret) != dict:
      logger.Error("could not connect to node %s" % (node_name))
      ret = {}

    utils.CheckDict(ret,
                    { 'memory_total' : '-',
                      'memory_dom0' : '-',
                      'memory_free' : '-',
                      'vg_size' : 'node_unreachable',
                      'vg_free' : '-' },
                    "call_node_info",
                    )
  return retux


def call_node_add(node, dsa, dsapub, rsa, rsapub, ssh, sshpub):
  """Add a node to the cluster.

  This is a single-node call.

  """
  params = [dsa, dsapub, rsa, rsapub, ssh, sshpub]
  c = Client("node_add", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_node_verify(node_list, checkdict):
  """Request verification of given parameters.

  This is a multi-node call.

  """
  c = Client("node_verify", [checkdict])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_node_start_master(node):
  """Tells a node to activate itself as a master.

  This is a single-node call.

  """
  c = Client("node_start_master", [])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_node_stop_master(node):
  """Tells a node to demote itself from master status.

  This is a single-node call.

  """
  c = Client("node_stop_master", [])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_version(node_list):
  """Query node version.

  This is a multi-node call.

  """
  c = Client("version", [])
  c.connect_list(node_list)
  c.run()
  return c.getresult()


468
def call_blockdev_create(node, bdev, size, on_primary, info):
Iustin Pop's avatar
Iustin Pop committed
469 470 471 472 473
  """Request creation of a given block device.

  This is a single-node call.

  """
474
  params = [bdev.ToDict(), size, on_primary, info]
Iustin Pop's avatar
Iustin Pop committed
475 476 477 478 479 480 481 482 483 484 485 486
  c = Client("blockdev_create", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_remove(node, bdev):
  """Request removal of a given block device.

  This is a single-node call.

  """
487
  c = Client("blockdev_remove", [bdev.ToDict()])
Iustin Pop's avatar
Iustin Pop committed
488 489 490 491 492 493 494 495 496 497 498
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_assemble(node, disk, on_primary):
  """Request assembling of a given block device.

  This is a single-node call.

  """
499
  params = [disk.ToDict(), on_primary]
Iustin Pop's avatar
Iustin Pop committed
500 501 502 503 504 505 506 507 508 509 510 511
  c = Client("blockdev_assemble", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_shutdown(node, disk):
  """Request shutdown of a given block device.

  This is a single-node call.

  """
512
  c = Client("blockdev_shutdown", [disk.ToDict()])
Iustin Pop's avatar
Iustin Pop committed
513 514 515 516 517 518 519 520 521 522 523
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_addchild(node, bdev, ndev):
  """Request adding a new child to a (mirroring) device.

  This is a single-node call.

  """
524
  params = [bdev.ToDict(), ndev.ToDict()]
Iustin Pop's avatar
Iustin Pop committed
525 526 527 528 529 530 531 532 533 534 535 536
  c = Client("blockdev_addchild", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_removechild(node, bdev, ndev):
  """Request removing a new child from a (mirroring) device.

  This is a single-node call.

  """
537
  params = [bdev.ToDict(), ndev.ToDict()]
Iustin Pop's avatar
Iustin Pop committed
538 539 540 541 542 543 544 545 546 547 548 549
  c = Client("blockdev_removechild", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_getmirrorstatus(node, disks):
  """Request status of a (mirroring) device.

  This is a single-node call.

  """
550
  params = [dsk.ToDict() for dsk in disks]
Iustin Pop's avatar
Iustin Pop committed
551 552 553 554 555 556 557 558 559 560 561 562
  c = Client("blockdev_getmirrorstatus", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_blockdev_find(node, disk):
  """Request identification of a given block device.

  This is a single-node call.

  """
563
  c = Client("blockdev_find", [disk.ToDict()])
Iustin Pop's avatar
Iustin Pop committed
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_upload_file(node_list, file_name):
  """Upload a file.

  The node will refuse the operation in case the file is not on the
  approved file list.

  This is a multi-node call.

  """
  fh = file(file_name)
  try:
    data = fh.read()
  finally:
    fh.close()
  st = os.stat(file_name)
  params = [file_name, data, st.st_mode, st.st_uid, st.st_gid,
            st.st_atime, st.st_mtime]
  c = Client("upload_file", params)
  c.connect_list(node_list)
  c.run()
  return c.getresult()


def call_os_diagnose(node_list):
  """Request a diagnose of OS definitions.

  This is a multi-node call.

  """
  c = Client("os_diagnose", [])
  c.connect_list(node_list)
  c.run()
  result = c.getresult()
  new_result = {}
  for node_name in result:
    nr = []
    if result[node_name]:
      for data in result[node_name]:
        if data:
608 609
          if isinstance(data, dict):
            nr.append(objects.OS.FromDict(data))
610 611
          elif isinstance(data, tuple) and len(data) == 3:
            nr.append(errors.InvalidOS(data[0], data[1], data[2]))
Iustin Pop's avatar
Iustin Pop committed
612
          else:
613 614
            raise errors.ProgrammerError("Invalid data from"
                                         " xcserver.os_diagnose")
Iustin Pop's avatar
Iustin Pop committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
    new_result[node_name] = nr
  return new_result


def call_os_get(node_list, name):
  """Returns an OS definition.

  This is a multi-node call.

  """
  c = Client("os_get", [name])
  c.connect_list(node_list)
  c.run()
  result = c.getresult()
  new_result = {}
  for node_name in result:
    data = result[node_name]
632 633
    if isinstance(data, dict):
      new_result[node_name] = objects.OS.FromDict(data)
634 635
    elif isinstance(data, tuple) and len(data) == 3:
      new_result[node_name] = errors.InvalidOS(data[0], data[1], data[2])
Iustin Pop's avatar
Iustin Pop committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664
    else:
      new_result[node_name] = data
  return new_result


def call_hooks_runner(node_list, hpath, phase, env):
  """Call the hooks runner.

  Args:
    - op: the OpCode instance
    - env: a dictionary with the environment

  This is a multi-node call.

  """
  params = [hpath, phase, env]
  c = Client("hooks_runner", params)
  c.connect_list(node_list)
  c.run()
  result = c.getresult()
  return result


def call_blockdev_snapshot(node, cf_bdev):
  """Request a snapshot of the given block device.

  This is a single-node call.

  """
665
  c = Client("blockdev_snapshot", [cf_bdev.ToDict()])
Iustin Pop's avatar
Iustin Pop committed
666 667 668 669 670 671 672 673 674 675 676
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_snapshot_export(node, snap_bdev, dest_node, instance):
  """Request the export of a given snapshot.

  This is a single-node call.

  """
677
  params = [snap_bdev.ToDict(), dest_node, instance.ToDict()]
Iustin Pop's avatar
Iustin Pop committed
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
  c = Client("snapshot_export", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_finalize_export(node, instance, snap_disks):
  """Request the completion of an export operation.

  This writes the export config file, etc.

  This is a single-node call.

  """
  flat_disks = []
  for disk in snap_disks:
694 695
    flat_disks.append(disk.ToDict())
  params = [instance.ToDict(), flat_disks]
Iustin Pop's avatar
Iustin Pop committed
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  c = Client("finalize_export", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_export_info(node, path):
  """Queries the export information in a given path.

  This is a single-node call.

  """
  c = Client("export_info", [path])
  c.connect(node)
  c.run()
  result = c.getresult().get(node, False)
  if not result:
    return result
  return objects.SerializableConfigParser.Loads(result)


def call_instance_os_import(node, inst, osdev, swapdev, src_node, src_image):
  """Request the import of a backup into an instance.

  This is a single-node call.

  """
723
  params = [inst.ToDict(), osdev, swapdev, src_node, src_image]
Iustin Pop's avatar
Iustin Pop committed
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
  c = Client("instance_os_import", params)
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_export_list(node_list):
  """Gets the stored exports list.

  This is a multi-node call.

  """
  c = Client("export_list", [])
  c.connect_list(node_list)
  c.run()
  result = c.getresult()
  return result


def call_export_remove(node, export):
  """Requests removal of a given export.

  This is a single-node call.

  """
  c = Client("export_remove", [export])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)


def call_node_leave_cluster(node):
  """Requests a node to clean the cluster information it has.

  This will remove the configuration information from the ganeti data
  dir.

  This is a single-node call.

  """
  c = Client("node_leave_cluster", [])
  c.connect(node)
  c.run()
  return c.getresult().get(node, False)
768 769 770 771 772 773 774 775 776 777 778 779


def call_node_volumes(node_list):
  """Gets all volumes on node(s).

  This is a multi-node call.

  """
  c = Client("node_volumes", [])
  c.connect_list(node_list)
  c.run()
  return c.getresult()