Home | History | Annotate | Download | only in doc
      1 This document describes the environment variables found in the pounder30 package
      2 as of 2011-8-09.
      3 
      4 Author:
      5 Lucy Liang <lgliang (a] us.ibm.com>
      6 
      7 Copyright (C) 2011 IBM.
      8 
      9 Contents
     10 ========
     11 1. The libpounder.sh File
     12 2. The config File
     13 
     14 The libpounder.sh File
     15 ======================
     16 The "libpounder.sh" file defines most of the environment variables used in the test
     17 suite and referenced throughout the documentation. These variables are not
     18 intended to be modified by the user, although they can be if customization is desired.
     19 Below is a brief description of these variables (see libpounder.sh for details):
     20 
     21 	DATE			- the current date, used for logging
     22 	DEFAULT_SCHEDPACK	- name of the default test scheduler, "default"
     23 	TESTS			- list of scripts from the test_scripts/ directory
     24 	BUILDS			- list of scripts from the build_scripts/ directory
     25 	POUNDER_HOME		- the pounder/ directory
     26 	POUNDER_PIDFILE		- pid file created when running pounder
     27 	POUNDER_LOGLOCAL	- the log/ directory where output of ALL pounder runs
     28 				get logged
     29 	POUNDER_LOGDIR		- the log/$DATE directory where output of only the
     30 				current pounder run get logged
     31 	POUNDER_TMPDIR		- the tmp/ directory used for storing temporary files
     32 				used for test runs
     33 	POUNDER_OPTDIR		- the opt/ directory used for storing third party packages
     34 				used by subtests, which can be fetched from web or from
     35 				a user-created cache (see $POUNDER_CACHE below)
     36 	POUNDER_SRCDIR		- the src/ directory containing source files packaged with
     37 				pounder
     38 	POUNDER_VERSION		- the pounder version
     39 	NR_CPUS			- the number of cpus on the system
     40 
     41 The config File
     42 ===============
     43 The "config" file defines a few environment variables that ARE intended to be modified
     44 by the user for customizing pounder runs. The variables are described below:
     45 
     46 	DURATION		- Time in seconds for pounder to run. Setting this variable
     47 				to 0 will not put an upper bound on pounder run time.
     48 
     49 	MAX_FAILURES		- Maximum number of test failures allowed for each subtest
     50 				using infinite_loop or timed_loop (see the "Running Tests Repeatedly"
     51 				section in SCHEDULER for more info on these two procedures) before aborting.
     52 				Setting this variable to 0 will not put an upper bound on any
     53 				subtest failures.
     54 
     55 
     56 	NFS_LOGGING             - Enables/disables NFS logging. Setting this variable to
     57 				1 will enable NFS logging of pounder output; pounder will
     58                              	log output to remote directory on NFS server specified
     59                                 by $NFS_LOGDIR and  $NFS_LOGSERVER (see below), which
     60                                 will be mounted on $POUNDER_LOGLOCAL (see libpounder.sh).
     61                                 Setting this variable to 0 will disable this feature; all
     62 				output for pounder runs will be stored locally directly in
     63 				$POUNDER_LOGLOCAL instead.
     64 
     65 	NFS_LOGSERVER           - IP address of the NFS server to use for logging pounder results.
     66 				NFS_LOGGING should be enabled to use this feature.
     67 
     68 	NFS_LOGDIR		- Path to the log directory on $NFS_LOGSERVER; If $NFS_LOGGING
     69 				is enabled, pounder will attempt to mount $NFS_LOGSERVER:$NFS_LOGDIR/
     70 				on $POUNDER_LOGLOCAL (see libpounder.sh).
     71 
     72 	POUNDER_CACHE  		- Address of the cache to use for fetching outside packages,
     73                         	The cache is a user-created web-accessible directory
     74                         	containing cached tarballs/scripts/etc. used for
     75                         	the various tests you intend to build. This is optional
     76                         	but useful for saving download time and keeping everything in one place.
     77 
     78 				For instance, the build_kernel subtest requires downloading a
     79 				linux kernel tarball during build time (see build_scripts/build_kernel).
     80 				Instead of calling "wget http://www.kernel.org/pub/linux/kernel/v2.6/$TARNAME"
     81 				to retrieve the tarball, we can pre-download and store it in a user-created online
     82 				directory, then call "wget ${POUNDER_CACHE}${TARNAME}," where POUNDER_CACHE
     83 				is the address of the directory. Other provided subtests: bonnie++, lame, ipmitool,
     84 				and memtest also make use of this cache.
     85 
     86 				Examples of some things you may want to include in your cache for building
     87 				the provided tests:
     88 					bonnie++-1.03e.tgz	(for the bonnie++ subtest)
     89 					linux-2.6.39.tar.gz	(for the build_kernel subtest)
     90 					ipmitool-1.8.9.tar.gz	(for the ipmitool subtest)
     91 					...
     92 
     93 				These can be found in $POUNDER_OPTDIR after you run "make install" on the
     94 				default package.
     95 
     96 	[These variables below are used by specific subtests contained in the provided default
     97 	test scheduler, but they can be incorporated into other user-defined subtests as well.]
     98 
     99 	DO_X_TESTS		- 0 disables X system testing, 1 enables X system testing.
    100 				Used by the xterm_stress subtest.
    101 
    102 
    103 	NFS_SERVER=0		- IP address of the NFS server to use for nfs and ping_nfs
    104 				subtests. Setting this variable to 0 disables nfs testing.
    105 
    106 	NTP_SERVER		The NTP server to use. By default, it's set to pool.ntp.org.
    107 				Used by the time_drift subtest.
    108