IBM DataPower Operations Dashboard v1.0.13.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Upgrade to 1.0.9.0 - Special Steps

DPOD software updates are available from time to time and include enhancements, security updates, component upgrade, bug fixes etc.

The following sections describe the process of upgrading an existing installation. 

To upgrade for 1.0.9.0 you must be at version 1.0.8.5.

You should consider performing a full backup.

RPM Prerequisites

Additional RPM packages need to be installed when upgrading a non appliance DPOD installation.
Please make sure the following packages are installed before upgrading: fontconfig

Obtain the software update

DPOD software updates are available through IBM fix central.

The download consists of two types of files :

  1. The update file in the format of : DPOD-fixpack-<version number>.sfs (for example: DPOD-fixpack-1_0_9.sfs)
  2. The md5 hash calculation of the update file : DPOD-update-<version number>.md5

Copy the software update to the DPOD server

Copy the update files to the following directory on the DPOD server :

/installs/update/fix/TODO


If the directory is missing for some reason, please re create it :

mkdir -p /installs/update/fix/TODO

Install the software update

Run the following command from the location you downloaded the update files to.

MonTierUpdateInstaller.sh -u DPOD-update-<version number>.sfs -s DPOD-update-<version number>.md5

For example:

MonTierUpdateInstaller.sh -u DPOD-update-1_0_9.sfs -s DPOD-update-1_0_9.md5


After running the command you will be prompted to confirm the software update process. press "Y" to confirm or "N" to abort.

Software update :

   Please DO NOT interrupt during the process !

   Are you sure you want to continue ? [y/n]

When the software update level is not compatible with the current system version you will receive the following message on the console output : 

error, software update can NOT be applied to this system version. aborting update...


Do Not interrupt the software update process after it has begun

On it's first run , the command will complete with the following message :

Starting software update. log file is /installs/update/fix/logs/montier-update-2019-05-20_15-06-06.log

   Found new version of the software update installer... updating
   Software update installer was updated successfully.

   Important !!! Please run the software update installer again.


Rerun the upgrade command :

MonTierUpdateInstaller.sh -u DPOD-update-1_0_9.sfs -s DPOD-update-1_0_9.md5

Data Migration Tool

The upgrade process checks the existence of Store indices that were created in early versions of the product.
In case that early version indices exist, the upgrade process will stop and notify you of a manual step that you will need to run :

Some of the stored application data cannot be migrated to the latest version of the Store service.

A data migration tool has been deployed in /installs/data-migration-tool.

You may run it using the following command:

/installs/data-migration-tool/data-migration-tool.sh

Further information can be found in the documentation at:

Admin Guide -> Installation and Upgrade -> Upgrade -> Upgrade to v1.0.9.0 - Special Steps

Configuring the Data Migration Tool

You may edit the configuration file /installs/data-migration-tool/data-migration-tool.conf before running the tool. There are two entries of interest:

  • duration.limit (default: 999999) - limits the execution time in minutes.
    This option is useful if you want to schedule the tool to run during off-peak time. In such a case, you can limit the tool to run for a few hours each time and schedule it to start when off-peak time starts, so performance will not be impacted during peak time hours.
  • delete.kibana_indices (default: true) - determined whether Kibana indices should be deleted or not.
    true - delete old Kibana indices - all exiting Kibana dashboards and other settings will be deleted.
    false - keep and migrate Kibana indices to the new store version - however Kibana version that comes with DPOD 1.0.9.0 is unable to read the old indices format, so it is up to you to fix the indices manually according to Kibana's documentation.
  • Leave the other settings in data-migration-tool.conf as they are, unless advised otherwise by support.

Running the Data Migration Tool

To run the data migration tool manually:

/installs/data-migration-tool/data-migration-tool.sh

Make sure not to interrupt SSH session during the Data-Migration operation.
Alternatively, you can run the tool in a "no hang-up" mode, which will cause the process to continue running even after the SSH session is closed. In this mode, the console output will be written to the nohup.log file in the local directory.

nohup /installs/data-migration-tool/data-migration-tool.sh &


The data migration process may take anywhere between a few minutes and a few days, depending on the amount of data, the server load and the server hardware.
A rough estimation of the time left will be calculated and presented on the console output during the process run. These estimations will also be written to the log file.
The estimation is based on current server load, so it may change significantly between peak and off-peak hours.

Please review the data migration tool log file if the console displays any error message.
When the data migration completes, the console or log file will display the following message:

Data migration tool finished successfully

Interrupting the Data Migration Tool

Pressing Ctrl+C or setting duration.limit in the configuration file will stop the tool during the migration process.
Stopping the tool will cause it to re-process the last index that was migrated on the next run.

While this is usually not an issue, note that on some cases it may cause complications, for example:
1. The user wants the tool to run during a nightly maintenance window, between 2-4 AM.
2. The tool is scheduled using cron to 2 AM and the duration.limit setting is set to 120 minutes.
3. For this specific user, depending on its hardware and data sizes, processing of each index takes about 3 hours.
4. Since the tool is interrupted after 2 hours, on the next night, the tool will try to migrate the same index again and will never advance to the next index.

Resuming Software Update

To proceed with the software update, you can rerun the software update command:

MonTierUpdateInstaller.sh -u DPOD-update-1_0_9.sfs -s DPOD-update-1_0_9.md5


When the software update completes, the system will display the following messages on the console output.

Starting software update. log file is /installs/update/fix/logs/montier-update-2019-05-20_15-07-06.log
2019-05-20_15-07-17: INFO Starting software update (JRE). log file is /installs/update/fix/logs/montier-update-2019-05-20_15-07-06.log
2019-05-20_15-07-51: INFO Stopping application ...
2019-05-20_15-08-47: INFO Application stopped successfully.
2019-05-20_15-09-29: INFO Starting software update (JRE).
2019-05-20_15-10-33: INFO Starting software update (1.0.9.0). log file is /installs/update/fix/logs/montier-update-2019-05-20_15-07-06.log
2019-05-20_15-10-37: INFO Stopping application ...
2019-05-20_15-11-27: INFO Application stopped successfully.
2019-05-20_15-11-28: INFO Starting software update (1.0.9.0).
2019-05-20_15-17-18: INFO Updated complete successfully (1.0.9.0).  log file /installs/update/fix/logs/montier-update-2019-05-20_15-07-06.log.
2019-05-20_15-17-24: INFO Starting application ...
2019-05-20_15-19-55: INFO Application started successfully.
2019-05-20_15-20-00: INFO Please update store allocation now
2019-05-20_15-20-00: INFO Using the admin console in https://<your server name>/admin
2019-05-20_15-20-00: INFO Admin Console -> Utilities -> Store -> Store Allocation
update DPOD-update-1_0_9.sfs was installed successfully. log file /installs/update/fix/logs/montier-update-2019-05-20_15-07-06.log

Please review the upgrade log file if the console displays any error messages.


Update Store Allocation

Open the DPOD admin console on your favorite browser:

https://<your server name>/admin

Go to:

Admin Console -> Utilities -> Store -> Store Allocation

Run the Update Store Allocation utility:

Confirm the operation  :


The execution output window will appear. Wait for the "Command executed successfully" indication, and check that the line "Configuration ended successfully" in the output.


IBM DataPower Operations Dashboard (DPOD) v1.0.13.0