diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md index 74e5ad102..1f7c29358 100644 --- a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md @@ -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 --- \ No newline at end of file diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/_index.md new file mode 100644 index 000000000..aac92841b --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/_index.md @@ -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 +--- \ No newline at end of file diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/_index.md new file mode 100644 index 000000000..10ed76d03 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/_index.md @@ -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 +--- diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/pre-upgrade.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/pre-upgrade.md new file mode 100644 index 000000000..4522caef8 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/pre-upgrade.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md new file mode 100644 index 000000000..104c26b3f --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/_index.md new file mode 100644 index 000000000..c5b0b42cc --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/_index.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md new file mode 100644 index 000000000..c61b5c9b1 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md @@ -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.

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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md new file mode 100644 index 000000000..daa8605e4 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..1cee5d6eb --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md new file mode 100644 index 000000000..3424d9302 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md new file mode 100644 index 000000000..04287da73 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/_index.md new file mode 100644 index 000000000..8364e72cf --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/_index.md @@ -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 %}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/pre-upgrade.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/pre-upgrade.md new file mode 100644 index 000000000..68dd69ccc --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/pre-upgrade.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md new file mode 100644 index 000000000..734212196 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/_index.md new file mode 100644 index 000000000..bb97b7d9e --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/_index.md @@ -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" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md new file mode 100644 index 000000000..332f495fd --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server.md @@ -0,0 +1,51 @@ +--- +title: "Upgrade Application Server" +linkTitle: "Upgrade Application Server" +description: "Information about upgrading the Application Server." +weight: 30 +--- + +# {{< param title >}} + +This guide describes how to upgrade the Application Server components on the server from 2025.3 to 2025.5. 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.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 Application Server: + +{{< section "/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.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 Web Application Server][] + +[PreUpgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.PreUpgrade" >}} +[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md new file mode 100644 index 000000000..85c237114 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md @@ -0,0 +1,10 @@ +--- +title: "Upgrade 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 from 2025.3 to 2025.5. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. + +[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..48056aa8b --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md @@ -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.SingleServerWithoutHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.TryItOut" >}} diff --git a/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md new file mode 100644 index 000000000..1c2f6c945 --- /dev/null +++ b/content/en/docs/2025.5/Guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -0,0 +1,48 @@ +--- +title: "Upgrade Gateway" +linkTitle: "Upgrade Gateway" +description: "Information about upgrading {{% ctx %}} Gateway" +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to upgrade {{% ctx %}} Gateway from 2025.3 to 2025.5. Please ensure that the [Upgrade Application Server][] 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" >}} + +## 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" >}} + +## Next Steps? + +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] + +[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeCIP" >}} +[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/multi-server/make-artefacts-available.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/multi-server/make-artefacts-available.md new file mode 100644 index 000000000..2597d025a --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/multi-server/make-artefacts-available.md @@ -0,0 +1,31 @@ +1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it: + * Cortex Innovation 2025.5 - App Server Install Scripts.zip + * Cortex Innovation 2025.5 - App Services.zip + * Cortex Innovation 2025.5 - Block Packages.zip + * Cortex Innovation 2025.5 - Encryptor.zip + * Cortex Innovation 2025.5 - Gateway.zip + * Cortex Innovation 2025.5 - Web App Server Install Scripts.zip + + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + +1. Extract the `Cortex Innovation 2025.5 - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation 2025.5 - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.5 - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers, the `WebApplicationServer` value to contain the NETBIOS names or fully qualified domain name of the Web Application Server and the `LoadBalancerServer` value to contain the NETBIOS names or fully qualified domain name of the Load Balancer Server (remove the `LoadBalancerServer` parameter if using an [alternative load balancer][]): + + ```powershell + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" -LoadBalancerServer "lb-server" + ``` + +[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/single-server/make-artefacts-available.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/single-server/make-artefacts-available.md new file mode 100644 index 000000000..402d9e6eb --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/pre-upgrade/single-server/make-artefacts-available.md @@ -0,0 +1,29 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation 2025.5 - App Server Install Scripts.zip + * Cortex Innovation 2025.5 - App Services.zip + * Cortex Innovation 2025.5 - Block Packages.zip + * Cortex Innovation 2025.5 - Encryptor.zip + * Cortex Innovation 2025.5 - Gateway.zip + * Cortex Innovation 2025.5 - Web App Server Install Scripts.zip + + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + +1. Extract the `Cortex Innovation 2025.5 - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation 2025.5 - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.5 - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: + + ```powershell + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" + ``` diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md new file mode 100644 index 000000000..ef4cf3d47 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/disable-code-analyser.md @@ -0,0 +1,19 @@ +1. Open a File Explorer. +1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. + {{% alert title="Note" %}} +To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. + {{% /alert %}} +1. Open the `appsettings.json` file in a text editor. +1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. +1. Save and close the file. +1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. +1. Repeat steps 3 - 5. +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 the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. + + {{% alert title="Note" %}} +If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.CheckApplicationServices" title="Check Application Services" >}}. + {{% /alert %}} + +1. Expand `Cluster` then `Nodes`. +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. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md new file mode 100644 index 000000000..784aa1d13 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/multi-server/run-upgrade-script.md @@ -0,0 +1,30 @@ +1. Open a Windows PowerShell (x64) window as administrator. + {{< alert title="Important" color="warning" >}}It is critical to make sure this is a new PowerShell window. If any Service Fabric cmdlets have been run previously to running the `Cortex.Innovation.Upgrade.ps1` script, the upgrade will close halfway through due to the PowerShell module being updated.{{< /alert >}} +1. Navigate PowerShell to inside the `Cortex Innovation 2025.5 - App Server Install Scripts\Upgrade Application Server` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.5 - App Server Install Scripts\Upgrade Application Server" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Upgrade.ps1 + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -AcceptEULA + ``` + +1. Run the PowerShell command to upgrade the HA Services and required infrastructure. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all servers and press OK. +1. Wait for the script to finish running. This should take approximately 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If the errors do not give any instructions on how to rectify, see [Troubleshooting During Upgrade][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[Troubleshooting During Upgrade]: {{< url path="Cortex.Reference.Troubleshooting.Upgrade.TroubleshootingDuringUpgrade" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/configure-upgrade-script.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/configure-upgrade-script.md new file mode 100644 index 000000000..cfc15c0f6 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/configure-upgrade-script.md @@ -0,0 +1,37 @@ +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") ` + -Credential $Credential ` + -AcceptEULA:$AcceptEULA ` + *>&1 | Tee-Object -FilePath "cortex-app-upgrade-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |----------------------------------------------|-------------| + |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the server. | + |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. | + |`ApplicationServerIPv4Addresses` | The IPv4 address of the server.| + |`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.

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`. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md new file mode 100644 index 000000000..39a03c7d0 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser-debugger.md @@ -0,0 +1,19 @@ +1. Open a File Explorer. +1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. + {{% alert title="Note" %}} +To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. + {{% /alert %}} +1. Open the `appsettings.json` file in a text editor. +1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. +1. Save and close the file. +1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. +1. Repeat steps 3 - 5. +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 the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. + + {{% alert title="Note" %}} +If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA.CheckDebuggerApplicationServices" title="Check Application Services" >}}. + {{% /alert %}} + +1. Expand `Cluster` then `Nodes`. +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. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md new file mode 100644 index 000000000..0e8b6600e --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/disable-code-analyser.md @@ -0,0 +1,19 @@ +1. Open a File Explorer. +1. Navigate to the Execution service directory, e.g. `%ProgramData%\SF\.\Fabric\work\Applications\Cortex.Innovation.Execution_App\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name configured during installation, `` with the NETBIOS name of the server and `` with the highest number in the directory. + {{% alert title="Note" %}} +To check the value to be used for Customer Name open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. + {{% /alert %}} +1. Open the `appsettings.json` file in a text editor. +1. Locate the `"FeatureFlags"` line located under `"ExecutionEngine"` and set the value to `["f4fd94c0-a921-4b34-b82c-378b05e91555"]`. +1. Save and close the file. +1. In the File Explorer, navigate to `%ProgramData%\SF\.\Fabric\work\ImageCache\Store\Cortex.Innovation.Execution\ExecutionPkg.Code.27.3.0.25260` replacing `` with the Customer Name and `` with the NETBIOS name of the server specified in step 2. +1. Repeat steps 3 - 5. +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 the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation. + + {{% alert title="Note" %}} +If a certificate error occurs, it will be necessary to import the client certificate used in the original installation. Follow instructions provided in Step 2 of {{< ahref path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA.CheckApplicationServices" title="Check Application Services" >}}. + {{% /alert %}} + +1. Expand `Cluster` then `Nodes`. +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. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/make-installation-artefacts-available.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/make-installation-artefacts-available.md new file mode 100644 index 000000000..18ab6fb61 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/make-installation-artefacts-available.md @@ -0,0 +1,6 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation 2025.5 - Block Packages.zip + * Cortex Innovation 2025.5 - App Services.zip + * Cortex Innovation 2025.5 - App Server Install Scripts.zip + +1. Extract the `Cortex Innovation 2025.5 - App Server Install Scripts.zip` file to a folder with the same name. diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md new file mode 100644 index 000000000..494f2f948 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-application-server/single-server/run-upgrade-script.md @@ -0,0 +1,30 @@ +1. Open a Windows PowerShell (x64) window as administrator. + {{< alert title="Important" color="warning" >}}It is critical to make sure this is a new PowerShell window. If any Service Fabric cmdlets have been run previously to running the `Cortex.Innovation.Upgrade.ps1` script, the upgrade will close halfway through due to the PowerShell module being updated.{{< /alert >}} +1. Navigate PowerShell to inside the `Cortex Innovation 2025.5 - App Server Install Scripts\Upgrade Application Server` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.5 - App Server Install Scripts\Upgrade Application Server" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Upgrade.ps1 + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -AcceptEULA + ``` + +1. Run the PowerShell command to upgrade the application services and required infrastructure. +1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. +1. Wait for the script to finish running. This should take approximately 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If the errors do not give any instructions on how to rectify, see [Troubleshooting During Upgrade][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance. + +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Troubleshooting During Upgrade]: {{< url path="Cortex.Reference.Troubleshooting.Upgrade.TroubleshootingDuringUpgrade" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/configure-gateway-script.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/configure-gateway-script.md new file mode 100644 index 000000000..bcec79da8 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/configure-gateway-script.md @@ -0,0 +1,48 @@ +1. In the `Cortex Innovation 2025.5 - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.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.GatewayConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or any of the values should be changed then use the `Use New Configuration Values` tab removing any of the parameters that do need need to change leaving the minimum required parameters as can be seen in the `Use Previous Configuration Values` tab. + {{% /alert %}} + + {{< tabpane lang="powershell" >}} + {{< tab header="Use Previous Configuration Values" >}} +.\Cortex.Install.Gateway.ps1 ` + -GatewayPackagePath "C:\Install\Cortex Innovation 2025.5 - Gateway.zip" ` + -ApplySecurityMeasures $true ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" + {{< /tab >}} + {{< tab header="Use New Configuration Values">}} +.\Cortex.Install.Gateway.ps1 ` + -GatewayPackagePath "C:\Install\Cortex Innovation 2025.5 - Gateway.zip" ` + -GatewayApplicationPoolUsername "Domain\Username" ` + -WebRootFolder "C:\inetpub\wwwroot" ` + -WebsitePort "443" ` + -ImportCertificate $false ` + -CertificateFriendlyName "CertificateName" ` + -ConfigureSiteRedirect $true ` + -ApplySecurityMeasures $true ` + -UsingWindowsDefender $false ` + -AcceptEULA:$AcceptEula ` + *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt" + {{< /tab >}} + {{< /tabpane >}} + + | Name | Description | + |------------------------------------------------|-------------| + |`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation 2025.5 - Gateway.zip` file on the server. | + |`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.| + |`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.| + |`WebsitePort` | Replace this with the port that you wish the website to use. Typically this will be `443`.| + |`ImportCertificate` | This should be set to `$false`.| + |`CertificateFriendlyName` | Replace this with the friendly name that is allocated to the certificate that {{% ctx %}} Gateway is currently using.| + |`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.

To skip this rule creation change the value to `$false`.| + |`ApplySecurityMeasures` | Change this to `$false` if you do not require the latest recommended [Security Best Practices][] to be implemented as part of the installation process.| + |`UsingWindowsDefender` | Change this to `$false` if you are not using the Windows Defender firewall.

If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).| + |`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. | + |`FilePath` | The filename that installation 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.Install.Gateway.ps1`. + +[Security Best Practices]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.Advanced.SSLBestPractices" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/run-gateway-script.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/run-gateway-script.md new file mode 100644 index 000000000..a77f30ca8 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/run-gateway-script.md @@ -0,0 +1,32 @@ +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation 2025.5 - Web App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.5 - Web App Server Install Scripts" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Install.Gateway.ps1 + ``` + +1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g: + + ```powershell + .\.ps1 -AcceptEULA + ``` + +1. Run the PowerShell command to install {{% ctx %}} Gateway. +1. Check that there have been no errors in the script; these would appear in red in the console. + + If there are any errors, then please follow any instructions given within them to rectify the situation, and retry the upgrade. + + If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance. + +1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`). +{{< alert type="note" title="Note" >}} It is recommended to choose to restart later after the final step of this section has completed to ensure that no issues occur.{{< /alert >}} +1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `://:/`, e.g. `https://localhost/gateway` and wait for the login page to load. This may take a few minutes. + +[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}} +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/upgrade-cortex-interaction-portal.md b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/upgrade-cortex-interaction-portal.md new file mode 100644 index 000000000..8379ea670 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/2025.5/upgrade-web-application-server/upgrade-cortex-interaction-portal.md @@ -0,0 +1,5 @@ +If using the {{% ctx %}} Interaction Portal, it will need to be upgraded. + +For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. + +[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md new file mode 100644 index 000000000..226c4fda2 --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/configure-code-analyser.md @@ -0,0 +1,8 @@ +This release introduces a new Code Analyser used to restrict what C# code can be executed from flows within {{% ctx %}}. It is enabled and secure by default, restricting all C# data types and namespaces other than those required to run an empty flow. + +{{% alert title="Warning" color="warning" %}}This security feature WILL break existing flows.{{< /alert >}} + +It can either be [disabled][Disable Code Analyser] to restore behaviour to that prior of this release, or it's configured Allowed list can be [updated][Update Code Analyser] to allow the required C# data types and namespaces. + +[Update Code Analyser]: {{< ref "#update-code-analyser-allowed-list" >}} +[Disable Code Analyser]: {{< ref "#disable-code-analyser" >}} diff --git a/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md new file mode 100644 index 000000000..bd75d1fdb --- /dev/null +++ b/content/en/docs/2025.5/_shared/upgrade/upgrade-application-server/update-code-analyser.md @@ -0,0 +1,3 @@ +For assistance with configuring the Allowed list for the Code Analyser, please raise a case in the [{{% ctx %}} Service Portal][]. + +[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} diff --git a/data/urls.toml b/data/urls.toml index d6f56f311..802c2d991 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -900,6 +900,30 @@ UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.MultipleServerWithHA] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/" + PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/pre-upgrade" + TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/try-it-out" + Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade" + UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip" + UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger" + UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway" + UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server" + CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers/#check-application-services" + CheckDebuggerApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger/#check-application-services" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.3to2025.5.SingleServerWithoutHA] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/" + PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/pre-upgrade" + TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/try-it-out" + Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade" + UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip" + UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway" + UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-web-application-server" + CheckApplicationServices = "/docs/guides/upgrade-guides/upgrade-cortex/2025.3-to-2025.5/single-server-without-ha/upgrade/upgrade-application-server/#check-application-services" [Cortex.Guides.UpgradeGuides.UpgradeObservability] MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/" [Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise]