Kiuwan on premise installer is a powerful tool that suits multiple environment scenarios:
Depending on your needs, a different installation approach will be needed. Check this installation guide for details on how to proceed and find the solution that best fits your requirements.
It is mandatory for any host where a Kiuwan on premises service is installed to meet this requirements:
These software is also needed:
Please follow Docker official recommendations when installing Docker. These URLs describe the installation process for different Linux distributions:
We also recommend using the target installation hosts exclusively for Kiuwan services. If you plan running other containers than Kiuwan's in a single-host installation, please make sure that non of them is using the following network:
The following table shows the minimum requirements for each service. Note that these are only minimum requirements. You should take care of giving each service enough resources depending on your system demands.
Note: CPU clock speed and disk speed will affect overal response time.
With the configuration above a system with the following load should give continuous service without problems:
Given the table above, for a single-host installation where no service is externalized the minimum system requirements are:
It is recommended that you overscale these characteristics for the OS to have resources available for itself.
Kiuwan on premise installation process is carried out by our "kiuwan-cluster" tool.
The tool is provided as a tar.gz file. The following table summarizes the resources you will find once the tool distribution is extracted:
|/config/volumes.properties||Configuration file to set where your persistent volumes will reside.|
|/docker/*.sh||Advanced shell scripts to interact with your Kiuwan on premise installation.|
|/logs||The folder where the tool will write installation logs.|
|/ssl||Tools that ease the certificate creation to keep Kiuwan on premise under a secure environment.|
|/user-content||The folder where you will have to put some resources the installation process will need.|
|/volumes||The base persistent volumes (that may be copied to different locations depending on your installation needs).|
|Main shell scripts to interact with your Kiuwan on premise installation.|
The following sections will guide you through the installation process.
This guide will reference two important folders:
Sometimes this folders will be referenced inside command line examples. Please make sure you replace any of them with the needed real path.
Note that it is up to you where this folders will be located.
The first step is to download kiuwan-cluster, the Kiuwan on premises installation tool. It can be downloaded directly from a terminal like this:
This will download to the current directory the latest available installation tool.
Once downloaded you should untar the provided gz file:
tar xvzpf kiuwan-cluster_master.tar.gz
This will untar the installation tool to a folder with extended version information of the tool. For example:
This folder will be referred to as [INSTALL_DIR] through this guide.
In order to be able to start a Kiuwan on premises installation, you will need two license files:
Copy these files to the user-content folder of your installation tool directory (please replace [INSTALL_DIR] with the real location of your installation directory):
cp configq1.zip [INSTALL_DIR]/user-content cp configq1.zip [INSTALL_DIR]/user-content
Kiuwan on premise needs this exact MySQL driver:
You can download it by executing this command:
Copy the downloaded jar file to the user content folder:
cp mysql-connector-java-5.1.39.tar.gz [INSTALL_DIR]/user-content
The installation tool comes with the base volumes to boot a first installation of Kiuwan on premises. We provide three volumes:
Copy the provided volumes to a location of your desire:
cp -rp [INSTALL_DIR]/volumes/config-shared [VOLUMES_DIR]/config-shared cp -rp [INSTALL_DIR]/volumes/data-shared [VOLUMES_DIR]/data-shared cp -rp [INSTALL_DIR]/volumes/data-local [VOLUMES_DIR]/data-local
Take note of the locations you choose for each volume. You will need these paths for the next installation step.
Edit the file located in [INSTALL_DIR]/config/volumes.properties and set the previous paths to each property:
config.shared=[VOLUMES_DIR]/config-shared data.shared=[VOLUMES_DIR]/data-shared data.local=[VOLUMES_DIR]/data-local
Please remember that [VOLUMES_DIR] here is just a placeholder for the real path you chose.