...
Checking for new versions
Web application mode
Currently installed versions and latest available versions of Kiuwan On-Premises are shown in the System Administration Console. To access this page, log into your Kiuwan On-Premises installation as "sysadmin".
...
| Meaning | |
|---|---|
| Kiuwan Core | Kiuwan On-Premises itself. This is the image version of your Kiuwan containers (front, analyzer and scheduler nodes). |
| Kiuwan Clients | Kiuwan On-Premises clients. These are the clients provided along with your current Kiuwan On-Premises installation. Sometimes clients may be updated without the need of a full Kiuwan On-Premises upgrade that includes Kiuwan Core. See Upgrade: clients only mode section for more information. |
| Installed version | This column shows the version name of the current installed versions (both for Kiuwan core and clients). |
| Last available version | This column shows the latest available version of Kiuwan core and clients. |
| Status | When a new version is detected this column will indicate that an upgrade is available. |
| Minimum Kiuwan On-Premises version needed to upgrade clients | If your current Kiuwan Core version is less than this version, new versions of Kiuwan On-Premises clients will not be available for your installation anymore. If you want to upgrade, it is mandatory to perform a full upgrade. See Upgrade: full mode section for more information. |
...
Command Line Interface mode
You can upgrade only also check your current Kiuwan On-Premises clients or perform a full upgrade to your Kiuwan On-Premises installation.core version by running this command on a Kiuwan front instance host:
| Code Block | ||
|---|---|---|
| ||
cat [VOLUMES_DIR]/data-shared/publicData/current.version |
Upgrade modes
You can upgrade only Kiuwan On-Premises clients or perform a full upgrade to your Kiuwan On-Premises installation.
| Info |
|---|
Both clients only and full modes will |
| Info |
Both clients only and full modes will update changes made in the current configuration that have not been already applied, but keep in mind that new configuration properties will only be available after performing a full upgrade. Default configuration values will be used when starting a new version of Kiuwan services. |
...
If the old version of kiuwan-cluster is needed through the upgrade process, its path will be refererred to as [INSTALLER_DIR_OLD].
Step 2: download kiuwan-cluster latest version
In order to upgrade to the latest versions of For example, if you are upgrading from Kiuwan On-Premises images you need to download the latest version of the installation tool. Run this in your Kiuwan On-Premises host:
| Code Block | ||
|---|---|---|
| ||
wget https://static.kiuwan.com/download/onpremise/kiuwan-cluster.tar.gz |
This will download the latest available installation tool to the current directory.
Step 3: untar kiuwan-cluster
2.8.1910.1 to Kiuwan On-Premises 2.8.1910.4, your folders will look like this:
- [INSTALLER_DIR_OLD]: /home/user/kiuwan-cluster_master.265-2.8.1910.1
- [INSTALLER_DIR]: /home/user/kiuwan-cluster_master.473-2.8.1910.4 (you will create this folder in the next steps).
Step 2: download kiuwan-cluster latest version
In order to upgrade to the latest versions of Kiuwan On-Premises images you need to download the latest version of the installation tool. Run this in your Kiuwan On-Premises hostOnce downloaded, you should untar the provided gz file:
| Code Block | ||
|---|---|---|
| ||
tar xvzpf wget https://static.kiuwan.com/download/onpremise/kiuwan-cluster.tar.gz |
This will untar the download the latest available installation tool to a folder with extended version information of the tool. For example:
/home/user/kiuwan-cluster_master.XXXX-2.8.YYMM.V
the current directory.
Step 3: untar kiuwan-cluster
Once downloaded, you should untar the provided gz file:
| Code Block | ||
|---|---|---|
| ||
tar xvzpf kiuwan-cluster.tar.gz |
This will untar the installation tool to a folder with extended version information of the tool. For example:
/home/user/kiuwan-cluster_master.XXXX-2.8.YYMM.V
This folder will be referred to as [INSTALLER_DIRThis folder will be referred to as [INSTALLER_DIR] throughout the following steps.
Step
...
4: update kiuwan-cluster volumes and user-content configuration
Copy the volumes configuration from the old to the new kiuwan-cluster folders
Refer to Specific upgrade notes section. If the current Kiuwan core version shown in System Administration Console needs a special upgrade process, follow the steps shown and return here after you have finished.
Step 4: run the full upgrade
Change the directory to [INSTALLER_DIR] and execute this command:
| Code Block | ||
|---|---|---|
| ||
sudo ./update-full.sh |
Updating Apache load balancer configuration
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.
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.
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: stop kiuwan services
*stop-kiuwan.sh (version vieja)
Step 2: update your current configuration
*update.sh (version nueva)
...
cp [INSTALLER_DIR_OLD]/config/volumes.properties [INSTALLER_DIR]/config/volumes.properties |
This will configure the volumes location in the new kiuwan-cluster.
Then copy the old user-content folder to the new kiuwan-cluster user-content folder:
| Code Block | ||
|---|---|---|
| ||
cp -r [INSTALLER_DIR_OLD]/user-content [INSTALLER_DIR]/user-content |
This will keep track of the latest license and certificates you configured with the previous kiuwan-cluster:
Step 5: check specific upgrade steps
First, identify which Kiuwan On-Premises version you have currently installed. Refer to Checking for updates section for details on how to check it.
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
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.
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: 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 2: 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 3: prune current containers
Pruning containers is needed to safely upgrade from this version,
*uninstall.sh (version nueva)
...