Find the most recent directions here.
TABLE OF CONTENTS
- What is the Illuminate Integration Gateway?
- General System Requirements
- What is Docker and why does N2N use this?
- Docker Installation Instructions
- Detailed instructions for installing Docker & Docker Compose (on CentOS)
- Integration Gateway Installation
- Load Balancing the Integration Gateway
- Integration Gateway setup for PROD on the same QA host/server
- Optional step to autostart the containers after a server reboot
- SSL Certs In Dataport/IIG
- What is an SSL certificate?
- What are Certificate Chains?
- What is SSL Certificate Chain Order?
- There are three parts to the chain certificates
- How To Update SSL Certs In Dataport
- Integration Gateway upgrade using manual steps
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.10
*Note: Prior versions of the Illuminate Integration Gateway were branded "Illuminate Dataport"
What do we provide?
N2N provides a Docker image with the following software packages included:
- Tomcat 9.0.20
- JVM 11.0
- Illuminate Integration Gateway Project 4.10 (the N2N application code)
General System Requirements
General system requirements for installing the Integration Gateway:
Software
Docker 17.x version or higher
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)
|
What is Docker and why does N2N use this?
What is Docker?
Docker is the world's leading software containerization platform. Docker containers wrap a piece of software in a complete file system that contains everything needed to run: code, run time, system tools, system libraries – anything that can be installed on a server. This guarantees that the software will always run the same, regardless of its environment. Containers isolate applications from one another and the underlying infrastructure while providing an added layer of protection for the application.
. For more details about Docker please visit this Docker page |
What is Docker Compose?
Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.
. For more details about docker-compose please visit the Docker Compose page |
Why does N2N use Docker for the Illuminate Integration Gateway?
The Docker platform provides N2N with a simple, effective way to deliver the right package of software to the Illuminate Integration Gateway. Docker allows N2N to combine tested versions of software with validated configuration files into one deployment package. This process greatly reduces the number of manual steps, which improves reliability and robustness, as well as making deployment faster!
Docker Installation Instructions
Docker CE (Community Edition) is available on multiple platforms. Use the following matrix to choose a supported operating system that provides the best installation path for you. Click on the platform to navigate for detailed documentation on the docker site. We provide detailed instructions for installing Docker and the Integration Gateway on CentOS along with other required configurations. Other Linux implementations will be similar.
Supported Platforms
Platform | Docket CE x86_64 |
---|---|
CentOS | Yes (Recommended) |
Yes | |
Yes | |
Yes | |
Yes | |
Yes | |
Yes | |
Yes | |
Yes | |
Oracle Linux | Yes |
SUSE Linux Enterprise Server | No |
Microsoft Windows Server 2016 | No |
For more details please visit docker supported-platform documentation |
Detailed instructions for installing Docker & Docker Compose (on CentOS)
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. (See SSL Certs FAQs at the end of this document)
Ports 443, 80, 2376 (2376 port is optional) need to be open on the VM instance where Docker and Integration Gateway are installed
Get the authorization credentials from N2N to pull the Docker image
Docker Installation
There are two ways to install Docker Engine
- Install using the yum package manager (Recommended)
- Install using the instruction from https://docs.docker.com/install/linux/docker-ce/centos/
Install with yum
- Log into your VM as a user with sudo rights to install and manage services or root user. If you are logged in as root you do not need to add the "sudo" at the beginning of each command.
- Make sure your existing packages are up-to-date using yum
- Add the yum repository if it doesn’t exist on your server where you are installing Docker.
- We will also need to enable the Redhat "extras" repository for RHEL 7 (The third command to enable the Redhat extras repository will only need to be run if you are running RHEL 7).
sudo yum install -y yum-utils |
Install the Docker package for RHEL 8.
sudo yum install -y --nobest docker-ce docker-ce-cli containerd.io |
Install the Docker package for RHEL 7.
sudo yum install -y docker-ce docker-ce-cli containerd.io |
Enable the Docker service. This is needed so docker will start whenever the system is restarted
sudo systemctl enable docker.service |
Start the Docker daemon
sudo systemctl start docker |
Verify Docker has been installed correctly by running a test image in a container
sudo docker ps |
- The screenshot below will show the installation is done properly.
Now that Docker installation is complete, the next step is to install Docker compose.
Docker Compose Installation
Run this command to download the current stable release of Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose |
If you have problems installing with |
Apply executable permissions to the binary.
sudo chmod +x /usr/local/bin/docker-compose |
. If the command For Example:
For more details about Docker Compose, please visit here |
Test the docker-compose Installation
docker-compose --version |
Integration Gateway Installation
There are two ways to install Integration Gateway
- Installation (Recommended, & detailed in this document)
- Install using manual steps (not included in this document)
Prerequisites
- Firewall rules need to be set up by this time. Whitelist N2N NAT IPs below
. QA: 23.20.165.255/32 PROD: 54.204.165.208/32 |
- Look at the Appendix-4 for SSL certs setup info
- We need an FQDN which connects to the Integration Gateway on HTTPS
Authorization to Access Integration Gateway Docker Images
Getting the quay credentials through the Illuminate app
- Login into the QA Illuminate app: https://qa.illuminateapp.com/api-universe/login
- Login into the PROD Illuminate app: https://illuminateapp.com/api-universe/login
Note: If you do not have an Illuminate account please contact appsupport@n2nservices.com
Get the credentials by following the below steps
- From the left-side menu, select the connection button.
- Next, click the button IIG CONTAINER KEY to the right top corner.
- Copy the username and password within the popup box.
Run the below command on the dataport server using the credentials above docker login |
Integration Gateway Installation
Login as root on to the VM
Create a folder with your preferred name
For Example: mkdir n2ndataport |
Download the docker-compose.yml file which attached to the bottom of this document.
- Place this docker-compose.yml file in the folder 'n2ndataport' which was created in the above step.
- Run the docker-compose.yml file to deploy both Nginx and Integration Gateway Docker containers. Use the below command;
docker-compose up -d |
. Once docker-compose up -d is executed:
|
The output after running the above command will look like the screenshot below
- Run docker ps command to view the installed/running containers.
In the screenshot below, we can see that the Integration Gateway (Dataport) and Nginx containers are up and running.
Applying the SSL Certificate
- Now copy all your SSL certificate files (such as the .crt and .key files*) to the “certs” folder inside the Nginx container
docker cp <your file name>.crt nginx:/certs/<your file name>.crt docker cp <your file name>.key nginx:/certs/<your file name>.key |
. File extensions .crt and .key are used as an example, use appropriate valid extensions as needed.
We are using X.509 type certificates.
Here SSL certificates should be in relation with host_name or domain name (while generating certificates). These certificates should point to the docker containers. Here, in this case, we are placing certificates in the Nginx container. |
Login to the Nginx container
docker exec -it nginx bash |
Open default.conf file:
cd /etc/nginx/conf.d/ vim default.conf |
|
Now test Nginx config using this command (the command checks whether the certificates are valid)
nginx -t |
If the validation is successful, exit from the nginx container. Otherwise, review the error and return to the Nginx default.conf file
exit |
Restart the Nginx container
docker restart nginx |
Test connection
Test the connection using the curl command below. It should return a response: "Not a valid request.”. Note that you need to configure the command below to match your organizational nomenclature.
curl -X GET https://{server_name(or)host_name}/idp |
Establishing a connection between Illuminate, Integration Gateway, and the SIS Database
Note: Firewall rules need to set up by this time. Whitelist N2N NAT IPs below
. QA: 23.20.165.255 PROD: 54.204.165.208 |
Step 1 - Adding Integration Gateway URL in Illuminate app
Note: In this step, we will configure the Integration Gateway details in the Illuminate App.
- Setting up Integration Gateway in Illuminate app
- Login into QA Illuminate app: https://qa.illuminateapp.com/api-universe/login
- Login into PROD Illuminate app: https://illuminateapp.com/api-universe/login
Note: If you do not have an Illuminate account please contact appsupport@n2nservices.com
- Configure the Integration Gateway details within the Illuminate App's Connection Module by following below steps
- From the left-side menu, select the connection button.
- Next, select Setup Dataport from the list of options
- Click on GET STARTED
- Enter the 'Dataport Name' field and the 'Dataport URL' field then click on the publish button on the screen.
- Note: Dataport Url example looks like https://{server_name(or)host_name}
- Note: You can also follow the steps from this link Step by Step instructions for Step1
Step 2 - Add the database provider in the Illuminate app
Note: This step is also performed in the Illuminate App.
- Configure the Database provider details within the Illuminate App's Connection Module using the following steps:
- From the left-side menu, select Connections.
- Click the ADD PROVIDER button above the provider list index table
- Next, under Provider Details select the Provider Type as Database.
- Select the appropriate database under Provider (i.e Oracle or SQL Server per your SIS).
- Enter the desired name for Provider Name.
- Enter a Connection Name for this setup.
- Enter a description for this connection.
- Click Save.
- A popup will appear with authorization details that should be copied and used to run the database curl command in Step 3.
- Note: The generated token will expire in 5 mins.
- Note: You can also follow the steps from this link Step by Step visual instructions for Step 2
Step 3 - Connecting the Integration Gateway to the Database(s)
Note: The instructions below are to be performed on the Integration Gateway Server.
In this step, we will establish the connection between the Integration Gateway and the database by creating a property file.
Note: Within these instructions, EMPDB.properties is used as an example. EMPDB can be replaced with an appropriate database name. The database properties are stored in an encrypted format in EMPDB.properties.
Use the below method to configure the EMPDB.properties:
The properties are generated using a curl command. For security, please turn off Linux history before running the curl command, using the following set command: set +o history |
The Illuminate Integration Gateway includes a web service that will create these properties in the system.
Step 4 - Creating the request body with the database properties
This service needs a JSON request body as shown below, edit this sample to include your specific database server information for Oracle or SQL Server:
{ "DBHost": "Server hostname or IP", // database host "port": "1234", // database port "SID": "", // sid or service name for oracle providers "ServiceName": "servicename", "databaseName": "", // databaseName is for SQL server providers "DBUsername": "name", // DB username or schema Name "DBPassword": "***********" // DB password } |
|
. { "DBHost": "0.0.0.0", "port": "1234", "SID": "", "ServiceName": "servicename", "DBUsername": "username", "DBPassword": "***********" } |
. { "DBHost": "0.0.0.0", "port": "1234", "databaseName": "", "DBUsername": "username", "DBPassword": "***********" } |
. { "DBHost": "0.0.0.0", "port": "1234", "databaseName": "", "DBUsername": "username", "DBPassword": "***********","informixServer": "" } |
Step 5 - Create & run the CURL command
- Run the following command to retrieve the Docker container IP (in this case we need the Integration Gateway container port)
docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' dataport |
- Replace "dataport_container_ip:port" with the response body from the last step, in the following curl. invoke the below service (Recommended)
curl -X POST 'https://{dataport_container_ip:port}/idp/addDBproperties' -H 'Authorization:Token from Illuminate connections page in Step 2' -H 'Content-Type: application/json' -d '{"DBHost": "0.0.0.0","port": "1234","SID": "","ServiceName": "servicename","DBUsername": "username","DBPassword": "***********"}' |
(OR)
- You can also use DNS (which is assigned to the Integration Gateway) to add DB properties file
curl -X POST 'https://{your_dns_name}/idp/addDBproperties' -H 'Authorization:Token from Illuminate connections page in Step 2' -H 'Content-Type: application/json' -d '{"DBHost": "0.0.0.0","port": "1234","SID": "","ServiceName": "servicename","DBUsername": "username","DBPassword": "***********"}' |
- Upon successful connection, you will see the following message
. {"status":"success","message":"Properties Added"} |
. If the Integration Gateway is on a load-balanced network and you use the DNS method to add the properties it will not update in all the containers. In this case, use the container IP to individually update the properties. |
. Load Balancing the Integration GatewayNote: Recommended but optional Load balancing refers to efficiently distributing incoming network traffic across a group of servers. A Load Balancer acts as the "traffic cop" sitting in front of your servers and routing requests across all servers capable of fulfilling those requests in a manner that maximizes speed and capacity utilization and ensures that no one server is overworked, which could degrade performance.If a single server goes down, the load balancer redirects traffic to the remaining online servers. When a new server is added to the server group, the load balancer automatically starts to send requests to it.
Sample load balancing diagram leveraging Docker |
Integration Gateway setup for PROD on the same QA host/serverIf the client wants to set up a PROD integration gateway on the QA host, they need to follow these steps
|
. Optional step to autostart the containers after a server rebootIf a server is rebooted, restarted, or start/restart, the docker engine must be restarted. To accomplish that automatically follow the steps below
|
. SSL Certs In Dataport/IIGIf a client wants to update SSL certs in Nginx, they can go through these instructions for more details What is an SSL certificate?An SSL (Secure Sockets Layer) certificate is a digital certificate that authenticates the identity of a website and encrypts information sent to the server using SSL technology. Encryption is the process of scrambling data into an undecipherable format that can only be returned to a readable format with the proper decryption key. What are Certificate Chains?A certificate chain (or Chain of Trust) is made up of a list of certificates that start from a server’s certificate and terminate with the root certificate. What is SSL Certificate Chain Order?The SSL certificate chain order consists of root certificates, intermediate certificates, and a server’s certificate. Root CAs are a trusted source of certificates. Intermediate CAs are bridges that link the server’s certificate to the root CA. There are three parts to the chain certificates
For an SSL certificate to be authenticated by the web browsers, it must be authentic and issued by a trusted certificate authority embedded in the browser’s trusted store. If your SSL certificate isn’t issued by a trusted certificate authority, i.e., if it isn’t issued by a Root CA, then the connecting device or web browser will continue to check if the issuing CA was issued by a root CA. It will keep going back down the SSL certificate chain order to find the root CA. If it finds a root CA, a secure connection will be established. If it doesn’t find a root CA, then the connection will be dropped, and your web browser will display an error message that reads “invalid certificate” or “certificate not trusted.” How To Update SSL Certs In Dataport
How To form a bundle .crt file
(OR) Example GoDaddy:
Other SSL providers with a single intermediate certificate:
Other SSL providers with multiple intermediate certificates:
Additional step if the private key is password protected:
Now you have the bundled cert and private key ready, do the below steps to update these files in the Nginx container: Step 1:
Step 2:
Step 3:
If NGINX does not come back as successful, then do not proceed to the restart of NGINX. A successful output looks like this.
Step 4:
A successful restart of NGINX looks like this
Step 5: Verify that the NGINX container is running
|
Dataport Upgrade - Appendix - 5 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Integration Gateway upgrade using manual steps
1) Authorization to Access Integration Gateway Docker Images
2) Find and stop the dataport container
3) Save the previous version of dataport
4) Pull and Run N2N's Integration Gateway image.
Auto Restart the containers
OptionalStep: Remove the renamed running container. Dataport is the container name
5) Add Database Credentials.
|
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article