X

Best Practices from Oracle Development's A‑Team

Deploying Remote Data Gateway in Oracle Analytics Cloud for Data Visualization

Updated October 20, 2019 with a link to Deploying Oracle Analytics Cloud Remote Data Gateway On Premise

Introduction

The latest releases of Oracle Analytics Cloud (OAC) now include the new Remote Data Gateway (RDG) for accessing databases that are not otherwise accessible by OAC.

This post is a step-by-step guide to installing gateway agents and creating Data Visualization connections using RDG. 

For tips on using RDG connections with the Oracle Developer Client Tool, visit Deploying Remote Data Gateway in Oracle Analytics Cloud for Metadata Repositories.

The official documentation is  Connect to On-premises Data Sources and Known Issues.

Updates

Published on July 9, 2019

August 21, 2019 for additional Linux agents on the same Linux host

Versions

  • Oracle Analytics Cloud version 105.3.x

  • MacBook Pro OS 10.13.6 

  • Windows Server R12 Compute Instance

  • Linux 7.2 Compute Instance

Topics

  • Before You Begin

  • Installing the Remote Data Gateway Agents

  • Enabling the Remote Data Gateway in OAC

  • Configuring the Remote Data Gateway Agents

  • Validating OAC Remote Data Access

 Before You Begin

Common Prerequisites

Deploying RDG requires the following common items:

  • If you are using a Linux or Windows compute instance in a private subnet, follow the additional networking steps in http://www.ateam-oracle.com/deploying-remote-data-gateway-in-a-private-subnet.

  • For Linux

    • The IP address or host name of a Linux compute instance.

    • The SSH private key associated with the instance's public key. 

    • A SSH utility with X11 tunneling capability to access the Linux instance.

    • If using Linux compute instances, an ingress rule is needed for the SSH port 22. This should have been created by default in the default security list for the VCN. Refer to Security Lists for detailed instructions on viewing and creating ingress rules.

  • For Windows

    • The Microsoft Remote Desktop (RDP) utility if accessing remote Windows instances.

    • If using a Windows compute instance, an ingress rule is needed for the RDP port 3389, refer to Refer to Security Lists for detailed instructions on viewing and creating ingress rules.

    • Administration privileges 

Reviewing Supported Data Sources and Operating Systems

  • Ensure your data source is supported by following the instructions in Supported Data Sources.

  • Ensure your operating system is supported by viewing the list at OAC Downloads.

Scenarios

This post covers three scenarios:

One:    RDG on-premise, RDG on MAC-OS, and RDG in an Oracle Cloud Infrastructure (OCI) tenancy using a public IP address

This scenario is the simplest. For compute instances, security list rules do need to allow ssh/scp for Linux and MS Remote Desktop for Windows.

For details about using RDG on-premise, MAC and Windows Desktops, visit Deploying Oracle Analytics Cloud Remote Data Gateway On Premise

Two:    RDG in OCI using a private IP address and VPN

This scenario requires the above plus additional OCI networking components so the agent can communicate with OAC.

For Linux instances an additional security list rule and a firewall rule are required to allow an HTTP connection.

Three: RDG in OCI using a private IP address without VPN

This scenario requires the above plus additional temporary compute instance(s) in a public subnet can reach the agent installer and configurator in a private subnet. After installation and configuration the temporary instances may be shut down or terminated.  

Downloading Remote Data Gateway

Scenarios One and Two

If using a remote Windows server, RDP to it.

If using a Linux server that does not have a browser, you may download the Linux installer to your client machine and then upload it to your Linux server. To upload to a Linux compute instance, SCP the installer using the following: 

scp -i < private key path >  <path to installer file> opc@< IP address or host name >:/tmp

Scenario Three

If using Windows first RDP to a Windows instance in a public subnet. Then RDP from there to the private Windows instance.

If using Linux first SCP the downloaded installer (and the appropriate private key) to a Linux instance in a public subnet. Then SCP it from there to the private Linux instance.

