From 5cf2c72942eeb787f8d698fc56c3a5ed2da1a3ed Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 2 Apr 2025 13:34:21 +0100 Subject: [PATCH 1/5] added 2025.6.1 to 2025.3 upgrade guide, removed CIP upgrade from 2025.1 to 2025.3 upgrade guide and hid old upgrade guides --- .../upgrade-cortex/2024.1-to-2024.3/_index.md | 1 + .../2024.11-to-2025.1/_index.md | 3 +- .../upgrade-cortex/2024.3-to-2024.5/_index.md | 3 +- .../upgrade-cortex/2024.5-to-2024.7/_index.md | 3 +- .../upgrade-cortex/2024.7-to-2024.9/_index.md | 3 +- .../2024.9-to-2024.11/_index.md | 3 +- .../2024.9.25161-to-2025.3/_index.md | 6 ++ .../multiple-server-with-ha/_index.md | 6 ++ .../multiple-server-with-ha/pre-upgrade.md | 20 ++++++ .../multiple-server-with-ha/try-it-out.md | 25 +++++++ .../multiple-server-with-ha/upgrade/_index.md | 10 +++ ...de-application-and-loadbalancer-servers.md | 71 +++++++++++++++++++ .../upgrade-web-application-server/_index.md | 10 +++ .../upgrade-debugger.md | 33 +++++++++ .../upgrade-gateway.md | 33 +++++++++ .../single-server-without-ha/_index.md | 6 ++ .../single-server-without-ha/pre-upgrade.md | 20 ++++++ .../single-server-without-ha/try-it-out.md | 25 +++++++ .../upgrade/_index.md | 10 +++ .../upgrade/upgrade-application-server.md | 33 +++++++++ .../upgrade/upgrade-web-application-server.md | 33 +++++++++ .../upgrade-cortex/2025.1-to-2025.3/_index.md | 2 +- .../upgrade-gateway.md | 4 -- .../upgrade/upgrade-web-application-server.md | 4 -- data/urls.toml | 20 ++++++ layouts/partials/sidebar-tree.html | 8 ++- 26 files changed, 378 insertions(+), 17 deletions(-) create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/_index.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/_index.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/pre-upgrade.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/try-it-out.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/_index.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/_index.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/try-it-out.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/_index.md create mode 100644 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 create mode 100644 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.md diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.1-to-2024.3/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.1-to-2024.3/_index.md index 719b7315d..95f39822f 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.1-to-2024.3/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.1-to-2024.3/_index.md @@ -3,4 +3,5 @@ title: "2024.1 to 2024.3" linkTitle: "2024.1 to 2024.3" description: "Instructions to upgrade {{% ctx %}} 2024.1 to 2024.3" weight: 1000 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.11-to-2025.1/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.11-to-2025.1/_index.md index 5d859e5a4..843dc1be9 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.11-to-2025.1/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.11-to-2025.1/_index.md @@ -2,5 +2,6 @@ title: "2024.11 to 2025.1" linkTitle: "2024.11 to 2025.1" description: "Instructions to upgrade {{% ctx %}} 2024.11 to 2025.1" -weight: 980 +weight: 940 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.3-to-2024.5/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.3-to-2024.5/_index.md index d180e4d11..c59ea49ee 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.3-to-2024.5/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.3-to-2024.5/_index.md @@ -2,5 +2,6 @@ title: "2024.3 to 2024.5" linkTitle: "2024.3 to 2024.5" description: "Instructions to upgrade {{% ctx %}} 2024.3 to 2024.5" -weight: 999 +weight: 990 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.5-to-2024.7/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.5-to-2024.7/_index.md index b8251f69d..d939b7310 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.5-to-2024.7/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.5-to-2024.7/_index.md @@ -2,5 +2,6 @@ title: "2024.5 to 2024.7" linkTitle: "2024.5 to 2024.7" description: "Instructions to upgrade {{% ctx %}} 2024.5 to 2024.7" -weight: 998 +weight: 980 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.7-to-2024.9/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.7-to-2024.9/_index.md index 4a29d5dca..5e7521be6 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.7-to-2024.9/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.7-to-2024.9/_index.md @@ -2,5 +2,6 @@ title: "2024.7 to 2024.9" linkTitle: "2024.7 to 2024.9" description: "Instructions to upgrade {{% ctx %}} 2024.7 to 2024.9" -weight: 997 +weight: 970 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/_index.md index 4dccf9d72..9e5bd8ab8 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/_index.md @@ -2,5 +2,6 @@ title: "2024.9 to 2024.11" linkTitle: "2024.9 to 2024.11" description: "Instructions to upgrade {{% ctx %}} 2024.9 to 2024.11" -weight: 990 +weight: 960 +outOfSupport: true --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/_index.md new file mode 100644 index 000000000..be85541e0 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/_index.md @@ -0,0 +1,6 @@ +--- +title: "2024.9.25161 to 2025.3" +linkTitle: "2024.9.25161 to 2025.3" +description: "Instructions to upgrade {{% ctx %}} 2024.9.25161 to 2025.3" +weight: 950 +--- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/_index.md new file mode 100644 index 000000000..10ed76d03 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/pre-upgrade.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/pre-upgrade.md new file mode 100644 index 000000000..348a0116a --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/pre-upgrade.md @@ -0,0 +1,20 @@ +--- +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.3/pre-upgrade/multi-server/make-artefacts-available.md">}} + +## Next Steps? + +1. [Upgrade][] + +[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.Upgrade" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/try-it-out.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/try-it-out.md new file mode 100644 index 000000000..f9ef3f973 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} +[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/_index.md new file mode 100644 index 000000000..2a86739e7 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.2024.9.25161to2025.3.MultipleServerWithHA.PreUpgrade" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md new file mode 100644 index 000000000..572d917ba --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers.md @@ -0,0 +1,71 @@ +--- +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 2024.9.25161 to 2025.3. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting this upgrade. + +## Configure Upgrade Script + +1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor. +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.3 - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation 2025.3 - 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.3 - App Services.zip" ` + -BlockPackagesPath "C:\Install\Cortex Innovation 2025.3 - 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.3/upgrade-application-server/multi-server/run-upgrade-script.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.2024.9.25161to2025.3.MultipleServerWithHA.PreUpgrade" >}} +[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/_index.md new file mode 100644 index 000000000..7dc7cfc29 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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 v2024.9.25161 version of Gateway and its prerequisites have already been installed. + +[Upgrade Application Servers and Load Balancer]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md new file mode 100644 index 000000000..71ff686de --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger.md @@ -0,0 +1,33 @@ +--- +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 2024.9.25161 to 2025.3. Please ensure that the [Upgrade Application and Load Balancer Servers][] has been completed before starting this upgrade. + +## Configure Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-application-server/single-server/configure-upgrade-script.md" >}} + +## Run Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-application-server/single-server/run-upgrade-script.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.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeGateway" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md new file mode 100644 index 000000000..a6b6edffc --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -0,0 +1,33 @@ +--- +title: "Upgrade Gateway" +linkTitle: "Upgrade Gateway" +description: "Information about upgrading {{% ctx %}} Gateway from 2024.9.25161 to 2025.3." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 2025.3. Please ensure that the [Flow Debugger upgrade][] has been completed before starting this upgrade. + +## Configure Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-web-application-server/configure-gateway-script.md" >}} + +## Run Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}} + +## Preserve installation files + +{{< section "/preserve-installation-files.md" >}} + +## Upgrade {{% ctx %}} Interaction Portal + +{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeDebugger" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/_index.md new file mode 100644 index 000000000..a43e88369 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/_index.md @@ -0,0 +1,6 @@ +--- +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 +--- diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade.md new file mode 100644 index 000000000..f8a802354 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade.md @@ -0,0 +1,20 @@ +--- +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.3/pre-upgrade/single-server/make-artefacts-available.md">}} + +## Next Steps? + +1. [Upgrade][] + +[Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.Upgrade" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/try-it-out.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/try-it-out.md new file mode 100644 index 000000000..42dcb6975 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} +[Web Application Server Upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeWebApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/_index.md new file mode 100644 index 000000000..daaeae289 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.2024.9.25161to2025.3.SingleServerWithoutHA.PreUpgrade" >}} diff --git a/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 b/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 new file mode 100644 index 000000000..625829d47 --- /dev/null +++ b/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 @@ -0,0 +1,33 @@ +--- +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 2024.9.25161 to 2025.3. Please ensure that the [Pre-Upgrade][PreUpgrade] steps have been completed before starting this upgrade. + +## Configure Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-application-server/single-server/configure-upgrade-script.md" >}} + +## Run Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-application-server/single-server/run-upgrade-script.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.2024.9.25161to2025.3.SingleServerWithoutHA.PreUpgrade" >}} +[Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeWebApplicationServer" >}} diff --git a/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.md b/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.md new file mode 100644 index 000000000..1ebd99976 --- /dev/null +++ b/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.md @@ -0,0 +1,33 @@ +--- +title: "Upgrade Web Application Server" +linkTitle: "Upgrade Web Application Server" +description: "Information about upgrading the Web Application Server from 2024.9.25161 to 2025.3." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 2025.3. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. + +## Configure Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-web-application-server/configure-gateway-script.md" >}} + +## Run Upgrade Script + +{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}} + +## Preserve installation files + +{{< section "/preserve-installation-files.md" >}} + +## Upgrade {{% ctx %}} Interaction Portal + +{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.TryItOut" >}} +[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md index 17ab09dab..74e5ad102 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/_index.md @@ -2,5 +2,5 @@ title: "2025.1 to 2025.3" linkTitle: "2025.1 to 2025.3" description: "Instructions to upgrade {{% ctx %}} 2025.1 to 2025.3" -weight: 979 +weight: 930 --- \ No newline at end of file diff --git a/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 b/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 index 8e665bfbf..d5402fd80 100644 --- a/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 +++ b/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 @@ -21,10 +21,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? 1. [Try It Out][] diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md index 43e3f809e..1fb3159af 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md @@ -21,10 +21,6 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? 1. [Try It Out][] diff --git a/data/urls.toml b/data/urls.toml index bc3a414bc..e81505fe7 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -837,6 +837,26 @@ Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade" UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-application-server" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.Advanced] + UpgradeFlows = "/docs/guides/upgrade-guides/upgrade-cortex/advanced/upgrade-flows" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/" + PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/pre-upgrade" + TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/try-it-out" + Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade" + UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers" + UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger" + UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway" + UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server" + [Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA] + MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/" + PreUpgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/pre-upgrade" + TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/try-it-out" + Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade" + UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-application-server" + 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.UpgradeObservability] MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/" [Cortex.Guides.UpgradeGuides.UpgradeObservability.OnPremise] diff --git a/layouts/partials/sidebar-tree.html b/layouts/partials/sidebar-tree.html index 4918834da..ea9135d4b 100644 --- a/layouts/partials/sidebar-tree.html +++ b/layouts/partials/sidebar-tree.html @@ -70,9 +70,11 @@ {{ .LinkTitle }} {{ else }} {{ $ulNr := add $ulNr 1 }} - + {{ if not .Params.outOfSupport }} + + {{ end }} {{ end }} {{ end }} {{ end }} From d6bc8dc1d8adeacbe23c211482c57e959f785227 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 3 Apr 2025 13:33:46 +0100 Subject: [PATCH 2/5] separated CIP upgrade into its own page as a distinct upgrade like debugger and gateway --- .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 10 +++------ .../upgrade-cortex-interaction-portal.md | 2 +- .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 10 +++------ .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 10 +++------ .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 12 ++++------- .../upgrade-web-application-server/_index.md | 10 +++++++++ .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md} | 14 +++++-------- .../upgrade-cortex-interaction-portal.md | 2 +- .../upgrade-cortex-interaction-portal.md | 2 +- data/urls.toml | 5 +++++ 15 files changed, 141 insertions(+), 41 deletions(-) create mode 100644 content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md create mode 100644 content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md create mode 100644 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/_index.md create mode 100644 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-cip.md rename 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.md => upgrade-web-application-server/upgrade-gateway.md} (60%) diff --git a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..686b39b91 --- /dev/null +++ b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/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/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md index 9e7c99a18..3b8585d5b 100644 --- a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md @@ -2,7 +2,7 @@ title: "Upgrade Gateway" linkTitle: "Upgrade Gateway" description: "Information about upgrading {{% ctx %}} Gateway from 2024.9 to 2024.11." -weight: 30 +weight: 40 --- # {{% param title %}} @@ -21,13 +21,9 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9 to 2024.11. {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] [Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeDebugger" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeCIP" >}} diff --git a/content/en/docs/2024.11/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md b/content/en/docs/2024.11/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md index ed5a7526b..8379ea670 100644 --- a/content/en/docs/2024.11/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md +++ b/content/en/docs/2024.11/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md @@ -1,4 +1,4 @@ -If using the {{% ctx %}} Interaction Portal, it will need to be re-installed. +If using the {{% ctx %}} Interaction Portal, it will need to be upgraded. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. diff --git a/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..685a99c91 --- /dev/null +++ b/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/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/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md index 1dc507599..73c981fd1 100644 --- a/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2025.1/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md @@ -2,7 +2,7 @@ title: "Upgrade Gateway" linkTitle: "Upgrade Gateway" description: "Information about upgrading {{% ctx %}} Gateway from 2024.9 to 2024.11." -weight: 30 +weight: 40 --- # {{% param title %}} @@ -21,13 +21,9 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9 to 2024.11. {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] [Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeDebugger" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeCIP" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..685a99c91 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/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/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md index 1dc507599..73c981fd1 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway.md @@ -2,7 +2,7 @@ title: "Upgrade Gateway" linkTitle: "Upgrade Gateway" description: "Information about upgrading {{% ctx %}} Gateway from 2024.9 to 2024.11." -weight: 30 +weight: 40 --- # {{% param title %}} @@ -21,13 +21,9 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9 to 2024.11. {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] [Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeDebugger" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeCIP" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..2573d9fa4 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/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.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.TryItOut" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md index a6b6edffc..cfd556aab 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -2,7 +2,7 @@ title: "Upgrade Gateway" linkTitle: "Upgrade Gateway" description: "Information about upgrading {{% ctx %}} Gateway from 2024.9.25161 to 2025.3." -weight: 30 +weight: 40 --- # {{% param title %}} @@ -15,19 +15,15 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202 ## Run Upgrade Script -{{< section "/upgrade/2025.3/upgrade-web-application-server/run-gateway-script.md" >}} +{{< section "/upgrade/2024.11/upgrade-web-application-server/run-gateway-script.md" >}} ## Preserve installation files {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] [Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeDebugger" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.MultipleServerWithHA.UpgradeCIP" >}} diff --git a/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/_index.md b/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/_index.md new file mode 100644 index 000000000..fbc56aa14 --- /dev/null +++ b/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/_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 {{% ctx %}} Gateway from 2024.9 to 2024.11. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. + +[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/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-cip.md b/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-cip.md new file mode 100644 index 000000000..31b455fcd --- /dev/null +++ b/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-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.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.TryItOut" >}} diff --git a/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.md b/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 similarity index 60% rename from 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.md rename to 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 index 1ebd99976..c8fb9d0d1 100644 --- a/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.md +++ b/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 @@ -1,7 +1,7 @@ --- -title: "Upgrade Web Application Server" -linkTitle: "Upgrade Web Application Server" -description: "Information about upgrading the Web Application Server from 2024.9.25161 to 2025.3." +title: "Upgrade Gateway" +linkTitle: "Upgrade Gateway" +description: "Information about upgrading {{% ctx %}} Gateway" weight: 30 --- @@ -21,13 +21,9 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9.25161 to 202 {{< section "/preserve-installation-files.md" >}} -## Upgrade {{% ctx %}} Interaction Portal - -{{< section "/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md" >}} - ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeCIP" >}} [Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.3/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md b/content/en/docs/2025.3/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md index ed5a7526b..8379ea670 100644 --- a/content/en/docs/2025.3/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md +++ b/content/en/docs/2025.3/_shared/upgrade/2024.11/upgrade-web-application-server/upgrade-cortex-interaction-portal.md @@ -1,4 +1,4 @@ -If using the {{% ctx %}} Interaction Portal, it will need to be re-installed. +If using the {{% ctx %}} Interaction Portal, it will need to be upgraded. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. diff --git a/content/en/docs/2025.3/_shared/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md b/content/en/docs/2025.3/_shared/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md index ed5a7526b..8379ea670 100644 --- a/content/en/docs/2025.3/_shared/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md +++ b/content/en/docs/2025.3/_shared/upgrade/2025.3/upgrade-web-application-server/upgrade-cortex-interaction-portal.md @@ -1,4 +1,4 @@ -If using the {{% ctx %}} Interaction Portal, it will need to be re-installed. +If using the {{% ctx %}} Interaction Portal, it will need to be upgraded. For further assistance, please raise a case in the [{{% ctx %}} Service Portal][]. diff --git a/data/urls.toml b/data/urls.toml index e81505fe7..40d7426aa 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -674,6 +674,7 @@ TryItOut = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/try-it-out" RetrieveAppServerEncryptionKey = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites/#retrieve-existing-encryption-key" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers" + UpgradeCIP = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip" UpgradeDebugger = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-debugger" UpgradeGateway = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server" @@ -788,6 +789,7 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/try-it-out" RetrieveAppServerEncryptionKey = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites/#retrieve-existing-encryption-key" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-cip" UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-debugger" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server" @@ -847,6 +849,7 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip" UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server" @@ -856,6 +859,8 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade" UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/single-server-without-ha/upgrade/upgrade-application-server" + 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.UpgradeObservability] MainDoc = "/docs/guides/upgrade-guides/upgrade-observability/" From 790dec531433fb6683a89ee9bb02fc03af1e5b5d Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Thu, 3 Apr 2025 14:12:23 +0100 Subject: [PATCH 3/5] added new single server upgrade structure to 2025.1 to 2025.3 upgrade guide --- .../upgrade/upgrade-web-application-server/_index.md | 2 +- .../upgrade/upgrade-web-application-server/_index.md | 10 ++++++++++ .../upgrade-gateway.md} | 6 +++--- 3 files changed, 14 insertions(+), 4 deletions(-) create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md rename content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/{upgrade-web-application-server.md => upgrade-web-application-server/upgrade-gateway.md} (82%) diff --git a/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/_index.md b/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/_index.md index fbc56aa14..c51e3d493 100644 --- a/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/_index.md +++ b/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/_index.md @@ -5,6 +5,6 @@ description: "Information about upgrading the Web Application Server." weight: 40 --- -This guide describes how to upgrade {{% ctx %}} Gateway from 2024.9 to 2024.11. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. +This guide describes how to upgrade the web application server from 2024.9.25161 to 2025.3. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. [Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/_index.md new file mode 100644 index 000000000..81bb8aaf5 --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/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.1 to 2025.3. Please ensure that the [Upgrade Application Server][] has been completed before starting this upgrade. + +[Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md similarity index 82% rename from content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md rename to content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md index 1fb3159af..0317fb315 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -1,7 +1,7 @@ --- -title: "Upgrade Web Application Server" -linkTitle: "Upgrade Web Application Server" -description: "Information about upgrading the Web Application Server from 2025.1 to 2025.3." +title: "Upgrade Gateway" +linkTitle: "Upgrade Gateway" +description: "Information about upgrading {{% ctx %}} Gateway" weight: 30 --- From ec415aaffbda17ab7e4e2fed8ff761e03bfab29a Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 7 Apr 2025 13:39:58 +0100 Subject: [PATCH 4/5] added CIP to upgrade process for 2025.1 to 2025.3 --- .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 4 ++-- .../upgrade-cip.md | 21 +++++++++++++++++++ .../upgrade-gateway.md | 4 ++-- data/urls.toml | 3 +++ 5 files changed, 49 insertions(+), 4 deletions(-) create mode 100644 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-cip.md create mode 100644 content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md diff --git a/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-cip.md b/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-cip.md new file mode 100644 index 000000000..ea2a74b85 --- /dev/null +++ b/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-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 + +No upgrade required + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.TryItOut" >}} diff --git a/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 b/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 index d5402fd80..434011577 100644 --- a/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 +++ b/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 @@ -23,7 +23,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] [Flow Debugger upgrade]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeDebugger" >}} -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.MultipleServerWithHA.UpgradeCIP" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip.md new file mode 100644 index 000000000..f567cda6a --- /dev/null +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/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 + +No upgrade required + +## Next Steps? + +1. [Try It Out][] + +[Upgrade Gateway]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeGateway" >}} +[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.TryItOut" >}} diff --git a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md index 0317fb315..0abe0276d 100644 --- a/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md +++ b/content/en/docs/2025.3/Guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway.md @@ -23,7 +23,7 @@ This guide describes how to upgrade {{% ctx %}} Gateway from 2025.1 to 2025.3. P ## Next Steps? -1. [Try It Out][] +1. [Upgrade {{% ctx %}} Interaction Portal][Upgrade CIP] -[Try It Out]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.TryItOut" >}} +[Upgrade CIP]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeCIP" >}} [Upgrade Application Server]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.2025.1to2025.3.SingleServerWithoutHA.UpgradeApplicationServer" >}} diff --git a/data/urls.toml b/data/urls.toml index 40d7426aa..7f033d06c 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -829,6 +829,7 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-application-and-loadbalancer-servers" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-cip" UpgradeDebugger = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-debugger" UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/multiple-server-with-ha/upgrade/upgrade-web-application-server" @@ -838,6 +839,8 @@ TryItOut = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/try-it-out" Upgrade = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade" UpgradeApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-application-server" + UpgradeCIP = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-cip" + UpgradeGateway = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server/upgrade-gateway" UpgradeWebApplicationServer = "/docs/guides/upgrade-guides/upgrade-cortex/2025.1-to-2025.3/single-server-without-ha/upgrade/upgrade-web-application-server" [Cortex.Guides.UpgradeGuides.UpgradeCortex.2024.9.25161to2025.3] MainDoc = "/docs/guides/upgrade-guides/upgrade-cortex/2024.9.25161-to-2025.3/" From b3ba879a6a9c795ef9d2d80f57aeeb56085b203b Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Mon, 7 Apr 2025 13:45:43 +0100 Subject: [PATCH 5/5] Changed Client Cert Path and Password Param descriptions to be specified for all Multi Server CA installs and not just built in LB --- ...ll-application-and-loadbalancer-servers.md | 24 +++++++++---------- ...ll-application-and-loadbalancer-servers.md | 24 +++++++++---------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 6bb7fef82..a93d17696 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.3/getting-started/on-premise/add-innovation-to-72/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -211,23 +211,23 @@ To check all necessary ports are free, follow these steps: | Name | Description | |----------------------------------------------|-------------| - |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | + |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server used for installation. | - |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

For security reasons it is recommended that the default value should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

For security reasons it is recommended that the default value should be changed.

This value will be needed [later, when upgrading Gateway][Upgrade Gateway].{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | |`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server used for installation. | |`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. This is only needed if using the built-in load balancer. | |`ServerCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the HA cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| - |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`ClientCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. This can be the same certificate as the `ServerCertificatePath`. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended) and using the Built-In Load Balancer. The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the load balancer and the nodes on the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}} - |`ClientCertificatePassword` | The password for the .PFX certificate file specified in `ClientCertificatePath`.

This is only needed if installing with CA Certificates (Recommended) and using the Built-In Load Balancer.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | - |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. Use when using an alternative load balancer or no load balancer. | - |`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. | - |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}The parameters `Host` and `Username` should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}. The parameter `Password` must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`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. | + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`ClientCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. This can be the same certificate as the `ServerCertificatePath`. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the load balancer and the nodes on the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}} + |`ClientCertificatePassword` | The password for the .PFX certificate file specified in `ClientCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. Use when using an alternative load balancer or no load balancer. | + |`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. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}The parameters `Host` and `Username` should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}. The parameter `Password` must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`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. | The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed [later, when upgrading Gateway][Upgrade Gateway]. diff --git a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md index 52c400533..91497df50 100644 --- a/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md +++ b/content/en/docs/2025.3/getting-started/on-premise/install-innovation-only/multiple-server-with-ha/installation/install-application-and-loadbalancer-servers.md @@ -211,23 +211,23 @@ To check all necessary ports are free, follow these steps: | Name | Description | |----------------------------------------------|-------------| - |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | + |`AppServicesPath` | Configure this value with the location of the Application Services zip file on the Application Server used for installation. | |`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the Application Server used for installation. | - |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| - |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

