Sun OpenSSO Enterprise 8.0 Installation and Configuration Guide

Installing and Configuring the OpenSSO Enterprise Session Failover Components

To install and configure the OpenSSO Enterprise session failover components, follow this procedure on each server in the Message Queue broker cluster:

Unzipping the ssoSessionTools.zip File

The ssoSessionTools.zip file, which is part of the opensso_enterprise_80.zip file, contains the session failover scripts, JAR, properties, and related files.

ProcedureTo Unzip the ssoSessionTools.zip File

Before You Begin

Unzip the opensso_enterprise_80.zip file. The ssoSessionTools.zip file is then available in the zip-root/opensso/tools directory, where zip-root is where you unzipped opensso_enterprise_80.zip.

  1. Log in to the server where you want to install and configure the session failover components.

  2. Create a new directory to unzip the ssoSessionTools.zip. For example: sfo-zip-root

  3. Copy the ssoSessionTools.zip file to the new directory.

  4. Unzip the ssoSessionTools.zip file in the new directory.

    The following table describes the layout after you unzip the ssoSessionTools.zip file. The directory where you unzip ssoSessionTools.zip is represented by sfo-zip-root.

    sfo-zip-root File or Directory

    Description 

    README.txt

    Description of the ssoSessionTools.zip file.

    setup

    Script to install the session tools on Solaris and Linux systems. 

    setup.bat

    Script to install the session tools on Windows systems. 

    ext directory

    • Message Queue JAR files for Solaris SPARC, Solaris x86, Linux. and Windows systems.

    • Oracle Berkeley DB JAR file (je.jar)

    lib directory

    • JAR file for the setup scripts (am_session_setup.jar)

    • JAR file for the session API (am_sessiondb.jar)

    locale directory

    Properties file for the session API (amSessionDB.properties)

    template directory

    Script templates for Solaris, Linux, and Windows systems. 

Running the Session Failover setup Script

The session failover setup script installs these files:

ProcedureTo Run the Session Failover setup Script

Before You Begin
  1. In the directory where you unzipped the ssoSessionTools.zip file, run the setup script.

    On Solaris and Linux systems, use this syntax to run the setup script:

    setup -p|--path dirname

    where dirname is a directory under the current directory where the setup script places the session failover scripts and related files. If dirname does not exist, the script will create the directory for you.

    For example: # ./setup -p sfo

    Considerations:

    • On Windows systems, run the setup.bat script.

    • If you run the setup script without any options, the script prompts you for a path.

    • If the path contains a space, run the setup script without any options and then provide the path when you are prompted.

    • To display the help for the setup script: setup -h|--help

    The setup (or setup.bat) script installs the session failover scripts and related files in the following directories:

    sfo-zip-root Directory

    Script or File 

    jmq/mq

    Message Queue scripts and related files 

    dirname/config/lib

    amsfo.conf session failover configuration file

    dirname/bin

    • Scripts to start and stop the Message Queue broker and amsessiondb client:

      • amsfo on Solaris and Linux systems

      • amsfo.pl on Windows systems

    • Scripts to run the Oracle Berkeley DB client (called by amsfo):

      • amssessiondb on Solaris and Linux systems

      • amssessiondb.bat on Windows systems

    • Scripts to encrypt the password for the Message Queue broker user (default is guest):

      • amsfopassword on Solaris and Linux systems

      • amsfopassword.bat on Windows systems

Editing the amsessiondb Script (if Needed)

The amsfo script calls amsessiondb to start the Oracle Berkeley DB client (amsessiondb), create the database, and set specific database values. The amsessiondb script contains variables that specify various default paths and directories. For example:

JAVA_HOME=/usr/jdk/entsys-j2se/
AM_HOME=/opensso/tools/sfo-zip-root/sfo
JMS_JAR_PATH=/usr/share/lib
IMQ_JAR_PATH=/usr/share/lib
BDB_JAR_PATH=/usr/share/db.jar
BDB_SO_PATH=/usr/lib

If any of these components are not installed in the directories shown in the amsessiondb script, edit the script and set each variable, as needed, to the path where the component is installed.

Encrypting the Message Queue Broker Password Using the amsfopassword Script (Required)

The amsfopassorwd script accepts the password for the Message Queue broker user (default is guest) in clear text and returns the encrypted password in a file. You can then use this file as input to the amsfo script by setting the PASSWORDFILE variable in the amsfo.conf configuration file.

To run the amsfopassword script, use the following syntax:

amsfopassword
-f|--passwordfile password-file -e|--encrypt clear-text-password

To display help, specify -h|--help.

ProcedureTo Encrypt the Message Queue Broker Password Using the amsfopassword Script

  1. On the server where you ran the setup script, run the amsfopassword script.

    For example, on a Solaris system:

    # cd /sfo-zip-root/sfo/bin
    # ./amsfopassword -f /sfo-zip-root/sfo/mqpassword -e clear-text-password
    

    You are not required to run amsfopassword as superuser (root).

  2. Use the encrypted password in the mqpassword file as input to the amsfo script by setting the PASSWORDFILE variable in the amsfo.conf file.

    For information about the PASSWORDFILE variable, see Table 8–1.

Running the amsfo Script to Start and Stop the Session Failover Components

The amsfo script (or amsfo.pl on Windows systems) reads variables in the amsfo.conf configuration file and then performs these functions:

To run the script on Windows systems, Active Perl version 5.8 or later is required.

To run amsfo, use the following syntax:

amsfo start | stop

The amsfo command then automatically finds the amsfo.conf file.

The following table describes the variables in the amsfo.conf file. Some variables are set when you run the setup (or setup.pl) script. Before you run the amsfo script, set other variables as required for your deployment.

Table 8–1 amsfo.conf Configuration File Parameters

Variable 

Description 

AM_HOME_DIR

Specifies the following directory: sfo-zip-root/dirname

where: 

  • sfo-zip-root is where you unzipped the ssoSessionTools.zip file.

  • dirname is the name you specified when you ran the setup script to install the session failover scripts and related files.

AM_SFO_RESTART

Specifies (true or false) whether the script should automatically restart the Oracle Berkeley DB client (amsessiondb).

The default is true (restart the amsessiondb client).

CLUSTER_LIST

Specifies the Message Queue broker list participating in the cluster. The format is:  

host1:port,host2:port, ... hostn:port

For example:  

mq1.example.com:7777,mq2.example.com:7777,mq3.example.com:7777

You can deploy the Message Queue brokers on the same servers that are running OpenSSO Enterprise instances. However, for improved performance, consider installing the brokers on different servers. 

DATABASE_DIR

Specifies the directory where the session database files will be created.  

Default: /tmp/amsession/sessiondb

DELETE_DATABASE

Specifies (true or false) whether the script should delete and then create a new database each time the Oracle Berkeley DB client (amsessiondb) is restarted.

Default: true

LOG_DIR

Specifies the location of the log directory.  

Default: /tmp/amsession/logs

START_BROKER

Specifies (true or false) whether the Message Queue broker should be started with the amsessiondb process on the same server:

true - The Message Queue broker will run on the same server as the amsessiondb process.

false - The Message Queue broker and the amsessiondb process will run on different servers.

Default: true

BROKER_INSTANCE_NAME

Specifies the name of the Message Queue broker instance to start.  

For example: mqbroker

BROKER_PORT

Specifies the port for the local Message Queue broker instance.  

Default: 7777 

BROKER_VM_ARGS

Specifies the Java VM arguments. Set to a maximum of 1024m, based on the system resources.

Default: "-Xms256m -Xmx512m"

USER_NAME

Specifies the user name used to connect to the Message Queue broker. 

Default: guest

PASSWORDFILE

Location of the password file that contains the encrypted password of the user name (default is guest) used to connect to the Message Queue broker. To generate the encrypted password, use the amsfopassword script, as described in Encrypting the Message Queue Broker Password Using the amsfopassword Script (Required).

Default: sfo-zip-root/dirname/.password

AMSESSIONDB_ARGS

amsessiondb script arguments.

The amsessiondb script is called by the amsfo (or amsfo.pl) script. To determine the list of arguments, run: amsession db -h

ProcedureTo Run the amsfo Script

Before You Begin

Stop each of the OpenSSO Enterprise instances in the session failover deployment.

  1. Set the variables in the amsfo.conf file, as required for your deployment.

    For a description of all variables, see Table 8–1.

  2. Run the amsfo script on Solaris or Linux systems or the amsfo.pl script on Windows systems.

    For example, to start the session failover components on a Solaris system:

    # cd /sfo-zip-root/sfo/bin
    # ./amsfo start

    The amsfo command then automatically finds the amsfo.conf file and displays status information as it runs.

  3. To check the results, see the /var/tmp/amsfo.log file.