Preparing to Upgrade the Appliance
Before starting the upgrade process, ensure that you have met the following requirements. These requirements are applicable to both standalone and High Availability (HA) environments.
Fulfill software and hardware requirements
Ensure that you fulfill the following requirements:
- Software download access to the
TIBCO eDelivery website or
TIBCO Support website.
If you do not have access, register at TIBCO Support website or contact Technical Support by email.
- Check which
TIBCO LogLogic® Log Source Packages versions are compatible with
LogLogic LMI. If your appliance is using an earlier version of
LogLogic® LSP, you must first upgrade to one of the supported
LogLogic LSP versions of the
LogLogic LMI release to which you want to upgrade. See "LogLogic LMI-LogLogic LSP Upgrade Matrix" in
TIBCO LogLogic® Log Management Intelligence
Release Notes.
The LogLogic LSP documentation is available on the eDelivery website or TIBCO Support site after logging in.
- A null modem cable (if connecting to the appliance by using a console)
Verify disk space requirements
Verify that the appliance has sufficient disk space available for the upgrade:
- Log in to the appliance via SSH and run the following command:
df -h
- In the Available column, the disk space required for the partitions must be as follows:
- Ensure that the maximum used space of the
/loglogic directory, excluding the
/loglogic/data and
/loglogic/update subdirectories, is up to 9 GB. Run the following command:
$du -sh --exclude=/loglogic/data --exclude=/loglogic/update /loglogic
Back up the appliance data
It is strongly recommended that you back up your data on the appliance before performing an upgrade.
You must wait at least one day after a software upgrade before performing a backup, otherwise the backed up log data is inconsistent with the platform software.
For more information, see Backup and Restore section in TIBCO LogLogic® Log Management Intelligence Administration.
Apply Hotfixes
Configure parameters
Before upgrading, configure the following parameters as applicable:- CPU and memory configuration
- Inbound Polling Community String
- Active Directory
- Data vault
- Upgrading via LogLogic Management Center
- CPU and memory configuration
- Before upgrading to LogLogic LMI 6.1.0 or later, the CPU and memory of TIBCO LogLogic® Enterprise Virtual Appliance must be changed to match the minimum hardware requirements of LogLogic LMI. For more information, see TIBCO LogLogic® Enterprise Virtual Appliance Quick Start.
- Inbound Polling Community String
- Before starting the upgrade to version 6.2.1 or later, you must change the default value (public) of the Inbound Polling Community String field to any other string.
- Active Directory
- If you are setting up Active Directory (AD), after adding the certificate to the truststore, in the
/loglogic/tomcat/bin/setenv.sh file, disable endpoint verification by setting the JAVA option:
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true"
- Data vault
- If you are upgrading from 6.3.0 and if the data vault feature is enabled, you must enable the automatic unlocking of the data vault by running the following command:
system data_vault enable_auto_unlock
- Upgrading via LogLogic Management Center
- When upgrading
LogLogic LMI via
LogLogic Management Center, the following error is displayed:
Unable to upgrade LMI. See log for details
If the error is displayed, then perform the following steps as a workaround:
- Before starting the upgrade process via
LogLogic Management Center, extend the timeout setting for
mcagent on the
LogLogic LMI appliance:
- Open the
mcagent configuration file:
/loglogic/mcagent/conf/upgradeconfig.properties
- Change the value of the ha.upgrade.slave.timeout property from 3600000 ms (1 hour) to a higher value, for example, 21600000 ms (6 hours).
- Restart
mcagent by running the following commands:
cd /loglogic/mcagent/bin ./mcagent stop ./mcagent start
- Open the
mcagent configuration file:
- In LogLogic Management Center, perform the following steps:
- Before starting the upgrade process via
LogLogic Management Center, extend the timeout setting for
mcagent on the
LogLogic LMI appliance:
Disable file system checks
If you are upgrading directly from version 6.2.1 to 6.3.1, the file system check will be run by default, to check the disk configuration.For any other upgrade paths, perform the following steps:
- Before starting the upgrade process, run the CLI command > system fsck disable to prevent running a file system check during upgrade.
- After the upgrade process is complete, run the CLI command > system fsck enable to reenable the check if needed.
Download and extract the upgrade package
Log in to the TIBCO eDelivery website or TIBCO Support website and download the latest software update that you want to apply to the appliance.
- Download the update package (in
.tar format),
TIB_loglmi_<version>_fileupgrade.tar
The package contains the following files:
The bz2 and bz2.sig files are required to perform file update process.File name Description bz2 The update file bz2.sig The signature file for the upgrade file healthcheck.tar.gz The health check utility tool mc-metadata Files related to LogLogic® Management Center (required for upgrading LogLogic LMI versions by using LogLogic® Management Center) - Connect to the appliance from the shell login as the toor user and the password that was created during Setting up the Appliance by Using the Console. Use the command line through the serial port with a null modem cable or by using SSH. It is recommended to use the serial port; by using SSH, the connection is lost after the final reboot but only temporarily.
- Extract all files into the destination directory (/loglogic/update) on the appliance by running the following command:
$ tar xf <filepath_update_package> -C /loglogic/update
- Clean up the directories by running the following command:
$ rm -f <filepath_update_package>
Extract and run the health check script
- Extract the health check package contents by running the following command:
$ tar zxvf <filepath_healthcheck_package> -C /loglogic/update
where: <filepath_healthcheck_package> is the file path. For example:
/loglogic/update/healthcheck/healthcheck.tar.gz
- (Only for
TIBCO LogLogic® LX1025R1 Appliance) Run the following command to bypass the swap file check:
$ touch /loglogic/update/flag_skip_for_LX1025R1
- Run the health check script:
$ /loglogic/update/healthcheck/healthcheck.sh
Health Check - Failure Scenarios
Scenarios when the health check script might fail and the workaround in each scenario are as follows:
Items checked | Failure scenario |
---|---|
/ and /loglogic partitions | The script checks the minimum disk space is available on the appliance, otherwise upgrade might fail. See
Verify disk space requirements. If the disk space is lesser, the error message
check FAILED is displayed. For example:
/ free 100 MB check FAILEDIf you need help to reduce disk space usage, contact TIBCO Support. |
RAID health | The script checks if the RAID status is optimal. The script fails if the disks are bad or missing, and the upgrade process fails.
In case of failure, contact TIBCO Support. |
Platform model | The script checks to ensure that the system product name and platform model from
/etc/platform matches the output from the
dmidecode command. The script also checks if the appliance model is supported in the current release.
In case of failure, contact TIBCO Support. |
Resource requirements | For LogLogic EVA: The script verifies the minimum CPU frequency, number of cores, and minimum memory requirements. See the "Minimum Hardware Requirements" section in TIBCO LogLogic® Enterprise Virtual Appliance Quick Start. |
LogLogic LMI hotfix version | The script verifies that the correct hot fix version is installed. |
Database schema | If the health check script finds any database schema inconsistencies, the console displays the message:
Ignore the inconsistency?[yes/no]:Type no to stop the process and go back and fix the issue before you proceed. You can run the health check command multiple times until you fix all inconsistencies. If you type yes, all inconsistencies are ignored and you can proceed. It is good practice to contact TIBCO Support for advice about whether it is safe to ignore the inconsistencies. If the health check fails with the error:
Schema consistency checking failedgo through the schema log files, and if required, run the following commands in MySQL as a workaround: use logappconfig alter table oddsfieldtags drop FOREIGN KEY oddsfieldtags_ibfk_1; alter table oddsfieldtags drop index msgPatternId; alter table oddsfieldtags add index oddsfieldtags_ibfk_1(msgPatternId); alter table oddsfieldtags add constraint oddsfieldtags_ibfk_1 FOREIGN KEY (msgPatternId) REFERENCES oddsmessagepattern(uuid) ON DELETE CASCADE; If you applied these specific schema changes in the past, there is no need to do them again. Contact TIBCO Support for assistance and provide the following log file:/loglogic/tmp/_schemaChecking/schemaChecking.log |
Report data | The following message might be displayed to warn you about unconverted report data from previous upgrade process:
There is report data on the system that was not converted after the last upgrade. Do you want to convert this data now? [yes/no]:
|
Data vault | The health check might fail and the following error might be displayed:
Data Vault is turned on but auto-unlock is not enabled.If this error occurs, enable the automatic unlocking of the data vault by running the following command: system data_vault enable_auto_unlock |
Advanced Features | The health check might fail and the following warning might be displayed:
WARNING: Advanced Features may not perform correctly with the current memory configuration on LMI 6.2.0 and above! Do you want to continue upgrade? [yes/no]This is because Advanced Features is enabled on the appliance but the configured memory is less than 64 GB. If this occurs, type yes to continue, or disable the Advanced Features, or configure more memory on the appliance. |
High availability | The health check might fail if the Advanced Features option is already enabled and in any of the following situations:
The following message is displayed: Please turn off Advanced Features before proceeding with the upgrade.If this error message is displayed, disable Advanced Features and run the health check script again. |