Preparing to upgrade
This section provides information about the steps you need to follow before performing an upgrade.
- Automatic migration of console and agent customizations
- Migrating customizations with the PATROL Configuration Manager
- Determining the location of PATROL
- Creating an installation package of the merged BMC PATROL for JBoss Application Server
- Removing files from the PATROL_CACHE directories
- Removing previous profiling libraries
Whether you are upgrading and migrating customizations or simply upgrading, you must first back up the current installation. If the .kml file or any of the .km files for the new version of BMC PATROL for JBoss Application Server has a different file name from the previous version, you must remove those files from the list of KMs that are preloaded on the PATROL Agent.
Before you begin
If you plan to migrate your customizations, determine whether you can migrate from a previous version of BMC PATROL for JBoss Application Server.
To back up the current installation
Back up your customizations so that you can restore the current installation if you want to roll back your upgrade.
- Shut down any PATROL Agents, consoles, and related services that are currently running.
- Ensure that no one is accessing any PATROL files or directories.
- Perform a full backup of the directories where PATROL files are typically stored. These directories are listed in the following tables:
Windows
File Type | Directory |
|---|---|
Executables and data | PATROL_HOME for agent and console installation directories |
Console customizations | PATROL_CACHE for the console working cache |
UNIX and Linux
File Type | Directory |
|---|---|
Executables and data | PATROL_HOME/.. for agent and console installation directories |
Console customizations | PATROL_CACHE for the console working cache |
Automatic migration of console and agent customizations
Only customizations to Knowledge Modules must be migrated. Whether you choose to save and migrate your KM customizations or not, the customizations you have made to the following components are preserved and incorporated into the new version automatically:
- Agents - Stored in the agent configuration file
- Consoles - Stored in the console cache files
Migrating customizations with the PATROL Configuration Manager
BMC recommends that if you have customized KMs that these customizations should be migrated to PATROL Configuration Manager rulesets. PATROL Configuration Manager rulesets allow you to manage customizations to KMs, depending on the type of customization.
- If you have localized parameters or global parameters that have customized poll times or thresholds, use the AS_CHANGESPRING KM to migrate these customizations into PATROL Configuration Manager rulesets.
- If you have created custom recovery actions, follow these steps:
- Ensure that you have made a record of your customizations and have backed up the customized files in the PATROL_HOME and PATROL_CACHE directories.
- Uninstall the old version of BMC PATROL for JBoss Application Server.
- Install the new version of BMC PATROL for JBoss Application Server as described in the section Performing the installation.
- Ensure that you have made a record of your custom recovery actions.
- Use the Recovery Action Event Management commands as described in the PATROL Configuration Manager User Guide to migrate your custom recovery actions to the PATROL Configuration Manager.
Determining the location of PATROL
During the installation process, the PATROL Installation Utility records where it installs PATROL components in environment variables. To function properly, various components of the PATROL product, such as the migration tools, require the information stored in these variables. Two important variables are PATROL_HOME and PATROL_CACHE.
Throughout this section, all references to PATROL_HOME represent %PATROL_HOME% if you are using Windows and $PATROL_HOME if you are using UNIX. All references to PATROL_CACHE represent %PATROL_CACHE% if you are using Windows and $HOME/patrol if you are using UNIX.
Default values for PATROL location variables
If you do not specify a location for the PATROL installation, the installer uses the following preprogrammed default locations and stores these locations in environment variables.
Default Values for PATROL Location Variables
Viewing environment variables set by PATROL
To view the value of PATROL_HOME, PATROL_CACHEand other environment variables, perform the appropriate procedure for your operating system:
Operating System | Procedure |
|---|---|
Microsoft Windows | Using the Control Panel tools
|
UNIX using Bourne or Korn Shell |
|
UNIX using C Shell |
|
Creating an installation package of the merged BMC PATROL for JBoss Application Server
After you have migrated and merged your customizations, you must create an installation package that can be used with the installation utility to install locally on one computer or with Distribution Server, to install remotely on multiple computers.
- Copy the entire contents of the BMC PATROL for JBoss Application Server CD to a temporary directory on a hard drive on a server. You can delete this temporary directory after you have successfully created an installable image.
- Navigate to the packaged_results directory for the merged package and open the .ppf file with a text editor. Write down the file name in the first line of the .ppf file. This file name is the name of the directory that you will look for in the Products directory of the CD image.
Rename the packaged_results directory with the file name that you found in the .ppf file in the previous step.
- Copy the renamed directory to the Products directory of the temporary directory that you used in Step 1. You will be replacing the files there with the merged files that contain your customizations.
- Copy theBMC PATROL for JBoss Application Server CD image to the server that you will use to installBMC PATROL for JBoss Application Server.
Removing files from the PATROL_CACHE directories
Before you install, you must remove the current BMC PATROL for JBoss Application Server files from the PATROL_CACHE directory for the console. If you do not, old product files in PATROL_CACHE are loaded instead of the newly installed files from PATROL_HOME. You may wish to create a backup copy of the files elsewhere on your system before deleting the files.
Delete files with the following naming patterns from PATROL_CACHE\knowledge and PATROL_CACHE\psl:
- PJB*
- JMX*
Removing previous profiling libraries
Advanced JVM monitoring features of PATROL for JBoss Application Server deploy files to the JAVA_HOME directory used by JBoss. Typically this directory is located at java/jre relative to the JBoss installation directory. If you previously activated these features using PATROL for JBoss 2.1.00 or later, you should remove these files.
To remove the files that support advanced monitoring features:
- Stop the PATROL Agent, all application servers, and any other JVMs that are using the JAVA_HOME directory.
- Remove the directory JAVA_HOME/lib/PATROL.
- Remove all files matching the pattern BMC.jar* under the directory JAVA_HOME/lib/ext.
- Remove any of the following platform-dependent advanced profiling files that may exist on your system.
Platform | Location | File |
|---|---|---|
Windows | %JAVA_HOME%\jre\bin | BMCProfiler.dll |
AIX or Linux | $JAVA_HOME/jre/bin | libBMCprofiler.so |
Solaris | $JAVA_HOME/jre/lib/sparc | |
HP | $JAVA_HOME/jre/lib/PA_RISC2 | libBMCprofiler.sl |
Once you have completed your upgrade of PATROL for JBoss, updated files be deployed if these features are active.