Sun Java System Access Manager 7 2005Q4 Performance Tuning Guide

Overview of the Access Manager Tuning Scripts

The Access Manager tuning scripts are non-interactive. To run a script, you first edit the parameters in the amtune-env configuration file to specify the tuning options you want to set for your specific environment. Then, you run either the amtune script, which calls other scripts as needed, or a specific script. For example, you might run only the amtune-identity script to tune only Access Manager.

The Access Manager tuning scripts and the amtune-env configuration file are installed in the following directory, depending on your platform:

Solaris systems: AccessManager-base/SUNWam/bin/amtune
Linux systems: AccessManager-base/identity/bin/amtune

AccessManager-base is the Access Manager 7 2005Q4 base installation directory. The default base installation directory is /opt on Solaris systems and /opt/sun on Linux systems.

The following table describes the tuning scripts that are available in the Access Manager 7 2005Q4 release.

Table 2–1 Access Manager Tuning Scripts


Script	Description
`amtune`	Wrapper script that calls other scripts based on values in the `amtune-env` file.
`amtune-identity`	Tunes the installed instance of Access Manager.
`amtune-os`	Tunes the Solaris OS kernel and TCP/IP parameters.
`amtune-ws61`	Tunes the Sun Java System Web Server 2005Q4 (6.1) Web container.
`amtune-as8`	Tunes the Sun Java System Application Server Enterprise Edition 8 (8.1) Web container.
`amtune-as7`	Tunes the Sun Java System Application Server 7 Web container.
`amtune-prepareDSTuner`	Generates the `amtune-directory` script, which you can use to tune the Directory Server that supports Access Manager. For more information, see Chapter 3, Directory Server Tuning.

Tuning Modes

The Access Manager tuning scripts can run in the following modes, as determined by the AMTUNE_MODE parameter in the amtune-env file.

REVIEW mode (default). The scripts return tuning recommendations for an Access Manager deployment, but they do not make any actual changes to the environment.
CHANGE mode. The scripts make all of the tuning modifications that are defined in the amtune-env file, except for Directory Server. For more information, see Chapter 3, Directory Server Tuning.

In either mode, the scripts return a list of tuning recommendations to the amtune debug log file and the terminal window. The location of the log file is determined by the com.iplanet.services.debug.directory parameter in the AMConfig.properties file. The default debug directory depends on your platform:

Solaris systems: /var/opt/SUNWam/debug
Linux systems: /var/opt/sun/identity/debug

Caution –

Tuning is an iterative process that can vary for different deployments. The Access Manager tuning scripts try to apply the optimal tuning parameter settings. However, each deployment is unique and might require further customization to suit specific requirements.

Therefore, use CHANGE mode only after you have reviewed and understand the tuning changes that will be applied to your deployment.

Running an Access Manager Tuning Script

To run a tuning script, use the following syntax:

amtune-script admin_password dirmanager_password [ as8_admin_password ]

The tuning script parameters are:

amtune-script is one of the tuning scripts: amtune, amtune-identity, amtune-os, amtune-ws61, amtune-as7, amtune-as8, or amtune-prepareDSTuner.
admin_password is the Access Manager Administrator password.
dirmanager_password is the Directory Manager (cn=Directory Manager) password.
as8_admin_password is the Administrator password that is required if you are tuning Application Server (WEB_CONTAINER is set to AS8).

To Run a Tuning Script

This section describes the basic steps to run an Access Manager Tuning script.

Steps

If you have not run the scripts in REVIEW mode, ensure that AMTUNE_MODE is set to REVIEW (default value) in the amtune-env file.

Edit other parameters in the amtune-env file, depending on the components you want to tune:
- Access Manager amtune-env file parameters
- Installation environment tuning parameters
- Application Server 8 Tuning Parameters (if Application Server 8 is the web container)
To tune the Directory Server that supports Access Manager, see Chapter 3, Directory Server Tuning.

In REVIEW mode, run either the amtune script or one of the component scripts.

Review the tuning recommendations in the debug log file. If needed, make changes to the amtune-env file based on this run.

If you are satisfied with the tuning recommendations from the REVIEW mode run, set AMTUNE_MODE to CHANGE in the amtune-env file.

In CHANGE mode, run either the amtune script or one of the component scripts. For example, to tune the Solaris OS, run amtune-os, as follows:
# ./amtune-os admin_password dirmanager_password

Check the debug log file for the results of the run.

Note –
In CHANGE mode, the amtune script might need to restart the Web container and Access Manager. In some instances, amtune might also recommend a system restart.