Kiuwan On-Premises Installation Guide

System Architecture Overview

Kiuwan On-Premises (KOP) is based on a client-server architecture with the following major server components:

• WildFly application server 
• MySQL database
• Redis in-memory data store

KOP solution is deployed on a centralized server (all the components are installed in the same host) and accessed by users via HTTP website access or by IDE plugins (Eclipse, Visual Studio).

KOP also supports distributed architecture with high-availability and load-balancing. For these scenarios, please contact Kiuwan support.

Server Host Requirements

Installation requirements

Kiuwan On-Premises (KOP)  solution is deployed on a centralized server host (all the components are installed in the same host) and accessed by users via HTTP or by IDE plugins (Eclipse, Visual Studio).

KOP installation process consists on building a Docker image.

Installation must be executed by a unix user with privileges to execute docker server commands.

During the installation process, you will need to specify a KOP unix user and group :

• KOP user will the owner of the KOP processes that will run within the docker container 
• the docker persistent volume will be owned by KOP user

KOP User and Group is specified during the KOP Installation process as KIUWAN_USER and KIUWAN_GROUP properties

You can create KOP user and group by executing next commands (no special privileges are needed):

• sudo groupadd ${KIUWAN_GROUP}
• sudo useradd -g ${KIUWAN_GROUP} -s /bin/false -m -d /home/${KIUWAN_USER} ${KIUWAN_USER}
  

KOP Persistent Volume is created by the installation process and must specified as DIR_PERSISTENT_VOLUME property

$ docker info | grep "Supports d_type:"
Supports d_type: true

$ xfs_info /docker-mount-point | grep ftype 
naming =version 2         bsize=4096      ascii-ci=0     ftype=1

$ mkfs.xfs -n ftype=1 /mount-point

CPU and memory requirements

 Server CPU and memory requirements depend on several factors:

• how many lines of code will need to be scanned
• how many analyses will need to be executed in parallel 
• how many users will access the web application
  

Above factors heavily influence host server requirements, but minimum requirements are:

Note: CPU clock speed and disk speed will affect overal response time. 

Above configuration is recommended for a system load that requires continuous service for:

• parallel execution of 2 analyses (any additional parallel analysis request will be enqueued, and it will be executed as soon as any of the running analyses finishes), and
• 50 concurrent web-users

Additional system requirements can be met by following next recommendations:

• In case you need a higher number of parallel analyses executions, you should add 1 CPU core and 512 Mb for any additional required parallel analysis
• In case you need to improve response time to web users, conside to add 1Gb for every 50 additional web users.

Dependencies

KOP docker image is build based on these external dependencies

Installation steps

Before installing KOP, make sure that you understand the System Architecture Overview, that your server host(s) complies with the Server Host Requirements, and that you have properly prepared the Environment as follows:

Step 1. Unpackage KOP Installation Package

Step 2. Configure Kiuwan Docker image

KOP Deployment scenarios

Before to install KOP, you should decide your KOP deployment scenario. 

Below picture displays these different scenarios

Scenario 1 - Direct connection to KOP server

First, you should decide the external URL that KOP clients will use. By KOP clients, we mean Browsers, Kiuwan Local Analyzer, Kiuwan for Developers and API-REST clients.

To configure your KOP in this scenario, please follow next steps

Scenario 1.1 - Direct KOP access through HTTP

Your URL will be something like : http://mykop.mydomain.com:7080/saas

You must configure below properties:

Scenario 1.2 - Direct KOP access through HTTPS

Your URL will be something like : https://mykop.mydomain.com:7080/saas

Procedure :

1. First, create the image as HTTP using 1.1 HTTP scenario configuration (XXXX)

2. Once the image is built, convert it to HTTPS following steps described at  Kiuwan On-Premises Installation Guide 

Step 3. Build the Kiuwan Docker image

     cd $KOP_INSTDIR/master.YYYYMMDDHHMM.buildnumber

     ./create_and_init_kop.sh

After image creation, you will be able to list the images in your docker server and identify your kiuwan image by issuing the next command:

     docker images

Step 3.1 (Optional) Moving the image to another server host

