[WIP] System Administration Guide

Contents:

Related pages:

System administration user (sysadmin) has access to Sysadmin Console :

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

• 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 

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

It's important to notice that we're assuming the typical use case where code analyses are performed locally through Kiuwan Local Analyzer, and therefore out of server machine (tipically at a user machine or within a build CI system).

Therefore, when we talk about analysis we mean 2nd phase of the analysis (i.e. indicator calculation that is executed within the host server)

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

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 specifying the values as command line arguments (see below Step3.Build the Kiuwan Docker image )

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

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>

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>

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