Versions Compared

Old Version 57

changes.mady.by.user Kiuwan Editor User

Saved on

compared with

New Version 58

changes.mady.by.user Kiuwan Editor User

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

After unpackaging, you should configure the docker image to be built.

Configuration of Kiuwan docker image is currently done by creating a configuration file (settings.custom) that will be used during the image building process.

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

  1. Create settings.custom file by copying the template file
    • cp settings.tpl settings.custom
  2. Edit the properties of settings.custom file

 

 

 

...

PropertyName

...

Meaning

Step 2. KOP Deployment scenarios


 

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


 

There are different KOP deployment scenarios depending on using an intermediate webserver or accessing directly the KOP app server:

  1. Direct connection to KOP AppServer 

    1. through HTTP

    2. through HTTPs

  2. Connection to KOP AppServer through a WebServer 

    1. through HTTP

    2. through HTTPs


Below pucture displays these different scenarios

 


Image Added


 

Scenario 1 - Direct connection to KOP server



 


Image Added

 

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.

 

Info

IMPORTANT: the KOP installation process will create a docker image that will use internally this URL.

After building the docker image, if you decide to change the configured URL you must create the image again.

So be sure of your KOP URL before creating the image.



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:



 

 PropertyName Value Comment
KIUWAN_HOST
KIUWAN_PORT

mykop.mydomain.com
7080

Hostname (Fully Qualified Domain Name, see note below ) and port number to access KOP.

These variables will be used to build Kiuwan URL.

Example (with default values):

Fully Qualified Domain Name (FQDN): https://en.wikipedia.org/wiki/Fully_qualified_domain_name

 

Must match KIUWAN_WEBSERVER_HOST

KIUWAN_WEBSERVER_PROTOCOL

http

 

KIUWAN_WEBSERVER_HOST

mykop.mydomain.com

Must match KIUWAN_HOST 

 

 

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 

Scenario 2 - Connection to KOP server through a WebServer


 

In this scenario, a webserver (typically Apache) is used as a frontend server to redirect to KOP appserver.

 


Image Added


 

As in the “direct” scenario, you should establish the URL to be used to connect to KOP.

Let suppose that will be something like http://mykop.mydomain.com:7080/saas 

 

Additionally, you will need to configure the “internal” KOP app server URL, for example : http://my_internal_kop.mydomain.com:7081/saas 

 

 

 PropertyName Value Comments

HTTPS

[ ON | OFF ]

 

KIUWAN_WEBSERVER_PROTOCOL

[ http | https ] 

If HTTPS=OFF, specify http

IF HTTPS=ON, specify https

KIUWAN_WEBSERVER_HOST
KIUWAN_WEBSERVER_PORT

mykop.mydomain.com
7080

External KOP hostname (Fully Qualified Domain Name, see note below ) and port number to access KOP.

These variables will be used to build Kiuwan URL.

Example (with default values):

  • http://my_internal_kop.mydomain.com:7081/saas

Fully Qualified Domain Name (FQDN): https://en.wikipedia.org/wiki/Fully_qualified_domain_name

...

KIUWAN_HOST
KIUWAN_PORT

my_internal_kop.mydomain.com

...

7081

...

Internal KOP hostname (Fully Qualified Domain Name, see note below ) and port number to access KOP.

These variables will be used to build internal Kiuwan URL.

Example (with default values):

  • http://

...

  • my_internal_kop.mydomain.com:

...

  • 7081/saas

Fully Qualified Domain Name (FQDN): https://en.wikipedia.org/wiki/Fully_qualified_domain_name

 

KIUWAN_HOST must be different to KIUWAN_WEBSERVER_HOST

KIUWAN_PORT must be different to KIUWAN_WEBSERVER_PORT only if the frontend server and KOP appserver execute in the same machine.

KIUWAN_APPSERVER_AJP_PORT

defaults to 7009

Port that the front-end server will use to communicate with KOP appserver through AJP

 



 

 KOP Configuration properties

 

 

Fully Qualified Domain Name (FQDN): https://en.wikipedia.org/wiki/Fully_qualified_domain_name

