Page tree
Skip to end of metadata
Go to start of metadata

Introduction

This section provides information that you may need to follow in case you are upgrading one of these specific versions (see Checking for new versions section if you want to check which version is installed in your company):

Kiuwan On-Premises versionSpecific upgrade process neededApache load balancer optional changes
2.8.1910.1YES

Added health check for Kiuwan front instances

Added new error pages

Added kiuwanDomain variable to ease configuration

Removed unneeded modules

2.8.1910.4OPTIONALAdded ProxyPreserveHost On directive

2.8.2010.2

YESChanged default configuration

Upgrading from version 2.8.1910.1

If you have currently installed Kiuwan On-Premises version 2.8.1910.1, you will need to follow this guide in order to adapt your Kiuwan On-Premises infrastructure to the latest version.

Due to changes in how Redis Cluster is created through the installation process, in order to keep your installation up to date with the latest infrastructure you will need to follow a different approach to perform a full upgrade from this version.

You will need both the kiuwan-cluster version you used to install 2.8.1910.1 and the latest available kiuwan-cluster (that can be downloaded here https://static.kiuwan.com/download/onpremise/kiuwan-cluster.tar.gz). We will refer to this locations:

  • [INSTALLER_DIR_OLD]: where the old kiuwan-cluster version was untared.
  • [INSTALLER_DIR]: where the new kiuwan-cluster version has been untared.

Note that if you are using AWS elasticache service to run Redis Cluster services you can ignore this section and follow the standard upgrade process.

Step 1: Wait for all enqueued analyses to end

Make sure there are no running analyses before continuing to the next step. You can check this in the System Administration Console:

  1. Access Kiuwan On-Premises with sysadmin user.
  2. Access the Analysis Administration option in the upper right dropdown menu.
  3. Click on the "Active analyses" button and check if the table shows any running or pending analysis.

If you are using an automation tool to launch Kiuwan analyses, make sure you pause the needed jobs so no more analyses enter your Kiuwan On-Premises queues.

Once there are no more active analyses, you should wait for the pending analyses to be completely freed before stopping the Kiuwan server. This should take up to 30 minutes maximum.

Step 2: Stop kiuwan services

Change the current directory to the old kiuwan-cluster docker scripts and stop all the Kiuwan On-Premises services:

This will stop all Kiuwan frontal, analyzer and schedulers containers currently running.

Step 3: Update your current configuration

In order to update the current Kiuwan On-Premises clients and your volumes global configuration file, you should run the update script located in the new kiuwan-cluster:

Step 4: Stop remaining containers and prune

Pruning containers is needed to safely upgrade from this version. To do so, run the uninstall.sh script from the new kiuwan-cluster installation directory.

Note that this step will NOT remove any data from your current installation:

Step 5: Clean Redis cluster data

Redis Cluster current data must be cleaned up in order to start a new fresh cluster. Run the following command:

Step 6: Update Redis cluster node information

Redis Cluster default configuration has been changed in later versions of Kiuwan On-Premises. If you are running the Redis provided service you will need to update the Redis Cluster nodes locations.

Edit the global configuration file:

You must change properties "redis.cache.nodes" and "redis.store.nodes" to these values:

Step 7: Update your configuration

If you need to update any other configuration property, you can modify now any other configuration option. Changes will be taken into account when Kiuwan services are started in the next steps.

Please refer to Upgrading from versions prior to 2.8.1910.7 for details on how to modify your mail server configuration.

Please refer to Upgrading from versions prior or equal to 2.8.2010.2 for details on how to modify your Apache Load Balancer's httpd.conf configuration file.

Step 8: Run the install script for the new version

Running the installation script will recreate the new Redis Cluster and start all needed services:

Step 9: Continue with full upgrade steps

You can now continue with the standard full upgrade process just where you left it: Step 8: load balancer manual configuration (optional).

Upgrading from versions prior to 2.8.1910.7

Configuration changes were made to how the mail server is configured starting from version 2.8.1910.7. If you made manual changes in the Wildfly instances configuration to support TLS/SSL/plaintext based email servers, you must update your mail server configuration.

  1. Edit the file [VOLUMES_DIR]/config-shared/globalConfig/globalConfig.properties
  2. Look for the following properties:
    1. kiuwan.mail.authentication
    2. kiuwan.mail.username
    3. kiuwan.mail.password
    4. kiuwan.mail.secure.layer
    5. kiuwan.mail.secure.layer.value
  3. Follow the instuctions found in the comments of each property or refer to Mail server configuration examples for details on how to set the value of each property.
  4. Continue with Upgrading from versions prior or equal to 2.8.2010.2. Or if you are upgrading from 2.8.1910.1 you can skip this step.

Upgrading from versions prior or equal to 2.8.2010.2

Icon

If you are upgrading from 2.8.1910.1 please follow the instructions in Upgrading from version 2.8.1910.1.

Otherwise, if you are upgrading from versions prior to 2.8.1910.7 also check Upgrading from versions prior to 2.8.1910.7 before continuing with following steps.

In Kiuwan On-Premise some of the underlying components have changed. In particular the versions of the MySQL and REDIS containers were updated to the latest versions that are compatible with Kiuwan.

Icon

To apply these changes, once the upgrade process has finished successfully you have to execute these commands manually from [INSTALLER_DIR]:
sudo ./stop-all.sh
sudo ./start-all.sh

Also, in this new version the Apache HTTP server’s default configuration has changed. So, if you are upgrading from previous version of Kiuwan On Premises and you are using the embedded Apache HTTP server, please apply these changes manually in next file:

[VOLUMES_DIR]/config-shared/ApacheLoadBalancer/conf/httpd.conf

If you are installing Kiuwan On Premises from zero, those changes are not needed to applied. Simply follow the standard installation procedure and skip the following.

These are the changes to apply:

  • Enable mod_rewrite module loading:
    Before:
    # LoadModule rewrite_module modules/mod_rewrite.so
    After:
    LoadModule rewrite_module modules/mod_rewrite.so
    and add next directives:

Just after this group:

  • Add next directive:
    Header set X-Frame-Options: "SAMEORIGIN” 
    Inside next group: <IfModule headers_module>
    And this is the result:
  • Replace the line:
    Require all granted
    by 
    Require all denied
    In this group:



 

  • No labels