Install the Remote Data Gateway

Install the remote data gateway to allow Oracle Analytics Cloud to access data stored in a private subnet.

Instructions and a link for downloading the installer are provided under the Download Code section.

To access to a database, the remote data gateway listener requires both an open port in a Linux firewall and an ingress rule in the virtual cloud network (VCN) security list.

Prepare to Install the Remote Data Gateway

To prepare to install the remote data gateway, you must copy the installer to the bastion compute instance and to the compute instance that will host the gateway. You must also create an inventory location file and an installer response file.

Before you begin the steps below, download the remote data gateway (RDG) installer. Instructions and a link for downloading the installer are provided under the Download Code section.

  1. Copy the installer archive and the SSH private key you created earlier to the compute instance that hosts the bastion server.
    Use secure copy protocol (SCP) from Linux-type systems (or remote desktop protocol (RDP) from Windows systems) to copy the installer. For example, from a Linux-type system where opc is the default user:
    $ scp -i <path to installer file> opc@<IP address or host name>:/tmp
  2. Similarly, copy the installer archive and the SSH private key to the compute instance that hosts the remote data gateway.
  3. Use secure shell (SSH) to connect to the instance that hosts the RDG. For example:
    $ ssh -i <private key path> <user>@<IP address or host name>
  4. Uncompress the installer archive. For example, the following uncompresses the archive to the current (opc) user's home directory:
    $ cd ~ && unzip <path to the installer zip file>
  5. Create an inventory location file.
    1. As the root user, use an editor to create an inventory location file. For example:
      $ sudo su -
      $ vi /etc/oraInst.loc
      inventory_loc=/home/opc/oraInventory
      inst_group=opc
      
      :wq
    2. Verify the contents of the file then exit the root user session:
       $ cat /etc/oraInst.loc 
      Inventory_loc=/home/opc/oralnventory 
      Inst_ group=opc 
      $ exit
  6. Create an installer response file.
    1. Change to the home directory:
      $ cd ~
    2. Use an editor to create an installer response file with a file name that you choose.

      Make sure to provide the credentials page administrator user name and password. For example:

      $ vi silentInstall.response
      [ENGINE]
      #DO NOT CHANGE THIS.
      Response File Version=1.0.0.0.0
      
      [GENERIC]
      ORACLE_HOME=/home/opc/Oracle/Middleware/Oracle_Home
      SELECT_RD_VERSION_RADIO_V1=false
      CREDENTIALS_PAGE_ADMIN_USERNAME=<admin user>
      CREDENTIALS_PAGE_PASSWORD=<admin password>
      
      :wq
    3. Verify the contents of the file then exit the root user session:
      $ cat silentInstall.response 
      [ENGINE]
      #DO NOT CHANGE THIS.
      Response File Version=1.0.0.0.0
      
      [GENERIC]
      ORACLE_HOME=/home/opc/Oracle/Middleware/Oracle_Home
      SELECT_RD_VERSION_RADIO_V1=false
      CREDENTIALS_PAGE_ADMIN_USERNAME=<admin user>
      CREDENTIALS_PAGE_PASSWORD=<admin password>

Install and Start the Remote Data Gateway

Install the remote data gateway on the compute instance using installer response and location files.

Before you can install the remote data gateway using the steps below, you must first have copied and uncompressed the gateway installer and created the installer response and location files.
  1. Change to the home directory.
    $ cd ~
  2. Run the installer "silently" using the previously created installer response and location files:
    $ ./datagateway-linux-105.5.bin -silent -responseFile /home/opc/silentInstall.response –invPtrLoc /etc/oraInst.loc 

    The installer display progress notifications and a message when it completes successfully.

  3. Change to the home directory specified in the response file. For example:
    $ cd /home/opc/Oracle/Middleware/Oracle_Home
  4. Start the gateway:
    $ domain/bin/startJetty.sh
  5. Run the status command and make a note of the HTTP Port and the URL for use in configuring the gateway.
    $ domain/bin/status.sh

Open a Firewall Port in the Remote Data Gateway Host

To access to a database on a compute instance virtual machine, the remote data gateway listener requires an open port in the firewall of the remote data gateway host.

Compute instance firewalls by default are created without listener ports opened. Only the Secure Shell (SSH) port 22 is open.

Before you begin, make sure that you have created security list ingress rules that specifies the listener port as 8080.

  1. Use secure shell (SSH) to connect to the remote data gateway instance as the opc user:
    ssh -i <private_key_path> opc@<rdg_ip_or_host_name>
  2. Switch to the root user:
    sudo su -
  3. To view open ports, use any or all of the following commands:
    • To view the open ports:
      firewall-cmd --list-ports
    • If a port is not listed, it may be open through a service. To view open services:
      firewall-cmd --list-services
    • To find a specific service, such as SSH, associated with a port:
      cat /etc/services | grep ssh
    • To find a specific port, such as 1521:
      at /etc/services | grep 1521
  4. To open a port in the currently running instance:
    firewall-cmd --add-port=<port>/<protocol>
    To specify that the port be opened in future restarts of the instance, add the --permanent option. For example:
    firewall-cmd --permanent --add-port=8080/tcp