Download the Installer

Navigate to https://www.oracle.com/technetwork/middleware/oac/downloads/index.html, accept the license agreement, and choose the desired platform. 

 Installing the Remote Data Gateway

The steps for all platforms are documented in Install Data Gateway.

Topics

  • Installing RDG on Windows

  • Installing RDG on MAC

  • Installing RDG on Linux

  • Installing Additional RDG Agents on Linux

Installing RDG on Windows

Scenarios One and Two

If using a remote Windows server, RDP to it.

Scenario Three

If using Windows first RDP to a Windows instance in a public subnet. Then RDP from there to the private Windows instance.

Install RDG

There is not a standalone installer. Extract the contents of the downloaded ZIP file to a desired directory.

Installing RDG on MAC-OS

Unpack the ZIP file contents to the /Application folder.

Installing RDG on Linux

Installing Remote Data Gateway on Linux requires a graphical user interface.  This post uses X11. Others include Gnome, VNC, etc. 

For X11, refer to http://www.ateam-oracle.com/preparing-linux-for-oracle-remote-data-gateway for pointers. 

Starting the X11 Server

Start the X11 server on the client machine. An xterm window opens.

Scenario 1

Proceed to Install RDG 

Scenario 2

SSH into the Linux instance with the private key. e.g 

​​ssh -i < private key path >  opc@< Public IP address or host name >

Configure X11. Refer to http://www.ateam-oracle.com/preparing-linux-for-oracle-remote-data-gateway for pointers.

End the SSH session. 

Then Proceed to Install RDG 

Scenario 3

Configure X11 in the Public Linux as shown above.

SSH into the Private Linux instance with the private key.

ssh -i < private key path >  opc@< Private IP address or host name >

Configure X11 in the Private Linux. Refer to http://www.ateam-oracle.com/preparing-linux-for-oracle-remote-data-gateway for pointers.

End both the Public and Private SSH sessions. 

Then Proceed to Install RDG 

Install RDG

For Scenario 1, SSH into the Linux server that has a graphical interface.

For Scenario 2, SSH into the Linux instance with an X11 tunnel (-X option)

​​ssh -X -i < private key path >  opc@< IP address or host name >

For Scenario 3:

First SSH into the Public Linux instance with an X11 tunnel.

Then, from there, SSH into the Private Linux instance with an X11 tunnel.

Unzipping the RDG Download

These steps assume the installer was downloaded or uploaded to the /tmp directory.

mv /tmp/datagateway-linux64-105.3.bin.zip ~

cd ~

unzip datagateway-linux64-105.3.zip

Making the RDG Installer Executable

If necessary,

chmod 777 datagateway-linux64-105.3.bin

Running the Installer

./datagateway-linux64-105.3.bin

Waiting For and Using the Installer GUI

It may take up to a minute before the installer screen appears.

Accept the defaults for the Installation Inventory Setup and click OK.

If a Welcome dialog is displayed, click Next.

At the Installation Location dialog, accept the defaults and click Next.

At the Select Remote Data Version dialog, select Remote Data Gateway and click Next.

At the Agent Configuration Credentials dialog, specify a username and password to use for logging into the Data Gateway Agent Configuration page and click Next.

At the Installation Summary dialog, click Install.

After the Installation Progress screen completes, click Next.

At the Installation Complete dialog, click Start Jetty and then click Finish.

Validating the Linux Installation and Obtaining the Port and the URL

Return to the SSH session and type the status command. Make a note of the HTTP Port and the URL for use in the next section.

/home/opc/Oracle/Middleware/Oracle_Home/domain/bin/status.sh

Installing Additional RDG Agents on Linux

If additional agents are desired on the same Linux host, rerun the installer and choose a different installation location. This spawns another agent process using a different HTTP port.

 Enabling the Remote Data Gateway in OAC

Log into OAC. From the home page, navigate to the DV Console:

