This page provides information on how to upgrade a Kiuwan On-Premises Distributed installation. Note that this guide only applies to Kiuwan On-Premises installations and distributed installations done using the kiuwan-cluster tool.
Keep in mind the information on Specific version upgrade notes when upgrading.
Checking for new versions
Web application mode
Currently installed versions and the 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".
You should see the following page (note that versions may change between this screenshot and your installation):
This table summarizes the meaning of the information shown in the previous screenshot:
| 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 also check your current Kiuwan On-Premises core version by running this command on a Kiuwan front instance host:
cat [VOLUMES_DIR]/data-shared/publicData/current.versionUpgrade modes
You can upgrade only Kiuwan On-Premises clients or perform a full upgrade to your Kiuwan On-Premises installation.
Both clients-only and full modes will update changes made in the current configuration that has 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.
Clients only mode
You can choose to upgrade only Kiuwan On-Premises clients as long as their latest versions are compatible with your currently installed Kiuwan core. The upgrade process will check this for you and stop the upgrade if your current Kiuwan core is not compatible with the latest available clients.
Do not mix up what a Kiuwan On-Premises client version is. These are different concepts:
- Client versions stored in your Kiuwan On-Premises servers: these are the versions that your Kiuwan On-Premises server provides to be downloaded and installed on your CI systems, development computers, etc. These versions are those shown in the System Administration Console.
- Client versions installed in your company's laptops, CI systems, etc.: these are the versions that were installed after your first Kiuwan On-Premises installation or subsequent upgrades. Once you upgrade your installation client versions, your company's computers may have old versions of Kiuwan On-Premises clients. The following steps address how to upgrade these as well.
Kiuwan On-Premises clients are those Kiuwan products that your Kiuwan On-Premises servers will provide to your users:
- Kiuwan Local Analyzer
- Kiuwan Engine
- Kiuwan for developers IDE plugins or extensions (Eclipse, JetBrains, Visual Studio, and Visual Studio Code).
There are more Kiuwan clients that you may need to upgrade, but are provided by external sources and you should follow the standard upgrade procedure of their platform. Note that these product's latests versions may be only compatible with the latest available Kiuwan On-Premises core services:
- Kiuwan Jenkins plugin: downloadable from the Jenkins plugin repository.
- Kiuwan Microsoft TFS Azure extension: downloadable through the Azure DevOps marketplace.
Choose this upgrade mode when:
- New versions of Kiuwan On-Premises clients are available.
- You want to upgrade your installation to make your Kiuwan On-Premises servers provide the latest available versions of each client.
- You want to keep your Kiuwan services untouched.
Full mode
The full-mode upgrade will upgrade both Kiuwan On-Premises clients and Kiuwan core services.
Keep in mind that when choosing this mode, you should always download the latest kiuwan-cluster version available. The latest version is always accessible through this link: https://static.kiuwan.com/download/onpremise/kiuwan-cluster.tar.gz.
Choose this upgrade mode when:
- You want to upgrade your Kiuwan On-Premises clients but your Kiuwan core services version is not compatible with the latest client versions.
- You want to have the latest fixes and features available in Kiuwan.
You can directly update your Kiuwan On-Premises installation guide from any version to the latest available version. For complete upgrade instructions, visit the KOP Upgrade Common Steps page.