Upgrading PingDataSync - PingDirectory - 9.3

PingDirectory 9.3

PingDirectory 9.3
PingDirectory 9.3

Use the PingDirectory server’s update command to upgrade the current code version.

Click the following tabs to see instructions for the tasks you want to perform.

Upgrading servers in a topology


This information is only applicable when updating from a server version that uses the admin backend to a server version that uses the topology registry. This is only the case when updating from a server version earlier than 7.x to a 7.x version, and is not applicable to any updates to server version 8.x or later.


For additional considerations, see Planning your upgrade.

An update to the current release includes significant changes, and the introduction of a topology registry, which will store information previously stored in the admin backend (server instances, instance and secret keys, server groups, and administrator user accounts). For the admin backend to be migrated, the update command must be provided LDAP authentication options to the peer servers of the server being updated.

The LDAP connection security options requested (either plain, TLS, StartTLS, or SASL) must be configured on every server in the topology. The LDAP credentials must be present on every server in the topology, and must have permissions to read from the admin backend and the config backend of every server in the topology. For example, a root DN user with the inherit-default-privileges set to true (such as the cn=Directory Manager user) that exists on every server can be used.

  • Changes to clustered configurations are not allowed in mixed-version clusters. This applies to configuration in the cn=Cluster,cn=config subtree and only applies to servers with matching cluster names. Consider this when updating multiple servers in a cluster.
  • To make clustered configuration changes in a mixed-version cluster, choose one of the following options:
    • Update each server to the same version.
    • Temporarily split up the cluster by changing the cluster-name property on the server instance configuration objects.
  • After you have updated all the servers to the same version, you can again make clustered configuration changes and those changes will mirror across the topology.

The update command will verify that the following conditions are satisfied on every server in the topology before allowing the update:

  • When the first server is being updated, all other servers in the topology must be online. When updating additional servers, all topology information will be obtained from one of the servers that has already been updated. The update command will connect to the peer servers of the server being updated to obtain the necessary information to populate the topology registry. The provided LDAP credentials must have read permissions to the configuration and admin backends of the peer servers.
  • The instance name is set on every server, and is unique across all servers in the topology. The instance name is a server’s identifier in the topology. After all servers in the topology have been updated, each server will be uniquely identified by its instance name. After it has been set, the name cannot be changed. If needed, you can use the following command to set the instance name of a server before the update:
    $ bin/dsconfig set-global-configuration-prop \
      --set instance-name:uniqueName
  • The cluster-wide configuration is synchronized on all servers in the topology. Older versions have some topology configuration under cn=cluster,cn=config (JSON attribute and field constraints). These items did not support mirrored cluster-wide configuration data. An update should avoid custom configuration changes on a server being overwritten with the configuration on the mirrored subtree primary. To synchronize the cluster-wide configuration data across all servers in the topology, run the config-diff command on each pair of servers to determine the differences, and use the dsconfig command to update each instance using the config-diff command's output. For example:
    $ bin/config-diff --sourceHost hostName \
      --sourcePort port \
      --sourceBindDN bindDN \
      --sourceBindPassword password \
      --targetHost hostName \
      --targetPort port \
      --targetBindDN bindDN \
      --targetBindPassword password

If any of these conditions are not satisfied, the update command will list all of the errors encountered for each server, and provide instructions on how to fix them.

Upgrading the server

This procedure assumes that an existing version of the server is stored at PingData-server-old. Make sure a complete, readable backup of the existing system is available before upgrading the server. Also, make sure there is a clear back-out plan and schedule.

  1. Download the latest version of the server software and unzip the file.
  2. Use the update command of the newly unzipped build to update the server. Make sure to specify the server instance that is being upgraded with the --serverRoot option. The server must be stopped for the update to be applied.

Reverting an update

If necessary, a server can be reverted to the previous version using the revert-update command. The command accesses a log of file actions taken by the update command to put the file system back to its prior state. If multiple updates have been run, you can run the revert-update command multiple times to revert to each prior update sequentially. For example, you can run the revert-update command to revert the server to its previous state, then run the command again to return it to its original state. The server is stopped during the revert-update process.

Reverting an update is not supported for upgrades to version 7.0, because of the topology backend changes.

Use the revert-update command in the server root directory to revert back to the most recent version of the server:
$ PingData-server-old/revert-update

Reverting from version 7.x to a version earlier than 7.0

You can revert from version 7.0 or later to a pre-7.0 version using the revert-update command with some extra steps. This is also the case when updating or reverting from a pre- to or later. These steps are listed when the update and revert-update commands are run as well. You might need to perform one or more of the following tasks, depending on your installation and configuration:

  • When updating or reverting from or later to a pre- version, you might need to rebuild the indexes. Older versions of the server use an incompatible format for Local DB Composite Indexes. To update a server with composite indexes in the previous format, delete these indexes and re-run the update. After the update is complete, recreate the indexes and use the rebuild-index command to rebuild the indexes. The command for recreating an index will be in the "Undo" portion of the logs/config-audit.log file. If you want to later revert to an older version, delete and recreate those composite indexes again after the revert has completed.
  • When updating to 7.x for the first time, you will need to set instance names for each server in the topology if they were not previously set. You can do this with the following dsconfig command:
    $ bin/dsconfig --bindDN "cn=Directory Manager" \
      --bindPassword secret \
      --no-prompt set-global-configuration-prop \
      --set instance-name:<name>
  • Topology information such as server instances, instance and secret keys, server groups, and administrator users have moved to the topology portion of the configuration from the admin backend. As long as new servers are not added to the topology after this update, you can run the revert-update command to return to the previous version.

    However, if new servers are added, then the restored admin backend of this server will not contain information about the new servers, and the local server will not be able to communicate with any other servers in the topology. New servers should not be added to the topology if reverting this update is a possibility.

  • If new servers were added to the topology after the update, you must temporarily remove the new servers from the topology until all servers have been reverted to the previous version.
  • When a server is reverted to a pre-7.x version, any servers in the topology using the topology portion of the configuration (rather than the admin backend) will need to know that the reverted server was downgraded to the admin backend. This is done by running the following dsconfig command on one of the servers that has not been reverted:
    $ bin/dsconfig set-server-instance-prop \
      --instance-name <Reverted server instance name> \
      --set server-version:<Version to which server is reverted>
  • If the topology does not have a primary server when this command is run, it will not succeed. In this case, one of the remaining updated servers in the topology must be made primary with the following command. This will enable the chosen instance to run the first command successfully.
    $ bin/dsconfig set-global-configuration-prop \
      --set force-as-master-for-mirrored-data:true
  • The 7.x server version includes database changes that are not compatible with previous server versions (6.x or older). If you want to later revert to an older version, the data must be exported to LDIF before performing the reversion. Re-import the data after the revert process has completed. In addition, the changelogDb/ and db/changelog/ directories in the reverted server root must be deleted after the revert has completed.

When starting up the server for the first time after a revert has been run, and the necessary extra steps have been completed, the server will display warnings about "offline configuration changes," but they are not critical and will not appear on subsequent startups.

Reverting to the most recent server version

Run the revert-update command in the server root directory to revert back to the most recent version of the server.

$ <PingServer>-old/revert-update