For security reasons it is recommended that the default value should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ApiGatewayBasicAuthUsername` | Configure this value with a username that can be used to make HTTPS requests to the API Gateway Service using Basic Authentication (e.g. starting flows). This username will be used by Gateway for all HTTPS requests to the API Gateway Service.

For security reasons it is recommended that the default value `BasicAuthUser` should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].

This username can also be used by external services for HTTPS requests to the API Gateway Service but is not recommended; these requests should use an OAuth2 session for an authorised Active Directory user.{{< alert type="note" title="Note" >}} This parameter should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| + |`ApiGatewayBasicAuthPassword` | Configure this value with the password for the username specified for `ApiGatewayBasicAuthUsername`.

For security reasons it is recommended that the default value should be changed.

This value will be needed later, [when installing Gateway][Install Gateway].{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}}| |`CustomerName` | A name identifying the platform being installed. This must have no spaces or symbols. It will be appended to the node names that are displayed in Service Fabric Explorer. | |`ApplicationServerIPv4Addresses` | The IPv4 addresses of the Application Servers. The first of these must be the Application Server used for installation. | |`LoadBalancerServerIPv4Address` | The IPv4 address of the Load Balancer Server. This is only needed if using the built-in load balancer. | |`ServerCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the Application Services.
  • Allowing Application Services to identify themselves to clients such as Gateway.
  • Preventing unauthorised nodes from joining the HA cluster.
  • Connecting to Service Fabric Explorer from each of the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}}| - |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`ClientCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. This can be the same certificate as the `ServerCertificatePath`. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended) and using the Built-In Load Balancer. The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the load balancer and the nodes on the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}} - |`ClientCertificatePassword` | The password for the .PFX certificate file specified in `ClientCertificatePath`.

This is only needed if installing with CA Certificates (Recommended) and using the Built-In Load Balancer.{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | - |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. Use when using an alternative load balancer or no load balancer. | - |`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. | - |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}The parameters `Host` and `Username` should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}. The parameter `Password` must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | - |`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. | + |`ServerCertificatePassword` | The password for the .PFX certificate file specified in `ServerCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`ClientCertificatePath` | The local path of a .PFX certificate file on the first Application Server in the `ApplicationServerIPv4Addresses` list. This can be the same certificate as the `ServerCertificatePath`. Environment variables cannot be used.

