Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Apache HTTP Server 2.2.x

Migrating a Version 2.2 Apache HTTP Server Policy Agent

The version 3.0 agentadmin program includes the new --migrate option to migrate a version 2.2 agent to version 3.0. After you migrate a version 2.2 agent, the agent can use the new version 3.0 agent features.

The migration process migrates the agent's binary files, updates the agent's deployment container configuration, and converts the agent's AMAgent.properties file to the new version 3.0 OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties files.

Migrating a version 2.2 agent involves these general steps:

  1. On the server where the version 2.2 agent is installed, run the version 3.0 agentadmin program with the --migrate option.

    To get the version 3.0 agentadmin program, you must download the version 3.0 agent that corresponds to the version 2.2 agent you are migrating. For example, if you are migrating the version 2.2 Apache HTTP Server agent, download the version 3.0 Apache HTTP Server 2.2.x agent.

  2. On the Oracle OpenSSO server, run the ssoadm utility to create the new version 3.0 agent configuration in the centralized agent configuration repository.

    Therefore, the ssoadm utility must be installed from the openssoAdminTools.zip file on the Oracle OpenSSO server. For information, see Chapter 6, Installing the OpenSSO Enterprise Utilities and Scripts, in Sun OpenSSO Enterprise 8.0 Installation and Configuration Guide.

The agentadmin program creates a new deployment directory for the migrated agent, starting with Agent_001. The program does not modify the version 2.2 agent deployment directory files, in case you need these files after you migrate.

The following procedure, the migrated version 3.0 agent instance uses a new agent profile name, which is v3ApacheAgent in the examples. The old version 2.2 and new version 3.0 agent profile passwords are the same. If you need to change the password for the new version 3.0 agent profile, see Changing the Password for an Agent Profile (Optional).

ProcedureTo Migrate a Version 2.2 Agent:

  1. Login to the server where the version 2.2 agent is installed.

    To migrate the agent, you must have write permission to the version 2.2 agent's deployment container files and directories.

  2. Stop the Apache HTTP Server instance for the version 2.2 agent.

  3. Create a directory to download and unzip the version 3.0 agent. For example: v30agent

  4. Download and unzip the version 3.0 agent that corresponds to the version 2.2 agent you are migrating.

    The version 3.0 agents are available from the OpenSSO project site: https://opensso.dev.java.net/public/use/index.html

  5. Change to the version 3.0 agent's /bin directory.

    For example, if you downloaded and unzipped the version 3.0 Apache HTTP Server 2.2.x agent in the v30agent directory:

    cd /v30agent/web_agents/apache22_agent/bin

  6. Run the version 3.0 agentadmin program with the --migrate option. For example:

    ./agentadmin --migrate

  7. When the agentadmin program prompts you, enter the path to the version 2.2 agent's deployment directory. For example:

    /opt/v22/web_agents/apache22_agent

    In this example, /opt/v22 is the directory where you downloaded and unzipped the version 2.2 agent.

    The agentadmin program migrates the version 2.2 agent.

  8. Copy the Agent_nnn/config/OpenSSOAgentConfiguration.properties file to the /bin directory where ssoadm is installed on the Oracle OpenSSO server.

  9. In OpenSSOAgentConfiguration.properties, add the un-encrypted version 2.2 agent profile password at the end of the file, as follows:

    userpassword=v2.2–agent-profile-password

  10. On Oracle OpenSSO server, create a password file for the Oracle OpenSSO administrator (amadmin).

    This password file is an ASCII text file with only one line specifying the amadmin password in plain text. For example: /tmp/amadminpw

  11. On Oracle OpenSSO server, run ssoadm to create a new agent configuration in the Oracle OpenSSO centralized agent configuration repository. For example:

    cd tools_zip_root/opensso/bin
    ./ssoadm create-agent -b v3ApacheAgent -t WebAgent -u amadmin 
    -f /tmp/amadminpw -D ./OpenSSOAgentConfiguration.properties

    In this example:

    • tools_zip_root is the directory where you unzipped openssoAdminTools.zip.

    • v3ApacheAgent is the version 3.0 agent profile name.

    • WebAgent is the agent type for web agents.

    • /tmp/amadminpw is the path to the amadmin password file.

    Caution: After you run ssoadm, you might want to delete OpenSSOAgentConfiguration.properties from the /bin directory. This file contains sensitive information, including as the agent profile password, and the original file is maintained on the server where the agent is installed.

  12. Restart the Apache HTTP Server instance for the migrated agent.

Next Steps

After you migrate the agent, you can manage the new 3.0 agent configuration using the Oracle OpenSSO Administration Console or the ssoadm utility, as described in Managing the Apache HTTP Server 2.2.x Agent.