Upgrading IT Data Analytics in a single server environment using the wizard

Where you are in the Upgrade process

You can upgrade IT Data Analytics using one of these settings:

• Typical: Upgrades all the components of IT Data Analytics (Collection Station, Configuration Database, Console Server, Indexer, and Search) using the default settings for the host, ports, and protocols. This is recommended for trial and small deployments.
• Custom: Allows you to customize these settings and authenticate users using Remedy Single Single-On (Remedy SSO). 

To perform a typical upgrade using the wizard

Do the following:

1. Log in to the host computer on which you want to upgrade IT Data Analytics, and delete all the files from the temporary directory: 

   • (Windows) %temp%

   • (Linux) /tmp

2. Extract the downloaded files (the installer) to a temporary location outside the following location to avoid any file sharing conflicts.

   • (Windows) C:\Program Files

   • (Linux) /opt

   It is strongly recommended that you exit all programs before starting the installation.

3. Run the installer: 

   • (Windows) Run setup.exe from Windows\Disk1

   • (Linux) As a non-root user, run ./setup.bin from Linux/Disk1

4. Review the welcome page, and click Next.

5. Read the license agreement, agree to the terms, and click Next.

6. (Optional) Select these settings, if required, and click Next:

   • Add TrueSight IT Data Analytics to the Start menu.
   • Start TrueSight IT Data Analytics services.

7. Preview the details, and verify the configurations.

8. Click Install to start the upgrade.
   After the upgrade is complete, the Installation Summary page is displayed.

9. (Optional) Click View log to view the installation log details on the screen. From the log view, you can expand and view the log messages.

10. Click Done to exit the installation program.

    The following environment variable points to the IT Data Analytics installation path after the upgrade. 

    • (Windows) %BMC_ITDA_HOME%

    • (Linux) $BMC_ITDA_HOME

11. Verify that IT Data Analytics has been upgraded successfully.
    To view the upgraded version of the product, reload the current browser page so that the cached content is ignored.

12. (Optional) Start using Remedy Single Sign-On as your authentication mechanism by running the  enablesso CLI command . Using Remedy Single Sign-On is required if you plan to use TrueSight IT Data Analytics in conjunction with the TrueSight products. For more information, see User authentication options.

13. (Optional) If you are upgrading from TrueSight IT Data Analyticsversion 2.7, ensure that you modify the properties for re-indexing after upgrading.

     To modify the properties for re-indexing

    When you upgrade from TrueSight IT Data Analyticsversion 2.7, the indexes are migrated to TrueSight IT Data Analytics11.3.01 by default. You can modify some properties to manage the way you are re-indexing the data. Search features of TrueSight IT Data Analytics such as histogram, facets, and search counts of older data are available after the migration is complete. The migration may take some time depending on the size of data.

    Notes

    • After upgrading, if you create an Upload file  type of data collector to collect earlier data, then it is possible that the collected data is added to an existing index. As a result, the search performed on this data will work in a case-sensitive way.
    • If you have existing external configurations for the TrueSight Infrastructure Management (or ProactiveNet) cells, you might need to edit them and change the encryption key. Changing the encryption key is required if TLS is enabled for TrueSight Infrastructure Management on TrueSight Operations Management 10.7. You must import the certificates generated on the TrueSight Operations Management side to be able to create new external configurations in version  11.3.01 of TrueSight IT Data Analytics. For more information, see  Enabling security for communication with Infrastructure Management server
    • Re-indexing may increase CPU utilization. You can use throttling, which increases the time taken for re-indexing, but reduces the CPU utilization. For more information refer to the table.

    Do the following:

    1. Log in to the host computer on which you have installed TrueSight IT Data Analytics.

    2. Navigate to the following location: 

       <ITDA_INSTALLATION_DIRECTORY>\BMC Software\TrueSight\ITDA\custom\conf\server\olaengineCustomConfig.properties

    3. Modify the values of the following properties in the olaengineCustomConfig.properties file:

       Property	Additional information
       reindex.enabled	Enables re-indexing. Example reindex.enabled=true By default the value is set to true. Note: If reindexed.enabled is set to false, the previously indexed data may not be compatible with the new version of TrueSight IT Data Analytics . Features such histograms and facets of older data will not be available.
       #reindex.number.of.last.days	Sets the number of days for which the re-indexing is to be done. Example #reindex.number.of.last.days=14 You can set the value to the number of days for which you want the re-indexing to be done. Depending on the number of days that you specify, the previously indexed data will be available for re-indexing. Tip You must uncomment the property if you want to change it.
       reindex.wait.before.next.bulk.write.millis	Sets the wait time in milliseconds before writing the next bulk (or chunk) into new Indexes while re-indexing. Example reindex.wait.before.next.bulk.write.millis=0 The default value is 0. The default value 0 means that there should be no wait time. Setting this value enables you to decrease the Indexer CPU usage while re-indexing. Increasing this value will decrease the CPU usage on the indexer.
       reindex.bulk.flush.threshold.millis	Sets the time in milliseconds; that are passed after the last bulk flush or start of the bulk process. The bulk that is accumulated will be flushed (written) into the Indexer after this period is over. This happens irrespective of the bulk size. Example reindex.bulk.flush.threshold.millis=60000 The default value is 60000.

       Note

       After changing the properties, if the Console Server component is already running, restart it.

