Overview

IriusRisk consists of three major components:

1. A reverse proxy to terminate SSL connections and implement HTTP header security. I.E: Nginx.
2. A Servlet 3.0 compliant Java application server to host the .war. I.E: Tomcat.
3. A PostgreSQL database.

To facilitate easy deployment for the OnPrem version, the reverse proxy and the application server can optionally be provided through Docker images and downloaded from our private Dockerhub repository. However, even if Docker is used for these two components we recommend using an external SQL database instead of a Dockerized DB instance.

Hardware Requirements

1. Single Server:
   All three components: reverse proxy, application server and database can be deployed on the same server.  The following hardware is recommended for such a deployment:
   • Quad core Intel Xeon at least 3.0Ghz
   • 16Gb RAM
   • 8 GB of disk space for the Application server
   • 230GB SSD available for the database's data volume

• High Availability configuration:
  The web application is stateful, and either requires a load balancer with sticky sessions enabled, or a clustered Tomcat instance.  We recommend the former due to ease of management and the ability to scale horizontally simply.
  The database can also be deployed in a high availability configuration. You can find PostgreSQL documentation here.
  The general view of the HA configuration would be:
  • Load balancer/reverse proxy with sticky session enabled.
  • Multiple Tomcat instances, either using our docker images or native Tomcat instances.
  • Databases in HA configuration as per the DB vendor guidelines
    
    The hardware requirements for this setup are:
  • Application servers:
    • Quad core Intel Xeon at least 2.0Ghz
    • 8 GB RAM
  • Database servers:
    • Quad core Intel Xeon at least 2.0Ghz
    • 8 GB RAM
    • 230GB SSD available for the database's data volume

Supported Installation Options

Iriusrisk can be installed on several ways.

Every major component (Nginx, Tomcat and PostgreSQL) can live on the same machine (single server) or may be individual components on different machines or a combination of both.

Besides PostgreSQL which is a native installation, both Nginx and Tomcat can be dockerized or not depending on your needs.

This allows us the following setup options:

Single server (everything on the same machine):

1. Nginx (docker) + tomcat (docker) + local postgres (native).
2. Nginx (native) + tomcat (docker) + local postgres (native).
3. Nginx (docker) + tomcat (native) + local postgres (native).
4. Nginx (native) + tomcat (native) + local postgres (native).

Multiple servers (services spread on several machines), from the point of view of tomcat:

1. External load balancer + tomcat (docker or native) + local postgres (native).
2. External load balancer + tomcat (docker or native) + external postgres.
3. Nginx (docker or native) + tomcat (docker or native) + external postgres.
4. External load balancer + tomcat (kubernetes) + external postgres.

For Kubernetes setup we will provide more details below on his own section.

Optional: Enable AD/LDAP authentication. We will provide more details below on his own section.

General PostgreSQL configuration steps

   1. Install the database server and ensure that it is accessible from the application server.

This requires editing the postgres.conf file. Find the line with the listen_address directive and add the proper listening network interface:

listen_addresses = 'localhost, DB_HOSTS_IP_ADDRESS'

If you are unsure what your interface is or you want postgres to listen on all interfaces you can use:

listen_addresses = '*'

To enable password based authentication, edit the hba.conf file and add at the bottom the line:

host all      all  172.17.0.0/24    md5

Substituting "172.17.0.0/24" with the docker network interface address where the Tomcat server will reside.  If you plan to use the Tomcat in Docker option, then "172.17.0.0/24" is correct as is, since that's the address of the docker containers.

If you are unsure what your interface is or you want postgres to allow password authentication from all sources, you can use: 

host all      all  0.0.0.0/0    md5

    2. Create a database user with createdb privileges using the following PSQL command:

create user iriusprod with createdb password 'alongandcomplexpassword2523';

   3. Create a database and assign it to this user with the following PSQL command:

create database iriusprod with owner='iriusprod';

   4. Ensure that the database service is started automatically when the server starts.

Single server option 1: Nginx (docker) + tomcat (docker) + local postgres (native).

1. Install docker using your system repositories or the official docker installation instructions here.
2. Install docker-compose using the official docker-compose installation instructions here.
3. Download the docker-compose file here.
4. Customize the docker-compose file.
   On the Nginx section: You need to edit "NG_SERVER_NAME" with the application endpoint Iriusrisk will be listening (as set in the postgres.conf file, even if the database is installed on the same host as the docker containers, this needs to be a real IP of the DB and not 'localhost').
   On the Tomcat section: You need to edit "IRIUS_DB_URL" with the JDBC string with proper IP and user password to connect to your database and "IRIUS_EXT_URL" with the application endpoint Iriusrisk will be listening (as set in the postgres.conf file, even if the database is installed on the same host as the docker containers, this needs to be a real IP of the DB and not 'localhost').
5. Create a directory on the server and ensure you have the following files:

$ ls
cert.pem
docker-compose.yml
key.pem

The files for the TLS certificate must be named cert.pem and key.pem and must have the certificate and the key in PEM format generated by a trusted CA authority.

"cert.pem" must contain the certificate with the chain and "key.pem" should contain the private key.
If you are evaluating iriusrisk on localhost and a self signed certificate is enough for you, you can use these (WARNING DO NOT USE THIS ON PRODUCTION, JUST FOR TESTING PURPOSES): cert.pem and key.pem

$ docker-compose up -d 

Nginx will listen on ports 80 and 443, all requests to port 80 will be redirected to 443. It will terminate the TLS connection and also inject several HTTP security headers, for more info please see the Nginx config file within the container: 

$ docker exec CONTAINER_ID cat /etc/nginx/conf.d/irius.conf 
#You can get the CONTAINER_ID by executing $ docker ps

Keep in mind the first time Iriusrisk runs it can take some time at creating the database tables and items it needs.

Single server option 2: Nginx (native) + tomcat (docker) + local postgres (native).

1. Follow steps 1-4 from "Single server option 1", you can skip the Nginx section configuration.
2. Delete from the docker-compose.yml file the entire "nginx:" section so only tomcat is launched as a container.
3. Configure your native Nginx to forward requests to the Tomcat server using the following rules:

$ docker-compose up -d