After creating the image, if you want to move it to another host server you first must save it to a tarball by executing: 

     docker save kop:v1.2 > kop_v12_saved_image.tar 

     docker load --input kop_v12_saved_image.tar 

    run_kop.sh 

    run_init_kop.sh 

     docker stop <my_container_name>

Step 4.1 Execution in debug mode (only sshd) 

Just in case you are running with problems while executing Kiuwan container, you can run it in debug mode.

This means to apply the configuration but not starting the services, allowing you to access the container through ssh.

     docker run --rm --name <my_container_name> \

                     -h <my_container_host_name> \

                     -v <server_host_mount_dir:container_mount_dir> \

                     -p <ssh_port_ext>:22  \

                     -d \

                     <image_name:version>

Step 5. (Optional) Making Kiuwan On Premise running on HTTPS

In you need to execute Kiwuan On Premise over HTTPS protocol, please follow next steps. 

Step 5.1 Create your KOP SSL configuration file

SSL configuration  is currently done by creating a configuration file (ssl.custom) within ssl directory 

There's a file (ssl.tpl) you can use as a template to configure your own settings.

1. cd ssl
2. Create ssl.custom file by copying the template file
   • cp ssl.tpl ssl.custom
3. Edit the properties of ssl.custom file and change default values

Step 5.2 Create the Private key and Certificate Signing Request (CSR) for your server

1. within ssl directory execute the script CreateKey_and_ReqCSR.sh 
2. this script generates the CSR file under ssl/certs
   • that file is named <yourhost.yourdomain.com>.csr , according to  $KIUWAN_HOST configuration property
3. send CSR file to your CA (Certificate Authority) 
4. CA will send back to you two files: 
   • CA's Certificate file (IMPORTANT: rename it to ca.crt )
   • your host's Certificate file : for example yourhost.yourdomain.com.crt
5. copy received files to ssl/certs directory

Step 5.3 Create the Keystore and switch from HTTP to HTTPS

1. within ssl directory execute the script TransferFilesToContainer.sh
   • this script transfers your server's certificate, your private key and CA's certificate to KOP container

   • also, it transfers the script templates that will be used to create the keystore and to change the configuration from http to https 

2. within ssl directory execute the script run_create_Keystore.sh 

   • this script executes (into the container) the script create_Keystore.sh (created from template create_Keystore.tpl)
3. within ssl directory execute the script run_change_ToHTTPS.sh 
   
   • this script stops wildfly service and executes the script change_ToHTTPS.sh (created from template change_ToHTTPS.tpl), this script will create files with .rollback extension of modified ones
   • then, it starts wildfly service 

Step 5.4 Just in case you are using your own CA, make it valid to your browsers and Java 

If the certificate is signed by your own Certification Authority, the browsers will not recognize it as a valid CA and you will get an error messages such as:

Your connection is not private
Attackers might be trying to steal your information from youthost.yourdomain.com (for example, passwords, messages, or credit cards).

NET::ERR_CERT_AUTHORITY_INVALID

To solve this issue, you have to import your CA Certificate into your browser : 

• In Chrome: Configuration >> Settings >> Advanced >> Manage certificates >>  Import (ca.crt) into "Trusted root certification entity store"

Log in to the KOP container and execute next commands:

1. cd /opt/jdk*/jre/lib/security/
2. supervisorctl stop wildfly 
3. cp cacerts cacerts.bck.original 
4. keytool -import -noprompt -alias root -keystore cacerts -trustcacerts -file /<kiuwan_vol>/configurations/ssl/ca.crt -storepass changeit
   • NOTE: change <kiuwan_vol> to the value of $KIUWAN_VOL (as configured in settings.custom) 
5. supervisorctl start wildfly

Then, log in to your docker server and make above changes persistent (i.e. to keep them after rebooting the container):

1. docker commit <kop docker name> <kop docker image> 
   
   • NOTE: run 'docker ps' to get NAMES and IMAGE values of your KOP container

Rollback to HTTP

Advanced Configuration

As above specified, settings.custom file allows you to specify most (but not all) configuration parameters.