Installing the Remote ETL Engine

Use the information in this topic to install the Remote ETL Engine silently. Use the sample response file that is included in the Remote ETL Engine installation image to install the Remote ETL Engine silently. Modify the default settings in the sample file instead of creating a new file. The Remote ETL Engine and the Gateway Server must be installed on the same computer. 

To install the Remote ETL Engine

1. In BMC Helix Portal, go to the BMC Helix Continuous Optimization tile and click Launch.

2. In BMC Helix Continuous Optimization, navigate to Administration > System > Downloads.

3. In the Remote ETL Installer tile, click Download.

4. Copy the installation files to the computer where you want to install the Remote ETL Engine.

5. Extract the downloaded files to the temporary directory, making sure that the temporary directory is different from the installation directory to avoid any file sharing conflict.

6. Create an API user in BMC Helix Portal and assign the Capacity ETL Client role to this API user. For details, see Setting up API users for programmatic access . 
   
   

7. 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.

   Can I copy the secret key later?

   No. The secret key is available for copying only when it is generated for the first time. Afterwards, it is saved in an encrypted form using the OpenBSD Bcrypt scheme. This encryption is irreversible. If you do not copy the secret key when it is generated or if you lose it, you must generate a new one.

   
   
   

8. At the shell prompt, change to the directory where you extracted the downloaded files and locate the sample response file.
   Example: BHCOtemp/BCO/Disk1/silentInstallTemplates/HO_ADDITIONAL_SERVER_REMOTE_EE.txt.

9. Edit the HO_ADDITIONAL_SERVER_REMOTE_EE.txt file in a text editor.

10. In the Authorization token section, paste the tenant ID, access key, and secret key that you have copied in Step 7.

11. Modify other properties of the file according to your preferences as listed below, and 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/BCO Example: -P installLocation=/opt/bmc/BCO
    Helix host details
    -J URL_HOST	Fully qualified domain name of BMC Helix Portal. Example: vw-abc-dev01.bmc.com
    Authorization token
    -J TENANT_ID	Unique identifier for the tenant. The tenant ID is displayed next to the API key setting. You can copy it, if required.  Example: -J TENANT_ID=900025273
    -J ACCESS_KEY	Access key of the API user. Copy the access key.
    -J ACCESS_SECRET_KEY	Secret key of the API user. Copy the secret key.
    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 because the installer can run only in one of these modes at a time: Reconfigure: Use the reconfigure mode to modify certain values that you had provided during installation. -J IS_RECONFIGURATION_FLOW Default value: false Re-installation: Use the re-installation mode to re-install the ETL Engine.  -J IS_REPAIR_FLOW Default value: false
    -J MIGRATION_SCHEDULER_ID	Use this property when you are migrating from existing Capacity Optimization instance to BMC Helix Continuous Optimization, and want to preserve the particular scheduler assignments, such as scheduled ETL tasks or Optimizer tasks on this Remote ETL Engine. Specify the ID of the scheduler that you want to register with this Remote ETL Engine. -J MIGRATION_SCHEDULER_ID=<scheduler_ID> Example: -J MIGRATION_SCHEDULER_ID=1
    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

12. Open a shell prompt and navigate to the directory that contains the installation files. BMC recommends that you install the Remote ETL Engine as a root user. 
    Example: /BCO/Disk1

13. Launch the silent installer:

    ./setup.sh -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 a successful installation is displayed.

To install the Remote ETL Engine by using the Proxy server

If you want to install the Remote ETL Engine by using the proxy server, perform the following steps in addition to the steps listed in the To install the Remote ETL Engine section:

1. Encrypt the password that will be used in the proxy settings by using the BCOEncoder.sh utility.

2. Run one of the following commands to encrypt the password.
   Copy the encrypted password. You will need to specify this password while configuring the proxy server connection in the options file.

   • ./BCOEncoder.sh encrypt -key <access key>

   • ./BCOEncoder.sh -encrypt -envvarname ENV_VAR_WITH_PWD -key <access key>

   • ./BCOEncoder.sh -encrypt -toencode <text to encode> -key <access key>

     Example

     ./BCOEncoder.sh -encrypt -toencode pa$$word -key U0262M32JQES27TJLGQFPLGF6PRBFO

      

3. Edit the HO_ADDITIONAL_SERVER_REMOTE_EE.txt file in a text editor.

4. Search for the # Proxy Server Connection section, and remove the '#' character from the properties to uncomment the properties.
   

   # Proxy Server Connection
   # Please note that password, in case it is required, it has to be encrypted
   # with BCOEncoder.sh utility
   ###############################################################################
   -J IS_PROXY_CONFIGURED=true
   -J REE_PROXY_HOST=
   -J REE_PROXY_PORT=
   -J IS_PROXY_AUTHENTICATION_REQUIRED=true
   -J REE_PROXY_USER=
   -J REE_PROXY_SECPWD=

5. Modify the properties according to your preferences as listed in the following table:
   

   Property name	Description
   Proxy server connection
   -J IS_PROXY_CONFIGURED	Configuration of the proxy server. Default value: false  Example: -J IS_PROXY_CONFIGURED=true
   -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=true
   -J REE_PROXY_USER	Proxy server user name. Example: -J REE_PROXY_USER=proxy_user
   -J REE_PROXY_SECPWD	Proxy server password. The password must be encrypted using the BCOEncoder.sh utility. Example: -J REE_PROXY_SECPWD=proxy_user_password

6. Paste the proxy server password in the REE_PROXY_SECPWD property that you have copied in Step 2. 
7. Save the file, navigate to the directory that contains the installation files, and launch the installer. 

(Optional) To test the proxy server connectivity from your Remote ETL Engine, use the curl command: 

Example: curl https://www.google.com -x <hostname>:<port> -U<username>:<password> -I

Sample output: HTTP/1.1 200 Connection established

To verify the installation

1. Log in with the user credentials that you used for installation.
   Example: cpit.

2. Navigate to the installation directory.
   Example: /opt/bmc/BCO.

3. Run the command: ./cpit status

4. Verify that the Scheduler service is running.

To troubleshoot the Remote ETL Engine installation

Where to go from here

Installing the Gateway Server