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
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.
Upgrade Paths
The following table describes the upgrade paths between versions:
From To | 1.0.8.0 | 1.0.8.6 | 1.0.9.0 | 1.0.10.0 | 1.0.10.1 | 1.0.11.0 | 1.0.12.0 |
---|---|---|---|---|---|---|---|
1.0.8.6 1 | 1.0.8.0 → 1.0.8.6 | ||||||
1.0.9.0 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.9.0 | 1.0.8.6 → 1.0.9.0 | |||||
1.0.10.0 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.10.0 | 1.0.8.6 → 1.0.10.0 | 1.0.9.0 → 1.0.10.0 | ||||
1.0.10.1 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.10.1 | 1.0.8.6 → 1.0.10.1 | 1.0.9.0 → 1.0.10.1 | 1.0.10.0 → 1.0.10.1 | |||
1.0.11.0 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.11.0 | 1.0.8.6 → 1.0.11.0 | 1.0.9.0 → 1.0.11.0 | 1.0.10.0 → 1.0.11.0 | 1.0.10.1 → 1.0.11.0 | ||
1.0.12.0 2 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.11.0 1.0.11.0 → 1.0.12.0 | 1.0.8.6 → 1.0.11.0 1.0.11.0 → 1.0.12.0 | 1.0.9.0 → 1.0.11.0 1.0.11.0 → 1.0.12.0 | 1.0.10.0 → 1.0.12.0 | 1.0.10.1 → 1.0.12.0 | 1.0.11.0 → 1.0.12.0 | |
1.0.13.0 | 1.0.8.0 → 1.0.8.6 1.0.8.6 → 1.0.11.0 1.0.11.0 → 1.0.13.0 | 1.0.8.6 → 1.0.11.0 1.0.11.0 → 1.0.13.0 | 1.0.9.0 → 1.0.11.0 1.0.11.0 → 1.0.13.0 | 1.0.10.0 → 1.0.13.0 | 1.0.10.1 → 1.0.13.0 | 1.0.11.0 → 1.0.13.0 | 1.0.12.0 → 1.0.13.0 |
1 Up to version 1.0.8.6, the fix pack file does not include previous fix packs, so each fix pack should be applied one by one.
2 Version 1.0.12.0 requires at least 1.0.10.0 because of Store engine upgrade and data upgrade issues.
Upgrading a Cell Environment
Note: This procedure has changed since 1.0.12.0. In previous versions the process of upgrading a cell environment was different.
To upgrade a cell environment:
- Make sure the entire cell is up and running. Upgrading is possible only if the cell is healthy.
- Upgrade the cell manager.
- When the cell manager upgrade is complete, the cell manager Web Console will be unavailable. Do not start the services manually on the cell manager unless requested explicitly.
- Upgrade all cell members (can be done in parallel).
- When the cell members upgrade is complete, start the cell manager services using
app-util.sh
("Start All").
Copy the Software Update Files to DPOD Server
- DPOD software updates are available through IBM Fix Central. The download consists of two files:
- The update file:
DPOD-fixpack-<version number>.sfs
- The md5 hash calculation of the update file:
DPOD-fixpack-<version number>.md5
- The update file:
- Copy the update files to the following directory on DPOD server:
/installs/update/fix/TODO
If the directory does not exist, execute the following command to create it:
mkdir -p /installs/update/fix/TODO
Make Sure there is Enough Disk Space
Inspect the free space of each mount point. You may use the following command:
df -h
Inspect the size of the internal configuration database. You may use the following command:
du -sh /app/derby/
Make sure the root ("/") mount point has at least 100 MB free space.
Make sure the "/installs" mount point has enough available space using the following table:
Upgrading to | Available Space on "/installs" |
---|---|
1.0.3.X - 1.0.9.X | 3 GB + internal configuration database size |
1.0.10.0 and above | 4 GB + internal configuration database size |
If there is not enough available space on the "/installs" mount point, you may free some from the following directories:
Directory | Description |
---|---|
/installs/update/fix/TODO | Remove old DPOD update files (.sfs) |
/installs/update/fix/backups | Remove old DPOD backup directories |
/installs/APPL-setup /installs/MonTierInstaller /installs/rpms | Remove the directories |
Follow Special Steps
Some versions require special steps. Make sure to follow them:
- Upgrade to 1.0.13.0 - Special Steps
- Upgrade to 1.0.11.0 - Special Steps
- Upgrade to 1.0.10.1 - Special Steps
- Upgrade to 1.0.10.0 - Special Steps
- Upgrade to 1.0.9.0 - Special Steps
- Upgrade to 1.0.8.0 - Special Steps
- Upgrade to 1.0.5.0 - Special Steps
Install the Software Update
Execute the following commands:
cd /installs/update/fix/TODO MonTierUpdateInstaller.sh -u DPOD-fixpack-<version number>.sfs -s DPOD-fixpack-<version number>.md5 For example: MonTierUpdateInstaller.sh -u DPOD-fixpack-1_0_12_0.sfs -s DPOD-fixpack-1_0_12_0.md5
Please review the upgrade log file if the console displays any error messages.
Do not interrupt the software update process after it has started.
Manual Steps during Software Update
Some versions require manual steps in order to complete the upgrade. These steps are described below.
Rerunning the Installer after Installer Update
Some versions make changes to the installer file itself (MonTierUpdateInstaller.sh
). In that case, the following message will be displayed, and the installer should be rerun manually:
Found new version of the software update installer... updating Software update installer was updated successfully. Important !!! Please run the software update installer again.
Rerunning the Installer after Operating System Update
Some versions upgrade the operating system (CentOS) when DPOD is installed in Appliance Mode.
In that case, the installer should be rerun manually after the OS upgrade is complete and the server is restarted.
Running Store Data Migration Tool
Some versions include new versions of the Store engine, which might require some of the existing data to be migrated to a newer format or structure.
If the upgrade process detects data that should be migrated before applying the upgrade, the following message will be displayed, and the data migration tool should be run manually:
Some of the existing data needs to be migrated to a newer format or structure. The data migration tool has been deployed in /installs/data-migration-tool. Further information can be found in the documentation at: Admin Guide -> Installation and Upgrade -> Upgrade
Configuring the Data Migration Tool
You may edit the configuration file /installs/data-migration-tool/data-migration-tool.conf
before running the tool.
The following entries are of interest (other settings should not change unless advised otherwise by IBM support):
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) - determines 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 Kibana indices and try to migrate them to the new store engine version - however, it is up to you to fix the indices manually according to Kibana's documentation.
Running the Data Migration Tool
- Make sure DPOD is up and running. The data migration tool is designed to work while DPOD is up and running, so users may sign in to DPOD and use it while the data migration tool is upgrading the data in the background.
Since the tool is a long-running process, it is recommended to run it 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 is written to
nohup.log
file in the local directory. Use the following command to run the tool and inspect the console output:nohup /installs/data-migration-tool/data-migration-tool.sh & tail -f nohup.out
- 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 presented while the process is running.
- Please review the data migration tool log file (/installs/logs/store_data_migration.log) if the console displays any error message.
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 in the middle of the migration on the next run.
While this is usually not an issue, note that on some cases it may cause complications, for example:
- The user wants the tool to run during a nightly maintenance window, between 2-4 AM.
- The tool is scheduled using cron to 2 AM and the
duration.limit
setting is set to 120 minutes. - For this specific user, depending on its hardware and data sizes, processing of each index takes about 3 hours.
- 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.