Versions Compared

Key

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

Contents:

Table of Contents

Related pages:

Page Tree
root@self


System Architecture Overview

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

...

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

Server Host 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).

...

  • 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.

 

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:

 

Info

Installation requirements:

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

  • Be sure you meet 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.*

 

Step 1. Unpackage KOP Installation Package

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

 

 

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 through below properties.

This configuration can be specified in two ways:

  1. either directly setting the values editing $KOP_INSTDIR/vX.Y/Dockerfile
  2. or specifyingthe values as command line arguments (see below Step3.Build the Kiuwan Docker image )

 

...

You can visit Advanced Configuration for additional configuration parameters.

 

Step 3. Build the Kiuwan Docker image

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

     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> .

 

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> .

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

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

 

...

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 load --input kop_v12_saved_image.tar 

 

Step 4. Post-build configuration of the Kiuwan Docker image

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.

...

  • 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

Info

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) 

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

...

Info

After the container is built, you can execute (run) the Kiuwan container in debug mode 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 <ssh_port_ext>:22  \
                     -d \
                     <image_name:version>


Step 6. Accessing Kiuwan On Premise

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 :

...