Page History

...

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): http://kiuwan.mydomain.com:7080/saas
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_PORT	3306	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_PORT	2222	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_START	false	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 (used to build the docker Kiuwan image)
USE_PROXY	false	false: don´t use proxy to build container true: use proxy to build container
PROTOCOL_PROXY	http	http 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_PWD	password	Password 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, visit Advanced Configuration for additional configuration parameters)
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)

...

Info

After configuration, you will build the Kiuwan docker image.

IMPORTANT: Please be sure you have already installed KOP licenses, otherwise the docker image will not be built !!

To build it (configuration done at Dockerfile)the docker image:

     cd $KOP_INSTDIR/vX.Y

  docker build -t <image_name:version> .

where image_name can be any string that helps you to identify the image (for example kop:v1.2)

If you prefer to specify the configuration by command line arguments, you can use:

     docker build \

            --build-arg KIUWAN_HOST=mykiuwan.mydomain.com \

            --build-arg KIUWAN_PORT=myPortNumber \

			--build-arg ...  \

            -t <image_name:version> .

/create_and_init_kop.sh

This step requires Internet connectivity.

If your installation uses an proxy, you should build it with next command:

     docker build \

            --build-arg http_proxy=http://user:pass@proxy_host:proxy_port \

-t <image_name:version> .

have previolsy configured the proxy settings.

In case you need to execute the Kiuwan container in a host server without Internet connectivity:

Build the image in a connected server host
Save the image, transfer it to the target host server and then load it and execute it (as further described)

...

     docker load --input kop_v12_saved_image.tar

Step

...

Info

After building the image, an initial execution of the image it’s need to complete the installation process.

To do it, execute:

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

                     -h <my_container_host_name> \

                     -v <server_host_mount_dir:container_mount_dir> \

                     -e KIUWAN_FIRST_TIME="Y" -it \

                     <image_name:version>

IMPORTANT: <container_mount_dir> must match KIUWAN_VOL property of Dokerfile

This step will configure and populate Kiuwan database as well as set up directory structure of Kiuwan image.

This step only should be executed once and previously to run the container.

For example, the next command:

   docker run --rm --name kop -h kop.mydomain.com -v /data/kop:/kiuwan_vol -e KIUWAN_FIRST_TIME="Y" -it kop:v1.2

will assign "kop" as the name of the container
will assign "kop.mydomin.com" as the hostname of the container
will install KOP sw in
- /data/kop in server host
- /kiuwan_vol/ in container

Step 5. Executing the Kiuwan Docker container

...

After the container is built, you can execute (run) the Kiuwan container by issuing the following command:

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

                     -h <my_container_host_name> \

                     -v <server_host_mount_dir:container_mount_dir> \

                     -p <mysql_port_ext>:3306 -p <ssh_port_ext>:22 -p <kiuwan_port_ext>:7080 \

                     -e START_AND_RUN="Y" -d \

                     <image_name:version>

<container_mount_dir> must match KIUWAN_VOL property of Dokerfile
You need to map several ports from the container to the host machine in order to access the container. That’s done by using –p server_port:container_port.
- <mysql_port_ext> : server host port to access container's MySQL (you can leave it to standard 3306 if MySQL is not running in server host)
- <ssh_port_ext> : server host port to access container thorugh SSH (must be different to standard 22 because most probably SHH:22 will be running in server host)
- <kiuwan_port_ext> : external port to access Kiuwan ( IMPORTANT: <kiuwan_port_ext> must match KIUWAN_PORT property of Dokerfile)

You can stop the Kiuwan container by issuing the following command:

     docker stop <my_container_name>

Step 6.1 Execution in debug mode (only sshd)

...

Info

Once Kiuwan On Premise container is running, you can access it from a browser in the following URL:

http://<$KIUWAN_HOST>:<$KIUWAN_PORT>/saas

where KIUWAN_HOST and KIUWAN_PORT match the values of those properties as configured in Dockerfile

Advanced Configuration

Below table shows available configuration parameters :

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

Info

There are some additional configuration parameters that you can configure at Dockerfile (located in your $KOP_INSTDIR)

Configuration done at settings.custom file always take precedence over configuration done at Dockerfile

Component	PropertyName (=default value)	Meaning
TimeZone	KIUWAN_TIMEZONE='UTC'	Timezone to be used by Kiuwan application.
WildFly	KIUWAN_WILDFLY_JVMMINMEMORY=512M KIUWAN_WILDFLY_JVMMAXMEMORY=3G	Max and Min ammount of heap memory to be used by WidlFly.
WildFly	KIUWAN_WILDFLY_JVMMINMETASIZE=96M KIUWAN_WILDFLY_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)

Page tree

Versions Compared

Old Version 4

New Version 5

Key

Step

Step 5. Executing the Kiuwan Docker container

Step 6.1 Execution in debug mode (only sshd)

Advanced Configuration