How To
Archived

How do I migrate to OpenIDM 4.x from an earlier release?

Last updated Jan 5, 2021

The purpose of this article is to provide information on migrating to OpenIDM 4.x from an earlier release. This article provides an alternative, less error prone approach to migrating your data as part of the upgrade. The upgrade process to OpenIDM 4 is a manual process; however, upgrading from OpenIDM 4 to a later version is a more automated process for deployments installed on UNIX® or Linux® systems.


1 reader recommends this article

Archived

This article has been archived and is no longer maintained by ForgeRock.

Overview

The upgrade path you should take depends on which release you are going from and to as summarized in the following table:

Source release Target release Upgrade path
OpenIDM 2.x OpenIDM 4
  1. Upgrade to OpenIDM 3.1 as per How do I upgrade from OpenIDM 2.x to OpenIDM 3.x?
  2. Upgrade from OpenIDM 3.1 to OpenIDM 4 as per instructions below.
OpenIDM 2.x OpenIDM 4.5
  1. Upgrade to OpenIDM 3.1 as per How do I upgrade from OpenIDM 2.x to OpenIDM 3.x?
  2. Upgrade from OpenIDM 3.1 to OpenIDM 4 as per instructions below.
  3. Upgrade from OpenIDM 4 to OpenIDM 4.5 as per OpenIDM Installation Guide › Updating From OpenIDM 4.0 to OpenIDM 4.5.
OpenIDM 3 OpenIDM 4 Upgrade from OpenIDM 3 to OpenIDM 4 as per instructions below.
OpenIDM 3 OpenIDM 4.5
  1. Upgrade from OpenIDM 3 to OpenIDM 4 as per instructions below.
  2. Upgrade from OpenIDM 4 to OpenIDM 4.5 as per OpenIDM Installation Guide › Updating From OpenIDM 4.0 to OpenIDM 4.5.
OpenIDM 3.1 OpenIDM 4 Upgrade from OpenIDM 3.1 to OpenIDM 4 as per instructions below.
OpenIDM 3.1 OpenIDM 4.5
  1. Upgrade from OpenIDM 3.1 to OpenIDM 4 as per instructions below.
  2. Upgrade from OpenIDM 4 to OpenIDM 4.5 as per OpenIDM Installation Guide › Updating From OpenIDM 4.0 to OpenIDM 4.5.

Prior to starting your upgrade, you should ensure you have read the OpenIDM Release Notes relevant to the target release and all interim releases, with particular focus on the OpenIDM Compatibility section to ascertain if your existing customizations will continue to work; you should also have read the Migrating to OpenIDM chapters in the relevant install guides:

Note

One other thing to consider is the encryption of certain data like passwords. This should work properly if the secret key in the keystore (security/keystore.jceks) remains the same in the later release (alias openidm-sym-default, configured in boot.properties, which is located in the /path/to/openidm/conf/boot directory).

Upgrade from OpenIDM 3.x to OpenIDM 4

You can upgrade from OpenIDM 3.x to OpenIDM 4 as follows:

  1. Follow steps 1 to 9 in the Install guide: OpenIDM Installation Guide › Migrating from OpenIDM 3.1 to OpenIDM 4 so that you have a separate OpenIDM 4 instance running alongside your OpenIDM 3.x instance; the steps are the same if you are going to OpenIDM 4 from OpenIDM 3 apart from steps 4 and 6. You should refer to OpenIDM 3.1 Installation Guide › Migrating to OpenIDM 3.1.0 for these steps if you are migrating from OpenIDM 3.
  2. Instead of step 10 in the install guide, you can follow this process which is less error prone (and assumes you are running separate OpenIDM 4 and OpenIDM 3.x instances alongside each other):
    1. Download the attached sample (scriptedcrest2idm.tar) which is based on the existing ScriptedCrest2DJ sample; this allows you to perform a reconciliation from a source OpenIDM 3.x instance to a target OpenIDM 4 instance.
    2. Customize the provisioner configuration and associated mapping in this sample to add your specific managed user attributes. The attributes currently specified are the ones used in our LDAP samples. If you want to provision other types of managed objects, you should also add these to the provisioner configuration and mappings as well.
    3. Perform the reconciliation from the OpenIDM 3.x instance to the OpenIDM 4 instance using the sample you customized in step b; this will migrate all your managed data straight into the OpenIDM repository.
  3. Continue with steps 11 to 13 in the Install guide: OpenIDM Installation Guide › Migrating from OpenIDM 3.1 to OpenIDM 4.

See Also

FAQ: Upgrading IDM

Upgrading IDM

OpenIDM 4 Installation Guide › Updating OpenIDM

OpenIDM 4 Release Notes

OpenIDM 4.5 Installation Guide

OpenIDM 4.5 Release Notes

Related Training

ForgeRock Identity Management Core Concepts (IDM-400)

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.