Sun Java System Access Manager Policy Agent 2.2 Guide for IBM WebSphere Portal Server 5.1.0.2

Chapter 3 Installing Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2

Sun JavaTM System Access Manager Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2, as with all J2EE agents in the 2.2 release of Policy Agent, is installed from the command line using the agentadmin program. For more information about the tasks you can perform with the agentadmin program, see Role of the agentadmin Program in a J2EE Agent for Policy Agent 2.2.


Note –

When installing Agent for IBM WebSphere Portal Server 5.1.0.2, you must run the agent installation program on every instance of the underlying IBM WebSphere Application Server. Typically, this includes two instances: the default instance, often named server1, and the IBM WebSphere Portal Server instance, often named WebSphere_Portal. This type of deployment is necessary since the security configuration in IBM WebSphere Application Server has global scope and cannot be performed independently for any particular instance of the server.


Before reading this chapter or performing any of the tasks described within, thoroughly review Chapter 2, Vital Installation Information for a J2EE Agent in Policy Agent 2.2 since various key concepts are introduced in that chapter.

This chapter is organized into the following sections:

Before describing any task, this chapter provides you with installation-related information specific to IBM WebSphere Portal Server 5.1.0.2. The subsequent sections lead you through the pre-installation and installation steps and describe how to view the installation log files. First, perform the pre-installation (preparation) steps. Then, perform the installation, itself. The installation process has two phases. The first phase of the installation includes launching the installation program, which requires a directory to already have been selected for the agent files. The second phase of the installation involves interacting with the installation program. During this phase, the program prompts you step by step to enter information. Accompanying the prompts, are explanations of the type of information to enter. After you complete the installation, you can look at the installation log files.

Once you have completed the steps described in this chapter, complete the applicable post-installation tasks described in Chapter 4, Post-Installation Tasks of Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2.

Installation Related Information About Agent for IBM WebSphere Portal Server 5.1.0.2

The following sections provide important information about Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2 required before you install the agent.

Supported Platforms and Compatibility of Agent for IBM WebSphere Portal Server 5.1.0.2

The following sections provide information about the supported platforms of Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2 as well as the compatibility of this agent with Access Manager.

Platform and Version Support of Agent for IBM WebSphere Portal Server 5.1.0.2

The following table presents the platforms supported by Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2.

Table 3–1 Platform and Version Support of Agent for IBM WebSphere Portal Server 5.1.0.2

Agent for 

Supported Policy Agent Version 

Supported Access Manager Versions 

Supported Platforms 

IBM WebSphere Portal Server 5.1.0.2 deployed on: 

  • IBM WebSphere Application Server 5.1.1.7

  • IBM WebSphere Business Integration-Server Foundation 5.1.1

Version 2.2 

Version 6.3 Patch 1 or greater 

Version 7 

SolarisTM Operating System (OS) for the SPARC® platform, versions 8, 9, and 10

AIX 5L version 5.2 

Windows 2003, Enterprise Edition 

Windows 2003, Standard Edition 

Compatibility of Agent for IBM WebSphere Portal Server 5.1.0.2 With Access Manager

Compatibility of Policy Agent 2.2 With Access Manager 7

All agents in the Policy Agent 2.2 release are compatible with Access Manager 7. Compatibility applies to both of the available modes of Access Manager: Realm Mode and Legacy Mode.

Install the latest Access Manager 7 patches to ensure that all enhancements and fixes are applied. For information about the latest Access Manager 7 patches, see the compatibility information discussed in Sun Java System Access Manager Policy Agent 2.2 Release Notes.

Compatibility of Policy Agent 2.2 With Access Manager 6.3

All agents in Policy Agent 2.2 are also compatible with Access Manager 6.3 Patch 1 or greater. However, certain limitations apply. For more information, see J2EE Agent Backward Compatibility With Access Manager 6.3.

Preparing to Install Agent for IBM WebSphere Portal Server 5.1.0.2

Detailed information about unpacking the distribution files for J2EE agents in Policy Agent 2.2 is covered in Chapter 2, Vital Installation Information for a J2EE Agent in Policy Agent 2.2. The best practice is to follow the detailed steps outlined in that chapter before you implement any steps outlined in this chapter.

The following examples provide quick details about the unpacking process. Furthermore, this section provides the opportunity to present again the cautionary note that follows about the GNU_tar program.


