Hybrid Data Pipeline supports connectivity to on-premises data stores. On-premises connectivity is enabled with the deployment and configuration of the On-Premises Connector (OPC). The OPC is a Java software component that must be installed on a Windows host on the same network in which the data store resides. In addition, the OPC requires a JVM for installation and runtime operation (see Product requirements for details). The OPC maintains a secure communication channel with the Hybrid Data Pipeline server. When the server requires access to the data store, this communication channel is used to send a connection request to the OPC.

Attention: To use the On-Premises Connector, the Hybrid Data Pipeline server must be configured for SSL during deployment. This enables the On-Premises Connector to maintain a secure channel to the Hybrid Data Pipeline server with outbound requests using HTTPS. The On-Premises Connector does not allow SSL decryption or inspection of HTTPS requests sent to the Hybrid Data Pipeline server. Any firewall or proxy used to manage communication from the OPC host to the Hybrid Data Pipeline server should be configured accordingly.
Important: FIPS is not supported for the On-Premises Connector.

OPC deployment workflow

The following workflow outlines the general steps you must take to deploy the OPC.

  1. Before deployment of the Hybrid Data Pipeline server, open ports on the host machine required for on-premises configuration. See Access ports for details.
    Note: For a Docker deployment, ports must be mapped in the docker run command. See Docker deployment steps.
  2. During deployment of the Hybrid Data Pipeline server, configure the server for on-premises connectivity.
    • Configure the server to use the On-Premises Connector.
    • Configure the server to use SSL. See SSL configuration.
    • Specify the ports that will be used to support connectivity with the OPC.
      Note: For a Docker deployment, the ports must be mapped in the docker run command (see Docker deployment steps). For a Linux installation, the ports may be specified when prompted by the installation program (see Installing the Hybrid Data Pipeline server).
  3. If you are deploying Hybrid Data Pipeline behind a load balancer, configure the load balancer to route queries to and from the on-premises data store. See the following topics for details.
  4. Install the OPC on a Windows host on the same network in which the data store resides. For details, see Installing the Hybrid Data Pipeline On-Premises Connector.
  5. On the machine hosting the OPC, use the Configuration Tool to register the OPC with the Hybrid Data Pipeline server. See Configuring the On-Premises Connector.
  6. If you are using multiple OPCs, you may set up a Connector Group to configure failover and load balancing with the Connector API. For details, refer to Using Failover and Balancing Requests with an On-Premises Connector Group in the User's Guide.

What's next

After you complete these deployment steps, you may connect to the on-premises data store by creating a Hybrid Data Pipeline data source. When creating the data source, you will specify the name of the On-Premises Connector or Connector Group with the Connector ID dropdown. For details, refer to How to create a data source in the Web UI in the User's Guide.

Note: An Administrator can use the Administrator Connectors API to retrieve information on any On-Premises Connector in a deployment. For details, refer to Obtaining information about On-Premises Connectors in the User's Guide.