Updating the Framework

Updating Existing XTAM Deployment to the Currently Supported OpenJDK Release.

 

While all new installations use the latest, XTAM officially supported OpenJDK components (https://jdk.java.net/) as the default configuration, existing deployments should be updated manually if needed

As of November 2020, XTAM officially supports OpenJDK 15 and this framework will be used for all new installations.

For existing deployments that are currently using OpenJDK 11, 12, 13 or 14 this guide will update you to the latest supported version.

For existing deployments that are currently using JRE 1.8_x, please see this guide for the update procedure.

Prerequisites

  • An operational XTAM deployment with the latest software version. Please update to the latest available version before proceeding.
  • An operational XTAM deployment with framework version 11, 12,13 or 14. If you are using 1.8_x, please use this guide to update.

To check your Framework version, login to XTAM with a System Administrator account, navigate to Management > About and locate the Framework parameter. If you see a version like Framework: 11.x.x or higher, please continue with this guide.

Considerations

  • Each XTAM node that is updated will be offline and inaccessible for the entirety of the migration.
  • The user performing the migration will be required to update files and configurations on the XTAM host server. Appropriate privileges are required.
  • We highly recommend deploying a test instance of XTAM that mirrors your production instance as closely as possible to test the migration (DB type, Federated Sign-In, certificates, MFA/SSO, AD Integration, etc). Once the migration is successful with the test instance you can reproduce the procedure on your production instance.

Please read the entire procedure outlined in the article before beginning. If you have any questions, please contact us.

Step 1. Download and Extract Framework Components

Download the latest supported framework packaged for XTAM Server to your XTAM host server and extract this archive outside the $XTAMdirectory. If you have multiple nodes, you will need to perform this procedure on all node servers.

Step 2. Stop the XTAM Services

Once the services are stopped, XTAM will become inaccessible until the update is completed.

  1. For Windows deployments, stop the PamManagement and PamDirectory services:
  2. Copy
    net stop PamManagement
    Copy
    net stop PamDirectory

  3. For Linux deployments, stop the pammanager and pamdirectory services:

    Copy
    service pammanager stop
    Copy
    service pamdirectory stop

Step 3. Updating the OpenJDK Framework

  1. Replace the existing XTAM jre directory.

    • Rename the directory $XTAM_HOME/jre to $XTAM_HOME/jre.old

    • Move the jre directory downloaded in Step 1 to $XTAM_HOME/jre

  2. Copy existing XTAM Certificates and Configurations

    • Copy the file $XTAM_HOME/jre.old/lib/security/cacerts to $XTAM_HOME/jre/lib/security overwriting the current file.

Note: This step will migrate the existing certificates loaded into the previous XTAM deployment including ADS, AD connection certificates as well as SSL certificate for CAS integration.

Step 4. Start the XTAM Services

  1. For Windows deployments, start the PamManagement and PamDirectory services:
  2. Copy
    net start PamDirectory
    Copy
    net start PamManagement

  3. For Linux deployments, start the pammanager and pamdirectory services:

    Copy
    service pamdirectory start
    Copy
    service pammanager start

These services may take a few minutes to fully start.

Step 5. Test and Verify

Once the services come back online, you should now login and thoroughly test the system. This should include, but not be limited to:

  • Login with all applicable types of user accounts; Local, AD/LDAP, MFA and SSO
  • Accessing existing records (and creating new records) in both the Record List and Personal Vault, including the unlock action
  • Creating remote sessions
  • Executing jobs and tasks (on demand and scheduled)
  • Viewing and exporting reports

To confirm the update, check the Framework version on the Management > About screen. The displayed version should match the version that was downloaded.

Rollback

If the migration or testing fails and you need to rollback to the previous Framework, then follow this procedure. If you do not need to rollback, proceed to the next section.

  1. Stop the XTAM services as described earlier
  2. Rename the new $XTAM_HOME/jre to $XTAM_HOME/jre.new
  3. Rename the previous $XTAM_HOME/jre.old back to $XTAM_HOME/jre
  4. Start the XTAM services as described earlier

When the services come back online, XTAM should be using the previous framework. You should now perform the testing and validation again.

Step 6. Cleanup

After all the testing is complete and the system is fully operational, you may choose to remove the following directories:

  • $XTAM_HOME/jre.old
  • Files downloaded in Step 1 and extracted archives