Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ linkTitle: "Multiple Server - With HA"
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
weight: 10
---

{{% alert title="Warning" color="warning" %}}
This upgrade guide is only applicable if upgrading from 2024.9.25161.
{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ linkTitle: "Single Server - Without HA"
description: "Upgrade instructions for a single on-premise server without high availability (HA)."
weight: 500
---

{{% alert title="Warning" color="warning" %}}
The Application Server will be reinstalled as part of the upgrade. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,15 @@ This guide describes how to perform the steps required before starting the upgra

{{< section "/upgrade/2025.3/pre-upgrade/single-server/make-artefacts-available.md">}}

## Backup Configuration Portal Data

If using the {{% ctx %}} Configuration Portal, the data will need to be backed up.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Next Steps?

1. [Upgrade][]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.Upgrade" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ weight: 30

This guide describes how to upgrade the Application Server components on the server from 2024.9.25161 to 2025.3. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting this upgrade.

{{% alert title="Warning" color="warning" %}}
The Application Server will be reinstalled as part of the upgrade. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}

## Configure Upgrade Script

{{< section "/upgrade/2025.3/upgrade-application-server/single-server/configure-upgrade-script.md" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,41 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202

{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}}

## Delete Old Execution Services

1. Open a web browser.
1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of one of the application servers. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.
1. Expand `Cluster` then `Applications` then `Cortex.Innovation.Execution`.
1. For all old execution applications:
* Click on the drop down menu and select `Delete Application`. Confirm application deletion by following the on-screen instructions.
* Give this a few minutes. If the application does not delete:
* Expand `Nodes`
* For each node:
* Expand the node and select the application that matches the engine version number of the application that is being attempted to be deleted.
* Expand each level up to and including `Code Packages`.
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

1. Log in to Gateway with a user that has the `Admin` role.
1. Click on the `Admin` charm, then `Packages`.
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
1. For each published package version:
* Select the package.
* Click `Unpublish` at the bottom of the `Definition` tab and click `Unpublish` on the confirmation pop-up dialog. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy
* Click `Create New Version` then click `Save` and wait for the new version to be created.
* Click `Publish`. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy.
* Sometimes the list of published packages in the `Package Definitions` grid disappears. To fix, set the `Is Published` filter in the `Package Definitions` grid to blank option and then set the filter to `Is Published` option again to show all published packages.

## Restore Configuration Portal Data

If using the {{% ctx %}} Configuration Portal, the data will need to be restored.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Preserve installation files

{{< section "/preserve-installation-files.md" >}}
Expand All @@ -25,5 +60,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202

1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeCIP" >}}
[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ linkTitle: "Multiple Server - With HA"
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
weight: 10
---

{{% alert title="Warning" color="warning" %}}
Due to breaking changes required for upgrading RabbitMQ from version 3 to version 4 the Application Servers need to be reinstalled rather than upgraded. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,17 @@ This guide describes how to perform the steps required before starting the upgra

{{< section "/upgrade/2025.3/pre-upgrade/multi-server/make-artefacts-available.md">}}

## Backup Configuration Portal Data

{{< alert type="note" title="Note" >}} This only needs to happen for upgrading to this release version as breaking changes were introduced as part of the RabbitMQ upgrade.{{< /alert >}}

If using the {{% ctx %}} Configuration Portal, the data will need to be backed up.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Next Steps?

1. [Upgrade][]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.Upgrade" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ weight: 30

This guide describes how to upgrade the Application Servers and Load Balancer Server from 2025.1 to 2025.3. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting this upgrade.

{{% alert title="Warning" color="warning" %}}
Due to breaking changes required for upgrading RabbitMQ from version 3 to version 4 the Application Servers need to be reinstalled rather than upgraded. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}

## Configure Upgrade Script

1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,47 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P

{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}}

## Delete Old Execution Services

{{< alert type="note" title="Note" >}} This only needs to happen for upgrading to this release version as breaking changes were introduced as part of the RabbitMQ upgrade.{{< /alert >}}

