IBM Performance Management

Upgrading the server on the same system

You can upgrade your Performance Management server from v8.1.2 to v8.1.3 on the same system. The advantage with this method is that a second system is not required for the upgrade. Customers with small to medium environments usually choose this method.

Before you begin

If your v8.1.2 Performance Management server is connected to a remote MongoDB, install MongoDB v3.0.6. For instructions, see Installing MongoDB v3.0.6 on your remote system.

About this task

The procedure for upgrading the Performance Management server from v8.1.2 to v8.1.3 on the same system involves these general steps:
  1. Install the patch on your v8.1.2 server.
  2. Back up your v8.1.2 server data and configuration files with the backup script that is part of the v8.1.3 server installation package.
  3. Back up the v8.1.2 databases.
  4. Uninstall your v8.1.2 Performance Management server.
  5. If your Performance Management server is connected to a remote DB2® server, run commands to update the SCR database on the remote DB2 server.
  6. Install the v8.1.3 Performance Management server.
  7. Restore the server data and configuration files from the v8.1.2 Performance Management server backup.

Procedure

While logged in as the root user on the system where your v8.1.2 Performance Management server is installed, complete these steps to upgrade your server to v8.1.3 on the same system:

  1. Download the Performance Management server installation image from the download site to a staging location of your choosing. See Downloading from Passport Advantage.
  2. If you plan to configure the agent images, the Hybrid Gateway image, or both during the server upgrade, download the images to the server system. For details, see Download instructions.
  3. Extract the server installation files for your offering. Use the same offering file for the v8.1.3 upgrade that you used for v8.1.2. If you had two offerings in v8.1.2, for example, IBM Monitoring and IBM Application Diagnostics, use one of these offering files for the v8.1.3 upgrade. The current offerings are:
    IBM Application Performance Management Advanced
    tar -xf ipm_apm_advanced_8.1.3.tar
    IBM Application Performance Management
    tar -xf ipm_apm_8.1.3.tar
    IBM Application Diagnostics
    tar -xf ipm_app_diagnostics_8.1.3.tar
    IBM Monitoring
    tar -xf ipm_monitoring_8.1.3.tar
  4. Download a new version of the restore.sh script from http://www.ibm.com/support/docview.wss?uid=swg21981940. Replace the restore.sh script in the tools directory on the v8.1.3 Performance Management server installation image with the new restore.sh script that you downloaded.
  5. Install the v8.1.2 patch:
    1. Starting from where you extracted the v8.1.3 installation files, change to the packages/Patches directory.
    2. Copy the 8.1.2.0-IBM-IPM-IF0014.tar file to your v8.1.2 Performance Management server and perform these steps on the v8.1.2 Performance Management server.
      1. Extract the patch package:
        tar xvf 8.1.2.0-IBM-IPM-IF0014.tar
      2. Run the following script to apply the patch:
        apmpatch.sh
  6. Verify that the default permissions are set correctly on the directory. Open a command prompt and enter umask.
    A value of 0022 is returned if the permissions are set correctly. If any other value is returned, set the permissions by entering the following command:
    umask 0022
  7. From the directory where you extracted the installation files, run the following command to back up your v8.1.2 Performance Management server installation where 813_image is the directory where you extracted the v8.1.3 server installation files.
    813_image/tools/backup.sh [-f ~/backup812.tar]
    Include the -f option if you want to specify the path and file name for the server backup. For example, ~/backup812.tar saves to /root/backup812.tar. The default path is /opt/ibm/backups/backup_yyyymmdd_hhmmss.tar, such as /opt/ibm/backups/backup_20150826_155605.tar.
    Important: If your MongoDB was installed on a remote system, use the backup file you created when you upgraded MongoDB instead. For details, see Installing MongoDB v3.0.6 on your remote system.

    If your existing v8.1.2 server is configured with a non-default user name for the Performance Management user interface administrator account, you must run the following backup.sh script:
    813_image/tools/backup.sh [-f ~/backup812.tar] 
    -u uiadmin_username -p uiadmin_password
    For example, if the Performance Management UI administrator user name is uiadmin and the non-default password for this user is uiadminpwd, enter the following command:
    813_image/tools/backup.sh -u uiadmin -p uiadminpwd
    Note:
    • If you do not want the password to be visible by other users, you can use environment variables to provide the password and the user name by entering the following commands:
      export APMADMIN_USERNAME=uiadmin
      export APMADMIN_PASSWORD=uiadminpwd
      Then, run the backup.sh script by entering the following command:
      813_image/tools/backup.sh [-f ~/backup812.tar]
      The Performance Management UI administrator's user name and password is read from the backup during the restore phase.
    • If your Performance Management server is connected to a remote DB2® server, you can ignore the warning to run the backup script on the remote server.

    Output messages inform you of the backup progress, backup path, and file name upon completion.

  8. Uninstall your v8.1.2 Performance Management server:
    1. Run the following command in the /opt/ibm/ccm directory (or /custom_path/ccm if you installed the server in a different path):
      ./uninstall.sh
    2. Review the list of installed Performance Management offerings and enter the number that uninstalls all the offerings (the whole product) or enter q (quit) to cancel the uninstall operation.
  9. If your Performance Management server is connected to a remote DB2 server, complete these steps on the system where DB2 is installed:
    1. Copy the setup-dbconfig-linux_64.bin script from the packages/SCR directory of the v8.1.3 Performance Management server installation image to the remote DB2 server system.
    2. All commands in this section are run as the DB2 instance user (db2apm), not the root user. If not already logged in as db2apm, enter:
      su - db2apm
    3. Run the setup_dbconfig-linux_64.bin script to set up the SCR32 database. Run the script as the same DB2 instance user (db2apm) who ran the script during the creation of the v8.1.2. SCR database. Do not run the script as user root.
      /path/setup-dbconfig-linux_64.bin -i console
      Follow the console prompts:
      1. When you are prompted to choose a locale, enter 2 to select English.
      2. Enter 1 to accept the license agreement.
      3. Enter the absolute path to the installation folder or press Enter to accept the default path. The default path is the setup-dbconfig installation path for v8.1.2. Do not change this path, unless the path is incorrect. In this procedure, we refer to this path as /opt/ibm/db2/tbsmdb.
      4. Enter 1 to select IBM SmartCloud Application Performance Management(APM)as the product that uses the database.
      5. Enter 1 to select Simple as the type of installation to run.
      6. Enter 2 to instruct the installer not to create the database schema, including the tables, table spaces, and views.
      7. Enter the database user ID and password.
      8. Enter the following database configuration details when you are prompted:
        • Database Name (maximum 8 characters) (DEFAULT: SCR32): SCR32
        • Database host name or IP address (DEFAULT): host_name_or_IP_address
        • Port (DEFAULT: 50000): 50000
    4. Upgrade the Java UDF routines in the restored DB2 SCR database. Enter:
      cd /opt/ibm/db2/tbsmdb/bin
      ./tbsm_db.sh -s sc -U db2apm -P db2Usrpasswd@08 -f  j
      Note: If you do not want the password visible on the command line, you can omit the -P flag and the script will prompt for the password. For example:
      ./tbsm_db.sh -s sc -U db2apm -f  j
      Enter the database password:
    5. Enter the following command as the db2apm user for each database to adjust the buffer pool after you determine the size of your environment.
      db2 connect to WAREHOUS
      db2 alter bufferpool IBMDEFAULTBP IMMEDIATE size WAREHOUS_PAGE_COUNT
      db2 disconnect WAREHOUS
      db2 connect to DATAMART
      db2 alter bufferpool IBMDEFAULTBP IMMEDIATE size DATAMART_PAGE_COUNT
      db2 disconnect DATAMART
      db2 connect to SCR32
      db2 alter bufferpool IBMDEFAULTBP IMMEDIATE size 5000
      db2 alter bufferpool TBSMCFG16KBP IMMEDIATE size 1000
      db2 alter bufferpool TBSM4KBP IMMEDIATE size 1000
      db2 alter bufferpool TBSM32KBP IMMEDIATE size 1000
      db2 alter bufferpool TBSMSCR16KBP IMMEDIATE size SCR32_PAGE_COUNT
      db2 disconnect SCR32
      where:

      WAREHOUS_PAGE_COUNT is the buffer pool page count (8 K page sizes): 50000 for extra small; 75000 for small; 100000 for medium; or 100000 for large.

      DATAMART_PAGE_COUNT is the buffer pool page count (8 K page sizes): 50000 for extra small; 100000 for small; 200000 for medium; or 300000 for large.

      SCR32_PAGE_COUNT is the buffer pool page count. Size recommendations for the first four SCR buffer pools are as follows:
      • For SCR32_TBSMSCR16KBP use
        • 10000 for extra small
        • 15000 for small
        • 30000 for medium
        • 30000 for large

      Estimate the size of your environment (extra small, small, medium, or large) from the server requirements table in System requirements.

  10. Install the new version of the Performance Management server and restore the data and configuration from the backup:
    1. If the computer system or VM where you are installing the Performance Management server with a local DB2 server is using LDAP for user authentication, update the passwords for the itmuser and the DB2 instance users if they are configured in your LDAP directory. Complete steps 1 to 8 in Installing on a system using LDAP.
    2. When you are upgrading your Performance Management server from v8.1.2 to v8.1.3, you must install v8.1.3 in the same directory where the v8.1.2 server was previously installed. This installation path was either the default /opt/ibm directory or a directory that you chose. Run the ./install.sh command to start the installation script.
    3. When you are asked if you want to upgrade from an existing installation of the Performance Management server, enter 1 (Yes).
    4. When you are asked if you want to migrate the server data and configuration automatically or manually, enter 2 for manual migration.
    5. When you are asked for the backup file location, enter the path and file name that you created in Step 7 (such as /opt/ibm/backups/backup_20150826_155605.tar).
    6. Review the offering or offerings that are displayed and enter 1 (yes) to continue with the installation or 2 (no) to stop the installation.
    7. When you are asked whether you accept the license agreement, enter 1 to accept the agreement and continue, or enter 2 to decline.
    8. After you are asked whether you want to configure your agent installation images and Hybrid Gateway installation image (if used) to connect to the server, enter either 1 (yes) to configure the images now or 2 (no) to defer configuration of the agent and Hybrid Gateway images.
      If you entered 1 (yes), you are prompted to confirm the following information:
      • The path to the directory on the server where the agent images and Hybrid Gateway (if used) are stored.
        The agent images and Hybrid Gateway images can be mounted on an NFS partition but must be accessible using the file system.
      • Enter the path to the directory for the configured agent installation images or accept the default install_dir/ccm/depot directory.
      • If you accepted the default directory for storing the configured agent and Hybrid Gateway images, the installer creates the directory install_dir/ccm/depot for storing the configured agent and Hybrid Gateway images. However, if you chose to change the directory, or if the installer fails to create the directory, or the directory is not writable, you are prompted to specify the output directory.

      If you entered 2 (no), this step is skipped.

    9. When you are prompted to enter the IP address and host name that will be used by agents to communicate with the server, enter the server IP address or host name for the agents and Hybrid Gateway to use. The format of the IP address can be IPv4 or the fully qualified domain name. You can change the IP address and host name later. See Changing the server IP address and host name.
    10. When you are prompted for the host name and IP address of the server, enter the fully qualified host name or IP address of the Performance Management server. This is the address that users enter to start the Performance Management console from their web browsers, for example: https://myserver:9443 or http://myserver:8080. You can change the IP address and host name later. See Changing the server IP address and host name.
    11. If your Performance Management server is connected to a remote DB2 server, respond to the prompts to connect to the remote DB2 database:
      Enter configuration parameters to establish connection to  the  existing DB2 database.
      Enter the hostname/IP address to the DB2 host or accept the default  [10.46.40.100]:
      Enter the port number of the DB2 instance or accept the default [50000]:
      Enter the password for the user "itmuser":
      Enter the password for the instance user "db2apm":
      Note: When your Performance Management server is connected to a remote DB2 server, you can ignore the following message. You are not required to run the restore script and you must not modify the database names.
      The following database names must match names used with restore.sh script on the external DB2 machine.
      Enter the name of Metric Cache database or accept the default [WAREHOUS]:
      Enter the name of Topology database or accept the default [SCR32]:
      Enter the name of Datamart database or accept the default [DATAMART]:

    If the installer detects any agent configuration packages in install_dir/ccm/depot from a previous installation of the Performance Management server, it warns you that it renamed the old packages and created new agent packages. The old packages are named install_dir/ccm/depot.old.

    If the installer detects a keyfiles directory in install_dir from a previous installation of the Performance Management server, it warns you that it renamed the old keyfiles directory and created a new directory. The old keyfiles directory is named install_dir/keyfiles.old.

    A prerequisite scan of your environment starts and takes a few moments to complete. If any requirements are missing, a message directs you to a log file with the reason for the failure, such as insufficient disk space. You must address the failure and start the installation again. A soft prerequisite such as low available memory does not stop the installation but you must enter 1 to continue installing or 2 to stop.

