Versions Compared

Old Version 10

changes.mady.by.user Kiuwan Editor User

Saved on

compared with

New Version 11

changes.mady.by.user Kiuwan Editor User

Saved on

Key

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

...

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.

Info
titleServer Host Requirements

  • Linux kernel version 3.10 or higher

  • CS Docker Engine version 1.10 or higher installed on your server 

  • Connectivity to SMTP Mail Server (i.e. remotely accessible or locally installed)

  • The first phase of installation process (building the Kiuwan image) requires Internet connectivity 

  • A minimum of 6 GB of free disk space :

    • 3 GB for the Docker image

    • 3 Gb for Permanent Volume


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 permanent 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 docker permanent volume is created by the installation process and must specified as DIR_PERSISTENT_VOLUME property

Be sure to dispose of a minimum of 6 GB of free disk space :

  • 3 GB for Docker image

  • 3 Gb for KOP Permanent Volume

 

CPU and memory requirements

 Server CPU and memory requirements depend on several factors:

...

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:

 

Info

Installation requirements:

  • The installation requires CS Docker Engine version 1.10 or higher installed on your server  

    • Be sure you meet

    Before installing KOP, make sure your server host complies with the Server Host Requirements

    The first phase of installation process (building the Kiuwan image) requires Internet connectivity

     

    Installation must be executed using any unix user with privileges to execute docker server commands

    Installation Steps:
    Table of Contents
    includeStep.*

     

    ...

    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 KOP 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)

    ...