Skip to content

Commit de5b78e

Browse files
author
Donna-Marie Smith
committed
initial 2025.5 upgrade guide
1 parent 0215f94 commit de5b78e

File tree

29 files changed

+784
-0
lines changed

29 files changed

+784
-0
lines changed

content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ title: "2025.1 to 2025.3"
33
linkTitle: "2025.1 to 2025.3"
44
description: "Instructions to upgrade {{% ctx %}} 2025.1 to 2025.3"
55
weight: 930
6+
outOfSupport: true
67
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "2025.3 to 2025.5"
3+
linkTitle: "2025.3 to 2025.5"
4+
description: "Instructions to upgrade {{% ctx %}} 2025.3 to 2025.5"
5+
weight: 920
6+
---
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Multiple Server - With HA"
3+
linkTitle: "Multiple Server - With HA"
4+
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
5+
weight: 10
6+
---
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "Pre-Upgrade"
3+
linkTitle: "Pre-Upgrade"
4+
description: "Information about the steps required to be completed prior to starting the upgrade."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to perform the steps required before starting the upgrade of {{% ctx %}}.
11+
12+
## Make Installation Artefacts Available on all Servers
13+
14+
{{< section "/upgrade/2025.5/pre-upgrade/multi-server/make-artefacts-available.md">}}
15+
16+
## Next Steps?
17+
18+
1. [Upgrade][]
19+
20+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
21+
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.Upgrade" >}}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: "Try it out"
3+
linkTitle: "Try it out"
4+
description: "Information about trying out {{% ctx %}} after upgrade."
5+
weight: 60
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
## Test Debugging Flows
13+
14+
{{< section "/upgrade/try-it-out/test-debugging-flows.md" >}}
15+
16+
## Test Publishing Production Flows
17+
18+
{{< section "/upgrade/try-it-out/test-publishing-flows.md" >}}
19+
20+
## Test Executing Production Flows
21+
22+
{{< section "/upgrade/try-it-out/multi-server/test-executing-production-flows.md" >}}
23+
24+
[Application Servers and Load Balancer Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
25+
[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Upgrade"
3+
linkTitle: "Upgrade"
4+
description: "Instructions to upgrade {{% ctx %}} across multiple on-premise servers with high availability (HA)."
5+
weight: 40
6+
---
7+
8+
This guide describes how to upgrade {{% ctx %}}. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting the upgrade.
9+
10+
[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.PreUpgrade" >}}
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: "Upgrade Application Servers and Load Balancer"
3+
linkTitle: "Upgrade Application Servers and Load Balancer"
4+
description: "Information about upgrading the Application Servers and Load Balancer Server."
5+
weight: 30
6+
---
7+
8+
# {{< param title >}}
9+
10+
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.
11+
12+
{{% alert title="Warning" color="warning" %}}
13+
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.
14+
{{% /alert %}}
15+
16+
## Configure Upgrade Script
17+
18+
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.
19+
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:
20+
21+
{{% alert title="Note" %}}
22+
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.
23+
{{% /alert %}}
24+
25+
{{< tabpane lang="powershell" >}}
26+
{{< tab header="Use Previous Configuration Values" >}}
27+
.\Cortex.Upgrade.ps1 `
28+
-AppServicesPath "C:\Install\Cortex Innovation 2025.5 - App Services.zip" `
29+
-BlockPackagesPath "C:\Install\Cortex Innovation 2025.5 - Block Packages.zip" `
30+
-Credential $Credential `
31+
-AcceptEULA:$AcceptEULA `
32+
*>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
33+
{{< /tab >}}
34+
{{< tab header="Use New Configuration Values">}}
35+
.\Cortex.Upgrade.ps1 `
36+
-AppServicesPath "C:\Install\Cortex Innovation 2025.5 - App Services.zip" `
37+
-BlockPackagesPath "C:\Install\Cortex Innovation 2025.5 - Block Packages.zip" `
38+
-ApplicationServerIPv4Addresses @("192.168.1.1, 192.168.1.2, 192.168.1.3") `
39+
-LoadBalancerServerIPv4Address "192.168.1.4" `
40+
-Credential $Credential `
41+
-AcceptEULA:$AcceptEULA `
42+
*>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
43+
{{< /tab >}}
44+
{{< /tabpane >}}
45+
46+
| Name | Description |
47+
|----------------------------------------------|-------------|
48+
|`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server being used for the upgrade. |
49+
|`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server being used for the upgrade. |
50+
|`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server being used for the upgrade.|
51+
|`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. If the built-in load balancer is not being used, this should be removed.|
52+
|`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. |
53+
|`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. |
54+
|`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. |
55+
56+
1. Save and close `Cortex.Innovation.Upgrade.ps1`.
57+
58+
## Run Upgrade Script
59+
60+
{{< section "/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md" >}}
61+
62+
## Check Application Services
63+
64+
{{< section "/upgrade/upgrade-application-server/multi-server/check-application-services.md" >}}
65+
66+
## Disable Whitelist Analyser
67+
68+
{{< alert type="note" title="Note" >}} This release introduces a Whitelist Analyser to prevent unauthorised execution of namespaces. This step only needs to happen if the Whitelist Analyser should be disabled.{{< /alert >}}
69+
70+
On each of the Application Servers:
71+
72+
1. Open a File Explorer.
73+
1. Navigate to `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App1\ExecutionPkg.Code.*` replacing `<CustomerName>` with the Customer Name and `<NodeName>` with the NETBIOS name of the Application Server configured during installation.
74+
{{% alert title="Note" %}}
75+
To check the values to be used open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`.
76+
{{% /alert %}}
77+
1. Open the `appsettings.json` file in a text editor.
78+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
79+
1. Save and close the file.
80+
1. In the File Explorer, navigate to `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.*` replacing `<CustomerName>` with the Customer Name and `<NodeName>` with the NETBIOS name of the Application Server specified in step 2.
81+
1. Repeat steps 3 - 5.
82+
1. Open a web browser.
83+
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.
84+
1. Expand `Cluster` then `Nodes`.
85+
1. Restart the current node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions.
86+
87+
Once all nodes have been updated and restarted, it will be necessary to [re-check the Application Services][Check Application Services] to ensure that the nodes have re-started correctly.
88+
89+
## Preserve installation files
90+
91+
{{< section "/preserve-installation-files.md" >}}
92+
93+
## Next Steps?
94+
95+
1. [Upgrade Web Application Server][]
96+
97+
[Check Application Services]: {{< ref "#check-application-services">}}
98+
[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.PreUpgrade" >}}
99+
[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeWebApplicationServer" >}}
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Upgrade the Web Application Server"
3+
linkTitle: "Upgrade Web Application Server"
4+
description: "Information about upgrading the Web Application Server."
5+
weight: 40
6+
---
7+
8+
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.
9+
10+
[Upgrade Application Servers and Load Balancer]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: "Upgrade Interaction Portal"
3+
linkTitle: "Upgrade Interaction Portal"
4+
description: "Information about upgrading {{% ctx %}} Interaction Portal."
5+
weight: 60
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
## Perform Upgrade
13+
14+
No upgrade required
15+
16+
## Next Steps?
17+
18+
1. [Try It Out][]
19+
20+
[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeGateway" >}}
21+
[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.TryItOut" >}}
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Upgrade Flow Debugger"
3+
linkTitle: "Upgrade Flow Debugger"
4+
description: "Information about upgrading the Flow Debugger."
5+
weight: 30
6+
---
7+
8+
# {{< param title >}}
9+
10+
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.
11+
12+
## Configure Upgrade Script
13+
14+
{{< section "/upgrade/2025.5/upgrade-application-server/single-server/configure-upgrade-script.md" >}}
15+
16+
## Run Upgrade Script
17+
18+
{{< section "/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md">}}
19+
20+
## Check Application Services
21+
22+
{{< section "/upgrade/upgrade-application-server/single-server/check-application-services.md">}}
23+
24+
## Disable Whitelist Analyser
25+
26+
{{< alert type="note" title="Note" >}} This release introduces a Whitelist Analyser to prevent unauthorised execution of namespaces. This step only needs to happen if the Whitelist Analyser should be disabled and has also been disabled on on the Application Servers.{{< /alert >}}
27+
28+
On the Web Application Server:
29+
30+
1. Open a File Explorer.
31+
1. Navigate to `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\Applications\Cortex.Innovation.Execution_App1\ExecutionPkg.Code.*` replacing `<CustomerName>` with the Customer Name and `<NodeName>` with the NETBIOS name of the Web Application Server configured during installation.
32+
{{% alert title="Note" %}}
33+
To check the values to be used open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`.
34+
{{% /alert %}}
35+
1. Open the `appsettings.json` file in a text editor.
36+
1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`.
37+
1. Save and close the file.
38+
1. In the File Explorer, navigate to `%ProgramData%\SF\<CustomerName>.<NodeName>\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.*` replacing `<CustomerName>` with the Customer Name and `<NodeName>` with the NETBIOS name of the Web Application Server specified in step 2.
39+
1. Repeat steps 3 - 5.
40+
1. Open a web browser.
41+
1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the Web Application Server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.
42+
1. Expand `Cluster` then `Nodes`.
43+
1. Restart the node by clicking on the drop down menu next to the node name and select `Restart`. Confirm node restart by following the on-screen instructions.
44+
45+
Once the node has been updated and restarted, it will be necessary to [re-check the Application Services][Check Application Services] to ensure that the node has re-started correctly.
46+
47+
## Preserve installation files
48+
49+
{{< section "/preserve-installation-files.md">}}
50+
51+
## Next Steps?
52+
53+
1. [Upgrade Gateway][]
54+
55+
[Check Application Services]: {{< ref "#check-application-services">}}
56+
[Upgrade Application and Load Balancer Servers]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}}
57+
[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.UpgradeGateway" >}}

0 commit comments

Comments
 (0)