Administer > RTSM > RTSM Data Flow Management > Data Flow Management Setup > Data Flow Probe Setup > Enhancements to Probe Upgrade Mechanism

Enhancements to Probe Upgrade Mechanism

Starting with version 10.31, there is no need for manual backup and restore of the probe configuration files during probe upgrade.

Note This feature is applicable to Data Flow Probe version 10.31 or later. It does not handle custom settings in  DataFlowProbe.properties for probes of version 10.30 (or earlier). Make sure you back up all your custom settings for probe of version 10.30 (or earlier) before you install a Data Flow Probe of version 10.31 (or later) and then restore the settings after.

The Data Flow Probe upgrade and deployment mechanism works in the following way:

  • Keeps all custom settings in a separate configuration file. A new configuration file DataFlowProbeOverride.properties is available in the <DataFlowProbe_InstallDir>/conf folder to store all custom input you enter during probe installation, as well as all customized changes made through the RTSM UI and the JMX Console. Only the out-of-the-box (OOTB) configuration file DataFlowProbe.properties is replaced during probe upgrade.

    • For automatic probe installation/upgrade,

      • If the DataFlowProbeOverride.properties file does not exist, the probe creates the file at probe startup.
      • If the DataFlowProbeOverride.properties file already exists, the probe keeps the file during the probe upgrade process.

    • For manual probe installation/upgrade,

      • The installer creates the DataFlowProbeOverride.propterties file directly if it does not exist.
      • All custom input during installatin/upgrade are written into the file directly.

    • Changes made through RTSM UI or by JMX methods are written to the DataFlowProbeOverride.properties now. The probe API is enhanced, all custom input and changes made to DataFlowProbe.properties parameters through RTSM UI or JMX console (like invoking setSharedKey and changeMasterKey) are automatically written to the DataFlowProbeOverride.properties file. The OOTB values in the DataFlowProbe.properties remain the same.

    For details about how the new probe configuration file works, see "DataFlowProbeOverride.properties File" on page 1.

    Note If you need to make changes to the settings in WrapperGatway.conf and WrapperManager.conf, make sure you save the new settings into the WrapperGatwayCustomer.conf and WrapperManagerCustomer.conf files, which will not be overwritten during probe upgrade.

  • Always loads the DataFlowProbeOverride.properties file first. The probe configuration load mechanism is modified and enhanced, so that at each probe startup, it always loads settings from the new configuration file first, and then from the OOTB DataFlowProbe.properties.

    During probe startup, the probe evaluates and combines settings in both DataFlowProbeOverride.properties and DataFlowProbe.properties, and takes actions as follows:

    • For parameters that exist in both DataFlowProbeOverride.properties and DataFlowProbe.properties, the probe loads DataFlowProbeOverride.properties first, and the parameters in DataFlowProbeOverride.properties will take effect.

      For parameters that have different values in two files, at probe startup, a warning log is printed in <DataFlowProbe_InstallDir>/conf/WrapperProbeGw.log for each parameter with value conflict, indicating which value takes effect.

    • For parameters that only exist in the OOTB DataFlowProbe.properties, the probe loads the OOTB configuration file, and those parameters work the same way as previous.

  • Extended support coverage for the probe upgrade mechanism, including:

    • Offers support for UCMDB Integration Service.

    • Also supports automatic backing up of other configuration files, including Wrapper.conf, SSL.conf, postgresql.conf, and so on.

The table below describes how the probe install/upgrade mechanism handles probe configuration files in different scenarios:

Upgrade Mechanism Probe Upgrade Path Upgrade Behavior
From To
Automatic 10.30 (or earlier)

10.31

10.32

After upgrade:

  1. At probe startup, it checks whether the DataFlowProbeOverride.properties file exists. If no, it creates the file; If yes, it keeps the file.

  2. At probe startup, the probe loads parameters from DataFlowProbeOverride.properties first and then from DataFlowProbe.properties.

  3. Changes made to probe properties through RTSM UI or JMX console are saved and stored in DataFlowProbeOverride.properties automatically.

10.31 10.32
  1. The 10.32 installer is a CUP like package, it does not contain DataFlowProbeOverride.properties.

  2. At probe startup, the probe loads parameters from DataFlowProbeOverride.properties first and then from DataFlowProbe.properties.

  3. Changes made to probe properties through RTSM UI or JMX console are saved and stored in DataFlowProbeOverride.properties automatically.

Manual install 10.30 (or earlier)

10.31

10.32
  1. Installer creates DataFlowProbeOverride.properties.

  2. At probe startup, the probe loads parameters from DataFlowProbeOverride.properties first and then from DataFlowProbe.properties.

  3. Changes made to any probe property through RTSM UI or JMX console are saved and stored in DataFlowProbeOverride.properties automatically.

10.30 (or earlier) 10.33
  1. Installer creates DataFlowProbeOverride.properties.

  2. Saves all custom input values during installation into DataFlowProbeOverride.properties.

  3. At probe startup, the probe loads parameters from DataFlowProbeOverride.properties first and then from DataFlowProbe.properties.

  4. Changes made to any probe property through RTSM UI or JMX console are saved and stored in DataFlowProbeOverride.properties automatically.

10.31

10.32

 10.33

  1. The uninstall script backs up the following files before the probe installation:

    • DataFlowProbeOverride.properties
    • DataFlowProbe.properties

    • WrapperGatwayCustomer.conf

    • WrapperManagerCustomer.conf

    • SSL.conf

      Note The uninstall script reads keystore information from SSL.conf, and then backs up both SSL.conf and the keystore file.

    • postgresql.conf

    • pg_hba.conf

  2. The install script restores the following during probe installation:

    • WrapperGatwayCustomer.conf
    • WrapperManagerCustomer.conf

    • SSL.conf and the keystore file

    • postgresql.conf

    • pg_hba.conf

  3. At probe startup, the probe loads parameters from DataFlowProbeOverride.properties first and then from DataFlowProbe.properties.

  4. Changes made to any probe property through UCMDB UI or JMX console are saved and stored in DataFlowProbeOverride.properties automatically.

Backup Location

The pg_hba.conf file is backed up to the $ProbeInstallDir/Backup_DataFlowProbe/pgsql/data folder.

All other files are backed up to the $ProbeInstallDir/Backup_DataFlowProbe/conf folder.

$ProbeInstallDir is where probe is installed, for example, C:\hp\UCMDB\DataFlowProbe.

Limitation

The uninstall script contained in version 10.31 probe installer is enhanced to perform the automatic backup action. So for the new install scenario, for any probe with a version lower than 10.31, after it is upgraded to version 10.31 (or higher) manually, it cannot not perform the backup and restore actions on configuration/properties files for the probe of version 10.30 (or earlier). Only after a new install of version 10.31 (or higher) probe, the enhanced uninstall script is available for performing backup action on the configuration/properties files, and then the install script is able to perform automatic restore of those files.

Also, for minor minor releases of probe (for example, 10.30), if a probe is upgraded to version 10.31 (or higher) using a CUP like installer, and then you perform another upgrade manually, the auto backup/restore feature does not work as well, because the uninstall script is not included in the CUP like installer.

Related Topics Link IconRelated Information

Send Help Center feedback