This is only needed if installing with CA Certificates (Recommended). The certificate should meet the [Certificate Requirements][].

This certificate will be used for:
  • Securing communication between the load balancer and the nodes on the Application Servers.
{{< alert type="warning" title="Warning" >}}It is critical to set a reminder to {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.RolloverCertificates" title="update certificates" >}} in good time before they expire. If they expire then the platform will cease to function and {{< ahref path="Cortex.ServicePortal.MainDoc" title="CORTEX Service Portal" >}} must be contacted for support.{{< /alert >}} + |`ClientCertificatePassword` | The password for the .PFX certificate file specified in `ClientCertificatePath`.

This is only needed if installing with CA Certificates (Recommended).{{< alert type="note" title="Note" >}} This parameter must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`UseSelfSignedCertificates` | Installs Application Services and required infrastructure using generated Self-Signed Certificates rather than CA Certificates.

Not recommended for production use. | + |`SkipLoadBalancer` | Installs Application Services and required infrastructure without installing a load balancer. Use when using an alternative load balancer or no load balancer. | + |`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. | + |`LdapConnectionDetails` | The connection details to the LDAP server.

This must be configured with a valid `Host`, `Username`, `Password`, and whether the LDAP server uses SSL using `UseSsl`. {{< alert type="note" title="Note" >}}The parameters `Host` and `Username` should be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}. The parameter `Password` must be {{< ahref path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.Advanced.EncryptText" title="CORTEX Encrypted" >}}.{{< /alert >}} | + |`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. | The `ApiGatewayBasicAuthUsername` and `ApiGatewayBasicAuthPassword` will be needed later, [when installing Gateway][Install Gateway].