Caution – Caution –

For .tar.gz archives, do not use a program other than GNU_tar to untar the contents of the J2EE agent deliverables. Using a different program, such as another tar program, can result in some files not being extracted properly. To learn more about the GNU_tar program, visit the following web site:

http://www.gnu.org/software/tar/tar.html



Example 3–1 Format of the Distribution Files of Agent for IBM WebSphere Portal Server 5.1.0.2

SJS_WebSphere_Portal_5102_agent_2.2.tar.gz
SJS_WebSphere_Portal_5102_agent_2.2.zip
SJS_WebSphere_Portal_5102_agent_2.2_SUNWamwps.tar.gz

For detailed information on the format of the distribution files, see Format of the Distribution Files for a J2EE Agent Installation in Policy Agent 2.2.



Example 3–2 Unpacking Non-Package Formatted Deliverables of Agent for IBM WebSphere Portal Server 5.1.0.2

# gzip -dc SJS_WebSphere_Portal_5102_agent_2.2.tar.gz | tar xvf -

For detailed information about this command, see To Unpack Non-Package Formatted Deliverables of a J2EE Agent in Policy Agent 2.2.



Example 3–3 Unpacking Package Formatted Deliverables of Agent for IBM WebSphere Portal Server 5.1.0.2


# gzip -dc SJS_WebSphere_Portal_5102_agent_2.2_SUNWamwps.tar.gz | tar xvf -

For detailed information about this command, see To Unpack Package Formatted Deliverables of a J2EE Agent in Policy Agent 2.2.



Example 3–4 Unpacking a .zip Compressed file of Agent for IBM WebSphere Portal Server 5.1.0.2

unzip SJS_WebSphere_Portal_5102_agent_2.2.zip

For detailed information about this command, see To Unpack a .zip Compressed file of a J2EE Agent in Policy Agent 2.2.


Follow the specific steps outlined in the following section before you install the agent to reduce the chance of complications occurring during and after the installation.

ProcedureTo Prepare to Install Agent for IBM WebSphere Portal Server 5.1.0.2

Perform the following pre-installation tasks:

  1. Ensure that the Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2 is supported on the desired platform as listed in Supported Platforms and Compatibility of Agent for IBM WebSphere Portal Server 5.1.0.2.

  2. Install IBM WebSphere Portal Server 5.1.0.2 if not already installed.

    You can visit http://www.ibm.com to download the IBM WebSphere Portal Server 5.1.0.2 software.

  3. (Conditional) If the IBM WebSphere Portal Server 5.1.0.2 instance or the underlying IBM WebSphere Application Server instance on which you are about to install the agent is running, shut it down.

  4. Create a valid agent profile in Access Manager Console if one has not already been created.

    For information on how to create an agent profile, see Creating a J2EE Agent Profile.

    To avoid a misconfiguration of the agent, ensure that you know the exact ID and password used to create the agent profile. You must enter the agent profile password correctly in the next step and you must enter the agent profile ID correctly when installing the agent.

  5. Create a text file and add the agent profile password to that file.

    Ensure that this file is located in a secure directory of your choice. You will refer to this file during the agent installation process.

    With the agent profile password in this file, stored in a secure location, you are not required to enter sensitive information in the console. A valid password file can have only one line that contains the agent profile password.

Launching the Installation Program of Agent for IBM WebSphere Portal Server 5.1.0.2

Once you have performed all the pre-installation steps, you can launch the installation program as described in the following subsection.

ProcedureTo Launch the Installation Program of Agent for IBM WebSphere Portal Server 5.1.0.2

To launch the installation program, perform the following steps:

  1. Change to the following directory:


    PolicyAgent-base/bin

    This directory contains the agentadmin program, which is used for installing a J2EE agent and for performing other tasks. For more information on the agentadmin program, see Role of the agentadmin Program in a J2EE Agent for Policy Agent 2.2.

  2. Issue the following command:


    ./agentadmin --install
  3. (Conditional) If you receive license agreement information, accept or reject the agreement prompts. If you reject any portion of the agreement, the program will end.

    The license agreement is displayed only during the first run of the agentadmin program.

Using the Installation Program of Agent for IBM WebSphere Portal Server 5.1.0.2


Note –