PropertyName

Default value

Meaning

SysAdmin configuration
KIUWAN_DOCKER_IMAGE Name of the docker image (repository name) to be built

DIR_PERSISTENT_VOLUME

/Datavol

Root directory of docker server where the container volume will be bound

KIUWAN_VOL/kiuwan_vol

Directory of the container where KOP will be installed.

EXTERNAL_PORT_TO_MAP_MYSQL_INTERNAL_PORT3306

Docker server port to access container's MySQL

  • you can leave it to standard 3306 if MySQL is not running in server host
EXTERNAL_PORT_TO_MAP_SSH_PORT2222

Docker server port to access container thorugh SSH

  • must be different to standard 22 because most probably SHH:22 will be running in server host
MONGODB_STARTfalse

Depending of your Kiuwan On Premises purchased license:

  • true: Start mongodb (license with Architecture included)
  • false: Don´t start mongodb (license without Architecture)
Proxy settings  
USE_PROXYfalse
  • false: don´t use proxy to build container
  • true: use proxy to build container
HOST_PROXY
PORT_PROXY		 Hostname (or ip address) and port number of proxy used for Intenet connectivity during the image building process
USER_PROXY
PWD_PROXY		 

Username and password to connect Proxy.

 

NO_PROXYlocalhost,127.*

Comma-separated list of destinations that will not be accessed through proxy. Do not use quotes (single or double) to enclose these values.

Important: KIUWAN_HOST value is automatically appended

KOP users
KIUWAN_USER
KIUWAN_GROUP		kiuwan
kiuwan		System user/group for KOP installation and execution
MYSQL_ROOT_PWDrootPassword for root user of KOP's MySQL instance
KIUWAN_MYSQL_USER
KIUWAN_MYSQL_USERPWD		kiuwan
kiuwan

Username and password used by KOP to access MySQL database

SSH_ROOT_PWDpasswordPassword for root user (SSH) of Kiuwan Container
KIUWAN_EMAIL_ADMIN_ACCOUNT 

Email address of kiuwanadmin user

  • this email address will be used to send notifications to kiuwanadmin user
KOP e-mail (SMTP) configuration

KIUWAN_SMTP_HOST
KIUWAN_SMTP_PORT

 SMTP host and port
KIUWAN_SMTP_USER_ACCOUNT
KIUWAN_SMTP_USER_PASSWORD		 SMTP account : username and password
KIUWAN_EMAIL_USER_ACCOUNT 

Sender email address for KOP email notifications

Advanced configuration (WildFly, MySQL, Redis, etc)

INNODB_BUFFER_POOL_SIZE 2G 
APPS_JVMMAXMEMORY 3G

Max ammount of heap memory to be used by WidlFly

KIUWAN_REDIS_MAXMEMORY 2gb

Max memory limit to be used by Redis server (https://redis.io/topics/config)

...

Component

PropertyName (=default value) 

Meaning

TimeZoneKIUWAN_TIMEZONE='UTC'Timezone to be used by Kiuwan application.
WildFly

APPS_JVMMINMEMORY=512M
APPS_JVMMAXMEMORY=3G

Max and Min ammount of heap memory to be used by WidlFly.
APPS_JVMMINMETASIZE=96M
APPS_JVMMAXMETASIZE=512M

Max and min ammount of perm gen memory to be used by WildFly

(see https://issues.jboss.org/browse/WFLY-5955)

MySQL

innodb_buffer_pool_size=2G
join_buffer_size=4M
query_cache_limit=16M
read_buffer_size=16M
read_rnd_buffer_size=4M
sort_buffer_size=4M
max_connections=1024
tmp_table_size=16M
max_allowed_packet=64M

Default MySQL parameters used to create database instance.

(see https://dev.mysql.com/doc/refman/5.6/en/ for reference) redis

Redis

KIUWAN_REDIS_MAXCLIENTS=100
KIUWAN_REDIS_MAXMEMORY=2gb

Maximum number of Redis clients that could be handled simultaneously (https://redis.io/topics/clients)

Max memory limit to be used by Redis server (https://redis.io/topics/config)