1. Open a web browser.
1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of one of the application servers. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.
1. Expand `Cluster` then `Applications` then `Cortex.Innovation.Execution`.
1. For all old execution applications:
* Click on the drop down menu and select `Delete Application`. Confirm application deletion by following the on-screen instructions.
* Give this a few minutes. If the application does not delete:
* Expand `Nodes`
* For each node:
* Expand the node and select the application that matches the engine version number of the application that is being attempted to be deleted.
* Expand each level up to and including `Code Packages`.
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

{{< alert type="note" title="Note" >}} This only needs to happen for upgrading to this release version as breaking changes were introduced as part of the RabbitMQ upgrade.{{< /alert >}}

1. Log in to Gateway with a user that has the `Admin` role.
1. Click on the `Admin` charm, then `Packages`.
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
1. For each published package version:
* Select the package.
* Click `Unpublish` at the bottom of the `Definition` tab and click `Unpublish` on the confirmation pop-up dialog. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy
* Click `Create New Version` then click `Save` and wait for the new version to be created.
* Click `Publish`. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy.
* Sometimes the list of published packages in the `Package Definitions` grid disappears. To fix, set the `Is Published` filter in the `Package Definitions` grid to blank option and then set the filter to `Is Published` option again to show all published packages.

## Restore Configuration Portal Data

{{< alert type="note" title="Note" >}} This only needs to happen for upgrading to this release version as breaking changes were introduced as part of the RabbitMQ upgrade.{{< /alert >}}

If using the {{% ctx %}} Configuration Portal, the data will need to be restored.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Preserve installation files

{{< section "/preserve-installation-files.md" >}}
Expand All @@ -25,5 +66,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P

1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeDebugger" >}}
[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeCIP" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ linkTitle: "Single Server - Without HA"
description: "Upgrade instructions for a single on-premise server without high availability (HA)."
weight: 500
---

{{% alert title="Warning" color="warning" %}}
The Application Server will be reinstalled as part of the upgrade. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,15 @@ This guide describes how to perform the steps required before starting the upgra

{{< section "/upgrade/2025.3/pre-upgrade/single-server/make-artefacts-available.md">}}

## Backup Configuration Portal Data

If using the {{% ctx %}} Configuration Portal, the data will need to be backed up.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Next Steps?

1. [Upgrade][]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.Upgrade" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ weight: 30

This guide describes how to upgrade the Application Server components on the server from 2025.1 to 2025.3. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting this upgrade.

{{% alert title="Warning" color="warning" %}}
The Application Server will be reinstalled as part of the upgrade. As a result packages will need to be republished and Configuration Portal data will need to be backed up and restored. Other data stored in Reliable Collections (e.g., data storage collections and semaphores) will be lost.
{{% /alert %}}

## Configure Upgrade Script

{{< section "/upgrade/2025.3/upgrade-application-server/single-server/configure-upgrade-script.md" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,41 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P

{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}}

## Delete Old Execution Services

1. Open a web browser.
1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of one of the application servers. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.
1. Expand `Cluster` then `Applications` then `Cortex.Innovation.Execution`.
1. For all old execution applications:
* Click on the drop down menu and select `Delete Application`. Confirm application deletion by following the on-screen instructions.
* Give this a few minutes. If the application does not delete:
* Expand `Nodes`
* For each node:
* Expand the node and select the application that matches the engine version number of the application that is being attempted to be deleted.
* Expand each level up to and including `Code Packages`.
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.

Repeat the above instructions for the `Flow Debugger`. In step 2 `server.domain.com` is the fully qualified domain name of the web application server.

## Republish Packages

1. Log in to Gateway with a user that has the `Admin` role.
1. Click on the `Admin` charm, then `Packages`.
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
1. For each published package version:
* Select the package.
* Click `Unpublish` at the bottom of the `Definition` tab and click `Unpublish` on the confirmation pop-up dialog. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy
* Click `Create New Version` then click `Save` and wait for the new version to be created.
* Click `Publish`. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy.
* Sometimes the list of published packages in the `Package Definitions` grid disappears. To fix, set the `Is Published` filter in the `Package Definitions` grid to blank option and then set the filter to `Is Published` option again to show all published packages.

## Restore Configuration Portal Data

If using the {{% ctx %}} Configuration Portal, the data will need to be restored.

For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].

## Preserve installation files

{{< section "/preserve-installation-files.md" >}}
Expand All @@ -25,5 +60,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P

1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeCIP" >}}
[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}}