When installing Agent for IBM WebSphere Portal Server 5.1.0.2, you must run the agent installation program on every instance of the underlying IBM WebSphere Application Server. Typically, this includes two instances: the default instance, often named server1, and the IBM WebSphere Portal Server instance, often named WebSphere_Portal. This type of deployment is necessary since the security configuration in IBM WebSphere Application Server has global scope and cannot be performed independently for any particular instance of the server.


After you issue the agentadmin command and accept the license agreement (if necessary) the installation program appears, prompting you for information.

The steps in the installation program are displayed in this section in an example interaction. Your answers to prompts can differ slightly or greatly from this example depending upon your site's specific deployment. In the example, most of the defaults have been accepted. This example is provided for your reference and does not necessarily indicate the precise information you should enter.

The following bulleted list provides key points about the installation program.

About Installation Prompts in Agent for IBM WebSphere Portal Server 5.1.0.2

The following list provides information about specific prompts in the installation. Often the prompt is self explanatory. However, at other times you might find the extra information presented here to be very helpful. This extra information is often not obvious. Study this section carefully before issuing the agentadmin --install command.

The Deployment URI for the Agent Application

The deployment URI for the agent application is required for the agent to perform necessary housekeeping tasks such as registering policy and session notifications, legacy browser support, and CDSSO support. Accept /agentapp as the default value for this interaction. Once the installation is completed, browse the directory PolicyAgent-base/etc. Use the agentapp.war file to deploy the agent application in the application container. Please note that the deployment URI for agent application during install time should match the deployment URI for the same application when deployed in the J2EE container.

The Encryption Key

This key is used to encrypt sensitive information such the passwords. The key should be at least 12 characters long. A key is generated randomly and provided as the default. You can accept the random key generated by the installer or create one using the .agentadmin --getEncryptKey command.

For information about creating a new encryption key, see agentadmin --getEncryptKey.

The Agent Profile Name

An agent profile should have been created as a pre-installation step. The creation of the agent profile is mentioned in that section. For the pre-installation steps, see Preparing to Install Agent for IBM WebSphere Portal Server 5.1.0.2. For the actual information on creating an agent profile, see Creating a J2EE Agent Profile.

In summary, the J2EE agent communicates with Access Manager with a specific ID and password created through an agent profile using Access Manager Console. For J2EE agents, the creation of an agent profile is mandatory. Access Manager uses the agent profile to authenticate an agent. This is part of the security infrastructure.

The J2EE Password File

The J2EE password file should have been created as a pre-installation step. For the pre-installation steps, see Preparing to Install Agent for IBM WebSphere Portal Server 5.1.0.2.

When the installation program prompts you for the password for the agent, enter the fully qualified path to this password file.

After you have completed all the steps, a summary of your responses appears followed by options that allow you to navigate through those responses to accept or reject them.

When the summary appears, note the agent instance name, such as agent-001. You might be prompted for this name during the configuration process.

About the options, the default option is 1, Continue with Installation.

You can edit your responses as necessary, return to the options list, and choose option 1 to finally process your responses.

Example of Installation Program Interaction in Agent for IBM WebSphere Portal Server 5.1.0.2

The following example is a sample installation snapshot of Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2. By no means does this sample represent a real deployment scenario.

The section following this example, Implications of Specific Deployment Scenarios in Agent for IBM WebSphere Portal Server 5.1.0.2, explains specific deployment scenarios, such as installing the agent on multiple IBM WebSphere Portal Server 5.1.0.2 instances. If any of these deployment scenarios apply to your site's deployment, you might be required to respond to prompts in a specified manner during the installation as explained in that section. Review the explanations in that section before proceeding with the installation. Those explanations are divided into subsections as follows:


Note –

You must install the agent on every instance of the underlying IBM WebSphere Application Server.

The following interaction example demonstrates the installation of Agent for IBM WebSphere Portal Server 5.1.0.2, where WebSphereServer-instance-name represents the WebSphere Server instance name. The default instance is often named server1 and the IBM WebSphere Portal Server instance is often named WebSphere_Portal.



************************************************************************
Welcome to the Access Manager Policy Agent for IBM WebSphere Portal Server
5.1.0.2 Agent. If the Policy Agent is used with Federation Manager services,
User needs to enter information relevant to Federation Manager.

************************************************************************


