Installing remote components to collect on-premises data
This section describes how to install the Remote ETL Engine, Gateway Server, and Capacity Agent that are needed to collect data from your environment.
For information about system requirements and sizing guidelines, see Planning.
This section describes how to install the Remote ETL Engine silently.
The following video (4:16) illustrates the process of installing the Remote ETL Engine.
A sample response file with default settings is included in the Remote ETL Engine install image. Modify the sample file instead of creating a new file. The sample file also includes instructions on how to run the installation silently.
Log in as a root user to the computer where you want to install the Remote ETL Engine, and create a temporary directory. Example: HOCO_temp.
Download the installation files from ftp://<customerprefix>-opt-ftp.onbmc.com/FromOnDemand/optimize-onprem.
Extract the downloaded files to the temporary directory. Ensure that the temporary directory is different from the installation directory to avoid any file sharing conflict.
Generate the API key from the Helix Capacity Optimization Console. You will need to specify this key while configuring the bearer authorization token in the options file.
Log in to the Helix Capacity Optimization Console as ho-admin or other admin user.
Select Administration > Users > Roles.
The Roles page shows a summary table listing the currently defined user roles, their description, and the associated Helix SSO (local or integrated LDAP) groups as external names, if applicable.Click the ADMIN role name.
The detail page for the selected role is displayed in the working area, listing all activities assigned to the role.- Click Generate API key.
- On the Generate API key page, select No expiration date.
The expiration date is the date when the API key will no longer be useful for authentication. The default expiration date is one month from the date of the API key generation. Click Generate. The credentials are encrypted and downloaded as the credentials.key file.
Open the credentials.key file in a text editor.
Contents of the credentials.key file
The credentials.key file contains the following:
- COConsoleURL: The URL of the Helix Capacity Optimization Console from where you generated the API key.
Authorization: The authorization key. The token includes the role ID that generated the key, activities assigned to the role at the time of creation, and the expiration date of the key. After the key is generated, if there are any changes to the activities assigned to the role that generated the key, those changes will not be reflected in the already generated key. You can use this authorization key to make authenticated calls to any API. For more information, see Accessing the public APIs.
Example of the credentials.key file{"COConsoleURL":"https://ho-ref-prod-optconsole.bmc.com","Authorization":"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBRE1JTiIsInJvbGVfaWQiOjAsInJvbGVzIjpbIldFQl9DT05GSUdVUkVfQUxMIiwiV0VQ"}
Copy and paste the authorization token from generated key to the silent installation response file (BCO_ADDITIONAL_SERVER_REMOTE_EE.txt) on the Remote ETL Engine in the following format:
-J AUTH_TOKEN=Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJBRE1JTiIsInJvbGVfaWQiOjAsInJvbGVzIjpbIldFQl9DT05GSUdVUkVfQUxMIiwiV0VQThe token must be on a single line, including the word Bearer.
At the shell prompt, change to the directory where you extracted the downloaded files. Example: HOCO_temp/BCO/Disk1.
Navigate to the directory where you extracted the downloaded files and locate the sample response file. Example: HOCO_temp/BCO/Disk1/silentInstallTemplates/BCO_ADDITIONAL_SERVER_REMOTE_EE.txt.
Edit the BCO_ADDITIONAL_SERVER_REMOTE_EE.txt file in a text editor.
In the -
J AUTH_TOKEN
property, paste the token that you have copied in Step 4. Modify other properties of the file according to your preferences as listed below, and save the file.- Open a shell prompt and navigate to the directory that contains the installation files. Example: /BCO/Disk1
Launch the silent installer:
./setup.sh -i silent -DOPTIONS_FILE=<file path>/BCO_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.
Verify the installation:
Log in with the user credentials that you used for installation. Example: cpit.
Navigate to the installation directory. Example: /opt/bmc/BCO.
- Run the command:
./cpit status
Verify that the Scheduler service is running.
The following steps (3, 4, and 5) are required only if you plan to use the Capacity Agent for collecting data.
Install BMC Helix Client Gateway to establish a connection between BMC Cloud and your on-premises datacenter. BMC Helix Client Gateway is a non-VPN solution to securely connect to your on-premises BMC Helix services. You must install and configure a small client in your environment to facilitate this connection. For information about downloading and installing BMC Helix Client Gateway, see BMC Helix Client Gateway connectivity.
Contact BMC Customer Support after installing BMC Helix Client Gateway. BMC will assist you in configuring BMC Helix Client Gateway and testing its connection with BMC Cloud.
Preparing to install the Gateway Server
- Install the Gateway Server on the same computer where you have installed the Remote ETL Engine.
- Use a non-privileged and non-root user account for installing the Gateway Server. The non-privileged user must be created on the installation computer before running the installer and must have access to use cron on the computer. This user owns all the Gateway Server files and runs most of the processes. The installer does not create the installation owner.
- KSH library must be available on the Linux system where you want to install the Gateway Server.
Installing the Gateway Server
- Log in as a non-root user to the computer where you want to install the Gateway Server and create a temporary directory. Example: HOCO_temp/BCO/Disk1.
- Download the installation files from ftp://<customerprefix>-opt-ftp.onbmc.com/FromOnDemand/optimize-onprem.
- Extract the Gateway Server installation files to the temporary directory by running this command:
tar -xvf TSCO_GatewayServer_<version>_Linux.tar
- In the directory where you extracted the Gateway Server installation files, navigate to the ./BCO/Disk1/silent directory.
Copy the HO_ConsoleSilentInstallOptions.txt file to a new directory.
This file contains the installation properties that are specified as name and value pairs with prefix tags. You can retain the default values or modify the properties of the file according to your preferences as listed below, and save the file. However, BMC recommends retaining the default values in the options file for the installation.Change to the directory that contains the extracted Gateway Server installation files.
Start the installation process by running the following command:
./setup.sh -i silent -DOPTIONS_FILE=<fileLocationPath>/HO_ConsoleSilentInstallOptions.txt
The variable<fileLocationPath>
represents the location where you saved the options file. If the path contains spaces, enclose the path and options file name in quotation marks.- If the installation is executed as a non-root user, the /installLocation/b1configVVVV.sh script (where vvvv is the Gateway Server version) must be executed as the root user to complete the installation. The b1configVVVV.sh script is executed automatically when the Gateway Server install is done by the root user.
Verify that the installation is successful.
If you have installed the Gateway Server to collect data, you must install the Capacity Agent on the infrastructure that you want to monitor.
The Capacity Agent collects data from the managed systems in your environment. After collecting data, the Agent transfers it to the Gateway Server. You can install the Capacity Agent using a Shell script or a Docker container. For instructions, see Installing the Capacity Agent.
Comments
Where are the details related to upgrade of remote components - Gateway Server and Remote ETL Engine Server?
Thank you for your comment, Brandon. We have added the steps to upgrade the Gateway Server and Remote ETL Engine ETL.
Link for reference: Upgrading remote components
Thanks,
Shweta
The instructions for the REE install above describe how to install the REE using the silent install method, where are the instructions if you dont want to install it silently? Or is that the only option?
Thank you for your comment, Brandon. I checked with the SME. It is recommended to install REE by using the silent install method only.
The Dashboard page: https://docs.bmc.com/docs/helixcapacityoptimization/hco2002/accessing-and-navigating-the-helix-capacity-optimization-dashboard-914170333.html?src=search shows a screenshot of the Dashboard, with a link to install the ETL server on-prem. Where are the docs which describes this process, install of the on-prem ETL server, without silent install option?
Thank you for your comment, Brandon.
I checked with the SME. It is recommended to install REE by using the silent install method only. Closing the comment.
I think it would be useful to a few more hints in this page:
1) when mentioning API key generation, there's no indication of the Helix CO Role for which the API key should be generated Do we have to use ADMIN? Or can we create a custom role for this? If so, what is the minimal set of role activities we must assign to it?
2) in the properties files, when configuring "URL_HOST", the host to be specified is the URL of the server with Data API . The comment in this page is quite clear, but such server URL is NOT included in the mail sent by BMCHelixActivation@bmc.com when the instance has been provisioned. For the time being, only console and dash URL are provided, so one could wrongly assume that DataAPI URL and Console URL are the same (while It's not the case)
Thank you for your comment, Stefano.
1) The ADMIN role is required for generating the API key. We have updated the documentation with the required information.
2) BMC provides https://<companyname>-optconsole.onbmc.com URL in the activation email. You need to replace console with api and provide that value in the URL_HOST.
Change https://<companyname>-optconsole.onbmc.com to https://<companyname>-optapi.onbmc.com, and provide https://<companyname>-optapi.onbmc.com in the URL_HOST property.
Thanks,
Shweta
I forgot to add one more point:
3) In the proxy server connection, property "IS_PROXY_AUTHENTICATION_REQUIRED" is missing... Generally speaking it would be nice to have a full sample file with silent installer properties attached to this page.
Thank you for your comment, Stefano.
The sample response file with default settings is included in the Remote ETL Engine install image.
We also checked with the SMEs, and it is not recommended to attach the sample file to the documentation.
Thanks,
Shweta
Log in or register to comment.