Chapter 4. Upgrading OpenAM Components

This chapter is concerned with upgrades for policy agents, OpenAM tools, and the OpenAM distributed authentication UI.

Procedure 4.1. To Upgrade Web Policy Agents

  1. Back up the policy agent installation and configuration directories.

    Also back up the configuration if it is stored centrally in OpenAM.

  2. Redirect client traffic away from the protected application.

  3. Stop the web server where the policy agent is installed.

  4. Extract the new files over the old installation.

  5. Start the web server where the policy agent is installed.

    For new features, the policy agent uses the default configuration until you make changes.

  6. Validate that the policy agent is performing as expected.

  7. Allow client traffic to flow to the protected application.

Procedure 4.2. To Upgrade Java EE Policy Agents

  1. Back up the policy agent installation and configuration directories.

    Also back up the configuration if it is stored centrally in OpenAM.

  2. Redirect client traffic away from the protected application.

  3. Uninstall the old policy agent.

  4. Install the new policy agent.

    For new features, the policy agent uses the default configuration until you make changes.

  5. Validate that the policy agent is performing as expected.

  6. Allow client traffic to flow to the protected application.

Procedure 4.3. To Upgrade OpenAM Tools

Since OpenAM 10.1, the session tools are no longer needed. Upgrading other tools consists of installing new tools and customizing tools scripts as necessary.

  1. Install new versions of the tools.

  2. Apply any customizations you made to the scripts, referring to the old tools installation as necessary.

  3. Once the new tools are working, you can delete the old tools.

Procedure 4.4. To Upgrade OpenAM Distributed Authentication Server

If you deployed the distributed authentication server (DAS) .war file, then you should upgrade the DAS when you upgrade other OpenAM servers.

  1. Redirect client application traffic away from the server.

  2. Stop the DAS or the container in which it runs.

  3. Deploy the new DAS .war file.

    When you deploy the new .war file, you might have to delete working files left by the old installation.

  4. Restart the DAS or the container in which it runs.

  5. Validate that the DAS is working as expected.

  6. Allow client application traffic to flow back to the server.