Updating the MobileFirst server

improve this page | report issue

Overview

IBM MobileFirst Platform Foundation provides several components that you might have installed.

Here is a description of their dependencies to update them:

MobileFirst Server Administration Service, MobileFirst Operations Console, and MobileFirst runtime environment

These three components compose as MobileFirst Server. They must be updated together.

Application Center

The installation of this component is optional. This component is independent of the other components. It can be run at a different interim fix level than the others if needed.

MobileFirst Operational Analytics

The installation of this component is optional. The MobileFirst components send data to MobileFirst Operational Analytics via a REST API. It is preferable to run MobileFirst Operational Analytics with the other components of MobileFirst Server of the same interim fix level.

MobileFirst Operational Analytics Receiver

The installation of this component is optional. MobileFirst applications send log data to MobileFirst Operational Analytics Receiver via a REST API. Install this component only if MobileFirst Operational Analytics is installed. It is preferable to run MobileFirst Operational Analytics Receiver with the other components of MobileFirst Server of the same interim fix level (iFix).

Updating MobileFirst Server Administration Service, MobileFirst Operations Console, and MobileFirst runtime environment

You can update these components in two ways:

  • With Server Configuration Tool
  • With Ant tasks

The updating procedure depends on the method you used at the initial installation.

Note: It is recommended to back up the existing MFP installation directory before you update the MobileFirst server. No special procedure is required when you back up these files, except for ensuring that the MobileFirst server is stopped. Otherwise, the data might change while the backup is occurring, and the data that is stored in memory might not yet be written to the file system. To avoid inconsistent data, stop the MobileFirst server before you start your backup.

MFP does not support rolling back of an update/iFix through IBM Installation Manager (IM). However, rollback is possible using the ANT Tasks or Server Configuration Tool (SCT) using the MFP related war files that are backed up before updating.

Applying a fix pack by using the Server Configuration Tool

If MobileFirst Server is installed with the configuration tool and the configuration file is kept, you can apply a fix pack or an interim fix by reusing the configuration file.

  1. Start the Server Configuration Tool.
    • On Linux, from application shortcuts Applications → IBM MobileFirst Platform Server → Server Configuration Tool.
    • On Windows, click Start → Programs → IBM MobileFirst Platform Server → Server Configuration Tool.
    • On macOS, open a shell console. Go to mfp_server_install_dir/shortcuts and type ./configuration-tool.sh.
    • The mfp_server_install_dir directory is where you installed MobileFirst Server.
  2. Click Configurations → Replace the deployed WAR files and select an existing configuration to apply the fix pack or an interim fix.

Rollback a fix pack by using the Server Configuration Tool

If the MobileFirst server is installed using the Server Configuration Tool and the configuration file is retained, you can roll back a fix pack or an interim fix by reusing the configuration file.

  1. Start the Server Configuration Tool.
    • Manually replace the MFP related war files by copying them from the backed up location of MFP install directory (mfp_server_install_dir/MobileFirstServer).
    • On Linux, from application shortcuts Applications → IBM MobileFirst Platform Server → Server Configuration Tool.
    • On Windows, click Start → Programs → IBM MobileFirst Platform Server → Server Configuration Tool.
    • On MacOS, open a shell console. Go to mfp_server_install_dir/shortcuts and type ./configuration-tool.sh.
    • The mfp_server_install_dir directory is where you installed the MobileFirst Server.
  2. Select the configuration that has to be rolled back. Click Configurations and select the option - Edit and redeploy configuration.

  3. Click Next on each page, traverse till the end and click Update.

Applying a fix pack by using the Ant files

Updating with the sample Ant file

If you use the sample Ant files that are provided in the mfp_install_dir/MobileFirstServer/configuration-samples directory to install MobileFirst Server, you can reuse a copy of this Ant file to apply a fix pack. For password values, you can enter 12 stars (*) instead of the actual value, to be prompted interactively when the Ant file is run.

  1. Verify the value of the mfp.server.install.dir property in the Ant file. It must point to the directory that contains the product with the fix pack applied. This value is used to take the updated MobileFirst Server WAR files.
  2. Run the command: mfp_install_dir/shortcuts/ant -f your_ant_file update

Updating with own Ant file

If you use your own Ant file, make sure that for each installation task (installmobilefirstadmin, installmobilefirstruntime, and installmobilefirstpush), you have a corresponding update task in your Ant file with the same parameters. The corresponding update tasks are updatemobilefirstadmin, updatemobilefirstruntime, and updatemobilefirstpush.

  1. Verify the class path of the taskdef element for the mfp-ant-deployer.jar file. It must point to the mfp-ant-deployer.jar file in an MobileFirst Server installation that the fix pack is applied. By default, the updated MobileFirst Server WAR files are taken from the location of mfp-ant-deployer.jar.
  2. Run the update tasks (updatemobilefirstadmin, updatemobilefirstruntime, and updatemobilefirstpush) of your Ant file.

Rollback a fix pack by using the Ant files

Rollback with the sample Ant file

If you use the sample Ant files that are provided in the mfp_install_dir/MobileFirstServer/configuration-samples directory to install MobileFirst server, you can reuse a copy of this Ant file to rollback a fix pack. For password values, you can enter 12 stars (*) instead of the actual value, which will be prompted for interactively when the Ant file is run.

  1. Manually replace the MFP related war files by copying them from the backed up location of MFP install directory (mfp_server_install_dir/MobileFirstServer).
  2. Verify the value of the mfp.server.install.dir property in the Ant file. This value is used to take the updated MobileFirst server WAR files.
  3. Run the following command:
    mfp_install_dir/shortcuts/ant -f <your_ant_file update>
    

Rollback with own Ant file

If you use your own Ant file, make sure that for each update/rollback task (installmobilefirstadmin, installmobilefirstruntime, and installmobilefirstpush), you have a corresponding update task in your Ant file with the same parameters. The corresponding update tasks are updatemobilefirstadmin, updatemobilefirstruntime, and updatemobilefirstpush.

  1. Manually replace the MFP related war files by copying them from the backed up location of MFP install directory (mfp_server_install_dir/MobileFirstServer).
  2. Verify the class path of the taskdef element for the mfp-ant-deployer.jar file. It must point to the mfp-ant-deployer.jar file in an MobileFirst server installation that the fix pack is applied. By default, the updated MobileFirst server WAR files are taken from the location of mfp-ant-deployer.jar.
  3. Run the update tasks (updatemobilefirstadmin, updatemobilefirstruntime, and updatemobilefirstpush) of your Ant file.
Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on June 01, 2020