...
...
...
...
...
...
...
...
...
...
The Specific upgrade notes section shows which versions need special upgrade steps.
If your current Kiuwan On-Premises core version needs a special upgrade process, follow the specific upgrade steps for your current Kiuwan On-Premises core version shown in the Specific upgrade notes section.
Step 6: run the upgrade process
NOTE: you should IGNORE this step if you come from a specific upgrade process.
If your current Kiuwan On-Premises core version is not listed in the Specific upgrade notes section, change the directory to [INSTALLER_DIR] and execute this command:
Code Block | ||
---|---|---|
| ||
sudo ./update-full.sh |
This will run the upgrade process in full mode.
Step 7: load balancer manual configuration (optional)
Kiuwan On-Premises installation tool will not update automatically your load balancer configuration, so changes in this file must be made manually. Refer to the Specific upgrade notes section for information on what changes have been made in this element if you want to keep your installation up to date with the latests features added in the load balancer configuration.
Info |
---|
Note that this is an optional step. If you are happy with your current configuration or you want to mantain your own custom configuration, you can safely ignore it. |
In case you are running the default configuration, you can safely overwrite your configuration, but REMEMBER TO UPDATE "kiuwanDomain" variable to point to your specific Kiuwan On-Premises domain:
Code Block | ||
---|---|---|
| ||
cp ./volumes/config-shared/ApacheLoadBalancer/conf/httpd.conf [VOLUMES_DIR]/config-shared/ApacheLoadBalancer/conf/httpd.conf |
Once the file has been overwritten, edit it and change this line in [VOLUMES_DIR]/config-shared/ApacheLoadBalancer/conf/httpd.conf:
Code Block |
---|
Define kiuwanDomain kiuwan.onpremise.local |
It should point to your specific domain.
Once the configuration changes have been made, you should restart the apacheloadbalancer container:
Code Block | ||
---|---|---|
| ||
cd [INSTALLER_DIR]/docker
sudo ./stop-infrastructure.sh apacheloadbalancer
sudo ./start-infrastructure.sh apacheloadbalancer |
In case you have externalized the Apache load balancer service, remember to restart it after modifying its configuration.
Checking your Kiuwan On-Premises clients installations after upgrading
Once the update process is finished, all the published clients in your Kiuwan On-Premises installation will be ready to be downloaded. Check the specific client guide to see how to upgrade each client installation:
- Kiuwan Local Analyzer: upgrades automatically when started whenever your Kiuwan On-Premises servers provide a new version to download.
- Kiuwan Engine: upgrades automatically from Kiuwan Local Analyzer, as long as your Kiuwan On-Premises servers provide a new version and your engine is not frozen (see Engine documentation for more information on this topic).
- Kiuwan for developers:
- Eclipse: check Kiuwan for Developers for Eclipse-based IDEs user guide.
- JetBrains: check Kiuwan for Developers for JetBrains user guide.
- Microsoft Visual Studio: check Kiuwan for Developers for Microsoft Visual Studio user guide.
- Microsoft Visual Studio Code: check Kiuwan for Developers for Microsoft Visual Studio Code user guide.
- Kiuwan Jenkins plugin: check Jenkins plugin user guide.
- Kiuwan TFS extension: check Microsoft TFS-Azure DevOps Extension user guide.
Specific upgrade notes
This section provides information that you may need to follow in case you are upgrading one of these specific versions (see Checking for updates section if you want to check which version is installed in your company):
Kiuwan On-Premises version | Specific upgrade process needed | Apache load balancer optional changes |
---|---|---|
2.8.1910.1 | YES | Added health check for Kiuwan front instances Added new error pages Added kiuwanDomain variable to ease configuration Removed unneeded modules |
Upgrading from Kiuwan On-Premises 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 process 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:
- Access Kiuwan On-Premises with sysadmin user.
- Access the Analysis Administration option in the upper right dropdown menu.
- 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:
Code Block | ||
---|---|---|
| ||
cd [INSTALLER_DIR_OLD]/docker
sudo ./stop-kiuwan.sh |
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:
Code Block | ||
---|---|---|
| ||
cd [INSTALLER_DIR]/docker
sudo ./update.sh |
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:
Code Block | ||
---|---|---|
| ||
cd [INSTALLER_DIR]
sudo ./uninstall.sh |
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:
Code Block | ||
---|---|---|
| ||
sudo rm -rf [VOLUMES_DIR]/data-local/Redis/data |
Step 6: update Redis cluster node information
Redis Cluster default configuration has been changed in the following versions of Kiuwan On-Premises. If you are running the provided service you will need to update the Redis Cluster nodes locations.
Edit the global configuration file:
Code Block | ||
---|---|---|
| ||
sudo vim [VOLUMES_DIR]/config-shared/globalConfig/globalConfig.properties |
You must change properties "redis.cache.nodes" and "redis.store.nodes" to these values:
Code Block | ||
---|---|---|
| ||
redis.cache.nodes=172.17.0.1:6379,172.17.0.1:6380,172.17.0.1:6381,172.17.0.1:6382,172.17.0.1:6383,172.17.0.1:6384
redis.store.nodes=172.17.0.1:6379,172.17.0.1:6380,172.17.0.1:6381,172.17.0.1:6382,172.17.0.1:6383,172.17.0.1:6384 |
If you need to update any other configuration property, you can modify now any other configuration option. Changes will be taken into account.
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:
Code Block | ||
---|---|---|
| ||
cd [INSTALL_DIR]
sudo ./install.sh |
Step 9: continue with full upgrade steps
You can now continue with the standard upgrade process. See Step 7: load balancer manual configuration (optional).
...