Enter the fully qualified path to the configuration directory of the Server
Instance for the WebSphere node. Please ensure that the installer is run on
the WebSphere instance that will host the WebSphere Administration Console
first before the installer is run on the WebSphere Portal instance.
[ ? : Help, ! : Exit ]
Enter the Instance Config Directory
[/opt/WebSphere/AppServer/config/cells/wpshost/nodes/wpshost/servers/WebSphereServer-instance-name]: 


Enter the Server/Portal Instance name.
[ ? : Help, < : Back, ! : Exit ]
Enter the Server/Portal Instance name [WebSphereServer-instance-name]:


Enter the WebSphere Install Root directory.
[ ? : Help, < : Back, ! : Exit ]
Enter the WebSphere Install Root directory [/opt/WebSphere/AppServer]: 


Enter the fully qualified host name of the server where Access Manager
Services are installed.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Host: amhost.example.com


Enter the port number of the Server that runs Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services port [80]:


Enter http/https to specify the protocol used by the Server that runs Access
Manager services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Protocol [http]:


Enter the Deployment URI for Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Deployment URI [/amserver]:


Enter the fully qualified host name on which the Application Server
protected by the agent is installed.
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Host name: wpshost.example.com


Enter the preferred port number on which the application server provides its
services.
[ ? : Help, < : Back, ! : Exit ]
Enter the port number for Application Server instance [80]:


Select http or https to specify the protocol used by the Application server
instance that will be protected by Access Manager Policy Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the Preferred Protocol for Application Server instance [http]:


Enter the deployment URI for the Agent Application. This Application is used
by the agent for internal housekeeping.
[ ? : Help, < : Back, ! : Exit ]
Enter the Deployment URI for the Agent Application [/agentapp]:


Enter a valid Encryption Key.
[ ? : Help, < : Back, ! : Exit ]
Enter the Encryption Key [r2s+z4TxPsSwBLe/FbncKrwzVudy+nU5]:


Enter a valid Agent profile name. Before proceeding with the agent
installation, please ensure that a valid Agent profile exists in Access
Manager.
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Profile name: wpsagent


Enter the path to a file that contains the password to be used for identifying
the Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the path to the password file: /tmp/password.txt


Enter true if the Agent is being installed on the same instance of Application
Server on which Access Manager is deployed. Enter false if that is not the
case.
[ ? : Help, < : Back, ! : Exit ]
Are the Agent and Access Manager installed on the same instance of
Application Server ? [false]:


-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
Instance Config Directory :
/opt/WebSphere/AppServer/config/cells/wpshost/nodes/wpshost/servers/WebSphereServer-instance-name

Instance Server/Portal name : WebSphereServer-instance-name
WebSphere Install Root Directory : /opt/WebSphere/AppServer

Access Manager Services Host : amhost.example.com
Access Manager Services Port : 80
Access Manager Services Protocol : http
Access Manager Services Deployment URI : /amserver
Agent Host name : wpshost.example.com
Application Server Instance Port number : 80
Protocol for Application Server instance : http
Deployment URI for the Agent Application : /agentapp
Encryption Key : r2s+z4TxPsSwBLe/FbncKrwzVudy+nU5
Agent Profile name : wpsagent
Agent Profile Password file name : /tmp/password.txt
Agent and Access Manager on same application server instance : false

Verify your settings above and decide from the choices below.
1. Continue with Installation
2. Back to the last interaction
3. Start Over
4. Exit
Please make your selection [1]:

Copy agent.jar,amclientsdk.jar to
/opt/WebSphere/AppServer/lib/ext...DONE.

Creating directory layout and configuring AMAgent.properties file for
agent_001 instance ...DONE.

Reading data from file /tmp/password.txt and encrypting it ...DONE.

Generating audit log file name ...DONE.

Creating tag swapped AMAgent.properties file for instance agent_001 ...DONE.

Creating a backup for file
/opt/WebSphere/AppServer/config/cells/wpshost/nodes/wpshost/servers/WebSphereServer-instance-name/server.xml
...DONE.

Configure server.xml file
/opt/WebSphere/AppServer/config/cells/wpshost/nodes/wpshost/servers/WebSphereServer-instance-name/server.xml...DONE.


SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: agent_001
Agent Configuration file location:
/opt/j2ee_agents/am_wps_agent/agent_001/config/AMAgent.properties
Agent Audit directory location:
/opt/j2ee_agents/am_wps_agent/agent_001/logs/audit
Agent Debug directory location:
/opt/j2ee_agents/am_wps_agent/agent_001/logs/debug


Install log file location:
/opt/j2ee_agents/am_wps_agent/logs/audit/install.log

Thank you for using Access Manager Policy Agent

Implications of Specific Deployment Scenarios in Agent for IBM WebSphere Portal Server 5.1.0.2

The following sections refer to specific deployment scenarios involving Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2. These scenarios are likely to affect how you respond to prompts during the installation process. You might also be required to perform additional configurations.

Installing a J2EE Agent on Multiple IBM WebSphere Portal Server 5.1.0.2 Instances

Once a J2EE agent is installed for a particular IBM WebSphere Portal Server 5.1.0.2 instance, you can install the agent on another instance on the same machine by running the agentadmin --install command. Once prompted to enter the appropriate server instance name, enter the server configuration directory and unique instance name that will enable the agent to distinguish the first instance from consecutive instances.

Installing Agent for IBM WebSphere Portal Server 5.1.0.2 on the Access Manager Host

If a J2EE agent and Access Manager are collocated on the same container, enter true for the following question:


Enter true if the Agent is being installed on the same instance of Application
Server on which Access Manager is deployed. Enter false if that is not the
case.
[ ? : Help, < : Back, ! : Exit ]
Are the Agent and Access Manager installed on the same instance of
Application Server ? [false]: true

In this case, the agentadmin program will make the necessary changes to install and configure the agent on the same IBM WebSphere Portal Server 5.1.0.2 instance that hosts Access Manager.

However, this deployment scenario changes the agent configuration in a manner that requires your attention. For details, see Combining J2EE Agents With Access Manager.

Summary of a J2EE Agent Installation in Policy Agent 2.2

At the end of the installation process, the installation program prints the status of the installation along with the installed J2EE agent information. The information that the program displays can be very useful. For example, the program displays the agent instance name, which is required when configuring a remote instance. The program also displays the location of specific files, which can be of great importance. In fact, you might want to view the installation log file once the installation is complete, before performing the post-installation steps as described in Chapter 4, Post-Installation Tasks of Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2.

The location of directories displayed by the installer are specific. However, throughout this guide and specifically in Summary of Agent Installation shown in this section, PolicyAgent-base is used to describe the directory where the distribution files are stored for a specific J2EE agent.

The following example serves as a quick description of the location of the J2EE agent base directory (PolicyAgent-base) of Policy Agent 2.2 for IBM WebSphere Portal Server 5.1.0.2.


Example 3–5 Policy Agent Base Directory of Agent for IBM WebSphere Portal Server 5.1.0.2

The following directory represents PolicyAgent-base of Agent for IBM WebSphere Portal Server 5.1.0.2:


Agent-HomeDirectory/j2ee_agents/am_wps_agent

where Agent-HomeDirectory is the directory you choose in which to unpack the J2EE agent binaries.

Information regarding the location of the J2EE agent base directory is explained in detail in Location of the J2EE Agent Base Directory in Policy Agent 2.2.


The following type of information is printed by the installer:


SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: agent_001
Agent Configuration file location:
PolicyAgent-base/agent_001/config/AMAgent.properties
Agent Audit directory location:
PolicyAgent-base/agent_001/logs/audit
Agent Debug directory location:
PolicyAgent-base/agent_001/logs/debug

Install log file location:
PolicyAgent-base/logs/audit/install.log

Thank you for using Access Manager Policy Agent

Once the agent is installed, the directories shown in the preceding example are created in the agent_00x directory, which for this example is specifically agent_001. Those directories and files are briefly described in the following paragraphs.

PolicyAgent-base/agent_001/config/AMAgent.properties

Location of the J2EE agent AMAgent.properties configuration file for the agent instance. Every instance of a J2EE agent has a unique copy of this file. You can configure this file to meet your site's requirements. For more information, see the following sections:

PolicyAgent-base/agent_001/logs/audit

Location of the J2EE agent local audit trail.

PolicyAgent-base/agent_001/logs/debug

Location of all debug files required to debug an agent installation or configuration issue.

PolicyAgent-base/logs/audit/install.log

Location of the file that has the agent install file location. If the installation failed for any reason, you can look at this file to diagnose the issue.