Home | History | Annotate | Download | only in loadstress
      1 #
      2 # CDDL HEADER START
      3 #
      4 # The contents of this file are subject to the terms of the
      5 # Common Development and Distribution License (the "License").
      6 # You may not use this file except in compliance with the License.
      7 #
      8 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
      9 # or http://www.opensolaris.org/os/licensing.
     10 # See the License for the specific language governing permissions
     11 # and limitations under the License.
     12 #
     13 # When distributing Covered Code, include this CDDL HEADER in each
     14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
     15 # If applicable, add the following below this CDDL HEADER, with the
     16 # fields enclosed by brackets "[]" replaced with your own identifying
     17 # information: Portions Copyright [yyyy] [name of copyright owner]
     18 #
     19 # CDDL HEADER END
     20 #
     21 
     22 #
     23 # Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
     24 # Use is subject to license terms.
     25 #
     26 # ident	"@(#)README	1.1	08/11/15 SMI"
     27 #
     28 
     29 README: STC2 NFS Load and Stress test suite
     30 
     31 1. Introduction
     32 ===============
     33 
     34 The test suite is a collection of load/stress tests to test the stablibility
     35 of the NFS server.
     36 
     37 2. System Requirements
     38 ======================
     39 
     40 There is no hareware requirement for running this test sutie; however,
     41 due to the nature of the tests to add loads and stress to the server,
     42 it is expected that the server is a "good" system that have enough
     43 disk and memory. The current workloads_in_zones would run better if
     44 both the server and client have at least 2GB memory and 100GB disk
     45 for testing (in addition to the partition for the OS).
     46 
     47 See tests/workloads_in_zones/README for more information on this.
     48 
     49 3 INSTALLATION
     50 ==============
     51   You can install the suite package, or install the suite source and
     52   build by yourself.
     53 
     54   1. Installing from Packages:
     55      If the test suite is available in package format from a server,
     56      you can use the standard Solaris package installation tool
     57      pkgadd(1M) to install to your test system for executeion.
     58      You must be as root to do that and simply run the following command.
     59 
     60         # pkgadd -d <package location>  SUNWstc-nfs-loadstress
     61 
     62      Where <package location> refers to the path containing the
     63      SUNWstc-nfs-loadstress package directory.
     64 
     65      It is recommended that you install the packages from scratch,
     66      rather than on top of an existing installation.  Thus, if an
     67      old version of the tests is installed:
     68 
     69         # pkgrm SUNWstc-nfs-loadstress
     70 
     71      It is also acceptable to use an nfs accessible version of the
     72      SUNWstc-nfs-loadstress package.
     73 
     74   2. Installing the Test Suite Source
     75      You can install the suite source locally as any user.
     76 
     77 
     78 4. UNINSTALLATION
     79 =================
     80   Prior to uninstalling the test suite, you may want to run
     81   stf_unconfigure to make sure the system is cleaned up.
     82 
     83   1. Uninstalling the Test Suite Package:
     84      Use the standard Solaris package installation tool pkgrm(1M) to
     85      uninstall the package as root:
     86 
     87      # pkgrm SUNWstc-nfs-loadstress
     88 
     89   2. Uninstalling the Test Suite Source
     90      You can remove the corresponding directory.
     91 
     92 5. BUILDING
     93 ===========
     94   If the suite is installed from packages, you can skip this section.
     95   To build the test suite from source, user needs the STF tools, to
     96   create the test executables and the package.
     97 
     98   Briefly, this build and installation is performed as follows:
     99 
    100     (set path to STF bin directory)
    101     % PATH=<path-to-STF>/bin/`uname -p`:$PATH
    102     % export PATH
    103 
    104     (To build the proto tree)
    105     % cd your_ws/.../suites/nfs/loadstress
    106     % stf_build install
    107 
    108     (Now to build and install the package)
    109     % stf_build package
    110     % cd your_ws/.../packages/`uname -p`
    111     % sudo pkgadd -d . SUNWstc-nfs-loadstress
    112 
    113 6. How to Run It
    114 ================
    115 
    116   You can run the test with STF tools, or just execute the commands;
    117   however you have to get into the sub-directory to run the tests.
    118   For example:
    119     # cd /opt/SUNWstc-nfs-loadstress/tests/workloads_in_zones
    120       (make sure STF tools are in your $PATH)
    121     # export SERVER=your_server_hostname
    122     # export SRV_ZFSDISK=srv_test_zfs_poolname
    123     # export ZONELIST="zone1 zone2 zone3 zone4 zone5"
    124     # export ZONE_SETUP=no
    125       (if ZONE_SETUP=no, user MUST make sure all the zones listed
    126        in $ZONELIST are running correctly, with the rsh/rcp enabled)
    127     # stf_configure
    128     # stf_execute -m `uname -p`
    129     # stf_unconfigure
    130 
    131   Or if you don't want to use STF tools, do the following after setting
    132   all the variables (same as above, except the last 3 steps):
    133     # ./setup
    134     # ./runtests
    135     # ./cleanup
    136 
    137   Please read the README file under the test sub-directory for procedure
    138   how to setup the test environment and run the workload tests.
    139 
    140 
    141 END of README file
    142 ==================
    143