Skip to content

Feature/upgrade guide for 2025.3 to 2025.5 #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 11, 2025
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 @@ -3,4 +3,5 @@ title: "2025.1 to 2025.3"
linkTitle: "2025.1 to 2025.3"
description: "Instructions to upgrade {{% ctx %}} 2025.1 to 2025.3"
weight: 930
outOfSupport: true
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "2025.3 to 2025.5"
linkTitle: "2025.3 to 2025.5"
description: "Instructions to upgrade {{% ctx %}} 2025.3 to 2025.5"
weight: 920
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Multiple Server - With HA"
linkTitle: "Multiple Server - With HA"
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
weight: 10
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Pre-Upgrade"
linkTitle: "Pre-Upgrade"
description: "Information about the steps required to be completed prior to starting the upgrade."
weight: 30
---

# {{% param title %}}

This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}}.

## Make Installation Artefacts Available on all Servers

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

## Next Steps?

1. [Upgrade][]

[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.Upgrade" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Try it out"
linkTitle: "Try it out"
description: "Information about trying out {{% ctx %}} after upgrade."
weight: 60
---

# {{% param title %}}

This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that both the [Application Servers and Load Balancer Upgrade][] and [Web Application Server Upgrade][] has been completed before taking these steps.

## Test Debugging Flows

{{< section "/upgrade/try-it-out/test-debugging-flows.md" >}}

## Test Publishing Production Flows

{{< section "/upgrade/try-it-out/test-publishing-flows.md" >}}

## Test Executing Production Flows

{{< section "/upgrade/try-it-out/multi-server/test-executing-production-flows.md" >}}

[Application Servers and Load Balancer Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Upgrade"
linkTitle: "Upgrade"
description: "Instructions to upgrade {{% ctx %}} across multiple on-premise servers with high availability (HA)."
weight: 40
---

This guide describes how to upgrade {{% ctx %}}. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.

[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.PreUpgrade" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: "Upgrade Application Servers and Load Balancer"
linkTitle: "Upgrade Application Servers and Load Balancer"
description: "Information about upgrading the Application Servers and Load Balancer Server."
weight: 30
---

# {{< param title >}}

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

## Configure Upgrade Script

1. In the `Cortex Innovation 2025.5 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor.
1. Choose the tab below that matches the configuration for this upgrade, then update the script to match, changing the parameters according to the details given below:

{{% alert title="Note" %}}
To check the previous configuration values open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or the values should be changed then use the `Use New Configuration Values` tab.
{{% /alert %}}

{{< tabpane lang="powershell" >}}
{{< tab header="Use Previous Configuration Values" >}}
.\Cortex.Upgrade.ps1 `
-AppServicesPath "C:\Install\Cortex Innovation 2025.5 - App Services.zip" `
-BlockPackagesPath "C:\Install\Cortex Innovation 2025.5 - Block Packages.zip" `
-Credential $Credential `
-AcceptEULA:$AcceptEULA `
*>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
{{< /tab >}}
{{< tab header="Use New Configuration Values">}}
.\Cortex.Upgrade.ps1 `
-AppServicesPath "C:\Install\Cortex Innovation 2025.5 - App Services.zip" `
-BlockPackagesPath "C:\Install\Cortex Innovation 2025.5 - Block Packages.zip" `
-ApplicationServerIPv4Addresses @("192.168.1.1, 192.168.1.2, 192.168.1.3") `
-LoadBalancerServerIPv4Address "192.168.1.4" `
-Credential $Credential `
-AcceptEULA:$AcceptEULA `
*>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
{{< /tab >}}
{{< /tabpane >}}

| Name | Description |
|----------------------------------------------|-------------|
|`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server being used for the upgrade. |
|`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server being used for the upgrade. |
|`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server being used for the upgrade.|
|`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. If the built-in load balancer is not being used, this should be removed.|
|`Credential` | The credentials of the user which will be used to perform remote operations on the Application Servers. It must be a domain user that is a member of the local Administrators group on all servers.<br><br>This does not need to be changed, a prompt will appear to enter this information when the script is run. |
|`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. |
|`FilePath` | The filename that upgrade logs are written to. If this should be written to a different location than where the installation files are then a full path should be specified. |

1. Save and close `Cortex.Innovation.Upgrade.ps1`.

## Run Upgrade Script

{{< section "/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md" >}}

## Configure {{% ctx %}} Code Analyser

{{< section "/upgrade/upgrade-application-server/configure-code-analyser.md" >}}

### Update Code Analyser Allowed List

{{< section "/upgrade/upgrade-application-server/update-code-analyser.md" >}}

### Disable Code Analyser

On each of the the Application Servers:

{{< section "/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md" >}}

## Check Application Services

{{< section "/upgrade/upgrade-application-server/multi-server/check-application-services.md" >}}

## Preserve installation files

{{< section "/preserve-installation-files.md" >}}

## Next Steps?

1. [Upgrade Web Application Server][]

[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.PreUpgrade" >}}
[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Upgrade the Web Application Server"
linkTitle: "Upgrade Web Application Server"
description: "Information about upgrading the Web Application Server."
weight: 40
---

This guide describes how to upgrade the Web Application Server. Please ensure that [Upgrade Application Servers and Load Balancer][] has been completed before starting this installation. These steps assume that the v2025.3 version of Gateway and its prerequisites have already been installed.

[Upgrade Application Servers and Load Balancer]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Upgrade Interaction Portal"
linkTitle: "Upgrade Interaction Portal"
description: "Information about upgrading {{% ctx %}} Interaction Portal."
weight: 60
---

# {{% param title %}}

This guide describes how to upgrade {{% ctx %}} Interaction Portal. Please ensure that the [{{% ctx %}} Gateway Upgrade][Upgrade Gateway] has been completed before starting this upgrade.

## Perform Upgrade

{{< section "/upgrade/2025.5/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}}

## Next Steps?

1. [Try It Out][]

[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeGateway" >}}
[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.TryItOut" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "Upgrade Flow Debugger"
linkTitle: "Upgrade Flow Debugger"
description: "Information about upgrading the Flow Debugger."
weight: 30
---

# {{< param title >}}

This guide describes how to upgrade the Flow Debugger on the Web Application Server from 2025.3 to 2025.5. Please ensure that the [Upgrade Application and Load Balancer Servers][] has been completed before starting this upgrade.

## Configure Upgrade Script

{{< section "/upgrade/2025.5/upgrade-application-server/single-server/configure-upgrade-script.md" >}}

## Run Upgrade Script

{{< section "/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md">}}

## Configure {{% ctx %}} Code Analyser

{{< section "/upgrade/upgrade-application-server/configure-code-analyser.md" >}}

### Update Code Analyser Allowed List

{{< section "/upgrade/upgrade-application-server/update-code-analyser.md" >}}

### Disable Code Analyser

On the Web Application Server:

{{< section "/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md" >}}

## Check Application Services

{{< section "/upgrade/upgrade-application-server/single-server/check-application-services.md">}}

## Preserve installation files

{{< section "/preserve-installation-files.md">}}

## Next Steps?

1. [Upgrade Gateway][]

[Upgrade Application and Load Balancer Servers]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeGateway" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Upgrade Gateway"
linkTitle: "Upgrade Gateway"
description: "Information about upgrading {{% ctx %}} Gateway from 2025.3 to 2025.5."
weight: 30
---

# {{% param title %}}

This guide describes how to upgrade {{% ctx %}} Gateway from 2025.3 to 2025.5. Please ensure that the [Flow Debugger upgrade][] has been completed before starting this upgrade.

## Configure Upgrade Script

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

## Run Upgrade Script

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

## Preserve installation files

{{< section "/preserve-installation-files.md" >}}

## Next Steps?

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.3to2025.5.MultipleServerWithHA.UpgradeDebugger" >}}
[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeCIP" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Single Server - Without HA"
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
@@ -0,0 +1,27 @@
---
title: "Pre-Upgrade"
linkTitle: "Pre-Upgrade"
description: "Information about the steps required to be completed prior to starting the upgrade."
weight: 30
---

# {{% param title %}}

This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}}.

## Make Installation Artefacts Available

{{< section "/upgrade/2025.5/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.3to2025.5.SingleServerWithoutHA.Upgrade" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Try it out"
linkTitle: "Try it out"
description: "Information about trying out {{% ctx %}} after upgrade."
weight: 60
---

# {{% param title %}}

This guide describes how to try out an upgraded {{% ctx %}} to make sure it is working. Please ensure that both the [Application Server Upgrade][] and [Web Application Server Upgrade][] has been completed before taking these steps.

## Test Debugging Flows

{{< section "/upgrade/try-it-out/test-debugging-flows.md" >}}

## Test Publishing Production Flows

{{< section "/upgrade/try-it-out/test-publishing-flows.md" >}}

## Test Executing Production Flows

{{< section "/upgrade/try-it-out/single-server/test-executing-production-flows.md" >}}

[Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeApplicationServer" >}}
[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeWebApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Upgrade"
linkTitle: "Upgrade"
description: "Instructions to upgrade {{% ctx %}} on a single on-premise server without high availability (HA)."
weight: 40
---

This guide describes how to upgrade {{% ctx %}}. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.

[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.PreUpgrade" >}}
Loading