Preparing to install the Hybrid Gateway

To install the IBM® Cloud Application Performance Management Hybrid Gateway, you must first ensure that your environment is set up correctly. Review the information to help you plan your Hybrid Gateway installation.

Where to install the Hybrid Gateway

The Hybrid Gateway must be installed on a Red Hat® Enterprise Linux® v6.2 (or later) x86-64 system that has a network connection with IBM Tivoli® Monitoring and IBM Cloud Application Performance Management.

The Hybrid Gateway can be installed on the same system as your Tivoli Enterprise Portal Server or on a separate system from the Tivoli Enterprise Portal Server if the systems are running on Red Hat Enterprise Linux. However, the Hybrid Gateway cannot be installed on the same system as your Cloud APM server.

A Tivoli Monitoring domain has one hub Tivoli Enterprise Monitoring Server. When your Tivoli Monitoring environment consists of multiple domains, you can install the Hybrid Gateway in more than one domain.

For system requirements related to the Hybrid Gateway, click the Hardware tab in the Software Product Compatibility Report for Hybrid Gateway.

Setting up the Tivoli Enterprise Portal Server for the Hybrid Gateway

For Tivoli Monitoring environments where the portal server has a heavy load, you should install a separate dedicated portal server to service the requests from the Hybrid Gateway. If you set up a separate portal server:
  • You can use the same host for the portal server and the Hybrid Gateway if the portal server is running Red Hat Enterprise Linux.
  • Ensure that the separate portal server has the application support for the agents whose data is displayed in the Cloud APM console.
  • Ensure that Tivoli Enterprise Portal clients are not connected to the separate portal server to complete administrative tasks such as creating custom workspaces, creating situations, and creating managed system groups.

The Tivoli Enterprise Portal Server must be at V6.3 Fix Pack 6 or higher. If your portal server is at an earlier version, the integrated Tivoli Monitoring agents might not be available for adding to an application in the Cloud APM console.

The IBM Tivoli Monitoring dashboard data provider must be enabled on the Tivoli Enterprise Portal Server. For details, see Verifying the dashboard data provider is enabled in the IBM Tivoli Monitoring topic collection on IBM Knowledge Center.

The TCP ports that must be opened on the Hybrid Gateway

The following TCP ports must be open on the Hybrid Gateway. For each port, one side sends a request and the other side provides a response. The side that initiates the connection is indicated.
  • If you use HTTP to communicate with the Cloud APM server, open port 80. If you use HTTPS, open port 443. The Hybrid Gateway initiates a unidirectional connection with the Cloud APM server on either port 80 or 443. HTTP communication is the default option.

    Alternatively, if the Hybrid Gateway uses a pass-through forwarding proxy to connect to the Cloud APM server, configure the Hybrid Gateway to use the proxy port instead of either port 80 or 443 for unidirectional connections that it initiates with the Cloud APM server. For instructions, see Using a forward proxy to communicate with the Cloud APM server.

  • If you use HTTP to communicate with the portal server, open port 15200. If you use HTTPS, open port 15201. The Hybrid Gateway initiates a unidirectional connection with the portal server on either port 15200 or 15201. To use a custom port, update the value of the Portal Server Port setting. For more information, see Hybrid Gateway Manager.

    Alternatively, if the Hybrid Gateway uses a pass-through forwarding proxy to connect to the portal server, configure the Hybrid Gateway to use the proxy port instead for unidirectional connections that it initiates with the portal server. Set the value of the Pass-through Proxy Port setting. For more information, see Hybrid Gateway Manager.

  • For the Hybrid Gateway to listen to inbound EIF events from the Tivoli Enterprise Monitoring Server, open port 9998. The monitoring server initiates a unidirectional connection with the Hybrid Gateway on port 9998. The installation utility displays a warning if this port is not open.

Root privileges required to run the Hybrid Gateway installation script

You must run the Hybrid Gateway installation script with root privileges. For a list of supported operating systems, see IBM Software Product Compatibility Reports for IBM Cloud Application Performance Management - Agents V8.1.

Configure the Hybrid Gateway images

Before you install the Hybrid Gateway, you must configure the Hybrid Gateway images with the connection details for the Cloud APM server. For more information, see Configuring the downloaded images.