Versions Compared

Key

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

...

Info

KOP Installation Package consists on a tarball gz file (vX.Y.tar.gz) containing all the kiuwan docker files.

  • Copy the distribution tarball to your host server’s installation directory ($KOP_INSTDIR)
  • Uncompress the distribution tarball  
    • tar xvzf vX.Y.tar.gz 
  • This will create a $KOP_INSTDIR/vX.Y directory with all the kiuwan docker files

  • In $KOP_INSTDIR/vX.Y  you will find a file named Dockerfile where you will configure the Kiuwan docker image.

 

KOP Licenses are distributed through a zip file that contains two license distribution zipfiles:

  • license.zip
  • configq1.zip

To install the licences:

  1. Copy both zipfiles to "license" directory of you KOP installation directory
    • cp license.zip $KOP_INSTDIR/vX.Y/license
    • cp configq1.zip $KOP_INSTDIR/vX.Y/license
  2. Continue configuring and building your KOP image

 Please visit How to Install KOP Licenses is you need to reinstall (or upgrade) licenses after the docker container is built.

 

Step 2. Configure Kiuwan Docker image

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

Default value

Meaning

SysAdmin configuration
KIUWAN_HOST
KIUWAN_PORT

kiuwan.mydomain.com
7080

Hostname (or ip address) and port number to access KOP.

These variables will be used to build Kiuwan URL.

Example (with default values):

KIUWAN_DOCKER_IMAGE Name of the docker image (repositoroy name) to be built
KIUWAN_TAG_DOCKER_IMAGE Tag of the docker image to be built

DIR_PERSISTENT_VOLUME

/data_kop

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
PROTOCOL_PROXYhttphttp or https
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

KOP users
KIUWAN_WILDFLY_USER
KIUWAN_WILDFLY_GROUP
kiuwan
gkiuwan
System user/group for WildFly's installation and execution
MYSQL_ROOT_PWD Password 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 
KIUWAN_WILDFLY_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)

...