14. Restore the backed up keystore file (bmcitda.jks), and restart the IT Data Analytics server after upgrading.

    Note: The bmcitda.jks keystore file is backed up before upgrading to ensure that the custom certificates are not lost after upgrading.

To perform a custom upgrade using the wizard

Do the following:

1. Log in to the host computer on which you want to upgrade IT Data Analytics, and delete all the files from the temporary directory: 

   • (Windows) %temp%

   • (Linux) /tmp

2. Extract the downloaded files (the installer) to a temporary location outside the following location to avoid any file sharing conflicts.

   • (Windows) C:\Program Files

   • (Linux) /opt

   It is strongly recommended that you exit all programs before starting the installation.

3. Run the installer: 

   • (Windows) Run setup.exe from Windows\Disk1

   • (Linux) As a non-root user, run ./setup.bin from Linux/Disk1

4. Review the welcome page, and click Next.
5. Read the license agreement, agree to the terms, and click Next.

6. Select the components of TrueSight IT Data Analytics that you would like to upgrade.

   • Indexer
   • Configuration Database
   • Collection Station
   • Console Server
   • Search

7. Depending on your selection, specify values in the applicable pages and click Next. As this is a single server installation, you must enter the same host name for all the components. Host name of the computer where you want to install the Indexer. The default is your local host name.

    Indexer

   • Host name of the computer where you want to install the Indexer. The default is your local host name.
     
   • Port number of the computer where you want to install the Indexer. The default is 9300.
     
   • If you are installing an Indexer that must function as the master, leave the Primary Node field blank.
     If you are installing an Indexer that must function as a peer or a restore Indexer or a component that communicates with the Indexer, provide the fully qualified host name and port number of the master Indexer installed on the primary node. This value must be in the format, hostName:Port.
     
   • Node type of the Indexer. The default is Live.
     
     • Live: An Indexer where the current data resides
     • Archive: An Indexer where data from the Live node is moved to for archiving or purging
     • Restore: An Indexer where archived data is restored.
    Configuration Database

   • Host name of the computer where you want to install the configuration database. The default is your local host name.

   • Port number of the computer where you want to install the configuration database. The default is 9999.

    Collection Station

   • Name of the Collection Station as it must be displayed under the Administration > Hosts tab.

   • If required, enable data collection redundancy.
     This selection implies that the Collection Station installed will be added to a common pool. If this Collection Station goes down, Collection Agents communicating with the Collection Station are moved to the other Collection Station in the pool.
     

   • The HTTP service bind address that the Collection Agent and the Console Server must use to connect with the Collection Station. The default is 0.0.0.0.

   • The HTTP service bind port number that the Collection Agent and the Console Server must use to connect with the Collection Station. The default is 8080.

   • The Payload Service bind address that the Collection Station must use for listening to incoming data. The default is 0.0.0.0.

   • The Payload Service bind port number that the Collection Station must use for listening to incoming data. The default is 41414.

    Search

   • Host name of the computer where you want to install the Search component. The default is your local host name.

   • Port number of the computer where you want to install the Search component. The default is 9797.
     

    Console Server

   • Host name of the computer where you want to install the Console Server component. The default is your local host name.

   • Port number of the computer where you want to install the Console Server component. The default is 9797.

   • Enable SSO if you want to use Remedy Single Sign-On as an authentication mechanism, and provide credentials for connecting with the Remedy Single Sign-On server. If you do not want to integrate with TrueSight Presentation Server, you can skip this option and click Next.

     If you enabled SSO, specify the following details:
     

     • Select a protocol. The default is HTTPS.

     • Fully Qualified Domain Name (FQDN) of the Remedy Single Sign-On server.

     • Port number of the Remedy Single Sign-On server.The default ports based on the operating system are:
       -(Windows) 448 for HTTPS or 88 for HTTP.
       -(Linux) 8048 for HTTPS or 8088 for HTTP.

     • Password for connecting with the Remedy Single Sign-On server. This password is the one that you provided while installing Remedy Single Sign-On.

     • Fully Qualified Domain Name (FQDN) of the TrueSight Presentation Server. If TrueSight Presentation Server is installed in a high-availability environment, specify the FQDN of the Load Balancer.

     • Port number of the TrueSight Presentation server. The default ports based on the operating system are:

       -(Windows) 443 for HTTPS or 80 for HTTP.

       -(Linux) 8043 for HTTPS or 8080 for HTTP.

     • Name of the tenant (also known as Realm in Remedy Single Sign-On).

       The default is " * ".

       Note: The same tenant name should be used when you configure TrueSight IT Data Analytics with TrueSight Presentation Server.

