Upgrading the Remote ETL Engine


Whenever a new version of Remote ETL Engine is available, the status of Remote ETL Engines changes to outdated on the Status page. If you are an administrator, you are notified by email about this status change. You can update the Remote ETL Engines to the latest version by using any of these methods:

  • Upgrade from the Status page
    On the Status page, upgrade all the Remote ETL Engines simultaneously or schedule their upgrade. You can also upgrade each Remote ETL Engine separately. For details, see Checking-the-status-of-remote-components.
    We recommend using this method as it saves your time to separately upgrade each Remote ETL Engine.
  • Upgrade by using the silent response file
    Manually upgrade the Remote ETL Engine silently by using a sample response file with default settings that is included in the Remote ETL Engine upgrade image. In the upgrade process, BMC Helix Continuous Optimization detects the existing version of the Remote ETL Engine and saves all the existing settings for the upgrade process. You can either retain the default values or change them and save the file.

To upgrade the Remote ETL Engine

  1. Log in as a root user to the computer where you want to upgrade the Remote ETL Engine, and create a temporary directory.
    Ensure that the temporary directory is different from the installation directory to avoid any file sharing conflict. 
    Example: HO_temp.
  2. From the Administration > System > Downloads page, download the Remote ETL installer.
  1. Extract the downloaded file (HO_RemoteETL_<version number>_Linux.tar.gz) to the temporary directory. 
  2. Create an API user in BMC Helix Portal. For details, see Setting up API users for programmatic access

    Important

    To use the API key in the Remote ETL Engine installation, you need to generate the key by using the Capacity ETL Client role.

  3. Copy the tenant ID, access key, and secret key that is generated while creating the API user. 
    You will need to specify this key while configuring the authorization token in the options file.
  4. At the shell prompt, change to the directory where you extracted the downloaded files.
  5. Example: HO_temp/HO/Disk1.
  6. Navigate to the directory where you extracted the downloaded files and locate the sample response file.
    Example: HO_temp/HO/Disk1/silentInstallTemplates/HO_ADDITIONAL_SERVER_REMOTE_EE.txt.
  7. Edit the HO_ADDITIONAL_SERVER_REMOTE_EE.txt file in a text editor.
  8. In the -J AUTH_TOKEN property, paste the token that you copied in Step 4, modify other properties of the file according to your preferences as listed below, and then save the file.

    Prefix tags for the silent installation properties:

    • -P: Precedes the directory properties
    • -A: Precedes the application features
    • -J: Precedes the Java properties

      Property name

      Description

      Installation settings

      -P installLocation

      Installation directory path.

      Default value: /opt/bmc/HO

      Example: -P installLocation=/opt/bmc/HO

      For root user

      -J HO_USER

      Name of the user (new or existing).

      Default value: cpit

      Example: -J HO_USER=cpit

      Helix host details

      -J URL_HOST

      External data API server name. Example: -J URL_HOST=companyname-optapi.onbmc.com

      Authorization Bearer Token

      -J AUTH_TOKEN

      Bearer authorization key. This key is used to authenticate the user when connecting to the BMC Helix Continuous Optimization.
      For instructions about generating the key, see Step 3.

      Example: -J AUTH_TOKEN=Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBRE1JTiIsInJvbG...
      VfaWQiOjAsInJvbGVMe5yckarMjPg

      Proxy server connection

      -J IS_PROXY_CONFIGURED

      Configuration of the proxy server. Default value: false Example: -J IS_PROXY_CONFIGURED=false

      -J REE_PROXY_HOST

      Name of the proxy server host.-J REE_PROXY_HOST=<proxy_server_hostname>

      Example: -J REE_PROXY_HOST=vw-abc-dev01.bmc.com

      -J REE_PROXY_PORT

      Port number to communicate with the proxy server.

      Example: -J REE_PROXY_PORT=8090

      -J IS_PROXY_AUTHENTICATION_REQUIRED

      If the proxy server requires authentication, set this value to true and specify the proxy server user name and password. Default value: false Example: -J IS_PROXY_AUTHENTICATION_REQUIRED=false

      -J REE_PROXY_USER

      Proxy server user name.

      Example: -J REE_PROXY_USER=proxy_user

      -J REE_PROXY_SECPWD

      Proxy server password.

      Example: -J REE_PROXY_SECPWD=proxy_user_password

      Advanced properties

      -J IS_RECONFIGURATION_FLOW 
      -J IS_REPAIR_FLOW

      To run the installer on the existing installation, choose one of the following modes. You can set only one of these properties to true as the installer can run only in one of these modes.

      • Reconfigure: Use the reconfigure mode to modify certain values that you had provided during installation, such as database connection or repository option, in the installed product. 
        -J IS_RECONFIGURATION_FLOWDefault value: false
      • Re-installation: Use the re-installation mode to re-install the Application Server or ETL Engine. We recommend that you back up your database before starting the re-installation.
        -J IS_REPAIR_FLOW
        Default value: false

      Do not modify these settings

      -J INSTALLATION_TYPE_SELECTION

      Retains the default installation type.

      Default value: EXTERNAL_SERVER

      Example: -J INSTALLATION_TYPE_SELECTION=EXTERNAL_SERVER

      -A <feature name>

      Installs the Remote ETL Engine component.

      Default value: featureCoreETL

      Example: -A featureCoreETL

      -J IS_REMOTE_COMPONENT

      Retains the default value.

      Default value: true

      Example: -J IS_REMOTE_COMPONENT=true

      -J URL_PORT

      Retains the default port number. Default value: 443 Example: -J URL_PORT=443

      -J CUSTOM_CONNECTION_PROTOCOL

      Retains the default connection protocol. Default value: https Example: -J CUSTOM_CONNECTION_PROTOCOL=https

  9. Open a shell prompt and navigate to the directory that contains the installation files.
    Example: /HO/Disk1
  10. Launch the silent installer:

    ./setup.sh -i silent -DOPTIONS_FILE=<file path>/HO_ADDITIONAL_SERVER_REMOTE_EE.txt

    If the path contains spaces, enclose the path and options file name in quotation marks.

    After the installation is complete a confirmation message about successful installation is displayed.

To verify the upgrade

  1. Log in with the user credentials that you used for installation.
    Example: cpit.
  2. Navigate to the installation directory.
    Example: /opt/bmc/HO.
  3. Run the command: ./cpit status
  4. Verify that the Scheduler service is running.

Where to go from here

Upgrading-the-Gateway-Server

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*