lustre-iokit/obdsurvey/README

   1 Lustre IO-Kit is a collection of benchmark-tools for a cluster with
   2 the lustre filesystem.
   3
   4 Currently only a Object Block Device-survey are included, but the kit may
   5 be extended with blockdevice- and filesystem- survey in the future.
   6
   7 Copyright (c) 2005 Scali AS. All Rights Reserved.
   8
   9 = Prerequisites
  10
  11 - python2.2 or newer, available at /usr/bin/python2
  12 - the "logging"-module from python2.3
  13 - Passwordless remote access to nodes in the system, through
  14   ScaSH (The Scali parallel shell) or SSH.
  15
  16
  17 = Interfaces
  18
  19 Two interfaces to OBD-survey; a python library interface and a command
  20 line interface.
  21
  22 The python library interface is documented in pydoc. Use
  23 "pydoc lustre_obdsurveylib" for information about the interface.
  24
  25 The command line interface is accessed through the "lustre_obdsurvey"
  26 application. Running the application with "--help" will list the
  27 various options.
  28
  29 lustre_obdsurvey implements 3 seperate test-modes:
  30
  31 - Disk IO
  32
  33 This testmode will set up a echo_client connected to existing obdfilters,
  34 and test the local disk-io performance on the fileservers. You need to list
  35 the names of the obdfilters you wish to test, and what nodes they are on,
  36 like this:
  37     lustre_obdsurvey --diskio server1:test_ost00 server2:test_ost01 ....
  38
  39 - Network IO
  40
  41 This testmode will set up pairs of obdecho and echo_clients, to test the
  42 network bandwith between pairs of nodes in the cluster. You need to list the
  43 pairs of nodes to test, like this:
  44     lustre_obdsurvey --networkio server1:client1 server2:client2 ....
  45
  46 - Remote Disk IO
  47
  48 This testmode will set up a echo_client that accesses a remote obdfilter-
  49 device, basically combining the two previous tests. The test assumes that the
  50 client already have a OSC-device configured for the remote obdfilter. You
  51 need to specify the names of the osc-devices and the nodes they are on like
  52 this:
  53     lustre_obdsurvey --networkdiskio client1:osc_server1_ost00 client2:osc_server2_ost00 ...
  54
  55
  56 lustre_obdsurvey will then run a benchmark in parallel across all listed
  57 devices, and list the results. The following options apply to all test-modes:
  58
  59 --pagesize=PAGESIZE: Set the pagesize for your nodes. Defaults to 4 KB.
  60
  61 --size=SIZE: Set the size of the dataset to use for the tests. Defaults to 100 MB.
  62     Make sure the size of the dataset is larger than the cache of your storage-devices.
  63
  64 --minrecordsize=MINRECORDSIZE
  65 --maxrecordsize=MAXRECORDSIZE
  66     Test performance with recordsizes in the range [MINRECORDSIZE, MAXRECORDSIZE]. By
  67     default only 1 MB recordsizes are used.
  68
  69 --minthreads=MINTHREADS
  70 --maxthreads=MAXTHREADS
  71     Test performance with [MINTHREADS, MAXTHREADS] number of threads for each client.
  72     By default the range [1, 16] is tested.