8. (Optional) Start the TrueSight IT Data Analytics services, and click Next.

9. Preview the details, and verify the configurations.
10. Click Install to start the upgrade.
    After the upgrade is complete, the Installation Summary page is displayed.
11. (Optional) Click View log to view the installation log details on the screen. From the log view, you can expand and view the log messages.

12. Click Done to exit the installation program.

    The following environment variable points to the IT Data Analytics installation path after the upgrade. 

    • (Windows) %BMC_ITDA_HOME%

    • (Linux) $BMC_ITDA_HOME

13. Verify that IT Data Analytics has been upgraded successfully.
    To view the upgraded version of the product, reload the current browser page so that the cached content is ignored.

14. (Optional) Start using Remedy Single Sign-On as your authentication mechanism by running the  enablesso CLI command . Using Remedy Single Sign-On is required if you plan to use TrueSight IT Data Analytics in conjunction with the TrueSight products. For more information, see User authentication options.

15. (Optional) If you are upgrading from TrueSight IT Data Analyticsversion 2.7, ensure that you modify the properties for re-indexing after upgrading.

     To modify the properties for re-indexing

    When you upgrade from TrueSight IT Data Analyticsversion 2.7, the indexes are migrated to TrueSight IT Data Analytics11.3.01 by default. You can modify some properties to manage the way you are re-indexing the data. Search features of TrueSight IT Data Analytics such as histogram, facets, and search counts of older data are available after the migration is complete. The migration may take some time depending on the size of data.

    Notes

    • After upgrading, if you create an Upload file  type of data collector to collect earlier data, then it is possible that the collected data is added to an existing index. As a result, the search performed on this data will work in a case-sensitive way.
    • If you have existing external configurations for the TrueSight Infrastructure Management (or ProactiveNet) cells, you might need to edit them and change the encryption key. Changing the encryption key is required if TLS is enabled for TrueSight Infrastructure Management on TrueSight Operations Management 10.7. You must import the certificates generated on the TrueSight Operations Management side to be able to create new external configurations in version  11.3.01 of TrueSight IT Data Analytics. For more information, see  Enabling security for communication with Infrastructure Management server
    • Re-indexing may increase CPU utilization. You can use throttling, which increases the time taken for re-indexing, but reduces the CPU utilization. For more information refer to the table.

    Do the following:

    1. Log in to the host computer on which you have installed TrueSight IT Data Analytics.

    2. Navigate to the following location: 

       <ITDA_INSTALLATION_DIRECTORY>\BMC Software\TrueSight\ITDA\custom\conf\server\olaengineCustomConfig.properties

    3. Modify the values of the following properties in the olaengineCustomConfig.properties file:

       Property	Additional information
       reindex.enabled	Enables re-indexing. Example reindex.enabled=true By default the value is set to true. Note: If reindexed.enabled is set to false, the previously indexed data may not be compatible with the new version of TrueSight IT Data Analytics . Features such histograms and facets of older data will not be available.
       #reindex.number.of.last.days	Sets the number of days for which the re-indexing is to be done. Example #reindex.number.of.last.days=14 You can set the value to the number of days for which you want the re-indexing to be done. Depending on the number of days that you specify, the previously indexed data will be available for re-indexing. Tip You must uncomment the property if you want to change it.
       reindex.wait.before.next.bulk.write.millis	Sets the wait time in milliseconds before writing the next bulk (or chunk) into new Indexes while re-indexing. Example reindex.wait.before.next.bulk.write.millis=0 The default value is 0. The default value 0 means that there should be no wait time. Setting this value enables you to decrease the Indexer CPU usage while re-indexing. Increasing this value will decrease the CPU usage on the indexer.
       reindex.bulk.flush.threshold.millis	Sets the time in milliseconds; that are passed after the last bulk flush or start of the bulk process. The bulk that is accumulated will be flushed (written) into the Indexer after this period is over. This happens irrespective of the bulk size. Example reindex.bulk.flush.threshold.millis=60000 The default value is 60000.

       Note

       After changing the properties, if the Console Server component is already running, restart it.

16. Restore the backed up keystore file (bmcitda.jks), and restart the IT Data Analytics server after upgrading.

    Note: The bmcitda.jks keystore file is backed up before upgrading to ensure that the custom certificates are not lost after upgrading.

Troubleshooting upgrade issues

If you face issues during the upgrade, see Troubleshooting an IT Data Analytics deployment