Feature/update disaster recovery documentation to use {{% ctx %}} placeholder for consistency

cortex-sa · cortex-sa · commit 490fb7ff2735 · 2025-04-24T09:18:06.000+01:00
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Multiple Server - With HA"
 linkTitle: "Multiple Server - With HA"
-description: "Instructions for Disaster recovery of CORTEX on multiple on-premise servers with high availability (HA)."
+description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on multiple on-premise servers with high availability (HA)."
 weight: 50
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Backup"
 linkTitle: "Backup"
-description: "Instructions to backup CORTEX on multiple on-premise servers with high availability (HA)."
+description: "Instructions to backup {{% ctx %}} on multiple on-premise servers with high availability (HA)."
 weight: 100
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md
@@ -23,6 +23,6 @@ weight: 30
 
 ## Next Steps?
 
-[Add Scheduled Backup to Application Server][]
+1. [Add Scheduled Backup to Application Server][]
 
 [Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md
@@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Application Serv
 
 ## Next Steps?
 
-[Add Scheduled Backups to Web Application Server][]
+1. [Add Scheduled Backups to Web Application Server][]
 
 [Add Scheduled Backups to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupsToWebApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md
@@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the backu
 
 ## Make Installation Artefacts Available on all Servers
 
-{{< section "/disaster-recovery/make-installation-artefacts-available.md">}}
+{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}}
 
 ## Next Steps?
 
-[Add Backup of Encryption Key][]
+1. [Add Backup of Encryption Key][]
 
-[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}}
+[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md
@@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Flow Debugger on
 
 ## Next Steps?
 
-[Add Scheduled Backup to Gateway][]
+1. [Add Scheduled Backup to Gateway][]
 
 [Add Scheduled Backup to Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Recovery"
 linkTitle: "Recovery"
-description: "Instructions to recover CORTEX on multiple on-premise servers with high availability (HA)."
+description: "Instructions to recover {{% ctx %}} on multiple on-premise servers with high availability (HA)."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md
@@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the recov
 
 ## Make Installation Artefacts Available on all Servers
 
-{{< section "/disaster-recovery/make-installation-artefacts-available.md">}}
+{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}}
 
 ## Next Steps?
 
-[Recover Encryption Key from Backup][]
+1. [Recover Encryption Key from Backup][]
 
 [Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoveryEncryptionKeyFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md
@@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re
 
 ## Next Steps?
 
-[Recover Web Application Server from Scheduled Backups][]
+1. [Recover Web Application Server from Scheduled Backups][]
 
 [Recover Web Application Server from Scheduled Backups]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverWebApplicationServerFromBackups" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md
@@ -42,6 +42,6 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}.
 
 ## Next Steps?
 
-[Recover Application Server from Scheduled Backup][]
+1. [Recover Application Server from Scheduled Backup][]
 
 [Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverApplicationServerFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md
@@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re
 
 ## Next Steps?
 
-[Recover Gateway from Scheduled Backup][]
+1. [Recover Gateway from Scheduled Backup][]
 
 [Recover Gateway from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverGatewayFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md
@@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve
 
 ## Next Steps?
 
-[Remove Scheduled Backups From Web Application Server][]
+1. [Remove Scheduled Backups From Web Application Server][]
 
 [Remove Scheduled Backups From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger.md
@@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th
 
 ## Next Steps?
 
-[Remove Scheduled Backup From Gateway][]
+1. [Remove Scheduled Backup From Gateway][]
 
 [Remove Scheduled Backup From Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Single Server - Without HA"
 linkTitle: "Single Server - Without HA"
-description: "Instructions for Disaster recovery of CORTEX on a single on-premise server without high availability (HA)."
+description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on a single on-premise server without high availability (HA)."
 weight: 50
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Backup"
 linkTitle: "Backup"
-description: "Instructions to backup CORTEX on a single on-premise server without high availability (HA)."
+description: "Instructions to backup {{% ctx %}} on a single on-premise server without high availability (HA)."
 weight: 100
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key.md
@@ -23,6 +23,6 @@ weight: 30
 
 ## Next Steps?
 
-[Add Scheduled Backup to Application Server][]
+1. [Add Scheduled Backup to Application Server][]
 
 [Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md
@@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Application Serv
 
 ## Next Steps?
 
-[Add Scheduled Backup to Web Application Server][]
+1. [Add Scheduled Backup to Web Application Server][]
 
 [Add Scheduled Backup to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md
@@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the backu
 
 ## Make Installation Artefacts Available on all Servers
 
-{{< section "/disaster-recovery/make-installation-artefacts-available.md">}}
+{{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}}
 
 ## Next Steps?
 
-[Add Backup of Encryption Key][]
+1. [Add Backup of Encryption Key][]
 
 [Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupOfEncryptionKey" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Recovery"
 linkTitle: "Recovery"
-description: "Instructions to recover CORTEX on a single on-premise server without high availability (HA)."
+description: "Instructions to recover {{% ctx %}} on a single on-premise server without high availability (HA)."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/pre-recovery.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/pre-recovery.md
@@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the recov
 
 ## Make Installation Artefacts Available on all Servers
 
-{{< section "/disaster-recovery/make-installation-artefacts-available.md">}}
+{{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}}
 
 ## Next Steps?
 
-[Recover Encryption Key from Backup][]
+1. [Recover Encryption Key from Backup][]
 
 [Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoveryEncryptionKeyFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md
@@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re
 
 ## Next Steps?
 
-[Recover Web Application Server from Scheduled Backup][]
+1. [Recover Web Application Server from Scheduled Backup][]
 
 [Recover Web Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverWebApplicationServerFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup.md
@@ -42,6 +42,6 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}.
 
 ## Next Steps?
 
-[Recover Application Server from Scheduled Backup][]
+1. [Recover Application Server from Scheduled Backup][]
 
 [Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverApplicationServerFromBackup" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application.md
@@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve
 
 ## Next Steps?
 
-[Remove Scheduled Backup From Web Application Server][]
+1. [Remove Scheduled Backup From Web Application Server][]
 
 [Remove Scheduled Backup From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove.RemoveBackupFromWebApplicationServer" >}}
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md
@@ -4,8 +4,8 @@
     ```powershell
     .\Cortex.Backup.ps1 `
         -ConfigFileName "Cortex.Application.Backup.Config.json" `
-        -AutoRestoreOnDataLoss $false `
         -BackupPolicyName "Customer1.BackupPolicy1" `
+        -AutoRestoreOnDataLoss $false `
         -MaxIncrementalBackups 5 `
         -BackupSchedule "Weekly" `
         -BackupDays @("Monday") `
@@ -19,13 +19,13 @@
     | Name                                           | Description |
     |------------------------------------------------|-------------|
     | `BackupPolicyName`                             | Configure this value with the unique name of the backup policy that will be set for the application policy and the scheduled Windows task. |
-    | `AutoRestoreOnDataLoss`                        | Configure this value as `$true` if you want to trigger a restore automatically using the latest available backup in case the partition experiences a data loss event on your current application server. |
-    | `MaxIncrementalBackups`                        | Configure this value with the maximum number of incremental backups to be taken between two full backups.<br /><br />This is just the upper limit.<br /><br />A full backup may be taken before the specified number of incremental backups are completed in one of the following conditions:<br /><br />&nbsp; - The replica has never taken a full backup since it became primary,<br /><br />&nbsp; - Some of the log records since the last backup have been truncated, or<br /><br />&nbsp; - The replica passed the `MaxAccumulatedBackupLogSizeInMB` limit. |
+    | `AutoRestoreOnDataLoss`                        | This should be left as `$false`. |
+    | `MaxIncrementalBackups`                        | Configure this value with the maximum number of incremental backups to be taken between two full backups. |
     | `BackupSchedule`                               | Configure this value with either `Daily` or `Weekly`, depending on when the schedule will run. |
-    | `BackupDays`                                   | This is only needed if the `BackupSchedule` is set to `Weekly`. Configure this value with the days of the week when the backup should run. |
-    | `BackupTimes`                                  | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format. The date specified along with the time will be ignored. |
+    | `BackupDays`                                   | This is only needed if the `BackupSchedule` is set to `Weekly`. Configure this value with the days of the week when the backup should run (e.g. `@("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")`). |
+    | `BackupTimes`                                  | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format (e.g. `@("12:00:00", "1:15:00", "2:20:30")`). |
     | `BackupPath`                                   | Replace `\\UncPath\BackupLocation` with the path of the location where the backups will be stored. If the path is a network path, the `Credential` will be used to access that location. |
-    | `RetentionDuration`                            | Configure this value with the minimum duration for which a backup will remain stored in the storage. It might get deleted after that span of time. The format of the value should be in ISO8601 format. The date specified along with the time will be ignored. |
+    | `RetentionDuration`                            | Configure this value with the minimum duration for which a backup will remain stored in the storage. It might get deleted after that span of time. The format of the value should be in ISO8601 format (e.g. `"12:00:00"`). |
     | `MinimumNumberOfBackups`                       | Configure this value with the minimum number of backups to be retained at any point in time. If specified with a non-zero value, backups will not be deleted even if they have exceeded the retention duration, as long as the number of backups is less than or equal to this value. |
     | `Credential`                                   | The credentials of the user that will be used to access the `BackupPath`. It must be a domain user who 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. |
 
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/run-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/run-backup-script.md
@@ -11,7 +11,7 @@
     .\Cortex.Innovation.EncryptionKey.Backup.ps1
     ```
 
-1. Run the PowerShell command to backup the application services.
+1. Run the PowerShell command to backup the Encryption Key.
 1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK.
-1. Wait for the script to finish running. This should take approximately 1 minute.
+1. Wait for the script to finish running. This should take seconds.
 1. Check that there have been no errors in the script; these would appear in red in the console.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md
@@ -0,0 +1,24 @@
+1. Copy the following artefacts to a folder on the server:
+   * Cortex Innovation {{< version >}} - App Server Install Scripts.zip
+   * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip
+
+    {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}}
+
+1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name.
+1. Open a Windows PowerShell (x64) window as administrator.
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary:
+
+    ```powershell
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts"
+    ```
+
+1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command:
+
+    ```powershell
+    Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1
+    ```
+
+1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server:
+
+    ```powershell
+    .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server"
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/single-make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/single-make-installation-artefacts-available.md