Results

The installer upgrades to the new version of the Performance Management server and restores the data and configuration from the server backup. This upgrade procedure can take up to 1 hour or longer depending on the size of your backup.

What to do next

  • If you are using the default certificate for the Performance Management console, complete these steps to use the updated certificate that is provided with v8.1.3:
    1. Stop the Performance Management server. Enter:
      apm stop_all
    2. Enter the following commands:
      cd install_dir/wlp/usr/servers/apmui/resources/security
      cp key.jks  key.jks.812
      cp key.jks_org  key.jks
    3. Start the Performance Management server. Enter:
      apm start_all
  • Before you use the Performance Management console that you upgraded, clear the cache of your web browser and restart it. Clearing the cache avoids display issues that new capabilities in this update introduced to some of the user interfaces.
  • If you want to use the old agent configuration packages from a previous installation for agent installations, complete these steps:
    1. Go to the install_dir/ccm directory.
    2. Delete the agentconfig file.
    3. Change the name of the agentconfig.old file to agentconfig.
  • If you want to use the old keystore from a previous installation for the Performance Management server, complete these steps:
    1. Go to the install_dir directory.
    2. Delete the keyfiles directory.
    3. Change the name of the keyfiles.old directory to keyfiles.
    4. Update the certificates that are used by the monitoring agents to connect to the Performance Management server to use the new keystore. For instructions, see Configuring certificates between the server and agents.
    5. Update the certificates that are used by the server agents to connect to the Performance Management server to use the new keystore. For instructions, see Configuring certificates between the server and agents.
  • If the system where you installed the Performance Management server is using LDAP, and you updated the passwords for the itmuser and the DB2 instances users in step 8.a, complete steps 10 and 11 in Installing on a system using LDAP.
  • If you enabled single sign-on between the Performance Management server and Tivoli® Common Reporting in v8.1.2, you must enable single sign-on again after the upgrade.
    1. Disable OpenID connect (OIDC) authorization. For more information, see Disabling OpenID Connect authentication for the Performance Management console.
    2. Complete steps 8 and 9 in Enabling single sign-on between IBM Performance Management and Tivoli Common Reporting to update the server.xml file and restart the Performance Management console.
  • Review the WAREHOUS database settings that were applied by the restore process.
    update database config for warehous using DFT_DEGREE any
    update database config for warehous using LOGBUFSZ 1024
    update database config for warehous using LOCKLIST AUTOMATIC
    update database config for warehous using SORTHEAP AUTOMATIC
    update database config for warehous using SHEAPTHRES_SHR AUTOMATIC
    update database config for warehous using NUM_IOCLEANERS AUTOMATIC
    update database config for warehous using NUM_IOSERVERS AUTOMATIC
    update database config for warehous using LOGFILSIZ 4096
    update database config for warehous using LOGPRIMARY 10
    update database config for warehous using DBHEAP AUTOMATIC
    update database config for warehous using LOGSECOND 40
    update database config for warehous using AVG_APPLS AUTOMATIC
    update database config for warehous using logarchmeth1 OFF
    update database config for warehous using logarchmeth2 OFF
    update database config for warehous using DATABASE_MEMORY 250000 AUTOMATIC
    Because Performance Management does not support pruning of database logs, the logarchmeth1 and logarchmeth2 settings are set to OFF. If you back up your Warehouse database and you support log pruning in your environment, modify these settings.