Click the Hamburger icon.

Click Console.

Click Remote Data Connectivity

Click Enable Data Gateway

 Configuring the Remote Data Gateway Agents

Configuring a Remote Data Gateway Agent requires navigating between the OAC Remote Data Connectivity console and the Remote Data Gateway Agent console.

Preparing to Configure Linux Agents

Configuring a Linux agent requires using a browser and HTTP to reach the Linux host and port that the agent is listening on. The default port is 8080. The port was listed and noted in the steps for installing the agent above.

Scenario 1: 

Confirm with the network administrator that the agent host and port are reachable by your browser via HTTP

Scenarios 2 and 3:

An ingress rule is required for the HTTP port. Refer to Security Lists for detailed instructions on viewing and creating ingress rules.

The HTTP port also needs to be available in the linux instance's firewall rules. Refer to Opening Ports in Linux 7 Firewalls for Oracle Analytics Cloud Access to Databases and Remote Data Connector for details.

Scenario 3:

Browser access is required to the agent's host and port.

Create a temporary or use an existing Windows instance in a public subnet unless a browser has been configured in the temporary public Linux instance. A browser in this instance is used to access the Linux agent.

Starting the RDG Configuration Utility

MAC

Start the RDG i.e. Oracle Analytics Data Gateway.app from the Applications folder.

Windows

Scenarios 1 and 2: Use RDP to reach a remote Windows server.

Scenario 3: RDP to the temporary Windows server on a public subnet and then from there RDP to the private Windows server.

Start RDG

Start RDG i.e. datagateway.exe from the installation directory.

Linux

Scenarios 1 and 2

Go to Test Access

Scenario 3

RDP to the temporary Windows instance on a public subnet. 

Test Access

To test if access is available, use a browser and the URL noted in the installation section above:

http://<Your RDG host name/IP>:<Your RDG HTTP port>/obiee/javads?status

If successful, an XML response is returned.

Start the Configuration

Use the URL noted in the installation section above to start the RDG Configuration Utility.

http://<Your RDG host name/IP>:<Your RDG HTTP port>/obiee/config.jsp

If asked for credentials use the ones supplied for the installation.

Obtaining the OAC URL

Log into the OAC instance. Copy the URL up to the end of the host name

e.g. < instance >-<tenancy>.analytics.ocp.oraclecoud.com

Creating an RDG Agent 1 of 2

Once the various configuration utilities have been started, the GUI is the same for all.

  • Enter the OAC URL obtained above and click Generate Key

  • Copy the generated key to the clipboard

​​​Leave the configuration screen as is and switch over to OAC,

Registering the Data Gateway Agent in OAC

Go to the OAC Remote Data Connectivity page in OAC.

  • Click Add.

  • Optionally enter a Name or one is created for you.Paste the key generated from the Agent definition screen into the Public Key. Note that the ID and Host are populated from the key contents. Click OK.

  • The agent is registered.

Creating an RDG Agent 2 of 2

Return to the configuration utility.

  1. Click Test. A Successfully authenticated message appears.

  2. Click Save. A Successfully Submitted message appears

  3. Click Enable.

  4. Click Save again. A Successfully Submitted message appears

​​​Repeat the above steps to create additional agents on other platforms. Additional agents prevent a single point of failure. Deploying multiple agents may also improve performance.

 Validating OAC Remote Data Access

With the agent(s) configured and running, creating a new DV data connection validates that RDG is configured correctly.

  • Login or Go To the OAC home page

  • Click the Hamburger icon.

  • Click Data

  • Click Connections

  • Enter the required fields.

    • Check the Use Remote Data Connectivity/Connector box.

    • Click Save

You can now create DV Data Sets and projects using the remote data source.

 Summary

This post described installing and configuring Remote Data Gateway agents and creating Data Visualization data connections using remote data sources.

For other posts relating to analytics and data integration visit http://www.ateam-oracle.com/dayne-carley

 

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha