Follow these steps to upgrade a site of servers. For information on the versions that are supported for upgrade, see "Supported Upgrade Paths" in the Release Notes.

During the upgrade process, you must take the OpenAM servers in the site out of production, instead redirecting client application traffic elsewhere. This is required because upgrade involves making changes to OpenAM's configuration model. If the upgrade fails, you must be able to roll back before the configuration changes impact other sites.

1. Prepare your customized OpenAM server .war file.

2. Back up your deployment.

3. Route client application traffic to another site during the upgrade.

4. For servers in the site, stop OpenAM, or if necessary stop the container where OpenAM runs.

5. For servers in the site, deploy your customized server .war file.

   When you deploy the new .war file, you might have to delete working files left by the old installation. For example, if you deploy on Apache Tomcat, replacing /path/to/tomcat/webapps/openam.war, then also recursively delete the /path/to/tomcat/webapps/openam/ and /path/to/tomcat/work/Catalina/localhost/openam/ directories before restarting the server.

6. For servers in the site, restart OpenAM or the container where it runs.

7. To upgrade the data in the configuration store, perform one of the following actions in one of the servers in the site:

   • Navigate to the OpenAM URL, for example https://openam.example.com:443/openam, and follow the instructions in the Upgrade Wizard for an interactive upgrade.

   • Use the openam-upgrade-tool-14.0.0.jar tool for an unattended upgrade:

     1. Install the openam-upgrade-tool-14.0.0.jar tool as described in "Setting up Configuration Tools" in the Installation Guide. A sampleupgrade file will be expanded in the directory where you install the tool.

     2. Create a configuration file for the openam-upgrade-tool-14.0.0.jar. You can use the sampleupgrade file as a template to create a configuration file, for example upgrade.properties.

        An upgrade configuration file may resemble the following:

        $ grep -v "^#" upgrade.properties
        SERVER_URL=http://openam.example.com:8080
        DEPLOYMENT_URI=/openam
        ACCEPT_LICENSES=true

     3. Upgrade OpenAM by using the tool with the properties file following this example:

        $ java -jar openam-upgrade-tool-14.0.0.jar --file upgrade.properties
        Writing Backup; Done.
        Upgrading Services
        New service iPlanetAMAuthPersistentCookieService; Done.
        New service iPlanetAMAuthOpenIdConnectService; Done.
        New service OAuth2Provider; Done.
        New service iPlanetAMAuthDevicePrintModuleService; Done.
        New service crestPolicyService; Done.
        New service RestSecurity; Done.
        New service MailServer; Done.
        New service dashboardService; Done.
        New service iPlanetAMAuthOATHService; Done.
        Add Organization schema to sunFAMSAML2Configuration; Done.
        Upgrade sunAMAuthHOTPService; Done.
        Upgrade sunAMAuthADService; Done.
        Upgrade sunAMAuthOAuthService; Done.
        Upgrade iPlanetAMAuthCertService; Done.
        Upgrade sunIdentityRepositoryService; Done.
        Upgrade iPlanetAMPasswordResetService; Done.
        Upgrade iPlanetAMSessionService; Done.
        Upgrade iPlanetAMAuthService; Done.
        Upgrade iPlanetAMAuthLDAPService; Done.
        Upgrade sunAMAuthDataStoreService; Done.
        Upgrade AgentService; Done.
        New sub schema sunIdentityRepositoryService; Done.
        New sub schema AgentService; Done.
        Delete service sunFAMLibertyInteractionService; Done.
        Delete service sunFAMLibertySecurityService; Done.
        Creating entitlement application type crestPolicyService; Done.
        Creating entitlement application crestPolicyService; Done.
        Re-enabling Generic LDAPv3 Data Store; Done.
        Upgrading data store embedded; Done.
        Updating Platform Properties; Done.
        Writing Upgrade Log; Done.
        
        Upgrade Complete.

        For additional information about the command-line tool, see the reference documentation for upgrade.jar(1) in the Reference.

     4. Restart OpenAM or the container where it runs.

8. (Optional) If you installed OpenAM using an external directory server as the configuration store, add an access control instruction (ACI) to the external directory to give the OpenAM administrative user server-side sorting privileges.

   The ACI should be similar to the following:

   aci: (targetcontrol="1.2.840.113556.1.4.473")(version 3.0;
    acl "Allow server-side sorting"; allow (read)
    (userdn = "ldap:///uid=openam,ou=admins,dc=example,dc=com");)

   See "Preparing an External Configuration Data Store" in the Installation Guide for more information about using an external directory server as the OpenAM configuration store.

9. (Optional) If you installed AM using an external directory server as the user store, update the user store schema as follows:

   1. Log into AM.

   2. Navigate to Realm Name > Datastores > External User Store.

   3. Click Load schema when saved, and then click Save to apply your changes.

   4. If you have additional external user stores, repeat the previous steps for each user store.

10. (Optional) If you want to configure the upgraded system for the Core Token Service (CTS), read "Implementing the Core Token Service" in the Installation Guide. For a list of supported directory services, see the "Data Store Requirements" in the Release Notes

11. Referral policies are not supported in AM 5.0.0. If your OpenAM deployment has referral policies, the following warning message will appear when you upgrade your server to AM 5.0.0:

    Referrals found that require removing 

    OpenAM will take the following actions during the upgrade:

    • Removing all referral policies from your OpenAM configuration.

    • Copying resource types and policy sets associated with removed referral policies to the realms targeted by the referral policies.

    For example, suppose you had an OpenAM 12 deployment with a referral policy in realm A, and that referral policy referred to policies in realm B. During an upgrade, OpenAM would delete the referral policy in realm A and copy all the resource types and policy sets associated with the deleted referral policy from realm A to realm B.

    After upgrading to AM 5.0.0, you are responsible for reconfiguring AM so that policy evaluation that previously depended upon referrals continues to function correctly. You might need to take one or both of the following actions:

    • Reconfiguring your policy agent with the realm and policy set that contain policies to be evaluated when that agent requests a policy decision from OpenAM. Previously, you might have configured the agent to use a realm that contained a referral policy. Because referral policies are not supported in AM 5.0.0, this is not possible.

      Note

      The agent configuration UI refers to a policy set as an application.

      For more information about configuring an agent with a realm and policy set, see "Working With Realms and Policy Agents" in the Setup and Maintenance Guide.

    • Copying or moving a policy or a group of policies. AM 5.0.0 has REST API endpoints that let you copy and move policies. This functionality might be helpful when migrating away from policy deployments that use referral policies. For more information about the REST endpoints that let you copy and move policies, see "Copying and Moving Policies" in the Authorization Guide.

12. If you have post authentication plugins that expect state to be maintained by OpenAM between login and logout, you must rewrite and redeploy them.

    In versions prior to AM 5, the Keep Authentication Module Objects for Logout Processing option was available in the Core Authentication module. This option, when enabled, directed OpenAM to maintain state information in server memory throughout a session's duration for post authentication plugin module instances. When logout was triggered, OpenAM invoked the same post authentication plugin module instance, with state information intact. Therefore, developers could access module state stored at login when users logged out.

    AM 5.0.0 does not maintain state in post authentication plugins between login and logout. Post authentication plugins that rely on module state being maintained in AM's memory between login and logout must be rewritten. You can store any information that you want to save between login and logout in a session property. AM stores session properties in the CTS token store after login, and retrieves them from the token store as part of the logout process.

    To set a session property, call the setProperty method on an SSOToken object as demonstrated by the post authentication plugin sample code in "Building Your Sample Post Authentication Plugin" in the Authentication and Single Sign-On Guide.

13. Validate that the service is performing as expected.

14. Allow client application traffic to flow to the upgraded site.

If you configured one or more JDBC audit event handlers in OpenAM 13.0.x, make the following changes to the audit tables' schema:

1. Run the following command on Oracle databases that support OpenAM audit event handlers:

   ALTER TABLE am_auditaccess ADD (response_detail CLOB NULL);

   This command adds the response_detail column to the am_auditaccess table.

2. Run the following commands on MySQL databases that support OpenAM audit event handlers:

   ALTER TABLE audit.am_auditconfig CHANGE COLUMN configobjectid objectid VARCHAR(255);
   ALTER TABLE audit.am_auditaccess ADD COLUMN response_detail TEXT NULL;

   The commands change the name of the configobjectid column in the am_auditconfig table to objectid and add the response_detail column to the am_auditaccess table.

3. If you use databases other than Oracle or MySQL to support OpenAM audit event handlers, review their schema.

   If the am_auditconfig table has a column named configobjectid, change that column's name to objectid.

   If the am_auditaccess table does not have a column named response_detail, add that column to the table's schema.

1. Prepare your customized OpenAM server .war file.

2. Prepare a new deployment, installing servers from the new, customized .war file, starting with the instructions in "Installing and Starting Servers" in the Installation Guide.

3. After installation, configure the new servers in the same way as the old servers, adapting as necessary.

   You can use the ssoadm do-batch command to apply multiple changes with one command.

4. Validate that the new service is performing as expected.

5. Redirect client application traffic from the old deployment to the new deployment.