Illuminate Integration Gateway Installation Using Podman

Modified on Tue, 28 May 2024 at 07:57 AM


TABLE OF CONTENTS

What is the Illuminate Integration Gateway?

The Illuminate Integration Gateway, also called the Dataport, is a tool used to provide the Illuminate platform with access to data that is located in physically and logically secure configurations, such as behind a firewall in the organization’s data center. The Integration Gateway provides a secure, encrypted channel to transport this data to the Illuminate cloud environment, where Illuminate creates a secure Application Program Interface (API) access platform. 

How it works

N2N provides a Docker container that runs Illuminate's Integration Gateway (IIG). This is installed on a Virtual Machine (VM) that is provided by the University and typically hosted on the University's network. The IIG is used to facilitate secure communication between the University database and the Illuminate Platform without having to allow direct external communication to the actual database. VM setup is operating system specific, please refer to your onsite System Administrator for VM setup. 

What is the current version of the Integration Gateway?

Illuminate Integration Gateway is at Version 4.12

*Note: Prior versions of the Illuminate Integration Gateway were branded "Illuminate Dataport"

What do we provide?

N2N provides a Podman image with the following software packages included:

  • Tomcat 9.0.20
  • JVM 11.0
  • Illuminate Integration Gateway Project 4.12 (the N2N application code)

General System Requirements

General system requirements for installing the Integration Gateway:

Software

  • Podman

Hardware (VM)

  • 4 to 8 CPU Cores (processors)

  • 8GB to 16GB RAM

  • Enough disk space to run the OS and other supporting software (recommended disk space 40+ GB)



  • Typically an 8 GB Ram server with 4 Core Processor can serve about 700-800 transactions per second.

  • For more information about Docker, prerequisites visit this Docker page


Prerequisites

  • An SSL certificate ready (self-signed is not supported) which includes .crt file (the .crt file must have the public, root, and

           intermediate certs, with public cert on top of the file) and a private key.

  • Ports 443, 80, need to be open on the VM instance where Docker and Integration Gateway are installed

  • Firewall rules need to set up by this time. Whitelist N2N NAT IPs below


.

QA: 23.20.165.255

PROD54.204.165.208



What is Podman?

  • Podman is an open source Open Container Initiative-compliant container management tool from Red Hat used for handling containers, images, volumes, and pods on the Linux operating system, with support for Mac OS and Microsoft Windows via a virtual machine

Installation


Note:  This installation applies only to RHEL 7. x + versions only


  • Update the default packages on the server
sudo yum update -y
  • Install Podman on the server
sudo yum install podman  /* then verify the displayed output and enter "yes" */


  • Verify the Podman installation
podman version



Integration Gateway Installation using podman


Installing The Integration Gateway

Note: If you do not have an Illuminate account please contact appsupport@n2nservices.com 


  • Goto “Connections” tab and Add integration Gateway



  • Click on the IIG Container Key(on Top right corner) tab and use those credentials to download IIG Podman images



podman login -u='n2n_iig' -p='xxxxxxxxxxxxxxxxxxxxxxxxxx' quay.io
  • Once you get the success note then lets pull the required images from quay.io

podman pull quay.io/n2ndevops/illuminatedataport:4.12
podman pull quay.io/n2ndevops/illuminatedataportnginx:1.24.0
  • Next, create Podman network in order to establish the communication between Nginx and dataport(IIG) containers

podman network create n2n_iig


  • Now copy all your SSL certificate files (such as the .crt and .key files*) to the “certs” folder inside the Nginx container

podman cp <your file name>.crt nginx:/certs/<your file name>.crt 
podman cp <your file name>.key nginx:/certs/<your file name>.key
  • Update the default.conf with appropriate details

podman exec -it nginx bash


  • vim /etc/nginx/conf.d/default.conf



Note:
  • Add SSL keyword in line 3

  • Update the server_name at line 4 and 46 and 

  • Add ssl_certificate (.crt and .key) with valid name details at line 5 and 6.


  • Test nginx configuration

nginx -t


  • Restart nginx



  • Run the status API



  • Login to Illuminate account again and then go to Connections > Add integration Gateway>Establish Connection tab to continue with this process



  • Provide the URL/DNS where the Integration Gateway is connected/installed. After providing the URL, the user will then click on the Validate button, which will verify the host connection and installation of IIG via Illuminate application



  • Upon successful validation of the URL, confirming both the host and Integration Gateway installation, the subsequent screen will be displayed




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article