Cross Reference: /test/stcnv/usr/src/suites/nfs/loadstress

#
# CDDL HEADER START
#
# The contents of this file are subject to the terms of the
# Common Development and Distribution License (the "License").
# You may not use this file except in compliance with the License.
#
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
# or http://www.opensolaris.org/os/licensing.
# See the License for the specific language governing permissions
# and limitations under the License.
#
# When distributing Covered Code, include this CDDL HEADER in each
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
# If applicable, add the following below this CDDL HEADER, with the
# fields enclosed by brackets "[]" replaced with your own identifying
# information: Portions Copyright [yyyy] [name of copyright owner]
#
# CDDL HEADER END
#

#
# Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
# Use is subject to license terms.
#
# ident	"@(#)README	1.1	08/11/15 SMI"
#

README: STC2 NFS Load and Stress test suite

1. Introduction
===============

The test suite is a collection of load/stress tests to test the stablibility
of the NFS server.

2. System Requirements
======================

There is no hareware requirement for running this test sutie; however,
due to the nature of the tests to add loads and stress to the server,
it is expected that the server is a "good" system that have enough
disk and memory. The current workloads_in_zones would run better if
both the server and client have at least 2GB memory and 100GB disk
for testing (in addition to the partition for the OS).

See tests/workloads_in_zones/README for more information on this.

3 INSTALLATION
==============
  You can install the suite package, or install the suite source and
  build by yourself.

  1. Installing from Packages:
     If the test suite is available in package format from a server,
     you can use the standard Solaris package installation tool
     pkgadd(1M) to install to your test system for executeion.
     You must be as root to do that and simply run the following command.

        # pkgadd -d <package location>  SUNWstc-nfs-loadstress

     Where <package location> refers to the path containing the
     SUNWstc-nfs-loadstress package directory.

     It is recommended that you install the packages from scratch,
     rather than on top of an existing installation.  Thus, if an
     old version of the tests is installed:

        # pkgrm SUNWstc-nfs-loadstress

     It is also acceptable to use an nfs accessible version of the
     SUNWstc-nfs-loadstress package.

  2. Installing the Test Suite Source
     You can install the suite source locally as any user.


4. UNINSTALLATION
=================
  Prior to uninstalling the test suite, you may want to run
  stf_unconfigure to make sure the system is cleaned up.

  1. Uninstalling the Test Suite Package:
     Use the standard Solaris package installation tool pkgrm(1M) to
     uninstall the package as root:

     # pkgrm SUNWstc-nfs-loadstress

  2. Uninstalling the Test Suite Source
     You can remove the corresponding directory.

5. BUILDING
===========
  If the suite is installed from packages, you can skip this section.
  To build the test suite from source, user needs the STF tools, to
  create the test executables and the package.

  Briefly, this build and installation is performed as follows:

    (set path to STF bin directory)
    % PATH=<path-to-STF>/bin/`uname -p`:$PATH
    % export PATH

    (To build the proto tree)
    % cd your_ws/.../suites/nfs/loadstress
    % stf_build install

    (Now to build and install the package)
    % stf_build package
    % cd your_ws/.../packages/`uname -p`
    % sudo pkgadd -d . SUNWstc-nfs-loadstress

6. How to Run It
================

  You can run the test with STF tools, or just execute the commands;
  however you have to get into the sub-directory to run the tests.
  For example:
    # cd /opt/SUNWstc-nfs-loadstress/tests/workloads_in_zones
      (make sure STF tools are in your $PATH)
    # export SERVER=your_server_hostname
    # export SRV_ZFSDISK=srv_test_zfs_poolname
    # export ZONELIST="zone1 zone2 zone3 zone4 zone5"
    # export ZONE_SETUP=no
      (if ZONE_SETUP=no, user MUST make sure all the zones listed
       in $ZONELIST are running correctly, with the rsh/rcp enabled)
    # stf_configure
    # stf_execute -m `uname -p`
    # stf_unconfigure

  Or if you don't want to use STF tools, do the following after setting
  all the variables (same as above, except the last 3 steps):
    # ./setup
    # ./runtests
    # ./cleanup

  Please read the README file under the test sub-directory for procedure
  how to setup the test environment and run the workload tests.


END of README file
==================
`Name`	`Date`	`Size`
Up to higher level directory
`config.vars`	17-Jun-2009	`1.5K`
`include/`	17-Jun-2009
`Makefile`	17-Jun-2009	`1.2K`
`README`	17-Jun-2009	`4.6K`
`STC.INFO`	17-Jun-2009	`4.1K`
`STF.INFO`	17-Jun-2009	`1,016`
`tests/`	17-Jun-2009