Skip to content

Commit b748e82

Browse files
Cortex-DMSCortex-DMS
authored
added additional upgrade instructions (#209)
Added additional upgrade instructions
1 parent c49827c commit b748e82

13 files changed

Lines changed: 165 additions & 0 deletions

File tree

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ linkTitle: "Multiple Server - With HA"
44
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
55
weight: 10
66
---
7+
8+
{{% alert title="Warning" color="warning" %}}
9+
This upgrade guide is only applicable if upgrading from 2024.9.25161.
10+
{{% /alert %}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ linkTitle: "Single Server - Without HA"
44
description: "Upgrade instructions for a single on-premise server without high availability (HA)."
55
weight: 500
66
---
7+
8+
{{% alert title="Warning" color="warning" %}}
9+
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.
10+
{{% /alert %}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,15 @@ This guide describes how to perform the steps required before starting the upgra
1313

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

16+
## Backup Configuration Portal Data
17+
18+
If using the {{% ctx %}} Configuration Portal, the data will need to be backed up.
19+
20+
For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].
21+
1622
## Next Steps?
1723

1824
1. [Upgrade][]
1925

26+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
2027
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.Upgrade" >}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-application-server.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ weight: 30
99

1010
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.
1111

12+
{{% alert title="Warning" color="warning" %}}
13+
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.
14+
{{% /alert %}}
15+
1216
## Configure Upgrade Script
1317

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

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,41 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202
1717

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

20+
## Delete Old Execution Services
21+
22+
1. Open a web browser.
23+
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.
24+
1. Expand `Cluster` then `Applications` then `Cortex.Innovation.Execution`.
25+
1. For all old execution applications:
26+
* Click on the drop down menu and select `Delete Application`. Confirm application deletion by following the on-screen instructions.
27+
* Give this a few minutes. If the application does not delete:
28+
* Expand `Nodes`
29+
* For each node:
30+
* Expand the node and select the application that matches the engine version number of the application that is being attempted to be deleted.
31+
* Expand each level up to and including `Code Packages`.
32+
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
33+
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.
34+
35+
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.
36+
37+
## Republish Packages
38+
39+
1. Log in to Gateway with a user that has the `Admin` role.
40+
1. Click on the `Admin` charm, then `Packages`.
41+
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
42+
1. For each published package version:
43+
* Select the package.
44+
* 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
45+
* Click `Create New Version` then click `Save` and wait for the new version to be created.
46+
* 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.
47+
* 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.
48+
49+
## Restore Configuration Portal Data
50+
51+
If using the {{% ctx %}} Configuration Portal, the data will need to be restored.
52+
53+
For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].
54+
2055
## Preserve installation files
2156

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

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

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

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ linkTitle: "Multiple Server - With HA"
44
description: "Upgrade instructions for multiple on-premise servers with high availability (HA)."
55
weight: 10
66
---
7+
8+
{{% alert title="Warning" color="warning" %}}
9+
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.
10+
{{% /alert %}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/pre-upgrade.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,17 @@ This guide describes how to perform the steps required before starting the upgra
1313

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

16+
## Backup Configuration Portal Data
17+
18+
{{< 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 >}}
19+
20+
If using the {{% ctx %}} Configuration Portal, the data will need to be backed up.
21+
22+
For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].
23+
1624
## Next Steps?
1725

1826
1. [Upgrade][]
1927

28+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
2029
[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.Upgrade" >}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ weight: 30
99

1010
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.
1111

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+
1216
## Configure Upgrade Script
1317

1418
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.

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,47 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P
1717

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

20+
## Delete Old Execution Services
21+
22+
{{< 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 >}}
23+
24+
1. Open a web browser.
25+
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.
26+
1. Expand `Cluster` then `Applications` then `Cortex.Innovation.Execution`.
27+
1. For all old execution applications:
28+
* Click on the drop down menu and select `Delete Application`. Confirm application deletion by following the on-screen instructions.
29+
* Give this a few minutes. If the application does not delete:
30+
* Expand `Nodes`
31+
* For each node:
32+
* Expand the node and select the application that matches the engine version number of the application that is being attempted to be deleted.
33+
* Expand each level up to and including `Code Packages`.
34+
* Click on the drop down menu for `Code` and select `Restart`. Confirm application restart by following the on-screen instructions.
35+
* Give this a few minutes. Once all nodes have been restarted the application should be deleted and disappear from the list of applications.
36+
37+
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.
38+
39+
## Republish Packages
40+
41+
{{< 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 >}}
42+
43+
1. Log in to Gateway with a user that has the `Admin` role.
44+
1. Click on the `Admin` charm, then `Packages`.
45+
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
46+
1. For each published package version:
47+
* Select the package.
48+
* 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
49+
* Click `Create New Version` then click `Save` and wait for the new version to be created.
50+
* 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.
51+
* 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.
52+
53+
## Restore Configuration Portal Data
54+
55+
{{< 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 >}}
56+
57+
If using the {{% ctx %}} Configuration Portal, the data will need to be restored.
58+
59+
For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].
60+
2061
## Preserve installation files
2162

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

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

69+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
2870
[Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeDebugger" >}}
2971
[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeCIP" >}}

‎content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/_index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ linkTitle: "Single Server - Without HA"
44
description: "Upgrade instructions for a single on-premise server without high availability (HA)."
55
weight: 500
66
---
7+
8+
{{% alert title="Warning" color="warning" %}}
9+
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.
10+
{{% /alert %}}

0 commit comments

Comments
 (0)