| Info | |||||||
|---|---|---|---|---|---|---|---|
Contents:
Related pages:
|
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
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).
...
- Recommended size for KOP persistent volume is 50 Gb
- Try to specify an independent disk/partition, so you can easily increase it later if needed
CPU and memory requirements
Server CPU and memory requirements depend on several factors:
...
- 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 | ||||
|---|---|---|---|---|
Before installing KOP, make sure your server host complies with the Server Host Requirements
Installation Steps:
|
Step 1. Unpackage KOP Installation Package
| Info |
|---|
KOP Installation Package consists on a tarball gz file (docker-for-kiuwan_master.X.Y.tar.gz) containing all the kiuwan docker files.
KOP Licenses are distributed through a zip file that contains two license distribution zipfiles:
To install the licences:
Please visit How to Install KOP Licenses is you need to reinstall (or upgrade) licenses after the docker container is built. |
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 by creating a configuration file (settings.custom) that will be used during the image building process. There's a file (settings.tpl) you can use as a template to configure your own settings.
|
...
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 the docker image: cd $KOP_INSTDIR/vX.Y ./create_and_init_kop.sh
This step requires Internet connectivity. If your installation uses an proxy, you should have previolsy configured the proxy settings.
In case you need to execute the Kiuwan container in a host server without Internet connectivity:
|
...
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. Executing the Kiuwan Docker container
| Info |
|---|
After executing docker image build script (./create_and_init_kop.sh ), two scripts are generated based on settings.custom configuration file
run_kop.sh Script to start the Kiuwan docker container and make KOP fully available and accessible to users.
run_init_kop.sh Script to initilize the Kiuwan docker container (i.e. resetting completely the KOP installation to factory defaults) without to create a new image. This script will remove any existing data of KOP installation (for example, all the database contents will be deleted).
IMPORTANT:
You can stop the Kiuwan container by issuing the following command: docker stop <my_container_name> |
Step 4.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 5. (Optional) Making Kiuwan On Premise running on HTTPS
In you need to execute Kiwuan On Premise over HTTPS protocol, please follow next steps.
Step 5.1 Create your KOP SSL configuration file
SSL configuration is currently done by creating a configuration file (ssl.custom) within ssl directory
...
Property Name | Default value | Meaning |
|---|---|---|
| Commons | ||
| SSL_O | Your Organization | |
SSL_LOCALITY | Your Locality | |
| SSL_STATE | Your State | |
| SSL_COUNTRY | Your Country | |
| SSL_OU | Your Organization Unit | |
| Keystore | ||
| SSL_KS_PWD | Password for Keystore that will be created | |
| Aliases | ||
| SSL_ALIAS | wildfly | Alias of the Certificate to be created. |
| HTTPS_PORT | 443 | HTTPS port |
Step 5.2 Create the Private key and Certificate Signing Request (CSR) for your server
- within ssl directory execute the script CreateKey_and_ReqCSR.sh
- this script generates the CSR file under ssl/certs
- that file is named <yourhost.yourdomain.com>.csr , according to $KIUWAN_HOST configuration property
- send CSR file to your CA (Certificate Authority)
- CA will send back to you two files:
- CA's Certificate file (IMPORTANT: rename it to ca.crt )
- your host's Certificate file : for example yourhost.yourdomain.com.crt
- copy received files to ssl/certs directory
Step 5.3 Create the Keystore and switch from HTTP to HTTPS
- within ssl directory execute the script TransferFilesToContainer.sh
- this script transfers your server's certificate, your private key and CA's certificate to KOP container
also, it transfers the script templates that will be used to create the keystore and to change the configuration from http to https
within ssl directory execute the script run_create_Keystore.sh
- this script executes (into the container) the script create_Keystore.sh (created from template create_Keystore.tpl)
- within ssl directory execute the script run_change_ToHTTPS.sh
- this script stops wildfly service and executes the script change_ToHTTPS.sh (created from template change_ToHTTPS.tpl), this script will create files with .rollback extension of modified ones
- then, it starts wildfly service
| Info |
|---|
After the conversion to HTTPS, please download a new version of Kiuwan Local Analyzer from your KOP site. |
Step 5.4 Just in case you are using your own CA, make it valid to your browsers and Java
If the certificate is signed by your own Certification Authority, the browsers will not recognize it as a valid CA and you will get an error messages such as:
...
- docker commit <kop docker name> <kop docker image>
- NOTE: run 'docker ps' to get NAMES and IMAGE values of your KOP container
Rollback to HTTP
...
After execution, KOP will come back to configuration previous to the execution of run_change_ToHTTPS.sh script.
Step 6. Accessing Kiuwan On Premise
KOP URL
Once Kiuwan On Premise container is running, you can access it from a browser in the following URL:
http[s]://<KIUWAN_HOST>:<KIUWAN_PORT>/saas
where KIUWAN_HOST and KIUWAN_PORT match the values of those properties as configured in settings.custom
KOP built-in users
KOP comes with the following built-in users.
- kiuwanadmin (password: kiuwanadmin)
- access to Kiuwan "functional" administration modules such as Users, Applications and Model Management (see Admin Guide )
- log in as kiuwanadmin to create users of your KOP instance
- sysadmin (password: sysadmin)
- log in as sysadmin to access functionalities related to monitoring and tuning KOP execution
- sysadmin will give you access KOP sysconsole
Upgrading your KOP installation
In order to maintain your KOP installation up-to-date to new features, bugfixes, etc, you will have to upgrade your KOP installation.
The following pages describe the upgrading Installation procedures of releases of KOP.
Before starting the upgrade process, it's always advisable to make a backup of current KOP installation.
- make a backup of MySQL
- stop the container
- docker stop <$KIUWAN_HOST>
- make a copy of permanent volume ( $KIUWAN_VOL setting ).
- cp -rpf <$KIUWAN_VOL> <$KIUWAN_VOL>.bck
- start the container
- run_kop.sh
Basically, a new relase is distributed as a new KOP Installation Package, consisting on a tarball gz file (docker-for-kiuwan_master.X.Y.tar.gz) containing all the new kiuwan docker files.
- copy the new distribution tarball to your host server’s updates directory ($KOP_INSTDIR/updates/download)
- uncompress the distribution tarball
- tar xvzf docker-for-kiuwan_master.X.Y.tar.gz
- a $KOP_INSTDIR/updates/download/docker-for-kiuwan_master.X.Y directory will be created
- change directory to $KOP_INSTDIR/updates/bin
- execute the script updateKiuwanLauncher.sh
- this script makes all the work to upgrade your current KOP app instance to the new one
- execute the script updateClientsLauncher.sh
- this script makes new KLA and K4D ready to be downloadable by KOP client users
Advanced Configuration
As above specified, settings.custom file allows you to specify most (but not all) configuration parameters.
...