Skip to content

Commit a558117

Browse files
author
cortex-lp
committed
shared documentation
1 parent 640d836 commit a558117

12 files changed

Lines changed: 307 additions & 0 deletions

File tree

‎content/en/docs/2026.3/_shared/upgrade/2026.3/pre-upgrade/multi-server/make-artefacts-available.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
1. Choose one of the Application Servers to be used for installation, and copy the following artefacts to a folder on it:
2+
* Cortex Innovation 2026.3 - App Server Install Scripts.zip
3+
* Cortex Innovation 2026.3 - App Services.zip
4+
* Cortex Innovation 2026.3 - Block Packages.zip
5+
* Cortex Innovation 2026.3 - Encryptor.zip
6+
* Cortex Innovation 2026.3 - Gateway.zip
7+
* Cortex Innovation 2026.3 - Web App Server Install Scripts.zip
8+
9+
{{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}}
10+
11+
1. Extract the `Cortex Innovation 2026.3 - App Server Install Scripts.zip` file to a folder with the same name.
12+
1. Open a Windows PowerShell (x64) window as administrator.
13+
1. Navigate PowerShell to inside the `Cortex Innovation 2026.3 - App Server Install Scripts` folder using the following command, modifying the path as necessary:
14+
15+
```powershell
16+
cd "C:\Install\Cortex Innovation 2026.3 - App Server Install Scripts"
17+
```
18+
19+
1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command:
20+
21+
```powershell
22+
Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1
23+
```
24+
25+
1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` value to contain the NETBIOS names or fully qualified domain names of the Application Servers, the `WebApplicationServer` value to contain the NETBIOS names or fully qualified domain name of the Web Application Server and the `LoadBalancerServer` value to contain the NETBIOS names or fully qualified domain name of the Load Balancer Server (remove the `LoadBalancerServer` parameter if using an [alternative load balancer][]):
26+
27+
```powershell
28+
.\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" -LoadBalancerServer "lb-server"
29+
```
30+
31+
[alternative load balancer]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.AltLoadBalancerNew" >}}

‎content/en/docs/2026.3/_shared/upgrade/2026.3/pre-upgrade/single-server/make-artefacts-available.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
1. Copy the following artefacts to a folder on the server:
2+
* Cortex Innovation 2026.3 - App Server Install Scripts.zip
3+
* Cortex Innovation 2026.3 - App Services.zip
4+
* Cortex Innovation 2026.3 - Block Packages.zip
5+
* Cortex Innovation 2026.3 - Encryptor.zip
6+
* Cortex Innovation 2026.3 - Gateway.zip
7+
* Cortex Innovation 2026.3 - Web App Server Install Scripts.zip
8+
9+
{{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}}
10+
11+
1. Extract the `Cortex Innovation 2026.3 - App Server Install Scripts.zip` file to a folder with the same name.
12+
1. Open a Windows PowerShell (x64) window as administrator.
13+
1. Navigate PowerShell to inside the `Cortex Innovation 2026.3 - App Server Install Scripts` folder using the following command, modifying the path as necessary:
14+
15+
```powershell
16+
cd "C:\Install\Cortex Innovation 2026.3 - App Server Install Scripts"
17+
```
18+
19+
1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command:
20+
21+
```powershell
22+
Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1
23+
```
24+
25+
1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server:
26+
27+
```powershell
28+
.\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server"
29+
```

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-application-server/multi-server/run-upgrade-script.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
1. Open a Windows PowerShell (x64) window as administrator.
2+
{{< alert title="Important" color="warning" >}}It is critical to make sure this is a new PowerShell window. If any Service Fabric cmdlets have been run previously to running the `Cortex.Innovation.Upgrade.ps1` script, the upgrade will close halfway through due to the PowerShell module being updated.{{< /alert >}}
3+
1. Navigate PowerShell to inside the `Cortex Innovation 2026.3 - App Server Install Scripts\Upgrade Application Server` folder using the following command, modifying the path as necessary:
4+
5+
```powershell
6+
cd "C:\Install\Cortex Innovation 2026.3 - App Server Install Scripts\Upgrade Application Server"
7+
```
8+
9+
1. Type the following command into PowerShell:
10+
11+
```powershell
12+
.\Cortex.Innovation.Upgrade.ps1
13+
```
14+
15+
1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g:
16+
17+
```powershell
18+
.\<CortexUpgradeScriptName>.ps1 -AcceptEULA
19+
```
20+
21+
1. Run the PowerShell command to upgrade the HA Services and required infrastructure.
22+
1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on all servers and press OK.
23+
1. Wait for the script to finish running. This should take approximately 10 minutes.
24+
1. Check that there have been no errors in the script; these would appear in red in the console.
25+
26+
If the errors do not give any instructions on how to rectify, see [Troubleshooting During Upgrade][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance.
27+
28+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
29+
[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}}
30+
[Troubleshooting During Upgrade]: {{< url path="Cortex.Reference.Troubleshooting.Upgrade.TroubleshootingDuringUpgrade" >}}

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-application-server/single-server/configure-upgrade-script.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
1. In the `Cortex Innovation 2026.3 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor.
2+
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:
3+
4+
{{% alert title="Note" %}}
5+
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.
6+
{{% /alert %}}
7+
8+
{{< tabpane lang="powershell" >}}
9+
{{< tab header="Use Previous Configuration Values" >}}
10+
.\Cortex.Upgrade.ps1 `
11+
-AppServicesPath "C:\Install\Cortex Innovation 2026.3 - App Services.zip" `
12+
-BlockPackagesPath "C:\Install\Cortex Innovation 2026.3 - Block Packages.zip" `
13+
-Credential $Credential `
14+
-AcceptEULA:$AcceptEULA `
15+
*>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
16+
{{< /tab >}}
17+
{{< tab header="Use New Configuration Values">}}
18+
.\Cortex.Upgrade.ps1 `
19+
-AppServicesPath "C:\Install\Cortex Innovation 2026.3 - App Services.zip" `
20+
-BlockPackagesPath "C:\Install\Cortex Innovation 2026.3 - Block Packages.zip" `
21+
-ApplicationServerIPv4Addresses @("192.168.1.1") `
22+
-Credential $Credential `
23+
-AcceptEULA:$AcceptEULA `
24+
*>&1 | Tee-Object -FilePath "cortex-app-upgrade-log.txt"
25+
{{< /tab >}}
26+
{{< /tabpane >}}
27+
28+
| Name | Description |
29+
|----------------------------------------------|-------------|
30+
|`AppServicesPath` | Configure this value with the location of the Application Services zip file on the server. |
31+
|`BlockPackagesPath` | Configure this value with the location of the Block Packages zip file on the server. |
32+
|`ApplicationServerIPv4Addresses` | The IPv4 address of the server.|
33+
|`Credential` | The credentials of the user which will be used to perform remote operations on the server. It must be a domain user that is a member of the local Administrators group on the server.<br><br>This does not need to be changed, a prompt will appear to enter this information when the script is run. |
34+
|`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. |
35+
|`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. |
36+
37+
1. Save and close `Cortex.Innovation.Upgrade.ps1`.

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-application-server/single-server/make-installation-artefacts-available.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
1. Copy the following artefacts to a folder on the server:
2+
* Cortex Innovation 2026.3 - Block Packages.zip
3+
* Cortex Innovation 2026.3 - App Services.zip
4+
* Cortex Innovation 2026.3 - App Server Install Scripts.zip
5+
6+
1. Extract the `Cortex Innovation 2026.3 - App Server Install Scripts.zip` file to a folder with the same name.

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-application-server/single-server/run-upgrade-script.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
1. Open a Windows PowerShell (x64) window as administrator.
2+
{{< alert title="Important" color="warning" >}}It is critical to make sure this is a new PowerShell window. If any Service Fabric cmdlets have been run previously to running the `Cortex.Innovation.Upgrade.ps1` script, the upgrade will close halfway through due to the PowerShell module being updated.{{< /alert >}}
3+
1. Navigate PowerShell to inside the `Cortex Innovation 2026.3 - App Server Install Scripts\Upgrade Application Server` folder using the following command, modifying the path as necessary:
4+
5+
```powershell
6+
cd "C:\Install\Cortex Innovation 2026.3 - App Server Install Scripts\Upgrade Application Server"
7+
```
8+
9+
1. Type the following command into PowerShell:
10+
11+
```powershell
12+
.\Cortex.Innovation.Upgrade.ps1
13+
```
14+
15+
1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g:
16+
17+
```powershell
18+
.\<CortexUpgradeScriptName>.ps1 -AcceptEULA
19+
```
20+
21+
1. Run the PowerShell command to upgrade the application services and required infrastructure.
22+
1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK.
23+
1. Wait for the script to finish running. This should take approximately 10 minutes.
24+
1. Check that there have been no errors in the script; these would appear in red in the console.
25+
26+
If the errors do not give any instructions on how to rectify, see [Troubleshooting During Upgrade][] for further information; if this does not help then please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for assistance.
27+
28+
[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}}
29+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}
30+
[Troubleshooting During Upgrade]: {{< url path="Cortex.Reference.Troubleshooting.Upgrade.TroubleshootingDuringUpgrade" >}}

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-web-application-server/configure-gateway-script.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
1. In the `Cortex Innovation 2026.3 - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.ps1` script and open it with a text editor.
2+
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:
3+
4+
{{% alert title="Note" %}}
5+
To check the previous configuration values open the `Cortex.Upgrade.GatewayConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or any of the values should be changed then use the `Use New Configuration Values` tab removing any of the parameters that do need need to change leaving the minimum required parameters as can be seen in the `Use Previous Configuration Values` tab.
6+
{{% /alert %}}
7+
8+
{{< tabpane lang="powershell" >}}
9+
{{< tab header="Use Previous Configuration Values" >}}
10+
.\Cortex.Install.Gateway.ps1 `
11+
-GatewayPackagePath "C:\Install\Cortex Innovation 2026.3 - Gateway.zip" `
12+
-ApplySecurityMeasures $true `
13+
-AcceptEULA:$AcceptEula `
14+
*>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt"
15+
{{< /tab >}}
16+
{{< tab header="Use New Configuration Values">}}
17+
.\Cortex.Install.Gateway.ps1 `
18+
-GatewayPackagePath "C:\Install\Cortex Innovation 2026.3 - Gateway.zip" `
19+
-GatewayApplicationPoolUsername "Domain\Username" `
20+
-WebRootFolder "C:\inetpub\wwwroot" `
21+
-WebsitePort "443" `
22+
-ImportCertificate $false `
23+
-CertificateFriendlyName "CertificateName" `
24+
-ConfigureSiteRedirect $true `
25+
-ApplySecurityMeasures $true `
26+
-UsingWindowsDefender $false `
27+
-AcceptEULA:$AcceptEula `
28+
*>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt"
29+
{{< /tab >}}
30+
{{< /tabpane >}}
31+
32+
| Name | Description |
33+
|------------------------------------------------|-------------|
34+
|`GatewayPackagePath` | Configure this value with the location of the `Cortex Innovation 2026.3 - Gateway.zip` file on the server. |
35+
|`GatewayApplicationPoolUsername` | Replace `Domain\Username` with the user that is used to run the {{% ctx %}} Gateway application pool currently.|
36+
|`WebRootFolder` | Replace this with the correct path for the Web Root Folder on the server. Typically this will be `C:\inetpub\wwwroot`.|
37+
|`WebsitePort` | Replace this with the port that you wish the website to use. Typically this will be `443`.|
38+
|`ImportCertificate` | This should be set to `$false`.|
39+
|`CertificateFriendlyName` | Replace this with the friendly name that is allocated to the certificate that {{% ctx %}} Gateway is currently using.|
40+
|`ConfigureSiteRedirect` | If the site hosting the {{% ctx %}} Gateway web application is an existing site that doesn’t have its own content, it is recommended to redirect the site URL to the {{% ctx %}} Gateway web application URL. The default behaviour of the script is to create a URL Rewrite redirect rule to achieve this.<br /><br />To skip this rule creation change the value to `$false`.|
41+
|`ApplySecurityMeasures` | Change this to `$false` if you do not require the latest recommended [Security Best Practices][] to be implemented as part of the installation process.|
42+
|`UsingWindowsDefender` | Change this to `$false` if you are not using the Windows Defender firewall.<br /><br />If Windows Defender is not being used but an alternative firewall is, it must be configured to allow communication inbound via TCP on the port configured for HTTPS (usually 443).|
43+
|`AcceptEULA` | This does not need to be changed, the EULA will be accepted at a later stage. |
44+
|`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. |
45+
46+
1. Save and close `Cortex.Innovation.Install.Gateway.ps1`.
47+
48+
[Security Best Practices]: {{< url path="Cortex.Guides.UpgradeGuides.UpgradeCortex.Advanced.SSLBestPractices" >}}

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-web-application-server/republish-packages.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
1. Log in to Gateway with a user that has the `Admin` role.
2+
1. Click on the `Admin` charm, then `Packages`.
3+
1. In the `Package Definitions` grid, select `Is Published` filter option on the `Is Published` column to show all published packages.
4+
1. For each published package version:
5+
* Select the package.
6+
* Click `Unpublish` at the bottom of the `Definition` tab and click `Unpublish` on the confirmation pop-up dialog. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy.
7+
* Click `Create New Version` then click `Save` and wait for the new version to be created.
8+
* Click `Publish`. A success message should appear. If it doesn't it means that there is a problem with the configuration in the `web.config` file for {{% ctx %}} Gateway, or the Application Services aren't healthy.
9+
* Sometimes the list of published packages in the `Package Definitions` grid disappears. To fix, set the `Is Published` filter in the `Package Definitions` grid to blank option and then set the filter to `Is Published` option again to show all published packages.

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-web-application-server/run-gateway-script.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
1. Open a Windows PowerShell (x64) window as administrator.
2+
1. Navigate PowerShell to inside the `Cortex Innovation 2026.3 - Web App Server Install Scripts` folder using the following command, modifying the path as necessary:
3+
4+
```powershell
5+
cd "C:\Install\Cortex Innovation 2026.3 - Web App Server Install Scripts"
6+
```
7+
8+
1. Type the following command into PowerShell:
9+
10+
```powershell
11+
.\Cortex.Innovation.Install.Gateway.ps1
12+
```
13+
14+
1. Please read the End User Licence Agreement which can be found [here][Eula]. Once you agree to the terms, add the flag `-AcceptEULA` to the command entered above, e.g:
15+
16+
```powershell
17+
.\<CortexInstallScriptName>.ps1 -AcceptEULA
18+
```
19+
20+
1. Run the PowerShell command to install {{% ctx %}} Gateway.
21+
1. Check that there have been no errors in the script; these would appear in red in the console.
22+
23+
If there are any errors, then please follow any instructions given within them to rectify the situation, and retry the upgrade.
24+
25+
If the errors do not give any instructions on how to rectify, please contact [{{% ctx %}} Service Portal][CORTEX Service Portal] for further assistance.
26+
27+
1. Once the PowerShell script execution has completed, a prompt will appear to restart the machine. You can choose to restart now (`N`) or later (`L`).
28+
{{< alert type="note" title="Note" >}} It is recommended to choose to restart later after the final step of this section has completed to ensure that no issues occur.{{< /alert >}}
29+
1. In a browser, navigate to the {{% ctx %}} Gateway website, available at `<protocol>://<host>:<port>/<webapplicationname>`, e.g. `https://localhost/gateway` and wait for the login page to load. This may take a few minutes.
30+
31+
[Eula]: {{< url path="Cortex.Website.Eula.MainDoc" >}}
32+
[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

‎content/en/docs/2026.3/_shared/upgrade/2026.3/upgrade-web-application-server/upgrade-cortex-configuration-portal.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
If using the {{% ctx %}} Configuration Portal, it will need to be upgraded.
2+
3+
For further assistance, please raise a case in the [{{% ctx %}} Service Portal][].
4+
5+
[{{% ctx %}} Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}}

0 commit comments

Comments
 (0)